mail 2.7.0.rc1 → 2.7.0.rc2

data/lib/mail/message.rb

@@ -56,15 +56,23 @@ module Mail
     #
     # ===Making an email via a block
     #
-    #  mail = Mail.new do
-    #       from 'mikel@test.lindsaar.net'
-    #         to 'you@test.lindsaar.net'
-    #    subject 'This is a test email'
-    #       body File.read('body.txt')
+    #  mail = Mail.new do |m|
+    #    m.from 'mikel@test.lindsaar.net'
+    #    m.to 'you@test.lindsaar.net'
+    #    m.subject 'This is a test email'
+    #    m.body File.read('body.txt')
     #  end
     #
     #  mail.to_s #=> "From: mikel@test.lindsaar.net\r\nTo: you@...
     #
+    # If may also pass a block with no arguments, in which case it will
+    # be evaluated in the scope of the new message instance:
+    #
+    #  mail = Mail.new do
+    #    from 'mikel@test.lindsaar.net'
+    #    # …
+    #  end
+    #
     # ===Making an email via passing a string
     #
     #  mail = Mail.new("To: mikel@test.lindsaar.net\r\nSubject: Hello\r\n\r\nHi there!")
@@ -129,8 +137,23 @@ module Mail
         init_with_string(args.flatten[0].to_s)
       end
 
+      # Support both builder styles:
+      #
+      #   Mail.new do
+      #     to 'recipient@example.com'
+      #   end
+      #
+      # and
+      #
+      #   Mail.new do |m|
+      #     m.to 'recipient@example.com'
+      #   end
       if block_given?
-        instance_eval(&block)
+        if block.arity.zero? || (RUBY_VERSION < '1.9' && block.arity < 1)
+          instance_eval(&block)
+        else
+          yield self
+        end
       end
 
       self
@@ -213,7 +236,7 @@ module Mail
     self.default_charset = 'UTF-8'
 
     def register_for_delivery_notification(observer)
-      $stderr.puts("Message#register_for_delivery_notification is deprecated, please call Mail.register_observer instead")
+      warn("Message#register_for_delivery_notification is deprecated, please call Mail.register_observer instead")
       Mail.register_observer(observer)
     end
 
@@ -225,7 +248,7 @@ module Mail
       Mail.inform_interceptors(self)
     end
 
-    # Delivers an mail object.
+    # Delivers a mail object.
     #
     # Examples:
     #
@@ -1188,8 +1211,8 @@ module Mail
     def default( sym, val = nil )
       if val
         header[sym] = val
-      else
-        header[sym].default if header[sym]
+      elsif field = header[sym]
+        field.default
       end
     end
 
@@ -1235,14 +1258,13 @@ module Mail
     def body(value = nil)
       if value
         self.body = value
-#        add_encoding_to_body
       else
         process_body_raw if @body_raw
         @body
       end
     end
 
-    def body_encoding(value)
+    def body_encoding(value = nil)
       if value.nil?
         body.encoding
       else
@@ -1251,7 +1273,7 @@ module Mail
     end
 
     def body_encoding=(value)
-        body.encoding = value
+      body.encoding = value
     end
 
     # Returns the list of addresses this message should be sent to by
@@ -1415,7 +1437,7 @@ module Mail
     end
 
     def has_transfer_encoding? # :nodoc:
-      $stderr.puts(":has_transfer_encoding? is deprecated in Mail 1.4.3.  Please use has_content_transfer_encoding?\n#{caller}")
+      warn(":has_transfer_encoding? is deprecated in Mail 1.4.3.  Please use has_content_transfer_encoding?\n#{caller}")
       has_content_transfer_encoding?
     end
 
@@ -1465,32 +1487,24 @@ module Mail
         # has not specified an encoding explicitly.
         if @defaulted_charset && !body.raw_source.ascii_only? && !self.attachment?
           warning = "Non US-ASCII detected and no charset defined.\nDefaulting to UTF-8, set your own if this is incorrect.\n"
-          $stderr.puts(warning)
+          warn(warning)
         end
         header[:content_type].parameters['charset'] = @charset
       end
     end
 
     # Adds a content transfer encoding
