mail 2.7.1 → 2.8.0.1

data/lib/mail/header.rb

@@ -1,13 +1,15 @@
 # encoding: utf-8
 # frozen_string_literal: true
+require 'mail/constants'
+require 'mail/utilities'
+
 module Mail
-  
   # Provides access to a header object.
-  # 
+  #
   # ===Per RFC2822
-  # 
+  #
   #  2.2. Header Fields
-  # 
+  #
   #   Header fields are lines composed of a field name, followed by a colon
   #   (":"), followed by a field body, and terminated by CRLF.  A field
   #   name MUST be composed of printable US-ASCII characters (i.e.,
@@ -18,14 +20,12 @@ module Mail
   #   2.2.3.  All field bodies MUST conform to the syntax described in
   #   sections 3 and 4 of this standard.
   class Header
-    include Constants
-    include Utilities
     include Enumerable
-    
+
     @@maximum_amount = 1000
 
     # Large amount of headers in Email might create extra high CPU load
-    # Use this parameter to limit number of headers that will be parsed by 
+    # Use this parameter to limit number of headers that will be parsed by
     # mail library.
     # Default: 1000
     def self.maximum_amount
@@ -36,12 +36,14 @@ module Mail
       @@maximum_amount = value
     end
 
+    attr_reader :raw_source, :charset
+
     # Creates a new header object.
-    # 
+    #
     # Accepts raw text or nothing.  If given raw text will attempt to parse
     # it and split it into the various fields, instantiating each field as
     # it goes.
-    # 
+    #
     # If it finds a field that should be a structured field (such as content
     # type), but it fails to parse it, it will simply make it an unstructured
     # field and leave it alone.  This will mean that the data is preserved but
@@ -50,7 +52,7 @@ module Mail
     # me the example so we can fix it.
     def initialize(header_text = nil, charset = nil)
       @charset = charset
-      self.raw_source = header_text
+      @raw_source = ::Mail::Utilities.to_crlf(header_text).lstrip
       split_header if header_text
     end
 
@@ -59,21 +61,15 @@ module Mail
       @fields = @fields.dup
       @fields.map!(&:dup)
     end
-    
-    # The preserved raw source of the header as you passed it in, untouched
-    # for your Regexing glory.
-    def raw_source
-      @raw_source
-    end
-    
+
     # Returns an array of all the fields in the header in order that they
     # were read in.
     def fields
       @fields ||= FieldList.new
     end
-    
+
     #  3.6. Field definitions
-    #  
+    #
     #   It is important to note that the header fields are not guaranteed to
     #   be in a particular order.  They may appear in any order, and they
     #   have been known to be reordered occasionally when transported over
@@ -83,36 +79,35 @@ module Mail
     #   header fields MUST NOT be reordered, and SHOULD be kept in blocks
     #   prepended to the message.  See sections 3.6.6 and 3.6.7 for more
     #   information.
-    # 
+    #
     # Populates the fields container with Field objects in the order it
     # receives them in.
     #
     # Acceps an array of field string values, for example:
-    # 
+    #
     #  h = Header.new
     #  h.fields = ['From: mikel@me.com', 'To: bob@you.com']
     def fields=(unfolded_fields)
       @fields = Mail::FieldList.new
-      Kernel.warn "WARNING: More than #{self.class.maximum_amount} header fields; only using the first #{self.class.maximum_amount} and ignoring the rest" if unfolded_fields.length > self.class.maximum_amount
-      unfolded_fields[0..(self.class.maximum_amount-1)].each do |field|
 
+      if unfolded_fields.size > self.class.maximum_amount
+        Kernel.warn "WARNING: More than #{self.class.maximum_amount} header fields; only using the first #{self.class.maximum_amount} and ignoring the rest"
+        unfolded_fields = unfolded_fields.slice(0...self.class.maximum_amount)
+      end
+
+      unfolded_fields.each do |field|
         if field = Field.parse(field, charset)
-          if limited_field?(field.name) && (selected = select_field_for(field.name)) && selected.any?
-            selected.first.update(field.name, field.value)
-          else
-            @fields << field
-          end
+          @fields.add_field field
         end
       end
-
     end
-    
+
     def errors
       @fields.map(&:errors).flatten(1)
     end
-    
+
     #  3.6. Field definitions
-    #  
+    #
     #   The following table indicates limits on the number of times each
     #   field may occur in a message header as well as any special
     #   limitations on the use of those fields.  An asterisk next to a value
@@ -122,35 +117,25 @@ module Mail
     #   <snip table from 3.6>
     #
     # As per RFC, many fields can appear more than once, we will return a string
-    # of the value if there is only one header, or if there is more than one 
+    # of the value if there is only one header, or if there is more than one
     # matching header, will return an array of values in order that they appear
     # in the header ordered from top to bottom.
-    # 
+    #
     # Example:
-    # 
+    #
     #  h = Header.new
     #  h.fields = ['To: mikel@me.com', 'X-Mail-SPAM: 15', 'X-Mail-SPAM: 20']
     #  h['To']          #=> 'mikel@me.com'
     #  h['X-Mail-SPAM'] #=> ['15', '20']
     def [](name)
