mail 2.5.2 → 2.6.4

data/lib/mail/field.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 require 'mail/fields'
 
 # encoding: utf-8
@@ -22,7 +23,7 @@ module Mail
   #
   class Field
 
-    include Patterns
+    include Utilities
     include Comparable
 
     STRUCTURED_FIELDS = %w[ bcc cc content-description content-disposition
@@ -67,6 +68,10 @@ module Mail
       "content-location" => ContentLocationField,
     }
 
+    FIELD_NAME_MAP = FIELDS_MAP.inject({}) do |map, (field, field_klass)|
+      map.update(field => field_klass::CAPITALIZED_FIELD)
+    end
+
     # Generic Field Exception
     class FieldError < StandardError
     end
@@ -109,16 +114,23 @@ module Mail
     #  Field.new('content-type', ['text', 'plain', {:charset => 'UTF-8'}])
     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)
+      when name.index(COLON)            # Field.new("field-name: field data")
+        @charset = Utilities.blank?(value) ? charset : value
+        @name = name[FIELD_PREFIX]
+        @raw_value = name
+        @value = nil
+      when Utilities.blank?(value)   # Field.new("field-name")
+        @name = name
+        @value = nil
+        @raw_value = nil
+        @charset = charset
       else                              # Field.new("field-name", "value")
-        create_field(name, value, charset)
+        @name = name
+        @value = value
+        @raw_value = nil
+        @charset = charset
       end
-      return self
+      @name = FIELD_NAME_MAP[@name.to_s.downcase] || @name
     end
 
     def field=(value)
@@ -126,11 +138,12 @@ module Mail
     end
 
     def field
-      @field
+      _, @value = split(@raw_value) if @raw_value && !@value
+      @field ||= create_field(@name, @value, @charset)
     end
 
     def name
-      field.name
+      @name
     end
 
     def value
@@ -138,33 +151,59 @@ 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 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 update(name, value)
-      create_field(name, value, charset)
+      @field = create_field(name, value, @charset)
     end
 
     def same( other )
-      match_to_s(other.name, field.name)
+      return false unless other.kind_of?(self.class)
+      match_to_s(other.name, self.name)
     end
 
-    alias_method :==, :same
+    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
 
     def <=>( other )
-      self_order = FIELD_ORDER.rindex(self.name.to_s.downcase) || 100
-      other_order = FIELD_ORDER.rindex(other.name.to_s.downcase) || 100
-      self_order <=> other_order
+      self.field_order_id <=> other.field_order_id
+    end
+
+    def field_order_id
+      @field_order_id ||= (FIELD_ORDER_LOOKUP[self.name.to_s.downcase] || 100)
     end
 
     def method_missing(name, *args, &block)
       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
@@ -174,37 +213,48 @@ module Mail
                       mime-version content-type content-transfer-encoding
                       content-location content-disposition content-description ]
 
+    FIELD_ORDER_LOOKUP = Hash[FIELD_ORDER.each_with_index.to_a]
+
     private
 
     def split(raw_field)