-    #
-    # Otherwise raises a warning
     def add_content_transfer_encoding
-      if body.only_us_ascii?
-        header[:content_transfer_encoding] = '7bit'
-      else
-        warning = "Non US-ASCII detected and no content-transfer-encoding defined.\nDefaulting to 8bit, set your own if this is incorrect.\n"
-        $stderr.puts(warning)
-        header[:content_transfer_encoding] = '8bit'
-      end
+      header[:content_transfer_encoding] ||= body.default_encoding
     end
 
     def add_transfer_encoding # :nodoc:
-      $stderr.puts(":add_transfer_encoding is deprecated in Mail 1.4.3.  Please use add_content_transfer_encoding\n#{caller}")
+      warn(":add_transfer_encoding is deprecated in Mail 1.4.3.  Please use add_content_transfer_encoding\n#{caller}")
       add_content_transfer_encoding
     end
 
     def transfer_encoding # :nodoc:
-      $stderr.puts(":transfer_encoding is deprecated in Mail 1.4.3.  Please use content_transfer_encoding\n#{caller}")
+      warn(":transfer_encoding is deprecated in Mail 1.4.3.  Please use content_transfer_encoding\n#{caller}")
       content_transfer_encoding
     end
 
@@ -1500,7 +1514,7 @@ module Mail
     end
 
     def message_content_type
-      $stderr.puts(":message_content_type is deprecated in Mail 1.4.3.  Please use mime_type\n#{caller}")
+      warn(":message_content_type is deprecated in Mail 1.4.3.  Please use mime_type\n#{caller}")
       mime_type
     end
 
@@ -1532,7 +1546,7 @@ module Mail
 
     # Returns the content type parameters
     def mime_parameters
-      $stderr.puts(':mime_parameters is deprecated in Mail 1.4.3, please use :content_type_parameters instead')
+      warn(':mime_parameters is deprecated in Mail 1.4.3, please use :content_type_parameters instead')
       content_type_parameters
     end
 
@@ -1780,9 +1794,6 @@ module Mail
       else
         basename = values[:filename]
         filedata = values
-        unless filedata[:content]
-          filedata = values.merge(:content=>File.open(values[:filename], 'rb') { |f| f.read })
-        end
       end
       self.attachments[basename] = filedata
     end
@@ -1808,7 +1819,7 @@ module Mail
     end
 
     def encode!
-      $stderr.puts("Deprecated in 1.1.0 in favour of :ready_to_send! as it is less confusing with encoding and decoding.")
+      warn("Deprecated in 1.1.0 in favour of :ready_to_send! as it is less confusing with encoding and decoding.")
       ready_to_send!
     end
 
@@ -1824,16 +1835,13 @@ module Mail
     end
 
     def without_attachments!
-      return self unless has_attachments?
-
-      parts.delete_if { |p| p.attachment? }
-      body_raw = if parts.empty?
-                   ''
-                 else
-                   body.encoded
-                 end
+      if has_attachments?
+        parts.delete_if { |p| p.attachment? }
 
-      @body = Mail::Body.new(body_raw)
+        reencoded = parts.empty? ? '' : body.encoded(content_transfer_encoding)
+        @body = nil # So the new parts won't be added to the existing body
+        self.body = reencoded
+      end
 
       self
     end
@@ -1993,7 +2001,7 @@ module Mail
 
     def raw_source=(value)
       value = value.dup.force_encoding(Encoding::BINARY) if RUBY_VERSION >= "1.9.1"
-      @raw_source = ::Mail::Utilities.to_crlf(value)
+      @raw_source = value
     end
 
     # see comments to body=. We take data and process it lazily
@@ -2005,11 +2013,9 @@ module Mail
         @body_raw = nil
         add_encoding_to_body
       when @body && @body.multipart?
-        @body << Mail::Part.new(value)
-        add_encoding_to_body
+        self.text_part = value
       else
         @body_raw = value
-#        process_body_raw
       end
     end
 
@@ -2024,7 +2030,7 @@ module Mail
 
     def set_envelope_header
       raw_string = raw_source.to_s
