mail 2.7.1 → 2.9.1

data/lib/mail/multibyte/utils.rb

@@ -3,59 +3,42 @@
 
 module Mail #:nodoc:
   module Multibyte #:nodoc:
-    if RUBY_VERSION >= "1.9"
-      # Returns a regular expression that matches valid characters in the current encoding
-      def self.valid_character
-        VALID_CHARACTER[Encoding.default_external.to_s]
-      end
-    else
-      def self.valid_character
-        case $KCODE
-        when 'UTF8'
-          VALID_CHARACTER['UTF-8']
-        when 'SJIS'
-          VALID_CHARACTER['Shift_JIS']
-        end
-      end
+    # Returns a regular expression that matches valid characters in the current encoding
+    def self.valid_character
+      VALID_CHARACTER[Encoding.default_external.to_s]
     end
 
-    if 'string'.respond_to?(:valid_encoding?)
-      # Verifies the encoding of a string
-      def self.verify(string)
-        string.valid_encoding?
-      end
-    else
-      def self.verify(string)
-        if expression = valid_character
-          # Splits the string on character boundaries, which are determined based on $KCODE.
-          string.split(//).all? { |c| expression =~ c }
-        else
-          true
-        end
+    # Returns true if string has valid utf-8 encoding
+    def self.is_utf8?(string)
+      case string.encoding
+      when Encoding::UTF_8
+        verify(string)
+      when Encoding::ASCII_8BIT, Encoding::US_ASCII
+        verify(to_utf8(string))
+      else
+        false
       end
     end
 
+    # Verifies the encoding of a string
+    def self.verify(string)
+      string.valid_encoding?
+    end
+
     # Verifies the encoding of the string and raises an exception when it's not valid
     def self.verify!(string)
       raise EncodingError.new("Found characters with invalid encoding") unless verify(string)
     end
 
-    if 'string'.respond_to?(:force_encoding)
-      # Removes all invalid characters from the string.
-      #
-      # Note: this method is a no-op in Ruby 1.9
-      def self.clean(string)
-        string
-      end
-    else
-      def self.clean(string)
-        if expression = valid_character
-          # Splits the string on character boundaries, which are determined based on $KCODE.
-          string.split(//).grep(expression).join
-        else
-          string
-        end
-      end
+    # Removes all invalid characters from the string.
+    #
+    # Note: this method is a no-op in Ruby 1.9
+    def self.clean(string)
+      string
+    end
+
+    def self.to_utf8(string)
+      string.dup.force_encoding(Encoding::UTF_8)
     end
   end
 end

data/lib/mail/multibyte.rb

@@ -19,7 +19,6 @@ module Mail #:nodoc:
 
     self.proxy_class = Mail::Multibyte::Chars
 
-    if RUBY_VERSION >= "1.9"
       # == Multibyte proxy
       #
       # +mb_chars+ is a multibyte safe proxy for string methods.
@@ -54,21 +53,12 @@ module Mail #:nodoc:
       # For more information about the methods defined on the Chars proxy see Mail::Multibyte::Chars. For
       # information about how to change the default Multibyte behaviour see Mail::Multibyte.
       def self.mb_chars(str)
-        if proxy_class.consumes?(str)
+        if is_utf8?(str)
           proxy_class.new(str)
         else
           str
         end
       end
-    else
-      def self.mb_chars(str)
-        if proxy_class.wants?(str)
-          proxy_class.new(str)
-        else
-          str
-        end
-      end
-    end
 
     # Regular expressions that describe valid byte sequences for a character
     VALID_CHARACTER = {

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

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
-module Mail
 
+module Mail
   # A delivery method implementation which sends via exim.
   #
   # To use this, first find out where the exim binary is on your computer,
@@ -39,11 +39,12 @@ module Mail
   class Exim < Sendmail
     DEFAULTS = {
       :location   => '/usr/sbin/exim',
-      :arguments  => '-i -t'
+      :arguments  => %w[ -i -t ]
     }
 
-    def self.call(path, arguments, destinations, encoded_message)
-      super path, arguments, nil, encoded_message
+    # Uses -t option to extract recipients from the message.
+    def destinations_for(envelope)
+      nil
     end
   end
 end

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

@@ -1,32 +1,28 @@
 # frozen_string_literal: true
-require 'mail/check_delivery_params'
+require 'mail/smtp_envelope'
 
 module Mail
   # FileDelivery class delivers emails into multiple files based on the destination
   # address.  Each file is appended to if it already exists.
-  # 
+  #
   # So if you have an email going to fred@test, bob@test, joe@anothertest, and you
   # set your location path to /path/to/mails then FileDelivery will create the directory
   # if it does not exist, and put one copy of the email in three files, called
   # by their message id
-  # 
+  #
   # Make sure the path you specify with :location is writable by the Ruby process
   # running Mail.
   class FileDelivery
-    if RUBY_VERSION >= '1.9.1'
-      require 'fileutils'
-    else
-      require 'ftools'
-    end
+    require 'fileutils'
 
     attr_accessor :settings
 
     def initialize(values)
-      self.settings = { :location => './mails' }.merge!(values)
+      self.settings = { :location => './mails', :extension => '' }.merge!(values)
     end
 
     def deliver!(mail)
-      Mail::CheckDeliveryParams.check(mail)
+      envelope = Mail::SmtpEnvelope.new(mail)
 
       if ::File.respond_to?(:makedirs)
         ::File.makedirs settings[:location]
@@ -34,8 +30,13 @@ module Mail
         ::FileUtils.mkdir_p settings[:location]
       end
 
-      mail.destinations.uniq.each do |to|
-        ::File.open(::File.join(settings[:location], File.basename(to.to_s)), 'a') { |f| "#{f.write(mail.encoded)}\r\n\r\n" }
+      envelope.to.uniq.each do |to|
+        path = ::File.join(settings[:location], File.basename(to.to_s+settings[:extension]))
+
+        ::File.open(path, 'a') do |f|
+          f.write envelope.message
+          f.write "\r\n\r\n"
+        end
       end
     end
   end

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

@@ -1,9 +1,7 @@
-require 'mail/check_delivery_params'
+require 'mail/smtp_envelope'
 
 module Mail
   class LoggerDelivery
-    include Mail::CheckDeliveryParams
-
     attr_reader :logger, :severity, :settings
 
     def initialize(settings)
@@ -13,8 +11,7 @@ module Mail
     end
 
     def deliver!(mail)
-      Mail::CheckDeliveryParams.check(mail)
-      logger.log(severity) { mail.encoded }
+      logger.log(severity) { Mail::SmtpEnvelope.new(mail).message }
     end
 
     private

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

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
-require 'mail/check_delivery_params'
+require 'mail/smtp_envelope'
 
 module Mail
   # A delivery method implementation which sends via sendmail.
@@ -40,56 +40,48 @@ module Mail
   class Sendmail
     DEFAULTS = {
       :location   => '/usr/sbin/sendmail',
-      :arguments  => '-i'
+      :arguments  => %w[ -i ]
     }
 
     attr_accessor :settings
 
+    class DeliveryError < StandardError
+    end
+
     def initialize(values)
       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)
+      envelope.to
     end
 
     def deliver!(mail)
-      smtp_from, smtp_to, message = Mail::CheckDeliveryParams.check(mail)
+      envelope = Mail::SmtpEnvelope.new(mail)
 
-      from = "-f #{self.class.shellquote(smtp_from)}" if smtp_from
-      to = smtp_to.map { |_to| self.class.shellquote(_to) }.join(' ')
+      command = [settings[:location]]
+      command.concat Array(settings[:arguments])
+      command.concat [ '-f', envelope.from ] if envelope.from
 
-      arguments = "#{settings[:arguments]} #{from} --"
-      self.class.call(settings[:location], arguments, to, message)
-    end
+      if destinations = destinations_for(envelope)
+        command.push '--'
+        command.concat destinations
+      end
 
-    def self.call(path, arguments, destinations, encoded_message)
-      popen "#{path} #{arguments} #{destinations}" do |io|
-        io.puts ::Mail::Utilities.binary_unsafe_to_lf(encoded_message)
+      popen(command) do |io|
+        io.puts ::Mail::Utilities.binary_unsafe_to_lf(envelope.message)
         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
+    private
+      def popen(command, &block)
+        IO.popen(command, 'w+', :err => :out, &block).tap do
+          if $?.exitstatus != 0
+            raise DeliveryError, "Delivery failed with exitstatus #{$?.exitstatus}: #{command.inspect}"
+          end
+        end
       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 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,20 +1,20 @@
 # frozen_string_literal: true
-require 'mail/check_delivery_params'
+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,12 +92,12 @@ 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,
-      :open_timeout         => nil,
-      :read_timeout         => nil
+      :open_timeout         => 5,
+      :read_timeout         => 5
     }
 
     def initialize(values)
@@ -105,23 +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|
-          if settings[:tls] || settings[:ssl]
-            if smtp.respond_to?(:enable_tls)
-              smtp.enable_tls(ssl_context)
-            end
-          elsif settings[:enable_starttls]
-            if smtp.respond_to?(:enable_starttls)
+          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)
-            end
-          elsif settings[:enable_starttls_auto]
-            if smtp.respond_to?(:enable_starttls_auto)
+            when :auto
               smtp.enable_starttls_auto(ssl_context)