-      name = dasherize(name)
-      name.downcase!
-      selected = select_field_for(name)
-      case
-      when selected.length > 1
-        selected.map { |f| f }
-      when !Utilities.blank?(selected)
-        selected.first
-      else
-        nil
-      end
+      fields.get_field(Utilities.dasherize(name))
     end
-    
+
     # Sets the FIRST matching field in the header to passed value, or deletes
     # the FIRST field matched from the header if passed nil
-    # 
+    #
     # Example:
-    # 
+    #
     #  h = Header.new
     #  h.fields = ['To: mikel@me.com', 'X-Mail-SPAM: 15', 'X-Mail-SPAM: 20']
     #  h['To'] = 'bob@you.com'
@@ -160,51 +145,39 @@ module Mail
     #  h['X-Mail-SPAM'] = nil
     #  h['X-Mail-SPAM'] # => nil
     def []=(name, value)
-      name = dasherize(name)
-      if name.include?(':')
+      name = name.to_s
+      if name.include?(Constants::COLON)
         raise ArgumentError, "Header names may not contain a colon: #{name.inspect}"
       end
-      fn = name.downcase
-      selected = select_field_for(fn)
-      
-      case
-      # User wants to delete the field
-      when !Utilities.blank?(selected) && value == nil
-        fields.delete_if { |f| selected.include?(f) }
-        
-      # User wants to change the field
-      when !Utilities.blank?(selected) && limited_field?(fn)
-        selected.first.update(fn, value)
-        
-      # User wants to create the field
+
+      name = Utilities.dasherize(name)
+
+      # Assign nil to delete the field
+      if value.nil?
+        fields.delete_field name
       else
-        # Need to insert in correct order for trace fields
-        self.fields << Field.new(name.to_s, value, charset)
-      end
-      if dasherize(fn) == "content-type"
+        fields.add_field Field.new(name.to_s, value, charset)
+
         # Update charset if specified in Content-Type
-        params = self[:content_type].parameters rescue nil
-        @charset = params[:charset] if params && params[:charset]
+        if name == 'content-type'
+          params = self[:content_type].parameters rescue nil
+          @charset = params[:charset] if params && params[:charset]
+        end
       end
     end
-    
-    def charset
-      @charset
-    end
-    
+
     def charset=(val)
       params = self[:content_type].parameters rescue nil
       if params
-        params[:charset] = val
+        if val
+          params[:charset] = val
+        else
+          params.delete(:charset)
+        end
       end
       @charset = val
     end
-    
-    LIMITED_FIELDS   = %w[ date from sender reply-to to cc bcc 
-                           message-id in-reply-to references subject
-                           return-path content-type mime-version
-                           content-transfer-encoding content-description 
-                           content-id content-disposition content-location]
+
 
     def encoded
       buffer = String.new
@@ -218,61 +191,47 @@ module Mail
     def to_s
       encoded
     end
-    
+
     def decoded
-      raise NoMethodError, 'Can not decode an entire header as there could be character set conflicts, try calling #decoded on the various fields.'
+      raise NoMethodError, 'Can not decode an entire header as there could be character set conflicts. Try calling #decoded on the various fields.'
     end
 
     def field_summary
-      fields.map { |f| "<#{f.name}: #{f.value}>" }.join(", ")
+      fields.summary
     end
 
     # Returns true if the header has a Message-ID defined (empty or not)
     def has_message_id?
-      !fields.select { |f| f.responsible_for?('Message-ID') }.empty?
+      fields.has_field? 'Message-ID'
     end
 
     # Returns true if the header has a Content-ID defined (empty or not)
     def has_content_id?
-      !fields.select { |f| f.responsible_for?('Content-ID') }.empty?
+      fields.has_field? 'Content-ID'
     end
 
     # Returns true if the header has a Date defined (empty or not)
     def has_date?
-      !fields.select { |f| f.responsible_for?('Date') }.empty?
+      fields.has_field? 'Date'
     end
 
     # Returns true if the header has a MIME version defined (empty or not)
     def has_mime_version?
-      !fields.select { |f| f.responsible_for?('Mime-Version') }.empty?
+      fields.has_field? 'Mime-Version'
     end
 
     private
-    
-    def raw_source=(val)
-      @raw_source = ::Mail::Utilities.to_crlf(val).lstrip
-    end
-    
+
     # Splits an unfolded and line break cleaned header into individual field
     # strings.
     def split_header
-      self.fields = raw_source.split(HEADER_SPLIT)
-    end
-    
-    def select_field_for(name)
-      fields.select { |f| f.responsible_for?(name) }
-    end
-    
-    def limited_field?(name)
-      LIMITED_FIELDS.include?(name.to_s.downcase)
+      self.fields = @raw_source.split(Constants::HEADER_SPLIT)
     end
 
-    # Enumerable support; yield each field in order to the block if there is one,
-    # or return an Enumerator for them if there isn't.
-    def each( &block )
-      return self.fields.each( &block ) if block
-      self.fields.each
-    end
 
+    # Enumerable support. Yield each field in order.
+    def each(&block)
+      fields.each(&block)
+    end
   end
 end

