mail 2.6.1 → 2.8.1

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

@@ -0,0 +1,34 @@
+require 'mail/smtp_envelope'
+
+module Mail
+  class LoggerDelivery
+    attr_reader :logger, :severity, :settings
+
+    def initialize(settings)
+      @settings = settings
+      @logger   = settings.fetch(:logger) { default_logger }
+      @severity = derive_severity(settings[:severity])
+    end
+
+    def deliver!(mail)
+      logger.log(severity) { Mail::SmtpEnvelope.new(mail).message }
+    end
+
+    private
+      def default_logger
+        require 'logger'
+        ::Logger.new($stdout)
+      end
+
+      def derive_severity(severity)
+        case severity
+        when nil
+          Logger::INFO
+        when Integer
+          severity
+        else
+          Logger.const_get(severity.to_s.upcase)
+        end
+      end
+  end
+end

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

@@ -1,4 +1,5 @@
-require 'mail/check_delivery_params'
+# frozen_string_literal: true
+require 'mail/smtp_envelope'
 
 module Mail
   # A delivery method implementation which sends via sendmail.
@@ -37,53 +38,96 @@ module Mail
   #
   #   mail.deliver!
   class Sendmail
-    include Mail::CheckDeliveryParams
+    DEFAULTS = {
+      :location   => '/usr/sbin/sendmail',
+      :arguments  => %w[ -i ]
+    }
+
+    attr_accessor :settings
+
+    class DeliveryError < StandardError
+    end
 
     def initialize(values)
-      self.settings = { :location       => '/usr/sbin/sendmail',
-                        :arguments      => '-i' }.merge(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)
     end
 
-    attr_accessor :settings
+    def destinations_for(envelope)
+      envelope.to
+    end
 
     def deliver!(mail)
-      smtp_from, smtp_to, message = check_delivery_params(mail)
+      envelope = Mail::SmtpEnvelope.new(mail)
 
-      from = "-f #{self.class.shellquote(smtp_from)}"
-      to = smtp_to.map { |_to| self.class.shellquote(_to) }.join(' ')
+      arguments = settings[:arguments]
+      if arguments.is_a? String
+        return old_deliver(envelope)
+      end
 
-      arguments = "#{settings[:arguments]} #{from} --"
-      self.class.call(settings[:location], arguments, to, message)
-    end
+      command = [settings[:location]]
+      command.concat Array(arguments)
+      command.concat [ '-f', envelope.from ] if envelope.from
 
-    def self.call(path, arguments, destinations, encoded_message)
-      popen "#{path} #{arguments} #{destinations}" do |io|
-        io.puts encoded_message.to_lf
+      if destinations = destinations_for(envelope)
+        command.push '--'
+        command.concat destinations
+      end
+
+      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
+    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
-    else
-      def self.popen(command, &block)
-        IO.popen command, 'w+', :err => :out, &block
+
+    #+ 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,
-    # 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)
+    # 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 = 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

@@ -1,4 +1,5 @@
-require 'mail/check_delivery_params'
+# frozen_string_literal: true
+require 'mail/smtp_envelope'
 
 module Mail
   # == Sending Email with SMTP
@@ -44,9 +45,8 @@ module Mail
   # hostname or update the certificate authorities trusted by your ruby. If
   # that isn't possible, you can control this behavior with
   # an :openssl_verify_mode setting. Its value may be either an OpenSSL
-  # verify mode constant (OpenSSL::SSL::VERIFY_NONE), or a string containing
-  # the name of an OpenSSL verify mode (none, peer, client_once,
-  # fail_if_no_peer_cert).
+  # 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 
   # 
@@ -74,69 +74,92 @@ module Mail
   # 
   #   mail.deliver!
   class SMTP
-    include Mail::CheckDeliveryParams
+    attr_accessor :settings
+
+    DEFAULTS = {
+      :address              => 'localhost',
+      :port                 => 25,
+      :domain               => 'localhost.localdomain',
+      :user_name            => nil,
+      :password             => nil,
+      :authentication       => nil,
+      :enable_starttls      => nil,
+      :enable_starttls_auto => true,
+      :openssl_verify_mode  => nil,
+      :ssl                  => nil,
+      :tls                  => nil,
+      :open_timeout         => 5,
+      :read_timeout         => 5
+    }
 
     def initialize(values)
