mail 2.6.1 → 2.7.1

data/lib/mail/multibyte/unicode.rb

@@ -1,6 +1,27 @@
+# frozen_string_literal: true
 module Mail
   module Multibyte
     module Unicode
+      # Adapted from https://github.com/rails/rails/blob/master/activesupport/lib/active_support/multibyte/unicode.rb
+      # under the MIT license
+      # The Unicode version that is supported by the implementation
+      UNICODE_VERSION = '7.0.0'
+
+      # Holds data about a codepoint in the Unicode database.
+      class Codepoint
+        attr_accessor :code, :combining_class, :decomp_type, :decomp_mapping, :uppercase_mapping, :lowercase_mapping
+
+        # Initializing Codepoint object with default values
+        def initialize
+          @combining_class = 0
+          @uppercase_mapping = 0
+          @lowercase_mapping = 0
+        end
+
+        def swapcase_mapping
+          uppercase_mapping > 0 ? uppercase_mapping : lowercase_mapping
+        end
+      end
 
       extend self
 
@@ -8,9 +29,6 @@ module Mail
       # information about normalization.
       NORMALIZATION_FORMS = [:c, :kc, :d, :kd]
 
-      # The Unicode version that is supported by the implementation
-      UNICODE_VERSION = '5.2.0'
-
       # The default normalization used for operations that require normalization. It can be set to any of the
       # normalizations in NORMALIZATION_FORMS.
       #
@@ -284,16 +302,16 @@ module Mail
         # See http://www.unicode.org/reports/tr15, Table 1
         codepoints = u_unpack(string)
         case form
-          when :d
-            reorder_characters(decompose_codepoints(:canonical, codepoints))
-          when :c
-            compose_codepoints(reorder_characters(decompose_codepoints(:canonical, codepoints)))
-          when :kd
-            reorder_characters(decompose_codepoints(:compatability, codepoints))
-          when :kc
-            compose_codepoints(reorder_characters(decompose_codepoints(:compatability, codepoints)))
-          else
-            raise ArgumentError, "#{form} is not a valid normalization variant", caller
+        when :d
+          reorder_characters(decompose_codepoints(:canonical, codepoints))
+        when :c
+          compose_codepoints(reorder_characters(decompose_codepoints(:canonical, codepoints)))
+        when :kd
+          reorder_characters(decompose_codepoints(:compatability, codepoints))
+        when :kc
+          compose_codepoints(reorder_characters(decompose_codepoints(:compatability, codepoints)))
+        else
+          raise ArgumentError, "#{form} is not a valid normalization variant", caller
         end.pack('U*')
       end
 
@@ -308,11 +326,6 @@ module Mail
         end.pack('U*')
       end
 
-      # Holds data about a codepoint in the Unicode database
-      class Codepoint
-        attr_accessor :code, :combining_class, :decomp_type, :decomp_mapping, :uppercase_mapping, :lowercase_mapping
-      end
-
       # Holds static data from the Unicode database
       class UnicodeDatabase
         ATTRIBUTES = :codepoints, :composition_exclusion, :composition_map, :boundary, :cp1252
@@ -390,11 +403,3 @@ module Mail
     end
   end
 end
-
-unless defined?(ActiveSupport)
-  module ActiveSupport
-    unless const_defined?(:Multibyte)
-      Multibyte = Mail::Multibyte
-    end
-  end
-end

data/lib/mail/multibyte/utils.rb

@@ -1,4 +1,5 @@
 # encoding: utf-8
+# frozen_string_literal: true
 
 module Mail #:nodoc:
   module Multibyte #:nodoc:

data/lib/mail/multibyte.rb

@@ -1,23 +1,73 @@
 # encoding: utf-8
+# frozen_string_literal: true
+require 'mail/multibyte/chars'
+
 module Mail #:nodoc:
   module Multibyte
-    require 'mail/multibyte/exceptions'
-    require 'mail/multibyte/chars'
-    require 'mail/multibyte/unicode'
+    # Raised when a problem with the encoding was found.
+    class EncodingError < StandardError; end
 
