mail-trunk 2.3.0

data/lib/mail/network/retriever_methods/pop3.rb

@@ -0,0 +1,140 @@
+# encoding: utf-8
+
+module Mail
+  # The Pop3 retriever allows to get the last, first or all emails from a POP3 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 :pop3, { :address             => "pop.gmail.com",
+  #                               :port                => 995,
+  #                               :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 pop mailbox
+  # with the following 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.
+  # 
+  #   Mail.find(:what => :first, :count => 10, :order => :asc)
+  #   #=> Returns the first 10 emails in ascending order
+  # 
+  class POP3 < Retriever
+    require 'net/pop'
+
+    def initialize(values)
+      self.settings = { :address              => "localhost",
+                        :port                 => 110,
+                        :user_name            => nil,
+                        :password             => nil,
+                        :authentication       => nil,
+                        :enable_ssl           => false }.merge!(values)
+    end
+    
+    attr_accessor :settings
+    
+    # Find emails in a POP3 mailbox. Without any options, the 5 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 false. Use #find_and_delete if you would like this to default to true.
+    #
+    def find(options = {}, &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
+    
+    # Delete all emails from a POP3 server   
+    def delete_all
+      start do |pop3|
+        unless pop3.mails.empty?
+          pop3.delete_all
+          pop3.finish
+        end
+      end
+    end
+
+    # Returns the connection object of the retrievable (IMAP or POP3)
+    def connection(&block)
+      raise ArgumentError.new('Mail::Retrievable#connection takes a block') unless block_given?
+
+      start do |pop3|
+        yield pop3
+      end
+    end
+    
+  private
+  
+    # Set default options
+    def validate_options(options)
+      options ||= {}
+      options[:count] ||= 10
+      options[:order] ||= :asc
+      options[:what]  ||= :first
+      options[:delete_after_find] ||= false
+      options
+    end
+  
+    # Start a POP3 session and ensure that it will be closed in any case. Any messages
+    # marked for deletion via #find_and_delete or with the :delete_after_find option
+    # will be deleted when the session is closed.
+    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], isapop = false)
+      pop3.enable_ssl(verify = OpenSSL::SSL::VERIFY_NONE) if settings[:enable_ssl]
+      pop3.start(settings[:user_name], settings[:password])
+    
+      yield pop3
+    ensure
+      if defined?(pop3) && pop3 && pop3.started?
+        pop3.finish
+      end
+    end
+
+  end
+end

data/lib/mail/network/retriever_methods/test_retriever.rb

@@ -0,0 +1,47 @@
+# encoding: utf-8
+
+module Mail
+
+  class TestRetriever < Retriever
+
+    def self.emails
+      @@emails
+    end
+
+    def self.emails=(val)
+      @@emails = val
+    end
+
+    def initialize(values)
+      @@emails = []
+    end
+
+    def find(options = {}, &block)
+      options[:count] ||= :all
+      options[:order] ||= :asc
+      options[:what] ||= :first
+      emails = @@emails.dup
+      emails.reverse! if options[:what] == :last
+      emails = case count = options[:count]
+        when :all then emails
+        when 1 then emails.first
+        when Fixnum then emails[0, count]
+        else
+          raise 'Invalid count option value: ' + count.inspect
+      end
+      if options[:what] == :last && options[:order] == :asc || options[:what] == :first && options[:order] == :desc
+        emails.reverse!
+      end
+      emails.each { |email| email.mark_for_delete = true } if options[:delete_after_find]
+      if block_given?
+        emails.each { |email| yield email }
+      else
+        emails
+      end.tap do |results|
+        emails.each { |email| @@emails.delete(email) if email.is_marked_for_delete? } if options[:delete_after_find]
+      end
+    end
+
+  end
+
+end

data/lib/mail/parsers/address_lists.rb

