mail 2.6.4 → 2.9.0

data/lib/mail/message.rb

@@ -1,6 +1,8 @@
 # encoding: utf-8
 # frozen_string_literal: true
-require "yaml"
+require 'mail/constants'
+require 'mail/utilities'
+require 'mail/yaml'
 
 module Mail
   # The Message class provides a single point of access to all things to do with an
@@ -46,25 +48,29 @@ module Mail
   #   follows the header and is separated from the header by an empty line
   #   (i.e., a line with nothing preceding the CRLF).
   class Message
-
-    include Constants
-    include Utilities
-
     # ==Making an email
     #
     # You can make an new mail object via a block, passing a string, file or direct assignment.
     #
     # ===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 +135,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?
+          instance_eval(&block)
+        else
+          yield self
+        end
       end
 
       self
@@ -212,11 +233,6 @@ module Mail
     def self.default_charset=(charset); @@default_charset = charset; end
     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")
-      Mail.register_observer(observer)
-    end
-
     def inform_observers
       Mail.inform_observers(self)
     end
@@ -225,7 +241,7 @@ module Mail
       Mail.inform_interceptors(self)
     end
 
-    # Delivers an mail object.
+    # Delivers a mail object.
     #
     # Examples:
     #
@@ -278,7 +294,7 @@ module Mail
           reply.references ||= bracketed_message_id
         end
         if subject
-          reply.subject = subject =~ /^Re:/i ? subject : "RE: #{subject}"
+          reply.subject = /^Re:/i.match?(subject) ? subject : "Re: #{subject}"
         end
         if reply_to || from
           reply.to = self[reply_to ? :reply_to : :from].to_s
@@ -333,6 +349,10 @@ module Mail
     # the same content, ignoring the Message-ID field, unless BOTH emails have a defined and
     # different Message-ID value, then they are false.
     #
+    # Note that Mail creates Date and Mime-Type fields if they don't exist.
+    # The Date field is derived from the current time, so this needs to be allowed for in comparisons.
+    # (Mime-type does not depend on dynamic data, so cannot affect equality)
+    #
     # So, in practice the == operator works like this:
     #
     #  m1 = Mail.new("Subject: Hello\r\n\r\nHello")
@@ -354,19 +374,17 @@ module Mail
     #  m1 = Mail.new("Message-ID: <1234@test>\r\nSubject: Hello\r\n\r\nHello")
     #  m2 = Mail.new("Message-ID: <DIFFERENT@test>\r\nSubject: Hello\r\n\r\nHello")
     #  m1 == m2 #=> false
-    def ==(other)
+    def ==(other) # TODO could be more efficient
       return false unless other.respond_to?(:encoded)
 
+      stamp = Mail::CommonDateField.normalize_datetime('')
+      # Note: must always dup the inputs so they are not altered by encoded
       if self.message_id && other.message_id
-        self.encoded == other.encoded
+        dup.tap { |m| m.date ||= stamp }.encoded ==
+          other.dup.tap { |m| m.date ||= stamp }.encoded
       else
-        self_message_id, other_message_id = self.message_id, other.message_id
-        begin
-          self.message_id, other.message_id = '<temp@test>', '<temp@test>'
-          self.encoded == other.encoded
-        ensure
-          self.message_id, other.message_id = self_message_id, other_message_id
-        end
+        dup.tap { |m| m.message_id = '<temp@test>'; m.date ||= stamp }.encoded ==
+          other.dup.tap { |m| m.message_id = '<temp@test>'; m.date ||= stamp }.encoded
       end
     end
 
@@ -388,9 +406,9 @@ module Mail
     end
 
     # Sets the envelope from for the email
-    def set_envelope( val )
+    def set_envelope(val)
       @raw_envelope = val
-      @envelope = Mail::Envelope.new( val )
+      @envelope = Mail::Envelope.parse(val) rescue nil
     end
 
     # The raw_envelope is the From mikel@test.lindsaar.net Mon May  2 16:07:05 2009