data/lib/mail/matchers/attachment_matchers.rb

@@ -9,6 +9,10 @@ module Mail
       AttachmentFilenameMatcher.new(filename)
     end
 
+    def an_attachment_with_mime_type(filename)
+      AttachmentMimeTypeMatcher.new(filename)
+    end
+
     class AnyAttachmentMatcher
       def ===(other)
         other.attachment?
@@ -25,5 +29,16 @@ module Mail
         other.attachment? && other.filename == filename
       end
     end
+
+    class AttachmentMimeTypeMatcher
+      attr_reader :mime_type
+      def initialize(mime_type)
+        @mime_type = mime_type
+      end
+
+      def ===(other)
+        other.attachment? && other.mime_type == mime_type
+      end
+    end
   end
 end

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,10 +48,6 @@ 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.
@@ -149,7 +147,7 @@ module Mail
       #     m.to 'recipient@example.com'
       #   end
       if block_given?
-        if block.arity.zero? || (RUBY_VERSION < '1.9' && block.arity < 1)
+        if block.arity.zero?
           instance_eval(&block)
         else
           yield self
@@ -235,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)
-      warn("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
@@ -301,7 +294,7 @@ module Mail
           reply.references ||= bracketed_message_id
         end
         if subject
-          reply.subject = subject =~ /^Re:/i ? subject : "RE: #{subject}"
+          reply.subject = subject =~ /^Re:/i ? subject : "Re: #{subject}"
         end
         if reply_to || from
           reply.to = self[reply_to ? :reply_to : :from].to_s
@@ -406,9 +399,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
@@ -1339,7 +1332,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
@@ -1385,7 +1378,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]
@@ -1436,11 +1429,6 @@ module Mail
       header[:content_transfer_encoding] && Utilities.blank?(header[:content_transfer_encoding].errors)
     end
 
-    def has_transfer_encoding? # :nodoc:
-      warn(":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
@@ -1489,7 +1477,9 @@ module Mail
           warning = "Non US-ASCII detected and no charset defined.\nDefaulting to UTF-8, set your own if this is incorrect.\n"
           warn(warning)
         end
-        header[:content_type].parameters['charset'] = @charset
+        if @charset
+          header[:content_type].parameters['charset'] = @charset
+        end
       end
     end
 
@@ -1498,30 +1488,15 @@ module Mail
       header[:content_transfer_encoding] ||= body.default_encoding
     end
 
-    def add_transfer_encoding # :nodoc:
-      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:
-      warn(":transfer_encoding is deprecated in Mail 1.4.3.  Please use content_transfer_encoding\n#{caller}")
-      content_transfer_encoding
-    end
-
     # Returns the MIME media type of part we are on, this is taken from the content-type header
     def mime_type
       has_content_type? ? header[:content_type].string : nil rescue nil
     end
 
-    def message_content_type
-      warn(":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
@@ -1544,12 +1519,6 @@ module Mail
       has_content_type? ? header[:content_type].sub_type : nil rescue nil
     end
 
-    # Returns the content type parameters
-    def mime_parameters
-      warn(':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
@@ -1798,12 +1767,22 @@ module Mail
       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(: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
 
@@ -1818,11 +1797,6 @@ module Mail
       add_required_fields
     end
 
-    def encode!
-      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
-
     # 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.
@@ -1836,7 +1810,7 @@ module Mail
 
     def without_attachments!
       if has_attachments?
-        parts.delete_if { |p| p.attachment? }
+        parts.delete_attachments
 
         reencoded = parts.empty? ? '' : body.encoded(content_transfer_encoding)
         @body = nil # So the new parts won't be added to the existing body
@@ -1867,7 +1841,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|
@@ -1900,6 +1874,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?
@@ -1984,7 +1967,7 @@ module Mail
 
   private
 
-    HEADER_SEPARATOR = /#{Constants::CRLF}#{Constants::CRLF}/
+    HEADER_SEPARATOR = /#{Constants::LAX_CRLF}#{Constants::LAX_CRLF}/
 
     #  2.1. General Description
     #   A message consists of header fields (collectively called "the header
@@ -2029,7 +2012,7 @@ module Mail
 
     def set_envelope_header
       raw_string = raw_source.to_s
-      if match_data = raw_string.match(/\AFrom\s(#{TEXT}+)#{Constants::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
@@ -2053,10 +2036,12 @@ 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.negotiate_best_encoding(@transport_encoding, allowed_encodings).to_s
+      if body
+        if 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
     end
 
@@ -2076,15 +2061,17 @@ 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
 
     def add_boundary
       unless body.boundary && boundary
-        header['content-type'] = 'multipart/mixed' unless header['content-type']
+        unless header['content-type']
+          _charset = charset
+          header['content-type'] = 'multipart/mixed'
+          header['content-type'].parameters[:charset] = _charset
+        end
         header['content-type'].parameters[:boundary] = ContentTypeField.generate_boundary
-        header['content_type'].parameters[:charset] = @charset
         body.boundary = boundary
       end
     end
@@ -2092,7 +2079,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
@@ -2109,7 +2095,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