mail 2.4.4 → 2.5.5

data/lib/mail/network/delivery_methods/sendmail.rb

@@ -1,3 +1,5 @@
+require 'mail/check_delivery_params'
+
 module Mail
   # A delivery method implementation which sends via sendmail.
   #
@@ -35,28 +37,55 @@ module Mail
   #
   #   mail.deliver!
   class Sendmail
+    DEFAULTS = {
+      :location   => '/usr/sbin/sendmail',
+      :arguments  => '-i'
+    }
+
+    attr_accessor :settings
 
     def initialize(values)
-      self.settings = { :location       => '/usr/sbin/sendmail',
-                        :arguments      => '-i -t' }.merge(values)
+      self.settings = self.class::DEFAULTS.merge(values)
     end
 
-    attr_accessor :settings
-
     def deliver!(mail)
-      envelope_from = mail.return_path || mail.sender || mail.from_addrs.first
-      return_path = "-f " + '"' + envelope_from.escape_for_shell + '"' if envelope_from
+      smtp_from, smtp_to, message = Mail::CheckDeliveryParams.check(mail)
 
-      arguments = [settings[:arguments], return_path].compact.join(" ")
+      from = "-f #{self.class.shellquote(smtp_from)}"
+      to = smtp_to.map { |to| self.class.shellquote(to) }.join(' ')
 
-      self.class.call(settings[:location], arguments, mail.destinations.collect(&:escape_for_shell).join(" "), mail)
+      arguments = "#{settings[:arguments]} #{from} --"
+      self.class.call(settings[:location], arguments, to, message)
     end
 
-    def self.call(path, arguments, destinations, mail)
-      IO.popen("#{path} #{arguments} #{destinations}", "w+") do |io|
-        io.puts mail.encoded.to_lf
+    def self.call(path, arguments, destinations, encoded_message)
+      popen "#{path} #{arguments} #{destinations}" do |io|
+        io.puts encoded_message.to_lf
         io.flush
       end
     end
+
+    if RUBY_VERSION < '1.9.0'
+      def self.popen(command, &block)
+        IO.popen "#{command} 2>&1", 'w+', &block
+      end
+    else
+      def self.popen(command, &block)
+        IO.popen command, 'w+', :err => :out, &block
+      end
+    end
+
+    # The following is an adaptation of ruby 1.9.2's shellwords.rb file,
+    # it is modified to include '+' in the allowed list to allow for
+    # sendmail to accept email addresses as the sender with a + in them.
+    def self.shellquote(address)
+      # Process as a single byte sequence because not all shell
+      # implementations are multibyte aware.
+      #
+      # A LF cannot be escaped with a backslash because a backslash + LF
+      # combo is regarded as line continuation and simply ignored. Strip it.
+      escaped = address.gsub(/([^A-Za-z0-9_\s\+\-.,:\/@])/n, "\\\\\\1").gsub("\n", '')
+      %("#{escaped}")
+    end
   end
 end

data/lib/mail/network/delivery_methods/smtp.rb

@@ -1,3 +1,5 @@
+require 'mail/check_delivery_params'
+
 module Mail
   # == Sending Email with SMTP
   # 
@@ -72,6 +74,7 @@ module Mail
   # 
   #   mail.deliver!
   class SMTP
+    attr_accessor :settings
 
     def initialize(values)
       self.settings = { :address              => "localhost",
@@ -86,68 +89,51 @@ module Mail
                         :tls                  => nil
                       }.merge!(values)
     end
-    
-    attr_accessor :settings
-    
+
     # Send the message via SMTP.
     # The from and to attributes are optional. If not set, they are retrieve from the Message.
     def deliver!(mail)
+      smtp_from, smtp_to, message = Mail::CheckDeliveryParams.check(mail)
 