@@ -453,7 +471,7 @@ module Mail
     #  message.errors.size #=> 1
     #  message.errors.first[0] #=> "Content-Transfer-Encoding"
     #  message.errors.first[1] #=> "weirdo"
-    #  message.errors.first[3] #=> <The original error message exception>
+    #  message.errors.first[2] #=> <The original error message exception>
     #
     # This is a good first defence on detecting spam by the way.  Some spammers send
     # invalid emails to try and get email parsers to give up parsing them.
@@ -1193,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
 
@@ -1240,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
@@ -1256,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
@@ -1306,7 +1323,7 @@ module Mail
     def []=(name, value)
       if name.to_s == 'body'
         self.body = value
-      elsif name.to_s =~ /content[-_]type/i
+      elsif /content[-_]type/i.match?(name.to_s)
         header[name] = value
       elsif name.to_s == 'charset'
         self.charset = value
@@ -1322,7 +1339,7 @@ module Mail
     #  mail['foo'] = '1234'
     #  mail['foo'].to_s #=> '1234'
     def [](name)
-      header[underscoreize(name)]
+      header[Utilities.underscoreize(name)]
     end
 
     # Method Missing in this implementation allows you to set any of the
@@ -1368,7 +1385,7 @@ module Mail
       #:nodoc:
       # Only take the structured fields, as we could take _anything_ really
       # as it could become an optional field... "but therin lies the dark side"
-      field_name = underscoreize(name).chomp("=")
+      field_name = Utilities.underscoreize(name).chomp("=")
       if Mail::Field::KNOWN_FIELDS.include?(field_name)
         if args.empty?
           header[field_name]
@@ -1399,7 +1416,7 @@ module Mail
       header.has_date?
     end
 
-    # Returns true if the message has a Mime-Version field, the field may or may
+    # Returns true if the message has a MIME-Version field, the field may or may
     # not have a value, but the field exists or not.
     def has_mime_version?
       header.has_mime_version?
@@ -1419,11 +1436,6 @@ module Mail
       header[:content_transfer_encoding] && Utilities.blank?(header[:content_transfer_encoding].errors)
     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}")
-      has_content_transfer_encoding?
-    end
-
     # Creates a new empty Message-ID field and inserts it in the correct order
     # into the Header.  The MessageIdField object will automatically generate
     # a unique message ID if you try and encode it or output it to_s without
@@ -1468,35 +1480,19 @@ module Mail
       if !body.empty?
         # Only give a warning if this isn't an attachment, has non US-ASCII and the user
         # has not specified an encoding explicitly.
-        if @defaulted_charset && body.raw_source.not_ascii_only? && !self.attachment?
+        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
+        if @charset
+          header[:content_type].parameters['charset'] = @charset
         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
-    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}")
-      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}")
-      content_transfer_encoding
+      header[:content_transfer_encoding] ||= body.default_encoding
     end
 
     # Returns the MIME media type of part we are on, this is taken from the content-type header
@@ -1504,15 +1500,10 @@ module Mail
       has_content_type? ? header[:content_type].string : nil rescue nil
     end
 
-    def message_content_type
-      STDERR.puts(":message_content_type is deprecated in Mail 1.4.3.  Please use mime_type\n#{caller}")
-      mime_type
-    end
-
     # Returns the character set defined in the content type field
     def charset
       if @header
-        has_content_type? ? content_type_parameters['charset'] : @charset
+        has_content_type? && !multipart? ? content_type_parameters['charset'] : @charset
       else
         @charset
       end
@@ -1535,12 +1526,6 @@ module Mail
       has_content_type? ? header[:content_type].sub_type : nil rescue nil
     end
 
-    # 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')
-      content_type_parameters
-    end
-
     # Returns the content type parameters
     def content_type_parameters
       has_content_type? ? header[:content_type].parameters : nil rescue nil
@@ -1548,22 +1533,29 @@ module Mail
 
     # Returns true if the message is multipart
     def multipart?
