mail 2.5.5 → 2.8.1

data/lib/mail/field.rb

@@ -1,4 +1,6 @@
+# frozen_string_literal: true
 require 'mail/fields'
+require 'mail/constants'
 
 # encoding: utf-8
 module Mail
@@ -21,8 +23,6 @@ module Mail
   #     sections 3 and 4 of this standard.
   #
   class Field
-
-    include Patterns
     include Comparable
 
     STRUCTURED_FIELDS = %w[ bcc cc content-description content-disposition
@@ -67,6 +67,10 @@ module Mail
       "content-location" => ContentLocationField,
     }
 
+    FIELD_NAME_MAP = FIELDS_MAP.inject({}) do |map, (field, field_klass)|
+      map.update(field => field_klass::NAME)
+    end
+
     # Generic Field Exception
     class FieldError < StandardError
     end
@@ -78,9 +82,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
 
@@ -88,49 +114,81 @@ 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 = 'utf-8')
+        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
+
+      def field_class_for(name) #:nodoc:
+        FIELDS_MAP[name.to_s.downcase]
+      end
+    end
+
+    attr_reader :unparsed_value
+
+    # 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 =~ /:/                  # Field.new("field-name: field data")
-        charset = value unless value.blank?
-        name, value = split(name)
-        create_field(name, value, charset)
-      when name !~ /:/ && value.blank?  # Field.new("field-name")
-        create_field(name, nil, charset)
-      else                              # Field.new("field-name", "value")
-        create_field(name, value, charset)
+      when name.index(Constants::COLON)
+        raise ArgumentError, 'Passing an unparsed header field to Mail::Field.new is not supported in Mail 2.8.0+. Use Mail::Field.parse instead.'
+      when Utilities.blank?(value)
+        @name = name
+        @unparsed_value = nil
+        @charset = charset
+      else
+        @name = name
+        @unparsed_value = value
+        @charset = charset
       end
-      return self
+      @name = FIELD_NAME_MAP[@name.to_s.downcase] || @name
     end
 
-    def field=(value)
-      @field = value
+    def field=(field)
+      @field = field
     end
 
     def field
-      @field
+      @field ||= create_field(@name, @unparsed_value, @charset)
     end
 
     def name
-      field.name
+      @name
     end
 
     def value
@@ -138,74 +196,88 @@ module Mail
     end
 
     def value=(val)
-      create_field(name, val, charset)
+      @field = create_field(name, val, @charset)
     end
 
     def to_s
       field.to_s
     end
 
-    def update(name, value)
-      create_field(name, value, charset)
+    def inspect
+      "#<#{self.class.name} 0x#{(object_id * 2).to_s(16)} #{instance_variables.map do |ivar|
+        "#{ivar}=#{instance_variable_get(ivar).inspect}"
+      end.join(" ")}>"
+    end
+
+    def same(other)
+      other.kind_of?(self.class) && Utilities.match_to_s(other.name, name)
     end
 
-    def same( other )
-      match_to_s(other.name, field.name)
+    def ==(other)
+      same(other) && Utilities.match_to_s(other.value, value)
     end
 
-    alias_method :==, :same
+    def responsible_for?(field_name)
+      name.to_s.casecmp(field_name.to_s) == 0
+    end
 
-    def <=>( other )
-      self.field_order_id <=> other.field_order_id
+    def <=>(other)
+      field_order_id <=> other.field_order_id
     end
 
     def field_order_id
-      @field_order_id ||= (FIELD_ORDER_LOOKUP[self.name.to_s.downcase] || 100)
+      @field_order_id ||= FIELD_ORDER_LOOKUP.fetch(self.name.to_s.downcase, 100)
     end
 
     def method_missing(name, *args, &block)
       field.send(name, *args, &block)
     end
 
-    FIELD_ORDER = %w[ return-path received
-                      resent-date resent-from resent-sender resent-to
-                      resent-cc resent-bcc resent-message-id
-                      date from sender reply-to to cc bcc
-                      message-id in-reply-to references
-                      subject comments keywords
-                      mime-version content-type content-transfer-encoding
-                      content-location content-disposition content-description ]
+    def respond_to_missing?(method_name, include_private)
+      field.respond_to?(method_name, include_private) || super
+    end
 
