Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

📚 Documentation updates #373

Merged
merged 12 commits into from
Jan 4, 2025
4 changes: 3 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,9 @@
# Net::IMAP

Net::IMAP implements Internet Message Access Protocol (IMAP) client
functionality. The protocol is described in [RFC3501](https://www.rfc-editor.org/rfc/rfc3501).
functionality. The protocol is described in
[RFC3501](https://www.rfc-editor.org/rfc/rfc3501),
[RFC9051](https://www.rfc-editor.org/rfc/rfc9051) and various extensions.

## Installation

Expand Down
12 changes: 11 additions & 1 deletion docs/styles.css
Original file line number Diff line number Diff line change
Expand Up @@ -10,18 +10,28 @@ main .method-detail {
justify-content: space-between;
}

main .method-header, main .method-controls {
main .method-header,
main .method-controls,
.attribute-method-heading {
padding: 0.5em;
/* border: 1px solid var(--highlight-color); */
background: var(--table-header-background-color);
line-height: 1.6;
}

.attribute-method-heading .attribute-access-type {
float: right;
}

main .method-header {
border-right: none;
border-radius: 4px 0 0 4px;
}

main .method-heading :any-link {
text-decoration: none;
}

main .method-controls {
border-left: none;
border-radius: 0 4px 4px 0;
Expand Down
8 changes: 5 additions & 3 deletions lib/net/imap/config.rb
Original file line number Diff line number Diff line change
Expand Up @@ -75,7 +75,7 @@ class IMAP
#
# client = Net::IMAP.new(hostname, config: :future)
# client.config.sasl_ir # => true
# client.config.responses_without_block # => :raise
# client.config.responses_without_block # => :frozen_dup
#
# The versioned default configs inherit certain specific config options from
# Config.global, for example #debug:
Expand Down Expand Up @@ -109,9 +109,11 @@ class IMAP
# [+:future+]
# The _planned_ eventual config for some future +x.y+ version.
#
# For example, to raise exceptions for all current deprecations:
# For example, to disable all currently deprecated behavior:
# client = Net::IMAP.new(hostname, config: :future)
# client.responses # raises an ArgumentError
# client.config.response_without_args # => :frozen_dup
# client.responses.frozen? # => true
# client.responses.values.all?(&:frozen?) # => true
#
# == Thread Safety
#
Expand Down
9 changes: 9 additions & 0 deletions lib/net/imap/fetch_data.rb
Original file line number Diff line number Diff line change
Expand Up @@ -103,6 +103,15 @@ class IMAP < Protocol
# as <tt>BODY[#{specifier}]</tt> or <tt>BINARY[#{section}]</tt>.
#
class FetchStruct < Struct
##
# method: attr
# :call-seq: attr -> hash
#
# Each key specifies a message attribute, and the value is the
# corresponding data item. Standard data items have corresponding
# accessor methods. The definitions of each attribute type is documented
# on its accessor.

# :call-seq: attr_upcase -> hash
#
# A transformation of #attr, with all the keys converted to upper case.
Expand Down
Loading
Loading