-      # Set the envelope from to be either the return-path, the sender or the first from address
-      envelope_from = mail.return_path || mail.sender || mail.from_addrs.first
-      if envelope_from.blank?
-        raise ArgumentError.new('A sender (Return-Path, Sender or From) required to send a message') 
-      end
-      
-      destinations ||= mail.destinations if mail.respond_to?(:destinations) && mail.destinations
-      if destinations.blank?
-        raise ArgumentError.new('At least one recipient (To, Cc or Bcc) is required to send a message') 
-      end
-      
-      message ||= mail.encoded if mail.respond_to?(:encoded)
-      if message.blank?
-        raise ArgumentError.new('A encoded content is required to send a message')
-      end
-      
       smtp = Net::SMTP.new(settings[:address], settings[:port])
       if settings[:tls] || settings[:ssl]
         if smtp.respond_to?(:enable_tls)
-          unless settings[:openssl_verify_mode]
-            smtp.enable_tls
-          else
-            openssl_verify_mode = settings[:openssl_verify_mode]
-            if openssl_verify_mode.kind_of?(String)
-              openssl_verify_mode = "OpenSSL::SSL::VERIFY_#{openssl_verify_mode.upcase}".constantize
-            end
-            context = Net::SMTP.default_ssl_context
-            context.verify_mode = openssl_verify_mode
-            smtp.enable_tls(context)
-          end        
+          smtp.enable_tls(ssl_context)
         end
       elsif settings[:enable_starttls_auto]
-        if smtp.respond_to?(:enable_starttls_auto) 
-          unless settings[:openssl_verify_mode]
-            smtp.enable_starttls_auto
-          else
-            openssl_verify_mode = settings[:openssl_verify_mode]
-            if openssl_verify_mode.kind_of?(String)
-              openssl_verify_mode = "OpenSSL::SSL::VERIFY_#{openssl_verify_mode.upcase}".constantize
-            end
-            context = Net::SMTP.default_ssl_context
-            context.verify_mode = openssl_verify_mode
-            smtp.enable_starttls_auto(context)
-          end
+        if smtp.respond_to?(:enable_starttls_auto)
+          smtp.enable_starttls_auto(ssl_context)
         end
       end
-      
+
       response = nil
       smtp.start(settings[:domain], settings[:user_name], settings[:password], settings[:authentication]) do |smtp_obj|
-        response = smtp_obj.sendmail(message, envelope_from, destinations)
+        response = smtp_obj.sendmail(message, smtp_from, smtp_to)
+      end
+
+      if settings[:return_response]
+        response
+      else
+        self
+      end
+    end
+
+    private
+
+    # Allow SSL context to be configured via settings, for Ruby >= 1.9
+    # Just returns openssl verify mode for Ruby 1.8.x
+    def ssl_context
+      openssl_verify_mode = settings[:openssl_verify_mode]
+
+      if openssl_verify_mode.kind_of?(String)
+        openssl_verify_mode = "OpenSSL::SSL::VERIFY_#{openssl_verify_mode.upcase}".constantize
       end
 
-      return settings[:return_response] ? response : self
+      context = Net::SMTP.default_ssl_context
+      context.verify_mode = openssl_verify_mode
+      context.ca_path = settings[:ca_path] if settings[:ca_path]
+      context.ca_file = settings[:ca_file] if settings[:ca_file]
+      context
     end
-    
-    
   end
 end

data/lib/mail/network/delivery_methods/smtp_connection.rb

@@ -1,3 +1,5 @@
+require 'mail/check_delivery_params'
+
 module Mail
   # == Sending Email with SMTP
   # 
@@ -35,40 +37,21 @@ module Mail
   # 
   #   mail.deliver!
   class SMTPConnection
+    attr_accessor :smtp, :settings
 
     def initialize(values)
       raise ArgumentError.new('A Net::SMTP object is required for this delivery method') if values[:connection].nil?
       self.smtp = values[:connection]
       self.settings = values
     end
-    
-    attr_accessor :smtp
-    attr_accessor :settings
-    
+
     # Send the message via SMTP.
     # The from and to attributes are optional. If not set, they are retrieve from the Message.
     def deliver!(mail)
+      smtp_from, smtp_to, message = Mail::CheckDeliveryParams.check(mail)
+      response = smtp.sendmail(message, smtp_from, smtp_to)
 