+            else
+              smtp.disable_starttls
             end
           end
 

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

@@ -1,41 +1,41 @@
 # frozen_string_literal: true
-require 'mail/check_delivery_params'
+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
@@ -49,18 +49,9 @@ module Mail
     # 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(dot_stuff(message), smtp_from, smtp_to)
-
+      envelope = Mail::SmtpEnvelope.new(mail)
+      response = smtp.sendmail(envelope.message, envelope.from, envelope.to)
       settings[:return_response] ? response : self
     end
-
-    private
-      # This is Net::SMTP's job, but before Ruby 2.x it does not dot-stuff
-      # an unterminated last line: https://bugs.ruby-lang.org/issues/9627
-      def dot_stuff(message)
-        message.gsub(/(\r\n\.)(\r\n|$)/, '\1.\2')
-      end
   end
 end

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

@@ -1,10 +1,10 @@
 # frozen_string_literal: true
-require 'mail/check_delivery_params'
+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
@@ -35,7 +35,9 @@ module Mail
     end
 
     def deliver!(mail)
-      Mail::CheckDeliveryParams.check(mail)
+      # Create the envelope to validate it
+      Mail::SmtpEnvelope.new(mail)
+
       Mail::TestMailer.deliveries << mail
     end
   end

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

@@ -11,38 +11,38 @@ module Mail
     #   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 ||= {}
+    def first(options = nil, &block)
+      options = options ? Hash[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 ||= {}
+    def last(options = nil, &block)
+      options = options ? Hash[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 ||= {}
+    def all(options = nil, &block)
+      options = options ? Hash[options] : {}
       options[:count] = :all
       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:
@@ -53,11 +53,11 @@ module Mail
     #   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 ||= {}
+    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