mail 2.8.1 → 2.9.0

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

@@ -49,12 +49,8 @@ module Mail
     end
 
     def initialize(values)
-      if values[:arguments].is_a?(String)
-        deprecation_warn.call \
-          'Initializing Mail::Sendmail with :arguments of type String is deprecated.' \
-          ' Instead ensure :arguments is an array of strings, e.g. ["-i", "-t"]'
-      end
       self.settings = self.class::DEFAULTS.merge(values)
+      raise ArgumentError, ":arguments expected to be an Array of individual string args" if settings[:arguments].is_a?(String)
     end
 
     def destinations_for(envelope)
@@ -64,13 +60,8 @@ module Mail
     def deliver!(mail)
       envelope = Mail::SmtpEnvelope.new(mail)
 
-      arguments = settings[:arguments]
-      if arguments.is_a? String
-        return old_deliver(envelope)
-      end
-
       command = [settings[:location]]
-      command.concat Array(arguments)
+      command.concat Array(settings[:arguments])
       command.concat [ '-f', envelope.from ] if envelope.from
 
       if destinations = destinations_for(envelope)
@@ -92,42 +83,5 @@ module Mail
           end
         end
       end
-
-    #+ support for delivery using string arguments (deprecated)
-    def old_deliver(envelope)
-      smtp_from = envelope.from
-      smtp_to = destinations_for(envelope)
-
-      from = "-f #{shellquote(smtp_from)}" if smtp_from
-      destination = smtp_to.map { |to| shellquote(to) }.join(' ')
-
-      arguments = "#{settings[:arguments]} #{from} --"
-      command = "#{settings[:location]} #{arguments} #{destination}"
-      popen command do |io|
-        io.puts ::Mail::Utilities.binary_unsafe_to_lf(envelope.message)
-        io.flush
-      end
-    end
-
-    # The following is an adaptation of ruby 1.9.2's shellwords.rb file,
-    # with the following modifications:
-    #
-    # - Wraps in double quotes
-    # - Allows '+' to accept email addresses with them
-    # - Allows '~' as it is not unescaped in double quotes
-    def 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
-    #- support for delivery using string arguments
-
-    def deprecation_warn
-      defined?(ActiveSupport::Deprecation.warn) ? ActiveSupport::Deprecation.method(:warn) : Kernel.method(:warn)
-    end
   end
 end

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

@@ -3,18 +3,18 @@ require 'mail/smtp_envelope'
 
 module Mail
   # == Sending Email with SMTP
-  # 
+  #
   # Mail allows you to send emails using SMTP.  This is done by wrapping Net::SMTP in
   # an easy to use manner.
-  # 
+  #
   # === Sending via SMTP server on Localhost
-  # 
+  #
   # Sending locally (to a postfix or sendmail server running on localhost) requires
   # no special setup.  Just to Mail.deliver &block or message.deliver! and it will
   # be sent in this method.
-  # 
+  #
   # === Sending via MobileMe
-  # 
+  #
   #   Mail.defaults do
   #     delivery_method :smtp, { :address              => "smtp.me.com",
   #                              :port                 => 587,
@@ -22,11 +22,11 @@ module Mail
   #                              :user_name            => '<username>',
   #                              :password             => '<password>',
   #                              :authentication       => 'plain',
-  #                              :enable_starttls_auto => true  }
+  #                              :enable_starttls      => :auto  }
   #   end
-  # 
+  #
   # === Sending via GMail
-  # 
+  #
   #   Mail.defaults do
   #     delivery_method :smtp, { :address              => "smtp.gmail.com",
   #                              :port                 => 587,
@@ -34,9 +34,17 @@ module Mail
   #                              :user_name            => '<username>',
   #                              :password             => '<password>',
   #                              :authentication       => 'plain',
-  #                              :enable_starttls_auto => true  }
+  #                              :enable_starttls      => :auto  }
   #   end
   #