-      # Set the envelope from to be either the return-path, the sender or the first from address
-      envelope_from = mail.return_path || mail.sender || mail.from_addrs.first
-      if envelope_from.blank?
-        raise ArgumentError.new('A sender (Return-Path, Sender or From) required to send a message') 
-      end
-      
-      destinations ||= mail.destinations if mail.respond_to?(:destinations) && mail.destinations
-      if destinations.blank?
-        raise ArgumentError.new('At least one recipient (To, Cc or Bcc) is required to send a message') 
-      end
-      
-      message ||= mail.encoded if mail.respond_to?(:encoded)
-      if message.blank?
-        raise ArgumentError.new('A encoded content is required to send a message')
-      end
-            
-      response = smtp.sendmail(message, envelope_from, destinations)
-      
-      settings[:return_response] ? response : self 
+      settings[:return_response] ? response : self
     end
-        
   end
 end

data/lib/mail/network/delivery_methods/test_mailer.rb

@@ -1,3 +1,5 @@
+require 'mail/check_delivery_params'
+
 module Mail
   # The TestMailer is a bare bones mailer that does nothing.  It is useful
   # when you are testing.
@@ -5,9 +7,8 @@ module Mail
   # It also provides a template of the minimum methods you require to implement
   # if you want to make a custom mailer for Mail
   class TestMailer
-
     # Provides a store of all the emails sent with the TestMailer so you can check them.
-    def TestMailer.deliveries
+    def self.deliveries
       @@deliveries ||= []
     end
 
@@ -22,19 +23,19 @@ module Mail
     # * length
     # * size
     # * and other common Array methods
-    def TestMailer.deliveries=(val)
+    def self.deliveries=(val)
       @@deliveries = val
     end
 
+    attr_accessor :settings
+
     def initialize(values)
-      @settings = {}
+      @settings = values.dup
     end
-    
-    attr_accessor :settings
 
     def deliver!(mail)
+      Mail::CheckDeliveryParams.check(mail)
       Mail::TestMailer.deliveries << mail
     end
-    
   end
-end
+end

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

@@ -18,7 +18,7 @@ module Mail
   #
   #   Mail.all    #=> Returns an array of all emails
   #   Mail.first  #=> Returns the first unread email
-  #   Mail.last   #=> 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:
@@ -28,12 +28,15 @@ module Mail
   #   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)
+  #   Mail.find(:what => :first, :count => 10, :order => :asc, :keys=>'ALL')
   #   #=> Returns the first 10 emails in ascending order
   #
   class IMAP < Retriever