-    # The proxy class returned when calling mb_chars. You can use this accessor to configure your own proxy
-    # class so you can support other encodings. See the Mail::Multibyte::Chars implementation for
-    # an example how to do this.
-    #
-    # Example:
-    #   Mail::Multibyte.proxy_class = CharsForUTF32
-    def self.proxy_class=(klass)
-      @proxy_class = klass
+    class << self
+      # The proxy class returned when calling mb_chars. You can use this accessor to configure your own proxy
+      # class so you can support other encodings. See the Mail::Multibyte::Chars implementation for
+      # an example how to do this.
+      #
+      # Example:
+      #   Mail::Multibyte.proxy_class = CharsForUTF32
+      attr_accessor :proxy_class
     end
 
-    # Returns the current proxy class
-    def self.proxy_class
-      @proxy_class ||= Mail::Multibyte::Chars
+    self.proxy_class = Mail::Multibyte::Chars
+
+    if RUBY_VERSION >= "1.9"
+      # == Multibyte proxy
+      #
+      # +mb_chars+ is a multibyte safe proxy for string methods.
+      #
+      # In Ruby 1.8 and older it creates and returns an instance of the Mail::Multibyte::Chars class which
+      # encapsulates the original string. A Unicode safe version of all the String methods are defined on this proxy
+      # class. If the proxy class doesn't respond to a certain method, it's forwarded to the encapsuled string.
+      #
+      #   name = 'Claus Müller'
+      #   name.reverse # => "rell??M sualC"
+      #   name.length  # => 13
+      #
+      #   name.mb_chars.reverse.to_s # => "rellüM sualC"
+      #   name.mb_chars.length       # => 12
+      #
+      # In Ruby 1.9 and newer +mb_chars+ returns +self+ because String is (mostly) encoding aware. This means that
+      # it becomes easy to run one version of your code on multiple Ruby versions.
+      #
+      # == Method chaining
+      #
+      # All the methods on the Chars proxy which normally return a string will return a Chars object. This allows
+      # method chaining on the result of any of these methods.
+      #
+      #   name.mb_chars.reverse.length # => 12
+      #
+      # == Interoperability and configuration
+      #
+      # The Chars object tries to be as interchangeable with String objects as possible: sorting and comparing between
+      # String and Char work like expected. The bang! methods change the internal string representation in the Chars
+      # object. Interoperability problems can be resolved easily with a +to_s+ call.
+      #
+      # 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)
+          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
@@ -39,4 +89,4 @@ module Mail #:nodoc:
   end
 end
 
-require 'mail/multibyte/utils'
+require 'mail/multibyte/utils'

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

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 module Mail
 
   # A delivery method implementation which sends via exim.
@@ -36,17 +37,13 @@ module Mail
   #
   #   mail.deliver!
   class Exim < Sendmail
-    def initialize(values)
-      self.settings = { :location       => '/usr/sbin/exim',
-                        :arguments      => '-i -t' }.merge(values)
-    end
+    DEFAULTS = {
+      :location   => '/usr/sbin/exim',
+      :arguments  => '-i -t'
+    }
 
-    def self.call(path, arguments, destinations, mail)
-      popen "#{path} #{arguments}" do |io|
-        io.puts mail.encoded.to_lf
-        io.flush
-      end
+    def self.call(path, arguments, destinations, encoded_message)
+      super path, arguments, nil, encoded_message
     end
-
   end
 end

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

@@ -1,7 +1,7 @@
+# frozen_string_literal: true
 require 'mail/check_delivery_params'
 
 module Mail
-  
   # FileDelivery class delivers emails into multiple files based on the destination
   # address.  Each file is appended to if it already exists.
   # 
@@ -13,22 +13,20 @@ module Mail
   # Make sure the path you specify with :location is writable by the Ruby process
   # running Mail.
   class FileDelivery
