mail 2.6.3 → 2.7.0

data/lib/mail/field.rb

@@ -1,4 +1,6 @@
+# frozen_string_literal: true
 require 'mail/fields'
+require 'mail/constants'
 
 # encoding: utf-8
 module Mail
@@ -82,9 +84,31 @@ module Mail
 
       def initialize(element, value, reason)
         @element = element
-        @value = value
-        @reason = reason
-        super("#{element} can not parse |#{value}|\nReason was: #{reason}")
+        @value = to_utf8(value)
+        @reason = to_utf8(reason)
+        super("#{@element} can not parse |#{@value}|: #{@reason}")
+      end
+
+      private
+        def to_utf8(text)
+          if text.respond_to?(:force_encoding)
+            text.dup.force_encoding(Encoding::UTF_8)
+          else
+            text
+          end
+        end
+    end
+
+    class NilParseError < ParseError #:nodoc:
+      def initialize(element)
+        super element, nil, 'nil is invalid'
+      end
+    end
+
+    class IncompleteParseError < ParseError #:nodoc:
+      def initialize(element, original_text, unparsed_index)
+        parsed_text = to_utf8(original_text[0...unparsed_index])
+        super element, original_text, "Only able to parse up to #{parsed_text.inspect}"
       end
     end
 
@@ -92,41 +116,62 @@ module Mail
     class SyntaxError < FieldError #:nodoc:
     end
 
-    # Accepts a string:
-    #
-    #  Field.new("field-name: field data")
-    #
-    # Or name, value pair:
-    #
-    #  Field.new("field-name", "value")
+    class << self
+      # Parse a field from a raw header line:
+      #
+      #  Mail::Field.parse("field-name: field data")
+      #  # => #<Mail::Field …>
+      def parse(field, charset = nil)
+        name, value = split(field)
+        if name && value
+          new name, value, charset
+        end
+      end
+
+      def split(raw_field) #:nodoc:
+        if raw_field.index(Constants::COLON)
+          name, value = raw_field.split(Constants::COLON, 2)
+          name.rstrip!
+          if name =~ /\A#{Constants::FIELD_NAME}\z/
+            [ name.rstrip, value.strip ]
+          else
+            Kernel.warn "WARNING: Ignoring unparsable header #{raw_field.inspect}: invalid header name syntax: #{name.inspect}"
+            nil
+          end
+        else
+          raw_field.strip
+        end
+      rescue => error
+        warn "WARNING: Ignoring unparsable header #{raw_field.inspect}: #{error.class}: #{error.message}"
+        nil
+      end
+    end
+
+    # Create a field by name and optional value:
     #
-    # Or a name by itself:
+    #  Mail::Field.new("field-name", "value")
+    #  # => #<Mail::Field …>
     #
-    #  Field.new("field-name")
+    # Values that aren't strings or arrays are coerced to Strings with `#to_s`.
     #
-    # Note, does not want a terminating carriage return.  Returns
-    # self appropriately parsed.  If value is not a string, then
-    # it will be passed through as is, for example, content-type
-    # field can accept an array with the type and a hash of
-    # parameters:
+    #  Mail::Field.new("field-name", 1234)
+    #  # => #<Mail::Field …>
     #
-    #  Field.new('content-type', ['text', 'plain', {:charset => 'UTF-8'}])
+    #  Mail::Field.new('content-type', ['text', 'plain', {:charset => 'UTF-8'}])
+    #  # => #<Mail::Field …>
     def initialize(name, value = nil, charset = 'utf-8')
       case
-      when name.index(COLON)            # Field.new("field-name: field data")
-        @charset = value.blank? ? charset : value
-        @name = name[FIELD_PREFIX]
-        @raw_value = name
-        @value = nil
-      when value.blank?                 # Field.new("field-name")
+      when name.index(COLON)
+        Kernel.warn 'Passing an unparsed header field to Mail::Field.new is deprecated and will be removed in Mail 2.8.0. Use Mail::Field.parse instead.'
+        @name, @unparsed_value = self.class.split(name)
+        @charset = Utilities.blank?(value) ? charset : value
+      when Utilities.blank?(value)
         @name = name
-        @value = nil
-        @raw_value = nil
+        @unparsed_value = nil
         @charset = charset
-      else                              # Field.new("field-name", "value")
+      else
         @name = name