-      has_content_type? ? !!(main_type =~ /^multipart$/i) : false
+      has_content_type? ? /^multipart$/i.match?(main_type) : false
     end
 
     # Returns true if the message is a multipart/report
     def multipart_report?
-      multipart? && sub_type =~ /^report$/i
+      multipart? && /^report$/i.match?(sub_type)
     end
 
     # Returns true if the message is a multipart/report; report-type=delivery-status;
     def delivery_status_report?
-      multipart_report? && content_type_parameters['report-type'] =~ /^delivery-status$/i
+      multipart_report? && /^delivery-status$/i.match?(content_type_parameters['report-type'])
     end
 
     # returns the part in a multipart/report email that has the content-type delivery-status
     def delivery_status_part
-      @delivery_stats_part ||= parts.select { |p| p.delivery_status_report_part? }.first
+      unless defined? @delivery_status_part
+        @delivery_status_part =
+          if delivery_status_report?
+            parts.detect(&:delivery_status_report_part?)
+          end
+      end
+
+      @delivery_status_part
     end
 
     def bounced?
@@ -1778,19 +1770,26 @@ 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
 
+    MULTIPART_CONVERSION_CONTENT_FIELDS = [ :content_description, :content_disposition, :content_transfer_encoding, :content_type ]
+    private_constant :MULTIPART_CONVERSION_CONTENT_FIELDS if respond_to?(:private_constant)
+
     def convert_to_multipart
-      text = body.decoded
-      self.body = ''
-      text_part = Mail::Part.new({:content_type => 'text/plain;',
-                                  :body => text})
+      text_part = Mail::Part.new(:content_type => 'text/plain;', :body => body.decoded)
+
+      MULTIPART_CONVERSION_CONTENT_FIELDS.each do |field_name|
+        if value = send(field_name)
+          writer = :"#{field_name}="
+          text_part.send writer, value
+          send writer, nil
+        end
+      end
       text_part.charset = charset unless @defaulted_charset
+
+      self.body = ''
       self.body << text_part
     end
 
@@ -1798,7 +1797,6 @@ module Mail
     # ready to send
     def ready_to_send!
       identify_and_set_transfer_encoding
-      parts.sort!([ "text/plain", "text/enriched", "text/html", "multipart/alternative" ])
       parts.each do |part|
         part.transport_encoding = transport_encoding
         part.ready_to_send!
@@ -1806,11 +1804,6 @@ module Mail
       add_required_fields
     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.")
-      ready_to_send!
-    end
-
     # Outputs an encoded string representation of the mail message including
     # all headers, attachments, etc.  This is an encoded email in US-ASCII,
     # so it is able to be directly sent to an email server.
@@ -1823,16 +1816,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_attachments
 
-      @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
@@ -1858,7 +1848,7 @@ module Mail
     end
 
     def self.from_yaml(str)
-      hash = YAML.load(str)
+      hash = Mail::YAML.load(str)
       m = self.new(:headers => hash['headers'])
       hash.delete('headers')
       hash.each do |k,v|
@@ -1872,7 +1862,7 @@ module Mail
           m.transport_encoding(v)
         when k == 'multipart_body'
           v.map {|part| m.add_part Mail::Part.from_yaml(part) }
-        when k =~ /^@/
+        when k.start_with?('@')
           m.instance_variable_set(k.to_sym, v)
         end
       end
@@ -1891,6 +1881,15 @@ module Mail
       "#<#{self.class}:#{self.object_id}, Multipart: #{multipart?}, Headers: #{header.field_summary}>"
     end
 
+    def inspect_structure
+      inspect +
+      if self.multipart?
+        "\n" + parts.inspect_structure
+      else
+        ''
+      end
+    end
+
     def decoded
       case
       when self.text?
@@ -1900,7 +1899,7 @@ module Mail
       when !self.multipart?
         body.decoded
       else