-    FIELD_ORDER_LOOKUP = Hash[FIELD_ORDER.each_with_index.to_a]
+    FIELD_ORDER_LOOKUP = Hash[%w[
+      return-path received
+      resent-date resent-from resent-sender resent-to
+      resent-cc resent-bcc resent-message-id
+      date from sender reply-to to cc bcc
+      message-id in-reply-to references
+      subject comments keywords
+      mime-version content-type content-transfer-encoding
+      content-location content-disposition content-description
+    ].each_with_index.to_a]
 
     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]
-    rescue
-      STDERR.puts "WARNING: Could not parse (and so ignoring) '#{raw_field}'"
-    end
-
     def create_field(name, value, charset)
-      begin
-        self.field = new_field(name, value, charset)
-      rescue Mail::Field::ParseError => e
-        self.field = Mail::UnstructuredField.new(name, value)
-        self.field.errors << [name, value, e]
-        self.field
-      end
+      parse_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)
-      lower_case_name = name.to_s.downcase
-      if field_klass = FIELDS_MAP[lower_case_name]
-        field_klass.new(value, charset)
+    def parse_field(name, value, charset)
+      value = unfold(value) if value.is_a?(String)
+
+      if klass = self.class.field_class_for(name)
+        klass.parse(value, charset)
       else
-        OptionalField.new(name, value, charset)
+        OptionalField.parse(name, value, charset)
       end
     end
 
+    # 2.2.3. Long Header Fields
+    #
+    #  The process of moving from this folded multiple-line representation
+    #  of a header field to its single line representation is called
+    #  "unfolding". Unfolding is accomplished by simply removing any CRLF
+    #  that is immediately followed by WSP.  Each header field should be
+    #  treated in its unfolded form for further syntactic and semantic
+    #  evaluation.
+    def unfold(string)
+      string.gsub(Constants::UNFOLD_WS, '\1')
+    end
   end
-
 end

data/lib/mail/field_list.rb

@@ -1,33 +1,87 @@
 # encoding: utf-8
+# frozen_string_literal: true
 module Mail
 
   # Field List class provides an enhanced array that keeps a list of 
   # email fields in order.  And allows you to insert new fields without
   # having to worry about the order they will appear in.
   class FieldList < Array
+    def has_field?(field_name)
+      any? { |f| f.responsible_for? field_name }
+    end
+
+    def get_field(field_name)
+      fields = select_fields(field_name)
+      case fields.size
+      when 0; nil
+      when 1; fields.first
+      else fields
+      end
+    end
 
-    include Enumerable
+    def add_field(field)
+      if field.singular?
+        replace_field field
+      else
+        insert_field field
+      end
+    end
+    alias_method :<<, :add_field
 
-    def <<( new_field )
-      current_entry = self.rindex(new_field)
-      if current_entry
-        self.insert((current_entry + 1), new_field)
+    def replace_field(field)
+      if first_offset = index { |f| f.responsible_for? field.name }
+        delete_field field.name
+        insert first_offset, field
       else
-        insert_idx = -1
-        self.each_with_index do |item, idx|
-          case item <=> new_field
-          when -1
-            next
-          when 0
-            next
-          when 1
-            insert_idx = idx
-            break
-          end
+        insert_field field
+      end
+    end
+
+    # Insert the field in sorted order.
+    #
+    # Heavily based on bisect.insort from Python, which is:
+    #   Copyright (C) 2001-2013 Python Software Foundation.
+    #   Licensed under <http://docs.python.org/license.html>
+    #   From <http://hg.python.org/cpython/file/2.7/Lib/bisect.py>
+    def insert_field(field)
+      lo, hi = 0, size
+      while lo < hi
+        mid = (lo + hi).div(2)
+        if field < self[mid]
+          hi = mid
+        else
+          lo = mid + 1
         end