+  # === Configuring TLS/SSL and STARTTLS
+  #
+  # A few remarks:
+  # - when enabling `tls` (or `ssl`), setting (truthy values for) either `enable_starttls` or `enable_starttls_auto` will raise an ArgumentError as TLS and STARTTLS are mutually exclusive.
+  # - to configure STARTTLS, use the `enable_starttls`-flag (instead of a combination of `enable_starttls` and `enable_starttls_auto`). Acceptable values are `:always`, `:auto` and `false`.
+  # - when providing a truthy value for `enable_starttls`, the `enable_starttls_auto`-flag will be ignored.
+  # - when none of `tls`, `ssl`, `enable_starttls` or `enable_starttls_auto` is set, the fallback will be `enable_starttls` `:auto`.
+  #
   # === Certificate verification
   #
   # When using TLS, some mail servers provide certificates that are self-signed
@@ -48,30 +56,30 @@ module Mail
   # verify mode constant (OpenSSL::SSL::VERIFY_NONE, OpenSSL::SSL::VERIFY_PEER),
   # or a string containing the name of an OpenSSL verify mode (none, peer).
   #
-  # === Others 
-  # 
+  # === Others
+  #
   # Feel free to send me other examples that were tricky
-  # 
+  #
   # === Delivering the email
-  # 
+  #
   # Once you have the settings right, sending the email is done by:
-  # 
+  #
   #   Mail.deliver do
   #     to 'mikel@test.lindsaar.net'
   #     from 'ada@test.lindsaar.net'
   #     subject 'testing sendmail'
   #     body 'testing sendmail'
   #   end
-  # 
+  #
   # Or by calling deliver on a Mail message
-  # 
+  #
   #   mail = Mail.new do
   #     to 'mikel@test.lindsaar.net'
   #     from 'ada@test.lindsaar.net'
   #     subject 'testing sendmail'
   #     body 'testing sendmail'
   #   end
-  # 
+  #
   #   mail.deliver!
   class SMTP
     attr_accessor :settings
@@ -84,7 +92,7 @@ module Mail
       :password             => nil,
       :authentication       => nil,
       :enable_starttls      => nil,
-      :enable_starttls_auto => true,
+      :enable_starttls_auto => nil,
       :openssl_verify_mode  => nil,
       :ssl                  => nil,
       :tls                  => nil,
@@ -105,39 +113,66 @@ module Mail
     end
 
     private
+      # `k` is said to be provided when `settings` has a non-nil value for `k`.
+      def setting_provided?(k)
+        !settings[k].nil?
+      end
+
+      # Yields one of `:always`, `:auto` or `false` based on `enable_starttls` and `enable_starttls_auto` flags.
+      # Yields `false` when `smtp_tls?`.
+      # Else defaults to `:auto` when neither `enable_starttls*` flag is provided.
+      # Providing a truthy value for `enable_starttls` will ignore `enable_starttls_auto`.
+      def smtp_starttls
+        return false if smtp_tls?
+
+        if setting_provided?(:enable_starttls) && settings[:enable_starttls]
+          # enable_starttls: provided and truthy
+          case settings[:enable_starttls]
+          when :auto then :auto
+          when :always then :always
+          else
+            :always
+          end
+        else
+          # enable_starttls: not provided or false
+          if setting_provided?(:enable_starttls_auto)
+            settings[:enable_starttls_auto] ? :auto : false
+          else
+            # enable_starttls_auto: not provided
+            # enable_starttls: when provided then false
+            # use :auto when neither enable_starttls* provided
+            setting_provided?(:enable_starttls) ? false : :auto
+          end
+        end
+      end
+
+      def smtp_tls?
+        (setting_provided?(:tls) && settings[:tls]) || (setting_provided?(:ssl) && settings[:ssl])
+      end
+
       def start_smtp_session(&block)
         build_smtp_session.start(settings[:domain], settings[:user_name], settings[:password], settings[:authentication], &block)
       end
 
       def build_smtp_session
+        if smtp_tls? && (settings[:enable_starttls] || settings[:enable_starttls_auto])
+          raise ArgumentError, ":enable_starttls and :tls are mutually exclusive. Set :tls if you're on an SMTPS connection. Set :enable_starttls if you're on an SMTP connection and using STARTTLS for secure TLS upgrade."
+        end
+
         Net::SMTP.new(settings[:address], settings[:port]).tap do |smtp|
