Sha256: eb2006c0612483b3013e8377b5cae55f5af1e28003bd509abefef4a446278907

Contents?: true

Size: 1.91 KB

Versions: 160

Compression:

Stored size: 1.91 KB

Contents

# encoding: utf-8

module Mail

  class Retriever

    # Get the oldest received email(s)
    #
    # Possible options:
    #   count: number of emails to retrieve. The default value is 1.
    #   order: order of emails returned. Possible values are :asc or :desc. Default value is :asc.
    #
    def first(options = {}, &block)
      options ||= {}
      options[:what] = :first
      options[:count] ||= 1
      find(options, &block)
    end
    
    # Get the most recent received email(s)
    #
    # Possible options:
    #   count: number of emails to retrieve. The default value is 1.
    #   order: order of emails returned. Possible values are :asc or :desc. Default value is :asc.
    #
    def last(options = {}, &block)
      options ||= {}
      options[:what] = :last
      options[:count] ||= 1
      find(options, &block)
    end
    
    # Get all emails.
    #
    # Possible options:
    #   order: order of emails returned. Possible values are :asc or :desc. Default value is :asc.
    #
    def all(options = {}, &block)
      options ||= {}
      options[:count] = :all
      find(options, &block)
    end

    # Find emails in the mailbox, and then deletes them. Without any options, the 
    # five last received emails are returned.
    #
    # Possible options:
    #   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.
    #   delete_after_find: flag for whether to delete each retreived email after find. Default
    #           is true. Call #find if you would like this to default to false.
    #
    def find_and_delete(options = {}, &block)
      options ||= {}
      options[:delete_after_find] ||= true
      find(options, &block)      
    end 

  end

end

Version data entries

160 entries across 147 versions & 21 rubygems

Version Path
mail-2.5.5 lib/mail/network/retriever_methods/base.rb
mail-2.5.5.rc1 lib/mail/network/retriever_methods/base.rb
mail-2.6.4.rc2 lib/mail/network/retriever_methods/base.rb
angular-rails4-templates-0.4.1 vendor/ruby/2.1.0/gems/mail-2.6.3/lib/mail/network/retriever_methods/base.rb
angular-rails4-templates-0.4.0 vendor/ruby/2.1.0/gems/mail-2.6.3/lib/mail/network/retriever_methods/base.rb
tdiary-4.2.1 vendor/bundle/ruby/2.2.0/gems/mail-2.6.3/lib/mail/network/retriever_methods/base.rb
tdiary-4.2.1 vendor/bundle/ruby/2.3.0/gems/mail-2.6.3/lib/mail/network/retriever_methods/base.rb
angular-rails4-templates-0.3.0 vendor/ruby/2.1.0/gems/mail-2.6.3/lib/mail/network/retriever_methods/base.rb
mail-2.6.4.rc1 lib/mail/network/retriever_methods/base.rb
sc_core-0.0.7 test/dummy/vendor/bundle/ruby/2.2.0/gems/mail-2.6.3/lib/mail/network/retriever_methods/base.rb
classiccms-0.7.5 vendor/bundle/gems/mail-2.4.4/lib/mail/network/retriever_methods/base.rb
classiccms-0.7.4 vendor/bundle/gems/mail-2.4.4/lib/mail/network/retriever_methods/base.rb
classiccms-0.7.3 vendor/bundle/gems/mail-2.4.4/lib/mail/network/retriever_methods/base.rb
solidus_backend-1.0.0.pre3 vendor/bundle/gems/mail-2.6.3/lib/mail/network/retriever_methods/base.rb
solidus_backend-1.0.0.pre2 vendor/bundle/gems/mail-2.6.3/lib/mail/network/retriever_methods/base.rb
solidus_backend-1.0.0.pre vendor/bundle/gems/mail-2.6.3/lib/mail/network/retriever_methods/base.rb
active_mailer-0.0.10 test/fixtures/dummyapp_rails_3.2/vendor/bundle/ruby/1.9.1/gems/mail-2.4.4/lib/mail/network/retriever_methods/base.rb
shoppe-paypal-1.1.0 vendor/bundle/ruby/2.1.0/gems/mail-2.6.3/lib/mail/network/retriever_methods/base.rb
judge-2.0.5 vendor/bundle/ruby/2.1.0/gems/mail-2.4.4/lib/mail/network/retriever_methods/base.rb
mail-2.6.3 lib/mail/network/retriever_methods/base.rb