-        insert(insert_idx, new_field)
+      end
+
+      insert lo, field
+    end
+
+    def delete_field(name)
+      delete_if { |f| f.responsible_for? name }
+    end
+
+    def summary
+      map { |f| "<#{f.name}: #{f.value}>" }.join(", ")
+    end
+
+    private
+
+    def select_fields(field_name)
+      fields = select { |f| f.responsible_for? field_name }
+      if fields.size > 1 && singular?(field_name)
+        Array(fields.detect { |f| f.errors.size == 0 } || fields.first)
+      else
+        fields
+      end
+    end
+
+    def singular?(field_name)
+      if klass = Mail::Field.field_class_for(field_name)
+        klass.singular?
+      else
+        false
       end
     end
-    
   end
-end
+end

data/lib/mail/fields/bcc_field.rb

@@ -1,56 +1,50 @@
 # encoding: utf-8
-# 
-# = Blind Carbon Copy Field
-# 
-# The Bcc field inherits from StructuredField and handles the Bcc: header
-# field in the email.
-# 
-# Sending bcc to a mail message will instantiate a Mail::Field object that
-# has a BccField as its field type.  This includes all Mail::CommonAddress
-# module instance metods.
-# 
-# Only one Bcc field can appear in a header, though it can have multiple
-# addresses and groups of addresses.
-# 
-# == Examples:
-# 
-#  mail = Mail.new
-#  mail.bcc = 'Mikel Lindsaar <mikel@test.lindsaar.net>, ada@test.lindsaar.net'
-#  mail.bcc    #=> ['mikel@test.lindsaar.net', 'ada@test.lindsaar.net']
-#  mail[:bcc]  #=> '#<Mail::Field:0x180e5e8 @field=#<Mail::BccField:0x180e1c4
-#  mail['bcc'] #=> '#<Mail::Field:0x180e5e8 @field=#<Mail::BccField:0x180e1c4
-#  mail['Bcc'] #=> '#<Mail::Field:0x180e5e8 @field=#<Mail::BccField:0x180e1c4
-# 
-#  mail[:bcc].encoded   #=> ''      # Bcc field does not get output into an email
-#  mail[:bcc].decoded   #=> 'Mikel Lindsaar <mikel@test.lindsaar.net>, ada@test.lindsaar.net'
-#  mail[:bcc].addresses #=> ['mikel@test.lindsaar.net', 'ada@test.lindsaar.net']
-#  mail[:bcc].formatted #=> ['Mikel Lindsaar <mikel@test.lindsaar.net>', 'ada@test.lindsaar.net']
-# 
-require 'mail/fields/common/common_address'
+# frozen_string_literal: true
+require 'mail/fields/common_address_field'
 
 module Mail
-  class BccField < StructuredField
-    
-    include Mail::CommonAddress
-    
-    FIELD_NAME = 'bcc'
-    CAPITALIZED_FIELD = 'Bcc'
-    
-    def initialize(value = '', charset = 'utf-8')
-      @charset = charset
-      super(CAPITALIZED_FIELD, strip_field(FIELD_NAME, value), charset)
-      self.parse
-      self
+  # = Blind Carbon Copy Field
+  #
+  # The Bcc field inherits from StructuredField and handles the Bcc: header
+  # field in the email.
+  #
+  # Sending bcc to a mail message will instantiate a Mail::Field object that
+  # has a BccField as its field type.  This includes all Mail::CommonAddress
+  # module instance metods.
+  #
+  # Only one Bcc field can appear in a header, though it can have multiple
+  # addresses and groups of addresses.
+  #
+  # == Examples:
+  #
+  #  mail = Mail.new
+  #  mail.bcc = 'Mikel Lindsaar <mikel@test.lindsaar.net>, ada@test.lindsaar.net'
+  #  mail.bcc    #=> ['mikel@test.lindsaar.net', 'ada@test.lindsaar.net']
+  #  mail[:bcc]  #=> '#<Mail::Field:0x180e5e8 @field=#<Mail::BccField:0x180e1c4
+  #  mail['bcc'] #=> '#<Mail::Field:0x180e5e8 @field=#<Mail::BccField:0x180e1c4
+  #  mail['Bcc'] #=> '#<Mail::Field:0x180e5e8 @field=#<Mail::BccField:0x180e1c4
+  #
+  #  mail[:bcc].encoded   #=> ''      # Bcc field does not get output into an email
+  #  mail[:bcc].decoded   #=> 'Mikel Lindsaar <mikel@test.lindsaar.net>, ada@test.lindsaar.net'
+  #  mail[:bcc].addresses #=> ['mikel@test.lindsaar.net', 'ada@test.lindsaar.net']
+  #  mail[:bcc].formatted #=> ['Mikel Lindsaar <mikel@test.lindsaar.net>', 'ada@test.lindsaar.net']
+  class BccField < CommonAddressField #:nodoc:
+    NAME = 'Bcc'
+
+    attr_accessor :include_in_headers
+
+    def initialize(value = nil, charset = nil)
+      super
+      self.include_in_headers = false
     end
