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.
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 last 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
# File lib/mail/network/retriever_methods/imap.rb, line 40 def initialize(values) self.settings = { :address => "localhost", :port => 143, :user_name => nil, :password => nil, :authentication => nil, :enable_ssl => false }.merge!(values) end
Returns the connection object of the retrievable (IMAP or POP3)
# File lib/mail/network/retriever_methods/imap.rb, line 121 def connection(&block) raise ArgumentError.new('Mail::Retrievable#connection takes a block') unless block_given? start do |imap| yield imap end end
Delete all emails from a IMAP mailbox
# File lib/mail/network/retriever_methods/imap.rb, line 108 def delete_all(mailbox='INBOX') mailbox ||= 'INBOX' mailbox = Net::IMAP.encode_utf7(mailbox) start do |imap| imap.uid_search(['ALL']).each do |message_id| imap.uid_store(message_id, "+FLAGS", [Net::IMAP::DELETED]) end imap.expunge end end
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'
# File lib/mail/network/retriever_methods/imap.rb, line 69 def find(options={}, &block) options = validate_options(options) start do |imap| options[:read_only] ? imap.examine(options[:mailbox]) : imap.select(options[:mailbox]) message_ids = imap.uid_search(options[:keys]) message_ids.reverse! if options[:what].to_sym == :last message_ids = message_ids.first(options[:count]) if options[:count].is_a?(Integer) message_ids.reverse! if (options[:what].to_sym == :last && options[:order].to_sym == :asc) || (options[:what].to_sym != :last && options[:order].to_sym == :desc) if block_given? message_ids.each do |message_id| fetchdata = imap.uid_fetch(message_id, ['RFC822'])[0] new_message = Mail.new(fetchdata.attr['RFC822']) new_message.mark_for_delete = true if options[:delete_after_find] if block.arity == 3 yield new_message, imap, message_id else yield new_message end imap.uid_store(message_id, "+FLAGS", [Net::IMAP::DELETED]) if options[:delete_after_find] && new_message.is_marked_for_delete? end imap.expunge if options[:delete_after_find] else emails = [] message_ids.each do |message_id| fetchdata = imap.uid_fetch(message_id, ['RFC822'])[0] emails << Mail.new(fetchdata.attr['RFC822']) imap.uid_store(message_id, "+FLAGS", [Net::IMAP::DELETED]) if options[:delete_after_find] end imap.expunge if options[:delete_after_find] emails.size == 1 && options[:count] == 1 ? emails.first : emails end end end
Start an IMAP session and ensures that it will be closed in any case.
# File lib/mail/network/retriever_methods/imap.rb, line 147 def start(config=Mail::Configuration.instance, &block) raise ArgumentError.new("Mail::Retrievable#imap_start takes a block") unless block_given? imap = Net::IMAP.new(settings[:address], settings[:port], settings[:enable_ssl], nil, false) if settings[:authentication].nil? imap.login(settings[:user_name], settings[:password]) else # Note that Net::IMAP#authenticate('LOGIN', ...) is not equal with Net::IMAP#login(...)! # (see also http://www.ensta.fr/~diam/ruby/online/ruby-doc-stdlib/libdoc/net/imap/rdoc/classes/Net/IMAP.html#M000718) imap.authenticate(settings[:authentication], settings[:user_name], settings[:password]) end yield imap ensure if defined?(imap) && imap && !imap.disconnected? imap.disconnect end end
Set default options
# File lib/mail/network/retriever_methods/imap.rb, line 132 def validate_options(options) options ||= {} options[:mailbox] ||= 'INBOX' options[:count] ||= 10 options[:order] ||= :asc options[:what] ||= :first options[:keys] ||= 'ALL' options[:delete_after_find] ||= false options[:mailbox] = Net::IMAP.encode_utf7(options[:mailbox]) options[:read_only] ||= false options end