-        raise NoMethodError, 'Can not decode an entire message, try calling #decoded on the various fields and body or parts if it is a multipart message.'
+        raise NoMethodError, 'This message cannot be decoded as _entire_ message, try calling #decoded on the various fields and body or parts if it is a multipart message.'
       end
     end
 
@@ -1970,12 +1969,12 @@ module Mail
     end
 
     def text?
-      has_content_type? ? !!(main_type =~ /^text$/i) : false
+      has_content_type? ? /^text$/i.match?(main_type) : false
     end
 
   private
 
-    HEADER_SEPARATOR = /#{CRLF}#{CRLF}|#{CRLF}#{WSP}*#{CRLF}(?!#{WSP})/m
+    HEADER_SEPARATOR = /#{Constants::LAX_CRLF}#{Constants::LAX_CRLF}/
 
     #  2.1. General Description
     #   A message consists of header fields (collectively called "the header
@@ -1984,9 +1983,6 @@ module Mail
     #   this standard. The body is simply a sequence of characters that
     #   follows the header and is separated from the header by an empty line
     #   (i.e., a line with nothing preceding the CRLF).
-    #
-    # Additionally, I allow for the case where someone might have put whitespace
-    # on the "gap line"
     def parse_message
       header_part, body_part = raw_source.lstrip.split(HEADER_SEPARATOR, 2)
       self.header = header_part
@@ -1994,8 +1990,7 @@ module Mail
     end
 
     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
@@ -2007,11 +2002,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
 
@@ -2026,7 +2019,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+([^:\s]#{Constants::TEXT}*)#{Constants::LAX_CRLF}/m)
         set_envelope(match_data[1])
         self.raw_source = raw_string.sub(match_data[0], "")
       end
@@ -2036,6 +2029,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
@@ -2043,11 +2043,13 @@ module Mail
     end
 
     def identify_and_set_transfer_encoding
-        if body && body.multipart?
-            self.content_transfer_encoding = @transport_encoding
+      if body
+        if body.multipart?
+          self.content_transfer_encoding = @transport_encoding
         else
-            self.content_transfer_encoding = body.get_best_encoding(@transport_encoding)
+          self.content_transfer_encoding = body.negotiate_best_encoding(@transport_encoding, allowed_encodings).to_s
         end
+      end
     end
 
     def add_required_fields
@@ -2066,7 +2068,6 @@ module Mail
 
     def add_multipart_alternate_header
       header['content-type'] = ContentTypeField.with_boundary('multipart/alternative').value
-      header['content_type'].parameters[:charset] = @charset
       body.boundary = boundary
     end
 
@@ -2074,7 +2075,6 @@ module Mail
       unless body.boundary && boundary
         header['content-type'] = 'multipart/mixed' unless header['content-type']
         header['content-type'].parameters[:boundary] = ContentTypeField.generate_boundary
-        header['content_type'].parameters[:charset] = @charset
         body.boundary = boundary
       end
     end
@@ -2082,7 +2082,6 @@ module Mail
     def add_multipart_mixed_header
       unless header['content-type']
         header['content-type'] = ContentTypeField.with_boundary('multipart/mixed').value
-        header['content_type'].parameters[:charset] = @charset
         body.boundary = boundary
       end
     end
@@ -2099,7 +2098,7 @@ module Mail
       body_content = nil
 
       passed_in_options.each_pair do |k,v|
-        k = underscoreize(k).to_sym if k.class == String
+        k = Utilities.underscoreize(k).to_sym if k.class == String
         if k == :headers
           self.headers(v)
         elsif k == :body
@@ -2130,10 +2129,10 @@ module Mail
       content_disp_name = header[:content_disposition].filename rescue nil
       content_loc_name  = header[:content_location].location rescue nil
       case
-      when content_type && content_type_name
-        filename = content_type_name
       when content_disposition && content_disp_name
         filename = content_disp_name
+      when content_type && content_type_name
+        filename = content_type_name
       when content_location && content_loc_name
         filename = content_loc_name
       else