-    
-    # Bcc field should never be :encoded
+
+    # Bcc field should not be :encoded by default
     def encoded
-      ''
-    end
-    
-    def decoded
-      do_decode
+      if include_in_headers
+        super
+      else
+        ''
+      end
     end
-    
   end
 end

data/lib/mail/fields/cc_field.rb

@@ -1,55 +1,34 @@
 # encoding: utf-8
-# 
-# = Carbon Copy Field
-# 
-# The Cc field inherits from StructuredField and handles the Cc: header
-# field in the email.
-# 
-# Sending cc to a mail message will instantiate a Mail::Field object that
-# has a CcField as its field type.  This includes all Mail::CommonAddress
-# module instance metods.
-# 
-# Only one Cc field can appear in a header, though it can have multiple
-# addresses and groups of addresses.
-# 
-# == Examples:
-# 
-#  mail = Mail.new
-#  mail.cc = 'Mikel Lindsaar <mikel@test.lindsaar.net>, ada@test.lindsaar.net'
-#  mail.cc    #=> ['mikel@test.lindsaar.net', 'ada@test.lindsaar.net']
-#  mail[:cc]  #=> '#<Mail::Field:0x180e5e8 @field=#<Mail::CcField:0x180e1c4
-#  mail['cc'] #=> '#<Mail::Field:0x180e5e8 @field=#<Mail::CcField:0x180e1c4
-#  mail['Cc'] #=> '#<Mail::Field:0x180e5e8 @field=#<Mail::CcField:0x180e1c4
-# 
-#  mail[:cc].encoded   #=> 'Cc: Mikel Lindsaar <mikel@test.lindsaar.net>, ada@test.lindsaar.net\r\n'
-#  mail[:cc].decoded   #=> 'Mikel Lindsaar <mikel@test.lindsaar.net>, ada@test.lindsaar.net'
-#  mail[:cc].addresses #=> ['mikel@test.lindsaar.net', 'ada@test.lindsaar.net']
-#  mail[:cc].formatted #=> ['Mikel Lindsaar <mikel@test.lindsaar.net>', 'ada@test.lindsaar.net']
-# 
-require 'mail/fields/common/common_address'
+# frozen_string_literal: true
+require 'mail/fields/common_address_field'
 
 module Mail
-  class CcField < StructuredField
-    
-    include Mail::CommonAddress
-    
-    FIELD_NAME = 'cc'
-    CAPITALIZED_FIELD = 'Cc'
-    
-    def initialize(value = nil, charset = 'utf-8')
-      self.charset = charset
-      super(CAPITALIZED_FIELD, strip_field(FIELD_NAME, value), charset)
-      self.parse
-      self
-    end
-    
-    def encoded
-      do_encode(CAPITALIZED_FIELD)
-    end
-    
-    def decoded
-      do_decode
-    end
-    
+  # = Carbon Copy Field
+  #
+  # The Cc field inherits from StructuredField and handles the Cc: header
+  # field in the email.
+  #
+  # Sending cc to a mail message will instantiate a Mail::Field object that
+  # has a CcField as its field type.  This includes all Mail::CommonAddress
+  # module instance metods.
+  #
+  # Only one Cc field can appear in a header, though it can have multiple
+  # addresses and groups of addresses.
+  #
+  # == Examples:
+  #
+  #  mail = Mail.new
+  #  mail.cc = 'Mikel Lindsaar <mikel@test.lindsaar.net>, ada@test.lindsaar.net'
+  #  mail.cc    #=> ['mikel@test.lindsaar.net', 'ada@test.lindsaar.net']
+  #  mail[:cc]  #=> '#<Mail::Field:0x180e5e8 @field=#<Mail::CcField:0x180e1c4
+  #  mail['cc'] #=> '#<Mail::Field:0x180e5e8 @field=#<Mail::CcField:0x180e1c4
+  #  mail['Cc'] #=> '#<Mail::Field:0x180e5e8 @field=#<Mail::CcField:0x180e1c4
+  #
+  #  mail[:cc].encoded   #=> 'Cc: Mikel Lindsaar <mikel@test.lindsaar.net>, ada@test.lindsaar.net\r\n'
+  #  mail[:cc].decoded   #=> 'Mikel Lindsaar <mikel@test.lindsaar.net>, ada@test.lindsaar.net'
+  #  mail[:cc].addresses #=> ['mikel@test.lindsaar.net', 'ada@test.lindsaar.net']
+  #  mail[:cc].formatted #=> ['Mikel Lindsaar <mikel@test.lindsaar.net>', 'ada@test.lindsaar.net']
+  class CcField < CommonAddressField #:nodoc:
+    NAME = 'Cc'
   end
 end

