✨ Add FetchData msg-att methods and update rdoc #220
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
nevans
force-pushed
the
fetch_data-attr-methods
branch
7 times, most recently
from
406c9e9 to
afcf01c
Compare
An accessor method has been created for every supported `msg-att` in
`#attrs`. These attrs accessors also provide a place for documentation
for each of the supported message attributes.
With one exception, all of the methods return the value from `#attrs`,
unchanged. The exception is `#internaldate`, which uses `parse_time` to
return a `Time` object rather than a string.
With one exception, these methods are given the same name as their
`msg-att` with "." changed to "_". The exception is the "body section"
attributes (`"BODY[#{section_spec}]<#offset}>"`), which has been given
several methods (which all accept an `offset` keyword argument):
* `#message` for `BODY[]`
* `#part(1, 2, 3)` for `BODY[1.2.3]`
* `#text(1, 2, 3)` for `BODY[1.2.3.TEXT]`
* `#mime(1, 2, 3)` for `BODY[1.2.3.MIME]`
* `#header(1, 2, 3)` for `BODY[1.2.3.HEADER]`
* `#header(fields: %w[Foo Bar])` or `#header_fields("Foo", "Bar")`
for `BODY[HEADER.FIELDS (Foo Bar)]`
* `#header(except: %w[Foo Bar])` or `#header_fields_not("Foo", "Bar")`
for `BODY[HEADER.FIELDS.NOT (Foo Bar)]`
nevans
force-pushed
the
fetch_data-attr-methods
branch
from
afcf01c to
5afd51a
Compare
24 tasks
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
An accessor method has been created for every supported
msg-attin#attr. These attr accessors also provide a place for documentation for each of the supported message attributes.With one exception, all of the methods return the value from
#attr, unchanged. The exception is#internaldate, which usesparse_timeto return aTimeobject rather than a string.With one exception, these methods are given the same name as their
msg-attwith"."changed to"_". The exception is the "body section" attributes ("BODY[#{section_spec}]<#offset}>"), which have been given several methods (which all accept anoffsetkeyword argument):#messageforBODY[]#part(1, 2, 3)forBODY[1.2.3]#text(1, 2, 3)forBODY[1.2.3.TEXT]#mime(1, 2, 3)forBODY[1.2.3.MIME]#header(1, 2, 3)forBODY[1.2.3.HEADER]#header(fields: %w[Foo Bar])or#header_fields("Foo", "Bar")for
BODY[HEADER.FIELDS (Foo Bar)]#header(except: %w[Foo Bar])or#header_fields_not("Foo", "Bar")for
BODY[HEADER.FIELDS.NOT (Foo Bar)]