Skip to content

Commit

Permalink
Updated IMAP documentation to fix typo and have all options documented
Browse files Browse the repository at this point in the history
  • Loading branch information
robdimarco committed Mar 16, 2012
1 parent aba2ed7 commit 7bd1f02
Showing 1 changed file with 11 additions and 3 deletions.
14 changes: 11 additions & 3 deletions lib/mail/network/retriever_methods/imap.rb
Original file line number Diff line number Diff line change
Expand Up @@ -28,8 +28,11 @@ module Mail
# order: order of emails returned. Possible values are :asc or :desc. Default value is :asc.
# count: number of emails to retrieve. The default value is 10. A value of 1 returns an
# instance of Message, not an array of Message instances.
# keys: are passed as criteria to the SEARCH command. They can either be a string holding the entire search string,
# or a single-dimension array of search keywords and arguments. Refer to [IMAP] section 6.4.4 for a full list
# The default is 'ALL'
#
# Mail.find(:what => :first, :count => 10, :order => :asc)
# Mail.find(:what => :first, :count => 10, :order => :asc, :keys=>'ALL')
# #=> Returns the first 10 emails in ascending order
#
class IMAP < Retriever
Expand All @@ -54,10 +57,15 @@ def initialize(values)
# order: order of emails returned. Possible values are :asc or :desc. Default value is :asc.
# count: number of emails to retrieve. The default value is 10. A value of 1 returns an
# instance of Message, not an array of Message instances.
# ready_only: will ensure that no writes are made to the inbox during the session.
# This is helpful when you don't want your messages to be set to read automatically. Default is false.
# read_only: will ensure that no writes are made to the inbox during the session. Specifically, if this is
# set to true, the code will use the EXAMINE command to retrieve the mail. If set to false, which
# is the default, a SELECT command will be used to retrieve the mail
# This is helpful when you don't want your messages to be set to read automatically. Default is false.
# delete_after_find: flag for whether to delete each retreived email after find. Default
# is false. Use #find_and_delete if you would like this to default to true.
# keys: are passed as criteria to the SEARCH command. They can either be a string holding the entire search string,
# or a single-dimension array of search keywords and arguments. Refer to [IMAP] section 6.4.4 for a full list
# The default is 'ALL'
#
def find(options={}, &block)
options = validate_options(options)
Expand Down

0 comments on commit 7bd1f02

Please sign in to comment.