data/lib/mail/fields/comments_field.rb

@@ -1,41 +1,32 @@
 # encoding: utf-8
-# 
-# = Comments Field
-# 
-# The Comments field inherits from UnstructuredField and handles the Comments:
-# header field in the email.
-# 
-# Sending comments to a mail message will instantiate a Mail::Field object that
-# has a CommentsField as its field type.
-#  
-# An email header can have as many comments fields as it wants.  There is no upper
-# limit, the comments field is also optional (that is, no comment is needed)
-# 
-# == Examples:
-# 
-#  mail = Mail.new
-#  mail.comments = 'This is a comment'
-#  mail.comments    #=> 'This is a comment'
-#  mail[:comments]  #=> '#<Mail::Field:0x180e5e8 @field=#<Mail::CommentsField:0x180e1c4
-#  mail['comments'] #=> '#<Mail::Field:0x180e5e8 @field=#<Mail::CommentsField:0x180e1c4
-#  mail['comments'] #=> '#<Mail::Field:0x180e5e8 @field=#<Mail::CommentsField:0x180e1c4
-# 
-#  mail.comments = "This is another comment"
-#  mail[:comments].map { |c| c.to_s } 
-#  #=> ['This is a comment', "This is another comment"]
-#
+# frozen_string_literal: true
+require 'mail/fields/named_unstructured_field'
+
 module Mail
-  class CommentsField < UnstructuredField
-    
-    FIELD_NAME = 'comments'
-    CAPITALIZED_FIELD = 'Comments'
-    
-    def initialize(value = nil, charset = 'utf-8')
-      @charset = charset
-      super(CAPITALIZED_FIELD, strip_field(FIELD_NAME, value))
-      self.parse
-      self
-    end
-    
+  # = Comments Field
+  #
+  # The Comments field inherits from UnstructuredField and handles the Comments:
+  # header field in the email.
+  #
+  # Sending comments to a mail message will instantiate a Mail::Field object that
+  # has a CommentsField as its field type.
+  #
+  # An email header can have as many comments fields as it wants.  There is no upper
+  # limit, the comments field is also optional (that is, no comment is needed)
+  #
+  # == Examples:
+  #
+  #  mail = Mail.new
+  #  mail.comments = 'This is a comment'
+  #  mail.comments    #=> 'This is a comment'
+  #  mail[:comments]  #=> '#<Mail::Field:0x180e5e8 @field=#<Mail::CommentsField:0x180e1c4
+  #  mail['comments'] #=> '#<Mail::Field:0x180e5e8 @field=#<Mail::CommentsField:0x180e1c4
+  #  mail['comments'] #=> '#<Mail::Field:0x180e5e8 @field=#<Mail::CommentsField:0x180e1c4
+  #
+  #  mail.comments = "This is another comment"
+  #  mail[:comments].map { |c| c.to_s }
+  #  #=> ['This is a comment', "This is another comment"]
+  class CommentsField < NamedUnstructuredField #:nodoc:
+    NAME = 'Comments'
   end
 end