-      self.settings = { :address              => "localhost",
-                        :port                 => 25,
-                        :domain               => 'localhost.localdomain',
-                        :user_name            => nil,
-                        :password             => nil,
-                        :authentication       => nil,
-                        :enable_starttls_auto => true,
-                        :openssl_verify_mode  => nil,
-                        :ssl                  => nil,
-                        :tls                  => nil
-                      }.merge!(values)
+      self.settings = DEFAULTS.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 = check_delivery_params(mail)
-
-      smtp = Net::SMTP.new(settings[:address], settings[:port])
-      if settings[:tls] || settings[:ssl]
-        if smtp.respond_to?(:enable_tls)
-          smtp.enable_tls(ssl_context)
-        end
-      elsif settings[:enable_starttls_auto]
-        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, smtp_from, smtp_to)
+      response = start_smtp_session do |smtp|
+        Mail::SMTPConnection.new(:connection => smtp, :return_response => true).deliver!(mail)
       end
 
-      if settings[:return_response]
-        response
-      else
-        self
-      end
+      settings[:return_response] ? response : self
     end
-    
 
     private
+      def start_smtp_session(&block)
+        build_smtp_session.start(settings[:domain], settings[:user_name], settings[:password], settings[:authentication], &block)
+      end
 
-    # 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]
+      def build_smtp_session
+        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
+              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
+              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"
+            end
+          end
 
-      if openssl_verify_mode.kind_of?(String)
-        openssl_verify_mode = "OpenSSL::SSL::VERIFY_#{openssl_verify_mode.upcase}".constantize
+          smtp.open_timeout = settings[:open_timeout] if settings[:open_timeout]
+          smtp.read_timeout = settings[:read_timeout] if settings[:read_timeout]
+        end
       end
 
-      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
+      # 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.const_get("VERIFY_#{openssl_verify_mode.upcase}")
+        end
+
+        context = Net::SMTP.default_ssl_context
+        context.verify_mode = openssl_verify_mode if 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,4 +1,5 @@
-require 'mail/check_delivery_params'
+# frozen_string_literal: true
+require 'mail/smtp_envelope'
 
 module Mail
   # == Sending Email with SMTP
@@ -37,7 +38,7 @@ module Mail
   # 
   #   mail.deliver!
   class SMTPConnection
-    include Mail::CheckDeliveryParams
+    attr_accessor :smtp, :settings
 
     def initialize(values)
       raise ArgumentError.new('A Net::SMTP object is required for this delivery method') if values[:connection].nil?
@@ -45,17 +46,12 @@ module Mail
       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 = check_delivery_params(mail)
-      response = smtp.sendmail(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
-
   end
 end

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

@@ -1,4 +1,5 @@
-require 'mail/check_delivery_params'
+# frozen_string_literal: true
+require 'mail/smtp_envelope'
 
 module Mail
   # The TestMailer is a bare bones mailer that does nothing.  It is useful
@@ -7,10 +8,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
-    include Mail::CheckDeliveryParams
-
     # Provides a store of all the emails sent with the TestMailer so you can check them.
-    def TestMailer.deliveries
+    def self.deliveries
       @@deliveries ||= []
     end
 
@@ -25,20 +24,21 @@ 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 = values.dup
     end
-    
-    attr_accessor :settings
 
     def deliver!(mail)
-      check_delivery_params(mail)
+      # Create the envelope to validate it
+      Mail::SmtpEnvelope.new(mail)
+
       Mail::TestMailer.deliveries << mail
     end
-    
   end
 end

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

@@ -1,4 +1,5 @@
 # encoding: utf-8
+# frozen_string_literal: true
 
 module Mail
 
@@ -10,8 +11,8 @@ 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)
@@ -23,8 +24,8 @@ 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 last(options = {}, &block)
-      options ||= {}
+    def last(options = nil, &block)
+      options = options ? Hash[options] : {}
       options[:what] = :last
       options[:count] ||= 1
       find(options, &block)
@@ -35,8 +36,8 @@ module Mail
     # 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
@@ -52,8 +53,8 @@ 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 

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

@@ -1,4 +1,5 @@
 # encoding: utf-8
+# frozen_string_literal: true
 
 module Mail
   # The IMAP retriever allows to get the last, first or all emails from a IMAP server.
@@ -44,7 +45,8 @@ module Mail
                         :user_name            => nil,
                         :password             => nil,
                         :authentication       => nil,
-                        :enable_ssl           => false }.merge!(values)
+                        :enable_ssl           => false,
+                        :enable_starttls      => false }.merge!(values)
     end
 
     attr_accessor :settings
@@ -66,14 +68,14 @@ module Mail
     #   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'.
     #
-    def find(options={}, &block)
+    def find(options=nil, &block)
       options = validate_options(options)
 
       start do |imap|
         options[:read_only] ? imap.examine(options[:mailbox]) : imap.select(options[:mailbox])
-
-        uids = imap.uid_search(options[:keys])
+        uids = imap.uid_search(options[:keys], options[:search_charset])
         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) ||
@@ -82,14 +84,18 @@ module Mail
         if block_given?
           uids.each do |uid|
             uid = options[:uid].to_i unless options[:uid].nil?