-    include Mail::CheckDeliveryParams
-
     if RUBY_VERSION >= '1.9.1'
       require 'fileutils'
     else
       require 'ftools'
     end
 
+    attr_accessor :settings
+
     def initialize(values)
       self.settings = { :location => './mails' }.merge!(values)
     end
-    
-    attr_accessor :settings
-    
+
     def deliver!(mail)
-      check_delivery_params(mail)
+      Mail::CheckDeliveryParams.check(mail)
 
       if ::File.respond_to?(:makedirs)
         ::File.makedirs settings[:location]
@@ -40,6 +38,5 @@ module Mail
         ::File.open(::File.join(settings[:location], File.basename(to.to_s)), 'a') { |f| "#{f.write(mail.encoded)}\r\n\r\n" }
       end
     end
-    
   end
 end

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

@@ -0,0 +1,37 @@
+require 'mail/check_delivery_params'
+
+module Mail
+  class LoggerDelivery
+    include Mail::CheckDeliveryParams
+
+    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)
+      Mail::CheckDeliveryParams.check(mail)
+      logger.log(severity) { mail.encoded }
+    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,3 +1,4 @@
+# frozen_string_literal: true
 require 'mail/check_delivery_params'
 
 module Mail
@@ -37,19 +38,21 @@ module Mail
   #
   #   mail.deliver!
   class Sendmail
-    include Mail::CheckDeliveryParams
+    DEFAULTS = {
+      :location   => '/usr/sbin/sendmail',
+      :arguments  => '-i'
+    }
+
+    attr_accessor :settings
 
     def initialize(values)
-      self.settings = { :location       => '/usr/sbin/sendmail',
-                        :arguments      => '-i' }.merge(values)
+      self.settings = self.class::DEFAULTS.merge(values)
     end
 
-    attr_accessor :settings
-
     def deliver!(mail)
-      smtp_from, smtp_to, message = check_delivery_params(mail)
+      smtp_from, smtp_to, message = Mail::CheckDeliveryParams.check(mail)
 
-      from = "-f #{self.class.shellquote(smtp_from)}"
+      from = "-f #{self.class.shellquote(smtp_from)}" if smtp_from
       to = smtp_to.map { |_to| self.class.shellquote(_to) }.join(' ')
 
       arguments = "#{settings[:arguments]} #{from} --"
@@ -58,7 +61,7 @@ module Mail
 
     def self.call(path, arguments, destinations, encoded_message)
       popen "#{path} #{arguments} #{destinations}" do |io|
-        io.puts encoded_message.to_lf
+        io.puts ::Mail::Utilities.binary_unsafe_to_lf(encoded_message)
         io.flush
       end
     end
@@ -74,15 +77,18 @@ module Mail
     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.
+    # 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 = address.gsub(/([^A-Za-z0-9_\s\+\-.,:\/@~])/n, "\\\\\\1").gsub("\n", '')
       %("#{escaped}")
     end
   end

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

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 require 'mail/check_delivery_params'
 
 module Mail
@@ -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,76 @@ 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         => nil,
+      :read_timeout         => nil
+    }
 
     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|
+          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)
+              smtp.enable_starttls(ssl_context)
+            end
+          elsif settings[:enable_starttls_auto]
+            if smtp.respond_to?(:enable_starttls_auto)
+              smtp.enable_starttls_auto(ssl_context)
+            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,3 +1,4 @@
+# frozen_string_literal: true
 require 'mail/check_delivery_params'
 
 module Mail
@@ -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,21 @@ 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)
+      smtp_from, smtp_to, message = Mail::CheckDeliveryParams.check(mail)
+
+      response = smtp.sendmail(dot_stuff(message), smtp_from, smtp_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,3 +1,4 @@
+# frozen_string_literal: true
 require 'mail/check_delivery_params'
 
 module Mail
@@ -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,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 = values.dup
     end
-    
-    attr_accessor :settings
 
     def deliver!(mail)
-      check_delivery_params(mail)
+      Mail::CheckDeliveryParams.check(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
 

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)
       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
@@ -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