Class: Mail::IMAP
- Defined in:
- lib/mail/network/retriever_methods/imap.rb
Overview
The IMAP retriever allows to get the last, first or all emails from a IMAP server. Each email retrieved (RFC2822) is given as an instance of Message
.
While being retrieved, emails can be yielded if a block is given.
Example of retrieving Emails from GMail:
Mail.defaults do
retriever_method :imap, { :address => "imap.googlemail.com",
:port => 993,
:user_name => '<username>',
:password => '<password>',
:enable_ssl => true }
end
Mail.all #=> Returns an array of all emails
Mail.first #=> Returns the first unread email
Mail.last #=> Returns the first unread email
You can also pass options into Mail.find to locate an email in your imap mailbox with the following options:
mailbox: name of the mailbox used for email retrieval. The default is 'INBOX'.
what: last or first emails. The default is :first.
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, :keys=>'ALL')
#=> Returns the first 10 emails in ascending order
Instance Attribute Summary collapse
-
#settings ⇒ Object
Returns the value of attribute settings.
Instance Method Summary collapse
-
#connection(&block) ⇒ Object
Returns the connection object of the retrievable (IMAP or POP3).
-
#delete_all(mailbox = 'INBOX') ⇒ Object
Delete all emails from a IMAP mailbox.
-
#find(options = {}, &block) ⇒ Object
Find emails in a IMAP mailbox.
-
#initialize(values) ⇒ IMAP
constructor
A new instance of IMAP.
Methods inherited from Retriever
#all, #find_and_delete, #first, #last
Constructor Details
#initialize(values) ⇒ IMAP
Returns a new instance of IMAP.
41 42 43 44 45 46 47 48 |
# File 'lib/mail/network/retriever_methods/imap.rb', line 41 def initialize(values) self.settings = { :address => "localhost", :port => 143, :user_name => nil, :password => nil, :authentication => nil, :enable_ssl => false }.merge!(values) end |
Instance Attribute Details
#settings ⇒ Object
Returns the value of attribute settings.
50 51 52 |
# File 'lib/mail/network/retriever_methods/imap.rb', line 50 def settings @settings end |
Instance Method Details
#connection(&block) ⇒ Object
Returns the connection object of the retrievable (IMAP or POP3)
122 123 124 125 126 127 128 |
# File 'lib/mail/network/retriever_methods/imap.rb', line 122 def connection(&block) raise ArgumentError.new('Mail::Retrievable#connection takes a block') unless block_given? start do |imap| yield imap end end |
#delete_all(mailbox = 'INBOX') ⇒ Object
Delete all emails from a IMAP mailbox
109 110 111 112 113 114 115 116 117 118 119 |
# File 'lib/mail/network/retriever_methods/imap.rb', line 109 def delete_all(mailbox='INBOX') mailbox ||= 'INBOX' mailbox = Net::IMAP.encode_utf7(mailbox) start do |imap| imap.uid_search(['ALL']).each do || imap.uid_store(, "+FLAGS", [Net::IMAP::DELETED]) end imap.expunge end end |
#find(options = {}, &block) ⇒ Object
Find emails in a IMAP mailbox. Without any options, the 10 last received emails are returned.
Possible options:
mailbox: mailbox to search the email(s) in. The default is 'INBOX'.
what: last or first emails. The default is :first.
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.
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'
70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 |
# File 'lib/mail/network/retriever_methods/imap.rb', line 70 def find(={}, &block) = () start do |imap| [:read_only] ? imap.examine([:mailbox]) : imap.select([:mailbox]) = imap.uid_search([:keys]) .reverse! if [:what].to_sym == :last = .first([:count]) if [:count].is_a?(Integer) .reverse! if ([:what].to_sym == :last && [:order].to_sym == :asc) || ([:what].to_sym != :last && [:order].to_sym == :desc) if block_given? .each do || fetchdata = imap.uid_fetch(, ['RFC822'])[0] = Mail.new(fetchdata.attr['RFC822']) .mark_for_delete = true if [:delete_after_find] if block.arity == 3 yield , imap, else yield end imap.uid_store(, "+FLAGS", [Net::IMAP::DELETED]) if [:delete_after_find] && .is_marked_for_delete? end imap.expunge if [:delete_after_find] else emails = [] .each do || fetchdata = imap.uid_fetch(, ['RFC822'])[0] emails << Mail.new(fetchdata.attr['RFC822']) imap.uid_store(, "+FLAGS", [Net::IMAP::DELETED]) if [:delete_after_find] end imap.expunge if [:delete_after_find] emails.size == 1 && [:count] == 1 ? emails.first : emails end end end |