@@ -0,0 +1,64 @@
+# Autogenerated from a Treetop grammar. Edits may be lost.
+
+
+module Mail
+  module AddressLists
+    include Treetop::Runtime
+
+    def root
+      @root ||= :primary_address
+    end
+
+    include RFC2822
+
+    module PrimaryAddress0
+      def addresses
+        ([first_addr] + other_addr.elements.map { |o| o.addr_value }).reject { |e| e.empty? }
+      end
+    end
+
+    module PrimaryAddress1
+      def addresses
+        [first_addr] + other_addr.elements.map { |o| o.addr_value }
+      end
+    end
+
+    def _nt_primary_address
+      start_index = index
+      if node_cache[:primary_address].has_key?(index)
+        cached = node_cache[:primary_address][index]
+        if cached
+          cached = SyntaxNode.new(input, index...(index + 1)) if cached == true
+          @index = cached.interval.end
+        end
+        return cached
+      end
+
+      i0 = index
+      r1 = _nt_address_list
+      r1.extend(PrimaryAddress0)
+      if r1
+        r0 = r1
+      else
+        r2 = _nt_obs_addr_list
+        r2.extend(PrimaryAddress1)
+        if r2
+          r0 = r2
+        else
+          @index = i0
+          r0 = nil
+        end
+      end
+
+      node_cache[:primary_address][start_index] = r0
+
+      r0
+    end
+
+  end
+
+  class AddressListsParser < Treetop::Runtime::CompiledParser
+    include AddressLists
+  end
+
+end

data/lib/mail/parsers/address_lists.treetop

@@ -0,0 +1,19 @@
+module Mail
+  grammar AddressLists
+
+    include RFC2822
+
+    rule primary_address
+      address_list {
+        def addresses
+          ([first_addr] + other_addr.elements.map { |o| o.addr_value }).reject { |e| e.empty? }
+        end
+      } / obs_addr_list {
+        def addresses
+          [first_addr] + other_addr.elements.map { |o| o.addr_value }
+        end
+      }
+    end
+    
+  end
+end

data/lib/mail/parsers/content_disposition.rb