-          tls = settings[:tls] || settings[:ssl]
-          if !tls.nil?
-            case tls
-            when true
-              smtp.enable_tls(ssl_context)
-            when false
-              smtp.disable_tls
-            else
-              raise ArgumentError, "Unrecognized :tls value #{settings[:tls].inspect}; expected true, false, or nil"
-            end
-          elsif settings.include?(:enable_starttls) && !settings[:enable_starttls].nil?
-            case settings[:enable_starttls]
-            when true
+          if smtp_tls?
+            smtp.disable_starttls
+            smtp.enable_tls(ssl_context)
+          else
+            smtp.disable_tls
+
+            case smtp_starttls
+            when :always
               smtp.enable_starttls(ssl_context)
-            when false
-              smtp.disable_starttls
-            else
-              raise ArgumentError, "Unrecognized :enable_starttls value #{settings[:enable_starttls].inspect}; expected true, false, or nil"
-            end
-          elsif settings.include?(:enable_starttls_auto) && !settings[:enable_starttls_auto].nil?
-            case settings[:enable_starttls_auto]
-            when true
+            when :auto
               smtp.enable_starttls_auto(ssl_context)
-            when false
-              smtp.disable_starttls
             else
-              raise ArgumentError, "Unrecognized :enable_starttls_auto value #{settings[:enable_starttls_auto].inspect}; expected true, false, or nil"
+              smtp.disable_starttls
             end
           end
 

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

@@ -3,39 +3,39 @@ require 'mail/smtp_envelope'
 
 module Mail
   # == Sending Email with SMTP
-  # 
+  #
   # Mail allows you to send emails using an open SMTP connection.  This is done by
   # passing a created Net::SMTP object.  This way we can get better performance to
   # our local mail server by reducing the number of connections at any one time.
   #
   # === Sending via SMTP server on Localhost
-  # 
+  #
   # To send mail open a connection with Net::Smtp using any options you like
   # === Delivering the email
-  # 
+  #
   # Once you have the settings right, sending the email is done by:
   #
   #   smtp_conn = Net::SMTP.start(settings[:address], settings[:port])
   #   Mail.defaults do
   #     delivery_method :smtp_connection, { :connection => smtp_conn }
   #   end
-  # 
+  #
   #   Mail.deliver do
   #     to 'mikel@test.lindsaar.net'
   #     from 'ada@test.lindsaar.net'
   #     subject 'testing sendmail'
   #     body 'testing sendmail'
   #   end
-  # 
+  #
   # Or by calling deliver on a Mail message
-  # 
+  #
   #   mail = Mail.new do
   #     to 'mikel@test.lindsaar.net'
   #     from 'ada@test.lindsaar.net'
   #     subject 'testing sendmail'
   #     body 'testing sendmail'
   #   end
-  # 
+  #
   #   mail.deliver!
   class SMTPConnection
     attr_accessor :smtp, :settings

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

@@ -4,7 +4,7 @@ require 'mail/smtp_envelope'
 module Mail
   # The TestMailer is a bare bones mailer that does nothing.  It is useful
   # when you are testing.
-  # 
+  #
   # 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
@@ -14,11 +14,11 @@ module Mail
     end
 
     # Allows you to over write the default deliveries store from an array to some
-    # other object.  If you just want to clear the store, 
+    # other object.  If you just want to clear the store,
     # call TestMailer.deliveries.clear.
-    # 
+    #
     # If you place another object here, please make sure it responds to:
-    # 
+    #
     # * << (message)
     # * clear
     # * length

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

@@ -17,7 +17,7 @@ module Mail
       options[:count] ||= 1
       find(options, &block)
     end
-    
+
     # Get the most recent received email(s)
     #
     # Possible options:
@@ -30,7 +30,7 @@ module Mail
       options[:count] ||= 1
       find(options, &block)
     end
-    
+
     # Get all emails.
     #
     # Possible options:
@@ -42,7 +42,7 @@ module Mail
       find(options, &block)
     end
 