-        @value = value
-        @raw_value = nil
+        @unparsed_value = value
         @charset = charset
       end
       @name = FIELD_NAME_MAP[@name.to_s.downcase] || @name
@@ -137,8 +182,7 @@ module Mail
     end
 
     def field
-      _, @value = split(@raw_value) if @raw_value && !@value
-      @field ||= create_field(@name, @value, @charset)
+      @field ||= create_field(@name, @unparsed_value, @charset)
     end
 
     def name
@@ -168,15 +212,19 @@ module Mail
     end
 
     def same( other )
+      return false unless other.kind_of?(self.class)
       match_to_s(other.name, self.name)
     end
 
+    def ==( other )
+      return false unless other.kind_of?(self.class)
+      match_to_s(other.name, self.name) && match_to_s(other.value, self.value)
+    end
+
     def responsible_for?( val )
       name.to_s.casecmp(val.to_s) == 0
     end
 
-    alias_method :==, :same
-
     def <=>( other )
       self.field_order_id <=> other.field_order_id
     end
@@ -189,6 +237,16 @@ module Mail
       field.send(name, *args, &block)
     end
 
+    if RUBY_VERSION >= '1.9.2'
+      def respond_to_missing?(method_name, include_private)
+        field.respond_to?(method_name, include_private) || super
+      end
+    else
+      def respond_to?(method_name, include_private = false)
+        field.respond_to?(method_name, include_private) || super
+      end
+    end
+
     FIELD_ORDER = %w[ return-path received
                       resent-date resent-from resent-sender resent-to
                       resent-cc resent-bcc resent-message-id
@@ -202,11 +260,26 @@ module Mail
 
     private
 
-    def split(raw_field)
-      match_data = raw_field.mb_chars.match(FIELD_SPLIT)
-      [match_data[1].to_s.mb_chars.strip, match_data[2].to_s.mb_chars.strip.to_s]
-    rescue
-      STDERR.puts "WARNING: Could not parse (and so ignoring) '#{raw_field}'"
+    def create_field(name, value, charset)
+      new_field(name, value, charset)
+    rescue Mail::Field::ParseError => e
+      field = Mail::UnstructuredField.new(name, value)
+      field.errors << [name, value, e]
+      field
+    end
+
+    def new_field(name, value, charset)
+      value = unfold(value) if value.is_a?(String)
+
+      if klass = field_class_for(name)
+        klass.new(value, charset)
+      else
+        OptionalField.new(name, value, charset)
+      end
+    end
+
+    def field_class_for(name)
+      FIELDS_MAP[name.to_s.downcase]
     end
 
     # 2.2.3. Long Header Fields
@@ -218,30 +291,7 @@ module Mail
     #  treated in its unfolded form for further syntactic and semantic
     #  evaluation.
     def unfold(string)
-      string.gsub(/[\r\n \t]+/m, ' ')
-    end
-
-    def create_field(name, value, charset)
-      value = unfold(value) if value.is_a?(String)
-
-      begin
-        new_field(name, value, charset)
-      rescue Mail::Field::ParseError => e
-        field = Mail::UnstructuredField.new(name, value)
-        field.errors << [name, value, e]
-        field
-      end
-    end
-
-    def new_field(name, value, charset)
-      lower_case_name = name.to_s.downcase
-      if field_klass = FIELDS_MAP[lower_case_name]
-        field_klass.new(value, charset)
-      else
-        OptionalField.new(name, value, charset)
-      end
+      string.gsub(/#{CRLF}(#{WSP})/m, '\1')
     end
-
   end
-
 end

data/lib/mail/field_list.rb

@@ -1,4 +1,5 @@
 # encoding: utf-8
+# frozen_string_literal: true
 module Mail
 
   # Field List class provides an enhanced array that keeps a list of 

data/lib/mail/fields/bcc_field.rb

@@ -1,4 +1,5 @@
 # encoding: utf-8
+# frozen_string_literal: true
 # 
 # = Blind Carbon Copy Field
 # 
@@ -36,16 +37,27 @@ module Mail
     FIELD_NAME = 'bcc'
     CAPITALIZED_FIELD = 'Bcc'
     
-    def initialize(value = '', charset = 'utf-8')
+    def initialize(value = nil, charset = 'utf-8')
       @charset = charset
-      super(CAPITALIZED_FIELD, strip_field(FIELD_NAME, value), charset)
-      self.parse
+      super(CAPITALIZED_FIELD, value, charset)
       self
     end
     
-    # Bcc field should never be :encoded
+    def include_in_headers=(include_in_headers)
+      @include_in_headers = include_in_headers
+    end
+
+    def include_in_headers
+      defined?(@include_in_headers) ? @include_in_headers : self.include_in_headers = false
+    end
+
+    # Bcc field should not be :encoded by default
     def encoded
-      ''
+      if include_in_headers
+        do_encode(CAPITALIZED_FIELD)
+      else
+        ''
+      end
     end
     
     def decoded

data/lib/mail/fields/cc_field.rb

@@ -1,4 +1,5 @@
 # encoding: utf-8
+# frozen_string_literal: true
 # 
 # = Carbon Copy Field
 # 
@@ -38,8 +39,7 @@ module Mail
     
     def initialize(value = nil, charset = 'utf-8')
       self.charset = charset
-      super(CAPITALIZED_FIELD, strip_field(FIELD_NAME, value), charset)
-      self.parse
+      super(CAPITALIZED_FIELD, value, charset)
       self
     end
     

data/lib/mail/fields/comments_field.rb

@@ -1,4 +1,5 @@
 # encoding: utf-8
+# frozen_string_literal: true
 # 
 # = Comments Field
 # 
@@ -32,7 +33,7 @@ module Mail
     
     def initialize(value = nil, charset = 'utf-8')
       @charset = charset
-      super(CAPITALIZED_FIELD, strip_field(FIELD_NAME, value))
+      super(CAPITALIZED_FIELD, value)
       self.parse
       self
     end

data/lib/mail/fields/common/address_container.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 module Mail
   
   class AddressContainer < Array
@@ -7,10 +8,10 @@ module Mail
       super(list)
     end
 
-    def << (address)
+    def <<(address)
       @field << address
     end
 
   end
   
-end
+end

data/lib/mail/fields/common/common_address.rb

@@ -1,25 +1,32 @@
 # encoding: utf-8
+# frozen_string_literal: true
 require 'mail/fields/common/address_container'
 
 module Mail
   module CommonAddress # :nodoc:
-      
     def parse(val = value)
-      unless val.blank?
+      unless Utilities.blank?(val)
         @address_list = AddressList.new(encode_if_needed(val))
       else
         nil
       end
     end
-    
+
     def charset
       @charset
     end
-    
-    def encode_if_needed(val)
-      Encodings.address_encode(val, charset)
+
+    def encode_if_needed(val) #:nodoc:
+      # Need to join arrays of addresses into a single value
+      if val.kind_of?(Array)
+        val.compact.map { |a| encode_if_needed a }.join(', ')
+
+      # Pass through UTF-8; encode non-UTF-8.
+      else
+        utf8_if_needed(val) || Encodings.encode_non_usascii(val, charset)
+      end
     end
-    
+
     # Allows you to iterate through each address object in the address_list
     def each
       address_list.addresses.each do |address|
@@ -84,10 +91,10 @@ module Mail
       case
       when val.nil?
         raise ArgumentError, "Need to pass an address to <<"
-      when val.blank?
+      when Utilities.blank?(val)
         parse(encoded)
       else
-        self.value = [self.value, val].reject {|a| a.blank? }.join(", ")
+        self.value = [self.value, val].reject {|a| Utilities.blank?(a) }.join(", ")
       end
     end
 
@@ -97,24 +104,43 @@ module Mail
     end
   
     private
-  
+
+    if 'string'.respond_to?(:encoding)
+      # Pass through UTF-8 addresses
+      def utf8_if_needed(val)
+        if charset =~ /\AUTF-?8\z/i
+          val
+        elsif val.encoding == Encoding::UTF_8
+          val
+        elsif (utf8 = val.dup.force_encoding(Encoding::UTF_8)).valid_encoding?
+          utf8
+        end
+      end
+    else
+      def utf8_if_needed(val)
+        if charset =~ /\AUTF-?8\z/i
+          val
+        end
+      end
+    end
+
     def do_encode(field_name)
-      return '' if value.blank?
+      return '' if Utilities.blank?(value)
       address_array = address_list.addresses.reject { |a| encoded_group_addresses.include?(a.encoded) }.compact.map { |a| a.encoded }
       address_text  = address_array.join(", \r\n\s")
       group_array = groups.map { |k,v| "#{k}: #{v.map { |a| a.encoded }.join(", \r\n\s")};" }
       group_text  = group_array.join(" \r\n\s")
-      return_array = [address_text, group_text].reject { |a| a.blank? }
+      return_array = [address_text, group_text].reject { |a| Utilities.blank?(a) }
       "#{field_name}: #{return_array.join(", \r\n\s")}\r\n"
     end
 
     def do_decode
-      return nil if value.blank?
+      return nil if Utilities.blank?(value)
       address_array = address_list.addresses.reject { |a| decoded_group_addresses.include?(a.decoded) }.map { |a| a.decoded }
       address_text  = address_array.join(", ")
       group_array = groups.map { |k,v| "#{k}: #{v.map { |a| a.decoded }.join(", ")};" }
       group_text  = group_array.join(" ")
-      return_array = [address_text, group_text].reject { |a| a.blank? }
+      return_array = [address_text, group_text].reject { |a| Utilities.blank?(a) }
       return_array.join(", ")
     end
 

data/lib/mail/fields/common/common_date.rb

@@ -1,4 +1,5 @@
 # encoding: utf-8
+# frozen_string_literal: true
 module Mail
   module CommonDate # :nodoc:
     # Returns a date time object of the parsed date
@@ -11,7 +12,7 @@ module Mail
     end
     
     def parse(val = value)
-      unless val.blank?
+      unless Utilities.blank?(val)
         @element = Mail::DateTimeElement.new(val)
       else
         nil

data/lib/mail/fields/common/common_field.rb

@@ -1,4 +1,5 @@
 # encoding: utf-8
+# frozen_string_literal: true
 module Mail
   module CommonField # :nodoc:
     include Mail::Constants
@@ -13,9 +14,8 @@ module Mail
 
     def value=(value)
       @length = nil
-      @tree = nil
       @element = nil
-      @value = value
+      @value = value.is_a?(Array) ? value : value.to_s
     end
 
     def value
@@ -40,18 +40,12 @@ module Mail
 
     private
 
-    def strip_field(field_name, value)
-      if value.is_a?(Array)
-        value
-      else
-        value.to_s.sub(/#{field_name}:\s+/i, EMPTY)
-      end
-    end
-
     FILENAME_RE = /\b(filename|name)=([^;"\r\n]+\s[^;"\r\n]+)/
     def ensure_filename_quoted(value)
       if value.is_a?(String)
-        value.sub! FILENAME_RE, '\1="\2"'
+        value.sub FILENAME_RE, '\1="\2"'
+      else
+        value
       end
     end
   end

data/lib/mail/fields/common/common_message_id.rb

@@ -1,12 +1,13 @@
 # encoding: utf-8
+# frozen_string_literal: true
 module Mail
   module CommonMessageId # :nodoc:
     def element
-      @element ||= Mail::MessageIdsElement.new(value) unless value.blank?
+      @element ||= Mail::MessageIdsElement.new(value) unless Utilities.blank?(value)
     end
 
     def parse(val = value)
-      unless val.blank?
+      unless Utilities.blank?(val)
         @element = Mail::MessageIdsElement.new(val)
       else
         nil

data/lib/mail/fields/common/parameter_hash.rb

@@ -1,4 +1,5 @@
 # encoding: utf-8
+# frozen_string_literal: true
 module Mail
 
   # ParameterHash is an intelligent Hash that allows you to add
@@ -29,7 +30,7 @@ module Mail
         super(exact || key_name)
       else # Dealing with a multiple value pair or a single encoded value pair
         string = pairs.sort { |a,b| a.first.to_s <=> b.first.to_s }.map { |v| v.last }.join('')
-        if mt = string.match(/([\w\-]+)'(\w\w)'(.*)/)
+        if mt = string.match(/([\w\-]+)?'(\w\w)?'(.*)/)
           string = mt[3]
           encoding = mt[1]
         else

data/lib/mail/fields/content_description_field.rb

@@ -1,4 +1,5 @@
 # encoding: utf-8
+# frozen_string_literal: true
 # 
 # 
 # 
@@ -10,7 +11,7 @@ module Mail
     
     def initialize(value = nil, charset = 'utf-8')
       self.charset = charset
-      super(CAPITALIZED_FIELD, strip_field(FIELD_NAME, value), charset)
+      super(CAPITALIZED_FIELD, value, charset)
       self.parse
       self
     end

data/lib/mail/fields/content_disposition_field.rb

@@ -1,26 +1,27 @@
 # encoding: utf-8
+# frozen_string_literal: true
 require 'mail/fields/common/parameter_hash'
 
 module Mail
   class ContentDispositionField < StructuredField
-    
+
     FIELD_NAME = 'content-disposition'
     CAPITALIZED_FIELD = 'Content-Disposition'
-    
+
     def initialize(value = nil, charset = 'utf-8')
       self.charset = charset
-      ensure_filename_quoted(value)
-      super(CAPITALIZED_FIELD, strip_field(FIELD_NAME, value), charset)
+      value = ensure_filename_quoted(value)
+      super(CAPITALIZED_FIELD, value, charset)
       self.parse
       self
     end
-    
+
     def parse(val = value)
-      unless val.blank?
+      unless Utilities.blank?(val)
         @element = Mail::ContentDispositionElement.new(val)
       end
     end
-    
+
     def element
       @element ||= Mail::ContentDispositionElement.new(value)
     end
@@ -28,20 +29,20 @@ module Mail
     def disposition_type
       element.disposition_type
     end
-    
+
     def parameters
       @parameters = ParameterHash.new
-      element.parameters.each { |p| @parameters.merge!(p) }
+      element.parameters.each { |p| @parameters.merge!(p) } unless element.parameters.nil?
       @parameters
     end
 
     def filename
       case
-      when !parameters['filename'].blank?
+      when parameters['filename']
         @filename = parameters['filename']
-      when !parameters['name'].blank?
+      when parameters['name']
         @filename = parameters['name']
-      else 
+      else
         @filename = nil
       end
       @filename
@@ -56,7 +57,7 @@ module Mail
       end
       "#{CAPITALIZED_FIELD}: #{disposition_type}" + p
     end
-    
+
     def decoded
       if parameters.length > 0
         p = "; #{parameters.decoded}"

data/lib/mail/fields/content_id_field.rb

@@ -1,4 +1,5 @@
 # encoding: utf-8
+# frozen_string_literal: true
 # 
 # 
 # 
@@ -11,18 +12,18 @@ module Mail
     def initialize(value = nil, charset = 'utf-8')
       self.charset = charset
       @uniq = 1
-      if value.blank?
+      if Utilities.blank?(value)
         value = generate_content_id
       else
-        value = strip_field(FIELD_NAME, value)
+        value = value.to_s
       end
-      super(CAPITALIZED_FIELD, strip_field(FIELD_NAME, value), charset)
+      super(CAPITALIZED_FIELD, value, charset)
       self.parse
       self
     end
     
     def parse(val = value)
-      unless val.blank?
+      unless Utilities.blank?(val)
         @element = Mail::MessageIdsElement.new(val)
       end
     end

data/lib/mail/fields/content_location_field.rb

@@ -1,4 +1,5 @@
 # encoding: utf-8
+# frozen_string_literal: true
 # 
 # 
 # 
@@ -10,13 +11,13 @@ module Mail
     
     def initialize(value = nil, charset = 'utf-8')
       self.charset = charset
-      super(CAPITALIZED_FIELD, strip_field(FIELD_NAME, value), charset)
+      super(CAPITALIZED_FIELD, value, charset)
       self.parse
       self
     end
     
     def parse(val = value)
-      unless val.blank?
+      unless Utilities.blank?(val)
         @element = Mail::ContentLocationElement.new(val)
       end
     end

data/lib/mail/fields/content_transfer_encoding_field.rb

@@ -1,4 +1,5 @@
 # encoding: utf-8
+# frozen_string_literal: true
 # 
 # 
 # 
@@ -12,13 +13,13 @@ module Mail
       self.charset = charset
       value = '7bit' if value.to_s =~ /7-?bits?/i
       value = '8bit' if value.to_s =~ /8-?bits?/i
-      super(CAPITALIZED_FIELD, strip_field(FIELD_NAME, value), charset)
+      super(CAPITALIZED_FIELD, value, charset)
       self.parse
       self
     end
     
     def parse(val = value)
-      unless val.blank?
+      unless Utilities.blank?(val)
         @element = Mail::ContentTransferEncodingElement.new(val)
       end
     end