-    require 'net/imap'
+    require 'net/imap' unless defined?(Net::IMAP)
     
     def initialize(values)
       self.settings = { :address              => "localhost",
@@ -54,16 +57,21 @@ module Mail
     #   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.
-    #   ready_only: will ensure that no writes are made to the inbox during the session. 
-    #               This is helpful when you don't want your messages to be set to read automatically. Default is false.
+    #   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'
     #
     def find(options={}, &block)
       options = validate_options(options)
 
       start do |imap|
-        options[:read_only] ? imap.select(options[:mailbox]) : imap.examine(options[:mailbox])
+        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

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

@@ -18,7 +18,7 @@ module Mail
   # 
   #   Mail.all    #=> Returns an array of all emails
   #   Mail.first  #=> Returns the first unread email
-  #   Mail.last   #=> 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 pop mailbox
   # with the following options:
@@ -32,7 +32,7 @@ module Mail
   #   #=> Returns the first 10 emails in ascending order
   # 
   class POP3 < Retriever
-    require 'net/pop'
+    require 'net/pop' unless defined?(Net::POP)
 
     def initialize(values)
       self.settings = { :address              => "localhost",

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

@@ -20,26 +20,22 @@ module Mail
       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]
+      emails_index = (0...@@emails.size).to_a
+      emails_index.reverse! if options[:what] == :last
+      emails_index = case count = options[:count]
+        when :all then emails_index
+        when Fixnum then emails_index[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]
+        emails_index.reverse!
       end
+      emails_index.each { |idx| @@emails[idx].mark_for_delete = true } if options[:delete_after_find]
+      emails = emails_index.map { |idx| @@emails[idx] }
+      emails.each { |email| yield email } if block_given?
+      @@emails.reject!(&:is_marked_for_delete?) if options[:delete_after_find]
+      emails.size == 1 && options[:count] == 1 ? emails.first : emails
     end
 
   end

data/lib/mail/network.rb

@@ -1,14 +1,14 @@
 require 'mail/network/retriever_methods/base'
 
 module Mail
-  autoload :SMTP, 'mail/network/delivery_methods/smtp'
-  autoload :FileDelivery, 'mail/network/delivery_methods/file_delivery'
-  autoload :Sendmail, 'mail/network/delivery_methods/sendmail'
-  autoload :Exim, 'mail/network/delivery_methods/exim'
-  autoload :SMTPConnection, 'mail/network/delivery_methods/smtp_connection'
-  autoload :TestMailer, 'mail/network/delivery_methods/test_mailer'
+  register_autoload :SMTP, 'mail/network/delivery_methods/smtp'
+  register_autoload :FileDelivery, 'mail/network/delivery_methods/file_delivery'
+  register_autoload :Sendmail, 'mail/network/delivery_methods/sendmail'
+  register_autoload :Exim, 'mail/network/delivery_methods/exim'
+  register_autoload :SMTPConnection, 'mail/network/delivery_methods/smtp_connection'
+  register_autoload :TestMailer, 'mail/network/delivery_methods/test_mailer'
 
-  autoload :POP3, 'mail/network/retriever_methods/pop3'
-  autoload :IMAP, 'mail/network/retriever_methods/imap'
-  autoload :TestRetriever, 'mail/network/retriever_methods/test_retriever'
+  register_autoload :POP3, 'mail/network/retriever_methods/pop3'
+  register_autoload :IMAP, 'mail/network/retriever_methods/imap'
+  register_autoload :TestRetriever, 'mail/network/retriever_methods/test_retriever'
 end

data/lib/mail/parsers/content_transfer_encoding.rb

@@ -85,19 +85,6 @@ module Mail
       r0
     end
 
-    module Encoding0
-      def ietf_token
-        elements[0]
-      end
-
-    end
-
-    module Encoding1
-      def text_value
-        ietf_token.text_value
-      end
-    end
-
     def _nt_encoding
       start_index = index
       if node_cache[:encoding].has_key?(index)
@@ -110,41 +97,93 @@ module Mail
       end
 
       i0 = index
-      i1, s1 = index, []
-      r2 = _nt_ietf_token
-      s1 << r2
-      if r2
-        if has_terminal?("s", false, index)
-          r4 = instantiate_node(SyntaxNode,input, index...(index + 1))
-          @index += 1
-        else
-          terminal_parse_failure("s")
-          r4 = nil
-        end
-        if r4
-          r3 = r4
-        else
-          r3 = instantiate_node(SyntaxNode,input, index...index)
-        end
-        s1 << r3
-      end
-      if s1.last
-        r1 = instantiate_node(SyntaxNode,input, i1...index, s1)
-        r1.extend(Encoding0)
-        r1.extend(Encoding1)
+      if has_terminal?("7bits", false, index)
+        r1 = instantiate_node(SyntaxNode,input, index...(index + 5))
+        @index += 5
       else
-        @index = i1
+        terminal_parse_failure("7bits")
         r1 = nil
       end
       if r1
         r0 = r1
       else
-        r5 = _nt_custom_x_token
-        if r5
-          r0 = r5
+        if has_terminal?("8bits", false, index)
+          r2 = instantiate_node(SyntaxNode,input, index...(index + 5))
+          @index += 5
+        else
+          terminal_parse_failure("8bits")
+          r2 = nil
+        end
+        if r2
+          r0 = r2
         else
-          @index = i0
-          r0 = nil
+          if has_terminal?("7bit", false, index)
+            r3 = instantiate_node(SyntaxNode,input, index...(index + 4))
+            @index += 4
+          else
+            terminal_parse_failure("7bit")
+            r3 = nil
+          end
+          if r3
+            r0 = r3
+          else
+            if has_terminal?("8bit", false, index)
+              r4 = instantiate_node(SyntaxNode,input, index...(index + 4))
+              @index += 4
+            else
+              terminal_parse_failure("8bit")
+              r4 = nil
+            end
+            if r4
+              r0 = r4
+            else
+              if has_terminal?("binary", false, index)
+                r5 = instantiate_node(SyntaxNode,input, index...(index + 6))
+                @index += 6
+              else
+                terminal_parse_failure("binary")
+                r5 = nil
+              end
+              if r5
+                r0 = r5
+              else
+                if has_terminal?("quoted-printable", false, index)
+                  r6 = instantiate_node(SyntaxNode,input, index...(index + 16))
+                  @index += 16
+                else
+                  terminal_parse_failure("quoted-printable")
+                  r6 = nil
+                end
+                if r6
+                  r0 = r6
+                else
+                  if has_terminal?("base64", false, index)
+                    r7 = instantiate_node(SyntaxNode,input, index...(index + 6))
+                    @index += 6
+                  else
+                    terminal_parse_failure("base64")
+                    r7 = nil
+                  end
+                  if r7
+                    r0 = r7
+                  else
+                    r8 = _nt_ietf_token
+                    if r8
+                      r0 = r8
+                    else
+                      r9 = _nt_custom_x_token
+                      if r9
+                        r0 = r9
+                      else
+                        @index = i0
+                        r0 = nil
+                      end
+                    end
+                  end
+                end
+              end
+            end
+          end
         end
       end
 
@@ -159,4 +198,4 @@ module Mail
     include ContentTransferEncoding
   end
 
-end
+end

data/lib/mail/parsers/content_transfer_encoding.treetop

@@ -9,12 +9,10 @@ module Mail
     end
     
     rule encoding
-      ietf_token "s"? {
-        def text_value
-          ietf_token.text_value
-        end
-      } / custom_x_token
+      "7bits" / "8bits" /
+      "7bit" / "8bit" / "binary" / "quoted-printable" / "base64" /
+      ietf_token / custom_x_token
     end
     
   end
-end
+end

data/lib/mail/parsers/content_type.rb

@@ -82,18 +82,22 @@ module Mail
               r6 = _nt_CFWS
               s5 << r6
               if r6
-                if has_terminal?(";", false, index)
-                  r8 = instantiate_node(SyntaxNode,input, index...(index + 1))
-                  @index += 1
-                else
-                  terminal_parse_failure(";")
-                  r8 = nil
-                end
-                if r8
-                  r7 = r8
-                else
-                  r7 = instantiate_node(SyntaxNode,input, index...index)
+                s7, i7 = [], index
+                loop do
+                  if has_terminal?(";", false, index)
+                    r8 = instantiate_node(SyntaxNode,input, index...(index + 1))
+                    @index += 1
+                  else
+                    terminal_parse_failure(";")
+                    r8 = nil
+                  end
+                  if r8
+                    s7 << r8
+                  else
+                    break
+                  end
                 end
+                r7 = instantiate_node(SyntaxNode,input, i7...index, s7)
                 s5 << r7
                 if r7
                   r9 = _nt_parameter
@@ -964,4 +968,4 @@ module Mail
     include ContentType
   end
 
-end
+end

data/lib/mail/parsers/content_type.treetop

@@ -5,7 +5,7 @@ module Mail
     include RFC2045
     
     rule content_type
-      main_type "/" sub_type param_hashes:(CFWS ";"? parameter CFWS)* {
+      main_type "/" sub_type param_hashes:(CFWS ";"* parameter CFWS)* {
         def parameters
           param_hashes.elements.map do |param|
             param.parameter.param_hash
@@ -65,4 +65,4 @@ module Mail
     end
 
   end
-end
+end