-    # Find emails in the mailbox, and then deletes them. Without any options, the 
+    # Find emails in the mailbox, and then deletes them. Without any options, the
     # five last received emails are returned.
     #
     # Possible options:
@@ -56,8 +56,8 @@ module Mail
     def find_and_delete(options = nil, &block)
       options = options ? Hash[options] : {}
       options[:delete_after_find] ||= true
-      find(options, &block)      
-    end 
+      find(options, &block)
+    end
 
   end
 

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

@@ -29,7 +29,7 @@ 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, 
+  #   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'
   #
@@ -38,7 +38,7 @@ module Mail
   #
   class IMAP < Retriever
     require 'net/imap' unless defined?(Net::IMAP)
-    
+
     def initialize(values)
       self.settings = { :address              => "localhost",
                         :port                 => 143,
@@ -65,7 +65,7 @@ module 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, 
+    #   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'
     #   search_charset: charset to pass to IMAP server search. Omitted by default. Example: 'UTF-8' or 'ASCII'.
@@ -75,7 +75,10 @@ module Mail
 
       start do |imap|
         options[:read_only] ? imap.examine(options[:mailbox]) : imap.select(options[:mailbox])
+
         uids = imap.uid_search(options[:keys], options[:search_charset])
+          .to_a # older net-imap may return nil, newer may return ESearchResult struct
+          .sort # RFC3501 does _not_ require UIDs to be returned in order
         uids.reverse! if options[:what].to_sym == :last
         uids = uids.first(options[:count]) if options[:count].is_a?(Integer)
         uids.reverse! if (options[:what].to_sym == :last && options[:order].to_sym == :asc) ||

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

@@ -6,9 +6,9 @@ module Mail
   # 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,
@@ -16,22 +16,22 @@ module Mail
   #                               :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 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' unless defined?(Net::POP)
 
@@ -44,9 +44,9 @@ module Mail
                         :enable_ssl           => false,
                         :read_timeout         => nil }.merge!(values)
     end
-    
+
     attr_accessor :settings
-    
+
     # Find emails in a POP3 mailbox. Without any options, the 5 last received emails are returned.
     #
     # Possible options:
@@ -59,18 +59,18 @@ module Mail
     #
     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)
@@ -86,11 +86,11 @@ module Mail
           end
           emails.size == 1 && options[:count] == 1 ? emails.first : emails
         end
-        
+
       end
     end
-    
-    # Delete all emails from a POP3 server   
+
+    # Delete all emails from a POP3 server
     def delete_all
       start do |pop3|
         unless pop3.mails.empty?
@@ -108,9 +108,9 @@ module Mail
         yield pop3
       end
     end
-    
+
   private
-  
+
     # Set default options
     def validate_options(options)
       options = options ? Hash[options] : {}
@@ -120,18 +120,18 @@ module Mail
       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], 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?

data/lib/mail/parsers/address_lists_parser.rb

@@ -1,4 +1,3 @@
-
 # frozen_string_literal: true
 require "mail/utilities"
 require "mail/parser_tools"
@@ -32011,10 +32010,10 @@ begin
               _trans = if (_slen > 0 &&
                            _trans_keys[_keys] <= _wide &&
                            _wide <= _trans_keys[_keys + 1])
-                         _indicies[_inds + _wide - _trans_keys[_keys]]
-                       else
-                         _indicies[_inds + _slen]
-                       end
+                  _indicies[_inds + _wide - _trans_keys[_keys]]
+                else
+                  _indicies[_inds + _slen]
+                end
               cs = _trans_targs[_trans]
               if _trans_actions[_trans] != 0
                 case _trans_actions[_trans]
@@ -33229,6 +33228,10 @@ begin
           end
         end
 
+        if false
+          testEof
+        end
+
         if p != eof || cs < 2461
           raise Mail::Field::IncompleteParseError.new(Mail::AddressList, data, p)
         end

data/lib/mail/parsers/address_lists_parser.rl

@@ -165,6 +165,10 @@ module Mail::Parsers
       %%write init;
       %%write exec;
 