-            fetchdata = imap.uid_fetch(uid, ['RFC822'])[0]
+            fetchdata = imap.uid_fetch(uid, ['RFC822', 'FLAGS'])[0]
             new_message = Mail.new(fetchdata.attr['RFC822'])
             new_message.mark_for_delete = true if options[:delete_after_find]
-            if block.arity == 3
+
+            if block.arity == 4
+              yield new_message, imap, uid, fetchdata.attr['FLAGS']
+            elsif block.arity == 3
               yield new_message, imap, uid
             else
               yield new_message
             end
+
             imap.uid_store(uid, "+FLAGS", [Net::IMAP::DELETED]) if options[:delete_after_find] && new_message.is_marked_for_delete?
             break unless options[:uid].nil?
           end
@@ -115,6 +121,7 @@ module Mail
       mailbox = Net::IMAP.encode_utf7(mailbox)
 
       start do |imap|
+        imap.select(mailbox)
         imap.uid_search(['ALL']).each do |uid|
           imap.uid_store(uid, "+FLAGS", [Net::IMAP::DELETED])
         end
@@ -135,7 +142,7 @@ module Mail
 
       # Set default options
       def validate_options(options)
-        options ||= {}
+        options = options ? Hash[options] : {}
         options[:mailbox] ||= 'INBOX'
         options[:count]   ||= 10
         options[:order]   ||= :asc
@@ -153,7 +160,14 @@ module Mail
       def start(config=Mail::Configuration.instance, &block)
         raise ArgumentError.new("Mail::Retrievable#imap_start takes a block") unless block_given?
 
+        if settings[:enable_starttls] && settings[:enable_ssl]
+          raise ArgumentError, ":enable_starttls and :enable_ssl are mutually exclusive. Set :enable_ssl if you're on an IMAPS connection. Set :enable_starttls if you're on an IMAP connection and using STARTTLS for secure TLS upgrade."
+        end
+
         imap = Net::IMAP.new(settings[:address], settings[:port], settings[:enable_ssl], nil, false)
+
+        imap.starttls if settings[:enable_starttls]
+
         if settings[:authentication].nil?
           imap.login(settings[:user_name], settings[:password])
         else

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

@@ -1,4 +1,5 @@
 # encoding: utf-8
+# frozen_string_literal: true
 
 module Mail
   # The Pop3 retriever allows to get the last, first or all emails from a POP3 server.
@@ -40,7 +41,8 @@ module Mail
                         :user_name            => nil,
                         :password             => nil,
                         :authentication       => nil,
-                        :enable_ssl           => false }.merge!(values)
+                        :enable_ssl           => false,
+                        :read_timeout         => nil }.merge!(values)
     end
     
     attr_accessor :settings
@@ -55,7 +57,7 @@ module Mail
     #   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)
+    def find(options = nil, &block)
       options = validate_options(options)
       
       start do |pop3|
@@ -111,7 +113,7 @@ module Mail
   
     # Set default options
     def validate_options(options)
-      options ||= {}
+      options = options ? Hash[options] : {}
       options[:count] ||= 10
       options[:order] ||= :asc
       options[:what]  ||= :first
@@ -127,6 +129,7 @@ module Mail
     
       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

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

@@ -1,4 +1,5 @@
 # encoding: utf-8
+# frozen_string_literal: true
 
 module Mail
 
@@ -16,7 +17,8 @@ module Mail
       @@emails = []
     end
 
-    def find(options = {}, &block)
+    def find(options = nil, &block)
+      options = options ? Hash[options] : {}
       options[:count] ||= :all
       options[:order] ||= :asc
       options[:what] ||= :first
@@ -24,7 +26,7 @@ module Mail
       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]
+        when Integer then emails_index[0, count]
         else
           raise 'Invalid count option value: ' + count.inspect
       end

data/lib/mail/network.rb

@@ -1,8 +1,10 @@
+# frozen_string_literal: true
 require 'mail/network/retriever_methods/base'
 
 module Mail
   register_autoload :SMTP, 'mail/network/delivery_methods/smtp'
   register_autoload :FileDelivery, 'mail/network/delivery_methods/file_delivery'
+  register_autoload :LoggerDelivery, 'mail/network/delivery_methods/logger_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'

data/lib/mail/parser_tools.rb

@@ -0,0 +1,15 @@
+module Mail
+  # Extends each field parser with utility methods.
+  module ParserTools #:nodoc:
+    # Slice bytes from ASCII-8BIT data and mark as UTF-8.
+    if 'string'.respond_to?(:force_encoding)
+      def chars(data, from_bytes, to_bytes)
+        data.slice(from_bytes..to_bytes).force_encoding(Encoding::UTF_8)
+      end
+    else
+      def chars(data, from_bytes, to_bytes)
+        data.slice(from_bytes..to_bytes)
+      end
+    end
+  end
+end