-      match_data = raw_field.mb_chars.match(/^(#{FIELD_NAME})\s*:\s*(#{FIELD_BODY})?$/)
-      [match_data[1].to_s.mb_chars.strip, match_data[2].to_s.mb_chars.strip]
+      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}'"
     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(/[\r\n \t]+/m, ' ')
+    end
+
     def create_field(name, value, charset)
+      value = unfold(value) if value.is_a?(String)
+
       begin
-        self.field = new_field(name, value, charset)
+        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
+        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
-      header_name = nil
-      FIELDS_MAP.each do |field_name, _|
-        header_name = field_name if lower_case_name == field_name
-      end
-      if header_name
-        FIELDS_MAP[header_name].new(value, charset)
+      if field_klass = FIELDS_MAP[lower_case_name]
+        field_klass.new(value, charset)
       else
         OptionalField.new(name, value, charset)
       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 
@@ -8,26 +9,26 @@ module Mail
 
     include Enumerable
 
+    # 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 <<( new_field )
-      current_entry = self.rindex(new_field)
-      if current_entry
-        self.insert((current_entry + 1), new_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
+      lo = 0
+      hi = size
+
+      while lo < hi
+        mid = (lo + hi).div(2)
+        if new_field < self[mid]
+          hi = mid
+        else
+          lo = mid + 1
         end
-        insert(insert_idx, new_field)
       end
+
+      insert(lo, new_field)
     end
-    
   end
-end
+end

data/lib/mail/fields/bcc_field.rb

@@ -1,4 +1,5 @@
 # encoding: utf-8
+# frozen_string_literal: true
 # 
 # = Blind Carbon Copy Field
 # 
@@ -6,7 +7,7 @@
 # field in the email.
 # 
 # Sending bcc to a mail message will instantiate a Mail::Field object that
-# has a BccField as it's field type.  This includes all Mail::CommonAddress
+# 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
@@ -16,7 +17,7 @@
 # 
 #  mail = Mail.new
 #  mail.bcc = 'Mikel Lindsaar <mikel@test.lindsaar.net>, ada@test.lindsaar.net'
-#  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
@@ -39,13 +40,24 @@ module Mail
     def initialize(value = '', charset = 'utf-8')
       @charset = charset
       super(CAPITALIZED_FIELD, strip_field(FIELD_NAME, value), charset)
-      self.parse
       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
 # 
@@ -6,7 +7,7 @@
 # field in the email.
 # 
 # Sending cc to a mail message will instantiate a Mail::Field object that
-# has a CcField as it's field type.  This includes all Mail::CommonAddress
+# 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
@@ -16,7 +17,7 @@
 # 
 #  mail = Mail.new
 #  mail.cc = 'Mikel Lindsaar <mikel@test.lindsaar.net>, ada@test.lindsaar.net'
-#  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
@@ -39,7 +40,6 @@ module Mail
     def initialize(value = nil, charset = 'utf-8')
       self.charset = charset
       super(CAPITALIZED_FIELD, strip_field(FIELD_NAME, value), charset)
-      self.parse
       self
     end
     

data/lib/mail/fields/comments_field.rb

@@ -1,4 +1,5 @@
 # encoding: utf-8
+# frozen_string_literal: true
 # 
 # = Comments Field
 # 
@@ -6,7 +7,7 @@
 # header field in the email.
 # 
 # Sending comments to a mail message will instantiate a Mail::Field object that
-# has a CommentsField as it's field type.
+# 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)

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

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 module Mail
   
   class AddressContainer < Array

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

@@ -1,12 +1,13 @@
 # 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?
-        @tree = AddressList.new(encode_if_needed(val))
+      unless Utilities.blank?(val)
+        @address_list = AddressList.new(encode_if_needed(val))
       else
         nil
       end
@@ -20,54 +21,60 @@ module Mail
       Encodings.address_encode(val, charset)
     end
     
-    # Allows you to iterate through each address object in the syntax tree
+    # Allows you to iterate through each address object in the address_list
     def each
-      tree.addresses.each do |address|
+      address_list.addresses.each do |address|
         yield(address)
       end
     end
 
     # Returns the address string of all the addresses in the address list
     def addresses
-      list = tree.addresses.map { |a| a.address }
+      list = address_list.addresses.map { |a| a.address }
       Mail::AddressContainer.new(self, list)
     end
 
     # Returns the formatted string of all the addresses in the address list
     def formatted
-      list = tree.addresses.map { |a| a.format }
+      list = address_list.addresses.map { |a| a.format }
       Mail::AddressContainer.new(self, list)
     end
   
     # Returns the display name of all the addresses in the address list
     def display_names
-      list = tree.addresses.map { |a| a.display_name }
+      list = address_list.addresses.map { |a| a.display_name }
       Mail::AddressContainer.new(self, list)
     end
   
     # Returns the actual address objects in the address list
     def addrs
-      list = tree.addresses
+      list = address_list.addresses
       Mail::AddressContainer.new(self, list)
     end
   
     # Returns a hash of group name => address strings for the address list
     def groups
-      @groups = Hash.new
-      tree.group_recipients.each do |group|
-        @groups[group.group_name.text_value.to_str] = get_group_addresses(group.group_list)
-      end
-      @groups
+      address_list.addresses_grouped_by_group
     end
   
     # Returns the addresses that are part of groups
     def group_addresses
-      groups.map { |k,v| v.map { |a| a.format } }.flatten
+      decoded_group_addresses
+    end
+
+    # Returns a list of decoded group addresses
+    def decoded_group_addresses
+      groups.map { |k,v| v.map { |a| a.decoded } }.flatten
+    end
+
+    # Returns a list of encoded group addresses
+    def encoded_group_addresses
+      groups.map { |k,v| v.map { |a| a.encoded } }.flatten
     end
 
     # Returns the name of all the groups in a string
     def group_names # :nodoc:
-      tree.group_names
+      address_list.group_names
     end
   
     def default
@@ -78,10 +85,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
 
@@ -93,34 +100,33 @@ module Mail
     private
   
     def do_encode(field_name)
-      return '' if value.blank?
-      address_array = tree.addresses.reject { |a| group_addresses.include?(a.encoded) }.compact.map { |a| a.encoded }
+      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?
-      address_array = tree.addresses.reject { |a| group_addresses.include?(a.decoded) }.map { |a| a.decoded }
+      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
 
-    # Returns the syntax tree of the Addresses
-    def tree # :nodoc:
-      @tree ||= AddressList.new(value)
+    def address_list # :nodoc:
+      @address_list ||= AddressList.new(value)
     end
   
     def get_group_addresses(group_list)
       if group_list.respond_to?(:addresses)
-        group_list.addresses.map do |address_tree|
-          Mail::Address.new(address_tree)
+        group_list.addresses.map do |address|
+          Mail::Address.new(address)
         end
       else
         []

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,9 +12,8 @@ module Mail
     end
     
     def parse(val = value)
-      unless val.blank?
+      unless Utilities.blank?(val)
         @element = Mail::DateTimeElement.new(val)
-        @tree = @element.tree
       else
         nil
       end
@@ -32,11 +32,5 @@ module Mail
     def element
       @element ||= Mail::DateTimeElement.new(value)
     end
-    
-    # Returns the syntax tree of the Date
-    def tree
-      @tree ||= element.tree
-    end
-    
   end
 end

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

@@ -1,6 +1,8 @@
 # encoding: utf-8
+# frozen_string_literal: true
 module Mail
   module CommonField # :nodoc:
+    include Mail::Constants
 
     def name=(value)
       @name = value
@@ -22,7 +24,7 @@ module Mail
     end
 
     def to_s
-      decoded
+      decoded.to_s
     end
 
     def default
@@ -43,15 +45,17 @@ module Mail
       if value.is_a?(Array)
         value
       else
-        value.to_s.gsub(/#{field_name}:\s+/i, '')
+        value.to_s.sub(/\A#{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?(Array) and /(.)*\s(filename|name)=[^"](.+\s)+[^"]/.match value
-        value.gsub!(/[^=]+$/, '"\\0"')
+      if value.is_a?(String)
+        value.sub FILENAME_RE, '\1="\2"'
+      else
+        value
       end
     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
@@ -18,7 +19,7 @@ module Mail
       exact = nil
       each do |k,v|
         if k =~ /^#{key_pattern}(\*|$)/i
-          if $1 == '*'
+          if $1 == ASTERISK
             pairs << [k, v]
           else
             exact = k
@@ -40,7 +41,7 @@ module Mail
     end
 
     def encoded
-      map.sort { |a,b| a.first.to_s <=> b.first.to_s }.map do |key_name, value|
+      map.sort_by { |a| a.first.to_s }.map! do |key_name, value|
         unless value.ascii_only?
           value = Mail::Encodings.param_encode(value)
           key_name = "#{key_name}*"
@@ -50,7 +51,7 @@ module Mail
     end
 
     def decoded
-      map.sort { |a,b| a.first.to_s <=> b.first.to_s }.map do |key_name, value|
+      map.sort_by { |a| a.first.to_s }.map! do |key_name, value|
         %Q{#{key_name}=#{quote_token(value)}}
       end.join("; ")
     end

data/lib/mail/fields/content_description_field.rb

@@ -1,4 +1,5 @@
 # encoding: utf-8
+# frozen_string_literal: true
 # 
 # 
 #