class Mail::POP3
#=> Returns the first 10 emails in ascending order
Mail.find(:what => :first, :count => 10, :order => :asc)
instance of Message, not an array of Message instances.
count: number of emails to retrieve. The default value is 10. A value of 1 returns an
order: order of emails returned. Possible values are :asc or :desc. Default value is :asc.
what: last or first emails. The default is :first.
with the following options:
You can also pass options into Mail.find to locate an email in your pop mailbox
Mail.last #=> Returns the last unread email
Mail.first #=> Returns the first unread email
Mail.all #=> Returns an array of all emails
end
:enable_ssl => true }
:password => ‘<password>’,
:user_name => ‘<username>’,
:port => 995,
retriever_method :pop3, { :address => “pop.gmail.com”,
Mail.defaults do
=== Example of retrieving Emails from GMail:
While being retrieved, emails can be yielded if a block is given.
Each email retrieved (RFC2822) is given as an instance of Message
.
The Pop3 retriever allows to get the last, first or all emails from a POP3 server.
def connection(&block)
def connection(&block) raise ArgumentError.new('Mail::Retrievable#connection takes a block') unless block_given? start do |pop3| yield pop3 end end
def delete_all
def delete_all start do |pop3| unless pop3.mails.empty? pop3.delete_all pop3.finish end end end
def find(options = nil, &block)
is false. Use #find_and_delete if you would like this to default to true.
delete_after_find: flag for whether to delete each retreived email after find. Default
instance of Message, not an array of Message instances.
count: number of emails to retrieve. The default value is 10. A value of 1 returns an
order: order of emails returned. Possible values are :asc or :desc. Default value is :asc.
what: last or first emails. The default is :first.
Possible options:
Find emails in a POP3 mailbox. Without any options, the 5 last received emails are returned.
def find(options = nil, &block) options = validate_options(options) start do |pop3| mails = pop3.mails pop3.reset # Clears all "deleted" marks. This prevents non-explicit/accidental deletions due to server settings. mails.sort! { |m1, m2| m2.number <=> m1.number } if options[:what] == :last mails = mails.first(options[:count]) if options[:count].is_a? Integer if options[:what].to_sym == :last && options[:order].to_sym == :desc || options[:what].to_sym == :first && options[:order].to_sym == :asc || mails.reverse! end if block_given? mails.each do |mail| new_message = Mail.new(mail.pop) new_message.mark_for_delete = true if options[:delete_after_find] yield new_message mail.delete if options[:delete_after_find] && new_message.is_marked_for_delete? # Delete if still marked for delete end else emails = [] mails.each do |mail| emails << Mail.new(mail.pop) mail.delete if options[:delete_after_find] end emails.size == 1 && options[:count] == 1 ? emails.first : emails end end end
def initialize(values)
def initialize(values) self.settings = { :address => "localhost", :port => 110, :user_name => nil, :password => nil, :authentication => nil, :enable_ssl => false, :read_timeout => nil }.merge!(values) end
def start(config = Configuration.instance, &block)
marked for deletion via #find_and_delete or with the :delete_after_find option
Start a POP3 session and ensure that it will be closed in any case. Any messages
def start(config = Configuration.instance, &block) raise ArgumentError.new("Mail::Retrievable#pop3_start takes a block") unless block_given? pop3 = Net::POP3.new(settings[:address], settings[:port], false) pop3.enable_ssl(OpenSSL::SSL::VERIFY_NONE) if settings[:enable_ssl] pop3.read_timeout = settings[:read_timeout] if settings[:read_timeout] pop3.start(settings[:user_name], settings[:password]) yield pop3 ensure if defined?(pop3) && pop3 && pop3.started? pop3.finish end end
def validate_options(options)
def validate_options(options) options = options ? Hash[options] : {} options[:count] ||= 10 options[:order] ||= :asc options[:what] ||= :first options[:delete_after_find] ||= false options end