@@ -0,0 +1,535 @@
+# Autogenerated from a Treetop grammar. Edits may be lost.
+
+
+module Mail
+  module ContentDisposition
+    include Treetop::Runtime
+
+    def root
+      @root ||= :content_disposition
+    end
+
+    include RFC2822
+
+    include RFC2045
+
+    module ContentDisposition0
+      def CFWS1
+        elements[0]
+      end
+
+      def parameter
+        elements[2]
+      end
+
+      def CFWS2
+        elements[3]
+      end
+    end
+
+    module ContentDisposition1
+      def disposition_type
+        elements[0]
+      end
+
+      def param_hashes
+        elements[1]
+      end
+    end
+
+    module ContentDisposition2
+      def parameters
+        param_hashes.elements.map do |param|
+          param.parameter.param_hash
+        end
+      end
+    end
+
+    def _nt_content_disposition
+      start_index = index
+      if node_cache[:content_disposition].has_key?(index)
+        cached = node_cache[:content_disposition][index]
+        if cached
+          cached = SyntaxNode.new(input, index...(index + 1)) if cached == true
+          @index = cached.interval.end
+        end
+        return cached
+      end
+
+      i0, s0 = index, []
+      r1 = _nt_disposition_type
+      s0 << r1
+      if r1
+        s2, i2 = [], index
+        loop do
+          i3, s3 = index, []
+          r4 = _nt_CFWS
+          s3 << r4
+          if r4
+            if has_terminal?(";", false, index)
+              r5 = instantiate_node(SyntaxNode,input, index...(index + 1))
+              @index += 1
+            else
+              terminal_parse_failure(";")
+              r5 = nil
+            end
+            s3 << r5
+            if r5
+              r6 = _nt_parameter
+              s3 << r6
+              if r6
+                r7 = _nt_CFWS
+                s3 << r7
+              end
+            end
+          end
+          if s3.last
+            r3 = instantiate_node(SyntaxNode,input, i3...index, s3)
+            r3.extend(ContentDisposition0)
+          else
+            @index = i3
+            r3 = nil
+          end
+          if r3
+            s2 << r3
+          else
+            break
+          end
+        end
+        r2 = instantiate_node(SyntaxNode,input, i2...index, s2)
+        s0 << r2
+      end
+      if s0.last
+        r0 = instantiate_node(SyntaxNode,input, i0...index, s0)
+        r0.extend(ContentDisposition1)
+        r0.extend(ContentDisposition2)
+      else
+        @index = i0
+        r0 = nil
+      end
+
+      node_cache[:content_disposition][start_index] = r0
+
+      r0
+    end
+
+    module DispositionType0
+    end
+
+    module DispositionType1
+    end
+
+    def _nt_disposition_type
+      start_index = index
+      if node_cache[:disposition_type].has_key?(index)
+        cached = node_cache[:disposition_type][index]
+        if cached
+          cached = SyntaxNode.new(input, index...(index + 1)) if cached == true
+          @index = cached.interval.end
+        end
+        return cached
+      end
+
+      i0 = index
+      i1, s1 = index, []
+      if has_terminal?('\G[iI]', true, index)
+        r2 = true
+        @index += 1
+      else
+        r2 = nil
+      end
+      s1 << r2
+      if r2
+        if has_terminal?('\G[nN]', true, index)
+          r3 = true
+          @index += 1
+        else
+          r3 = nil
+        end
+        s1 << r3
+        if r3
+          if has_terminal?('\G[lL]', true, index)
+            r4 = true
+            @index += 1
+          else
+            r4 = nil
+          end
+          s1 << r4
+          if r4
+            if has_terminal?('\G[iI]', true, index)
+              r5 = true
+              @index += 1
+            else
+              r5 = nil
+            end
+            s1 << r5
+            if r5
+              if has_terminal?('\G[nN]', true, index)
+                r6 = true
+                @index += 1
+              else
+                r6 = nil
+              end
+              s1 << r6
+              if r6
+                if has_terminal?('\G[eE]', true, index)
+                  r7 = true
+                  @index += 1
+                else
+                  r7 = nil
+                end
+                s1 << r7
+              end
+            end
+          end
+        end
+      end
+      if s1.last
+        r1 = instantiate_node(SyntaxNode,input, i1...index, s1)
+        r1.extend(DispositionType0)
+      else
+        @index = i1
+        r1 = nil
+      end
+      if r1
+        r0 = r1
+      else
+        i8, s8 = index, []
+        if has_terminal?('\G[aA]', true, index)
+          r9 = true
+          @index += 1
+        else
+          r9 = nil
+        end
+        s8 << r9
+        if r9
+          if has_terminal?('\G[tT]', true, index)
+            r10 = true
+            @index += 1
+          else
+            r10 = nil
+          end
+          s8 << r10
+          if r10
+            if has_terminal?('\G[tT]', true, index)
+              r11 = true
+              @index += 1
+            else
+              r11 = nil
+            end
+            s8 << r11
+            if r11
+              if has_terminal?('\G[aA]', true, index)
+                r12 = true
+                @index += 1
+              else
+                r12 = nil
+              end
+              s8 << r12
+              if r12
+                if has_terminal?('\G[cC]', true, index)
+                  r13 = true
+                  @index += 1
+                else
+                  r13 = nil
+                end
+                s8 << r13
+                if r13
+                  if has_terminal?('\G[hH]', true, index)
+                    r14 = true
+                    @index += 1
+                  else
+                    r14 = nil
+                  end
+                  s8 << r14
+                  if r14
+                    if has_terminal?('\G[mM]', true, index)
+                      r15 = true
+                      @index += 1
+                    else
+                      r15 = nil
+                    end
+                    s8 << r15
+                    if r15
+                      if has_terminal?('\G[eE]', true, index)
+                        r16 = true
+                        @index += 1
+                      else
+                        r16 = nil
+                      end
+                      s8 << r16
+                      if r16
+                        if has_terminal?('\G[nN]', true, index)
+                          r17 = true
+                          @index += 1
+                        else
+                          r17 = nil
+                        end
+                        s8 << r17
+                        if r17
+                          if has_terminal?('\G[tT]', true, index)
+                            r18 = true
+                            @index += 1
+                          else
+                            r18 = nil
+                          end
+                          s8 << r18
+                        end
+                      end
+                    end
+                  end
+                end
+              end
+            end
+          end
+        end
+        if s8.last
+          r8 = instantiate_node(SyntaxNode,input, i8...index, s8)
+          r8.extend(DispositionType1)
+        else
+          @index = i8
+          r8 = nil
+        end
+        if r8
+          r0 = r8
+        else
+          r19 = _nt_extension_token
+          if r19
+            r0 = r19
+          else
+            if has_terminal?('', false, index)
+              r20 = instantiate_node(SyntaxNode,input, index...(index + 0))
+              @index += 0
+            else
+              terminal_parse_failure('')
+              r20 = nil
+            end
+            if r20
+              r0 = r20
+            else
+              @index = i0
+              r0 = nil
+            end
+          end
+        end
+      end
+
+      node_cache[:disposition_type][start_index] = r0
+
+      r0
+    end
+
+    def _nt_extension_token
+      start_index = index
+      if node_cache[:extension_token].has_key?(index)
+        cached = node_cache[:extension_token][index]
+        if cached
+          cached = SyntaxNode.new(input, index...(index + 1)) if cached == true
+          @index = cached.interval.end
+        end
+        return cached
+      end
+
+      i0 = index
+      r1 = _nt_ietf_token
+      if r1
+        r0 = r1
+      else
+        r2 = _nt_custom_x_token
+        if r2
+          r0 = r2
+        else
+          @index = i0
+          r0 = nil
+        end
+      end
+
+      node_cache[:extension_token][start_index] = r0
+
+      r0
+    end
+
+    module Parameter0
+      def attr
+        elements[1]
+      end
+
+      def val
+        elements[3]
+      end
+
+    end
+
+    module Parameter1
+      def param_hash
+        {attr.text_value => val.text_value}
+      end
+    end
+
+    def _nt_parameter
+      start_index = index
+      if node_cache[:parameter].has_key?(index)
+        cached = node_cache[:parameter][index]
+        if cached
+          cached = SyntaxNode.new(input, index...(index + 1)) if cached == true
+          @index = cached.interval.end
+        end
+        return cached
+      end
+
+      i0, s0 = index, []
+      r2 = _nt_CFWS
+      if r2
+        r1 = r2
+      else
+        r1 = instantiate_node(SyntaxNode,input, index...index)
+      end
+      s0 << r1
+      if r1
+        r3 = _nt_attribute
+        s0 << r3
+        if r3
+          if has_terminal?("=", false, index)
+            r4 = instantiate_node(SyntaxNode,input, index...(index + 1))
+            @index += 1
+          else
+            terminal_parse_failure("=")
+            r4 = nil
+          end
+          s0 << r4
+          if r4
+            r5 = _nt_value
+            s0 << r5
+            if r5
+              r7 = _nt_CFWS
+              if r7
+                r6 = r7
+              else
+                r6 = instantiate_node(SyntaxNode,input, index...index)
+              end
+              s0 << r6
+            end
+          end
+        end
+      end
+      if s0.last
+        r0 = instantiate_node(SyntaxNode,input, i0...index, s0)
+        r0.extend(Parameter0)
+        r0.extend(Parameter1)
+      else
+        @index = i0
+        r0 = nil
+      end
+
+      node_cache[:parameter][start_index] = r0
+
+      r0
+    end
+
+    def _nt_attribute
+      start_index = index
+      if node_cache[:attribute].has_key?(index)
+        cached = node_cache[:attribute][index]
+        if cached
+          cached = SyntaxNode.new(input, index...(index + 1)) if cached == true
+          @index = cached.interval.end
+        end
+        return cached
+      end
+
+      s0, i0 = [], index
+      loop do
+        r1 = _nt_token
+        if r1
+          s0 << r1
+        else
+          break
+        end
+      end
+      if s0.empty?
+        @index = i0
+        r0 = nil
+      else
+        r0 = instantiate_node(SyntaxNode,input, i0...index, s0)
+      end
+
+      node_cache[:attribute][start_index] = r0
+
+      r0
+    end
+
+    module Value0
+      def text_value
+        quoted_content.text_value
+      end
+    end
+
+    def _nt_value
+      start_index = index
+      if node_cache[:value].has_key?(index)
+        cached = node_cache[:value][index]
+        if cached
+          cached = SyntaxNode.new(input, index...(index + 1)) if cached == true
+          @index = cached.interval.end
+        end
+        return cached
+      end
+
+      i0 = index
+      r1 = _nt_quoted_string
+      r1.extend(Value0)
+      if r1
+        r0 = r1
+      else
+        s2, i2 = [], index
+        loop do
+          i3 = index
+          r4 = _nt_token
+          if r4
+            r3 = r4
+          else
+            if has_terminal?('\G[\\x3d]', true, index)
+              r5 = true
+              @index += 1
+            else
+              r5 = nil
+            end
+            if r5
+              r3 = r5
+            else
+              @index = i3
+              r3 = nil
+            end
+          end
+          if r3
+            s2 << r3
+          else
+            break
+          end
+        end
+        if s2.empty?
+          @index = i2
+          r2 = nil
+        else
+          r2 = instantiate_node(SyntaxNode,input, i2...index, s2)
+        end
+        if r2
+          r0 = r2
+        else
+          @index = i0
+          r0 = nil
+        end
+      end
+
+      node_cache[:value][start_index] = r0
+
+      r0
+    end
+
+  end
+
+  class ContentDispositionParser < Treetop::Runtime::CompiledParser
+    include ContentDisposition
+  end
+
+end