+      if false
+        testEof
+      end
+
       if p != eof || cs < %%{ write first_final; }%%
         raise Mail::Field::IncompleteParseError.new(Mail::AddressList, data, p)
       end

data/lib/mail/parsers/content_disposition_parser.rb

@@ -1,4 +1,3 @@
-
 # frozen_string_literal: true
 require "mail/utilities"
 require "mail/parser_tools"
@@ -610,10 +609,10 @@ begin
               _trans = if (_slen > 0 &&
                            _trans_keys[_keys] <= _wide &&
                            _wide <= _trans_keys[_keys + 1])
-                         _indicies[_inds + _wide - _trans_keys[_keys]]
-                       else
-                         _indicies[_inds + _slen]
-                       end
+                  _indicies[_inds + _wide - _trans_keys[_keys]]
+                else
+                  _indicies[_inds + _slen]
+                end
               cs = _trans_targs[_trans]
               if _trans_actions[_trans] != 0
                 case _trans_actions[_trans]
@@ -654,7 +653,7 @@ begin
                     # Use quoted string value if one exists, otherwise use parameter value
                     value = qstr || chars(data, param_val_s, p - 1)
 
-                    content_disposition.parameters << {param_attr => value}
+                    content_disposition.parameters << { param_attr => value }
                     param_attr = nil
                     qstr = nil
                   end
@@ -712,7 +711,7 @@ begin
                     # Use quoted string value if one exists, otherwise use parameter value
                     value = qstr || chars(data, param_val_s, p - 1)
 
-                    content_disposition.parameters << {param_attr => value}
+                    content_disposition.parameters << { param_attr => value }
                     param_attr = nil
                     qstr = nil
                   end
@@ -742,7 +741,7 @@ begin
                     # Use quoted string value if one exists, otherwise use parameter value
                     value = qstr || chars(data, param_val_s, p - 1)
 
-                    content_disposition.parameters << {param_attr => value}
+                    content_disposition.parameters << { param_attr => value }
                     param_attr = nil
                     qstr = nil
                   end
@@ -799,7 +798,7 @@ begin
                     # Use quoted string value if one exists, otherwise use parameter value
                     value = qstr || chars(data, param_val_s, p - 1)
 
-                    content_disposition.parameters << {param_attr => value}
+                    content_disposition.parameters << { param_attr => value }
                     param_attr = nil
                     qstr = nil
                   end
@@ -823,7 +822,7 @@ begin
                     # Use quoted string value if one exists, otherwise use parameter value
                     value = qstr || chars(data, param_val_s, p - 1)
 
-                    content_disposition.parameters << {param_attr => value}
+                    content_disposition.parameters << { param_attr => value }
                     param_attr = nil
                     qstr = nil
                   end
@@ -857,7 +856,7 @@ begin
                     # Use quoted string value if one exists, otherwise use parameter value
                     value = qstr || chars(data, param_val_s, p - 1)
 
-                    content_disposition.parameters << {param_attr => value}
+                    content_disposition.parameters << { param_attr => value }
                     param_attr = nil
                     qstr = nil
                   end
@@ -875,7 +874,7 @@ begin
                     # Use quoted string value if one exists, otherwise use parameter value
                     value = qstr || chars(data, param_val_s, p - 1)
 
-                    content_disposition.parameters << {param_attr => value}
+                    content_disposition.parameters << { param_attr => value }
                     param_attr = nil
                     qstr = nil
                   end
@@ -888,6 +887,10 @@ begin
           end
         end
 
+        if false
+          testEof
+        end
+
         if p != eof || cs < 40
           raise Mail::Field::IncompleteParseError.new(Mail::ContentDispositionElement, data, p)
         end

data/lib/mail/parsers/content_disposition_parser.rl

@@ -75,6 +75,10 @@ module Mail::Parsers
       %%write init;
       %%write exec;
 
+      if false
+        testEof
+      end
+
       if p != eof || cs < %%{ write first_final; }%%
         raise Mail::Field::IncompleteParseError.new(Mail::ContentDispositionElement, data, p)
       end