-      if match_data = raw_source.to_s.match(/\AFrom\s(#{TEXT}+)#{CRLF}/m)
+      if match_data = raw_string.match(/\AFrom\s(#{TEXT}+)#{CRLF}/m)
         set_envelope(match_data[1])
         self.raw_source = raw_string.sub(match_data[0], "")
       end
@@ -2034,6 +2040,13 @@ module Mail
       body.split!(boundary)
     end
 
+    def allowed_encodings
+      case mime_type
+      when 'message/rfc822'
+        [Encodings::SevenBit, Encodings::EightBit, Encodings::Binary]
+      end
+    end
+
     def add_encoding_to_body
       if has_content_transfer_encoding?
         @body.encoding = content_transfer_encoding
@@ -2041,11 +2054,11 @@ module Mail
     end
 
     def identify_and_set_transfer_encoding
-        if body && body.multipart?
-            self.content_transfer_encoding = @transport_encoding
-        else
-            self.content_transfer_encoding = body.get_best_encoding(@transport_encoding)
-        end
+      if body && body.multipart?
+        self.content_transfer_encoding = @transport_encoding
+      else
+        self.content_transfer_encoding = body.negotiate_best_encoding(@transport_encoding, allowed_encodings).to_s
+      end
     end
 
     def add_required_fields

data/lib/mail/multibyte.rb

@@ -1,25 +1,23 @@
 # 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
-    end
+    self.proxy_class = Mail::Multibyte::Chars
 
     if RUBY_VERSION >= "1.9"
       # == Multibyte proxy
@@ -91,4 +89,4 @@ module Mail #:nodoc:
   end
 end
 
-require 'mail/multibyte/utils'
+require 'mail/multibyte/utils'

data/lib/mail/multibyte/chars.rb

@@ -1,5 +1,6 @@
 # encoding: utf-8
 # frozen_string_literal: true
+require 'mail/multibyte/unicode'
 
 module Mail #:nodoc:
   module Multibyte #:nodoc:
@@ -40,7 +41,7 @@ module Mail #:nodoc:
       if RUBY_VERSION >= "1.9"
         # Creates a new Chars instance by wrapping _string_.
         def initialize(string)
-          @wrapped_string = string
+          @wrapped_string = string.dup
           @wrapped_string.force_encoding(Encoding::UTF_8) unless @wrapped_string.frozen?
         end
       else

data/lib/mail/network.rb

@@ -4,6 +4,7 @@ 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/network/delivery_methods/exim.rb

@@ -37,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::Utilities.to_lf(mail.encoded)
-        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/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

@@ -38,17 +38,21 @@ module Mail
   #
   #   mail.deliver!
   class Sendmail
+    DEFAULTS = {
+      :location   => '/usr/sbin/sendmail',
+      :arguments  => '-i'
+    }
+
     attr_accessor :settings
 
     def initialize(values)
-      self.settings = { :location       => '/usr/sbin/sendmail',
-                        :arguments      => '-i' }.merge(values)
+      self.settings = self.class::DEFAULTS.merge(values)
     end
 
     def deliver!(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} --"
@@ -57,7 +61,7 @@ module Mail
 
     def self.call(path, arguments, destinations, encoded_message)
       popen "#{path} #{arguments} #{destinations}" do |io|
-        io.puts ::Mail::Utilities.to_lf(encoded_message)
+        io.puts ::Mail::Utilities.binary_unsafe_to_lf(encoded_message)
         io.flush
       end
     end

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

@@ -76,73 +76,74 @@ module Mail
   class SMTP
     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      => nil,
-                        :enable_starttls_auto => true,
-                        :openssl_verify_mode  => nil,
-                        :ssl                  => nil,
-                        :tls                  => nil,
-                        :open_timeout         => nil,
-                        :read_timeout         => nil
-                      }.merge!(values)
+      self.settings = DEFAULTS.merge(values)
     end
 
-    # 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)
-
-      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]
-        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
-      smtp.open_timeout = settings[:open_timeout] if settings[:open_timeout]
-      smtp.read_timeout = settings[:read_timeout] if settings[:read_timeout]
-
-      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.const_get("VERIFY_#{openssl_verify_mode.upcase}")
+          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 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
+      # 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