diff options
author | knu <knu@b2dd03c8-39d4-4d8f-98ff-823fe69b080e> | 2014-06-23 08:46:11 +0000 |
---|---|---|
committer | knu <knu@b2dd03c8-39d4-4d8f-98ff-823fe69b080e> | 2014-06-23 08:46:11 +0000 |
commit | 4fa35e0e9d16537b540b1daf10ee2c229b3168cf (patch) | |
tree | 7ce81bf231eb2ea9e4ee3621ff676c70c2247a94 /lib | |
parent | 8250aa2df0d6b4dcfa11dbad5307d28c2d5dd85f (diff) | |
download | ruby-4fa35e0e9d16537b540b1daf10ee2c229b3168cf.tar.gz |
* lib/net/imap.rb (Net::IMAP#fetch): [DOC] Describe how a range in
+set+ is interpreted, and mention -1 which can be used for '*'.
git-svn-id: svn+ssh://ci.ruby-lang.org/ruby/trunk@46512 b2dd03c8-39d4-4d8f-98ff-823fe69b080e
Diffstat (limited to 'lib')
-rw-r--r-- | lib/net/imap.rb | 23 |
1 files changed, 16 insertions, 7 deletions
diff --git a/lib/net/imap.rb b/lib/net/imap.rb index 9f8ad7b273..9c021bf7e8 100644 --- a/lib/net/imap.rb +++ b/lib/net/imap.rb @@ -774,12 +774,22 @@ module Net end # Sends a FETCH command to retrieve data associated with a message - # in the mailbox. The +set+ parameter is a number, an array of - # numbers, or a Range object. The number is a message sequence - # number. +attr+ is a list of attributes to fetch; see the - # documentation for Net::IMAP::FetchData for a list of valid - # attributes. - # The return value is an array of Net::IMAP::FetchData. For example: + # in the mailbox. + # + # The +set+ parameter is a number or a range between two numbers, + # or an array of those. The number is a message sequence number, + # where -1 repesents a '*' for use in range notation like 100..-1 + # being interpreted as '100:*'. Beware that the +exclude_end?+ + # property of a Range object is ignored, and the contents of a + # range are independent of the order of the range endpoints as per + # the protocol specification, so 1...5, 5..1 and 5...1 are all + # equivalent to 1..5. + # + # +attr+ is a list of attributes to fetch; see the documentation + # for Net::IMAP::FetchData for a list of valid attributes. + # + # The return value is an array of Net::IMAP::FetchData. For + # example: # # p imap.fetch(6..8, "UID") # #=> [#<Net::IMAP::FetchData seqno=6, attr={"UID"=>98}>, \\ @@ -3769,4 +3779,3 @@ EOF imap.disconnect end end - |