mail 2.7.1 → 2.8.0.rc1

data/lib/mail/fields/cc_field.rb

@@ -1,55 +1,34 @@
 # encoding: utf-8
 # frozen_string_literal: true
-# 
-# = 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'
+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, value, charset)
-      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,42 +1,32 @@
 # encoding: utf-8
 # frozen_string_literal: true
-# 
-# = 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"]
-#
+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, 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

data/lib/mail/fields/common_address_field.rb

@@ -0,0 +1,170 @@
+# encoding: utf-8
+# frozen_string_literal: true
+require 'mail/fields/named_structured_field'
+
+module Mail
+  class AddressContainer < Array #:nodoc:
+    def initialize(field, list = nil)
+      @field = field
+      super list if list
+    end
+
+    def <<(address)
+      @field << address
+    end
+  end
+
+  class CommonAddressField < NamedStructuredField #:nodoc:
+    def self.singular?
+      true
+    end
+
+    def initialize(value = nil, charset = nil)
+      super encode_if_needed(value, charset), charset
+    end
+
+    def element # :nodoc:
+      @element ||= AddressList.new(value)
+    end
+
+    # Allows you to iterate through each address object in the address_list
+    def each
+      element.addresses.each do |address|
+        yield(address)
+      end
+    end
+
+    def default
+      addresses
+    end
+
+    def address
+      addresses.first
+    end
+
+    # Returns the address string of all the addresses in the address list
+    def addresses
+      list = element.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 = element.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 = element.addresses.map { |a| a.display_name }
+      Mail::AddressContainer.new(self, list)
+    end
+
+    # Returns the actual address objects in the address list
+    def addrs
+      list = element.addresses
+      Mail::AddressContainer.new(self, list)
+    end
+
+    # Returns a hash of group name => address strings for the address list
+    def groups
+      element.addresses_grouped_by_group
+    end
+
+    # Returns the addresses that are part of groups
+    def group_addresses
+      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:
+      element.group_names
+    end
+
+    def <<(val)
+      case
+      when val.nil?
+        raise ArgumentError, "Need to pass an address to <<"
+      when Utilities.blank?(val)
+        self
+      else
+        self.value = [self.value, encode_if_needed(val)].reject { |a| Utilities.blank?(a) }.join(", ")
+      end
+    end
+
+    def encode_if_needed(val, val_charset = charset) #:nodoc:
+      case val
+      when nil
+        val
+
+      # Need to join arrays of addresses into a single value
+      when Array
+        val.compact.map { |a| encode_if_needed a, val_charset }.join(', ')
+
+      # Pass through UTF-8; encode non-UTF-8.
+      else
+        utf8_if_needed(val, val_charset) || Encodings.encode_non_usascii(val, val_charset)
+      end
+    end
+
+    private
+      if 'string'.respond_to?(:encoding)
+        # Pass through UTF-8 addresses
+        def utf8_if_needed(val, val_charset)
+          if val_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, val_charset)
+          if val_charset =~ /\AUTF-?8\z/i
+            val
+          end
+        end
+      end
+
+      def do_encode
+        return '' if Utilities.blank?(value)
+        address_array = element.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| Utilities.blank?(a) }
+        "#{name}: #{return_array.join(", \r\n\s")}\r\n"
+      end
+
+      def do_decode
+        return nil if Utilities.blank?(value)
+        address_array = element.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| Utilities.blank?(a) }
+        return_array.join(", ")
+      end
+
+      def get_group_addresses(group_list)
+        if group_list.respond_to?(:addresses)
+          group_list.addresses.map do |address|
+            Mail::Address.new(address)
+          end
+        else
+          []
+        end
+      end
+  end
+end

data/lib/mail/fields/common_date_field.rb

@@ -0,0 +1,58 @@
+require 'mail/fields/named_structured_field'
+require 'mail/elements/date_time_element'
+require 'mail/utilities'
+
+module Mail
+  class CommonDateField < NamedStructuredField #:nodoc:
+    def self.singular?
+      true
+    end
+
+    def self.normalize_datetime(string)
+      if Utilities.blank?(string)
+        datetime = ::DateTime.now
+      else
+        stripped = string.to_s.gsub(/\(.*?\)/, '').squeeze(' ')
+        begin
+          datetime = ::DateTime.parse(stripped)
+        rescue ArgumentError => e
+          raise unless 'invalid date' == e.message
+        end
+      end
+
+      if datetime
+        datetime.strftime('%a, %d %b %Y %H:%M:%S %z')
+      else
+        string
+      end
+    end
+
+    def initialize(value = nil, charset = nil)
+      super self.class.normalize_datetime(value), charset
+    end
+
+    # Returns a date time object of the parsed date
+    def date_time
+      ::DateTime.parse("#{element.date_string} #{element.time_string}")
+    rescue ArgumentError => e
+      raise e unless e.message == 'invalid date'
+    end
+
+    def default
+      date_time
+    end
+
+    def element
+      @element ||= Mail::DateTimeElement.new(value)
+    end
+
+    private
+      def do_encode
+        "#{name}: #{value}\r\n"
+      end
+
+      def do_decode
+        value.to_s
+      end
+  end
+end

data/lib/mail/fields/common_field.rb

@@ -0,0 +1,77 @@
+# encoding: utf-8
+# frozen_string_literal: true
+require 'mail/constants'
+
+module Mail
+  class CommonField #:nodoc:
+    def self.singular?
+      false
+    end
+
+    def self.parse(*args)
+      new(*args).tap(&:parse)
+    end
+
+    attr_accessor :name
+    attr_reader :value
+    attr_accessor :charset
+    attr_reader :errors
+
+    def initialize(name = nil, value = nil, charset = nil)
+      @errors = []
+
+      self.name = name
+      self.value = value
+      self.charset = charset || 'utf-8'
+    end
+
+    def singular?
+      self.class.singular?
+    end
+
+    def value=(value)
+      @element = nil
+      @value = value.is_a?(Array) ? value : value.to_s
+      parse
+    end
+
+    def parse
+      tap(&:element)
+    end
+
+    def element
+      nil
+    end
+
+    def to_s
+      decoded.to_s
+    end
+
+    def default
+      decoded
+    end
+
+    def decoded
+      do_decode
+    end
+
+    def encoded
+      do_encode
+    end
+
+    def responsible_for?(field_name)
+      name.to_s.casecmp(field_name.to_s) == 0
+    end
+
+    private
+
+    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"'
+      else
+        value
+      end
+    end
+  end
+end

data/lib/mail/fields/common_message_id_field.rb

@@ -0,0 +1,42 @@
+# encoding: utf-8
+# frozen_string_literal: true
+require 'mail/fields/named_structured_field'
+require 'mail/utilities'
+
+module Mail
+  class CommonMessageIdField < NamedStructuredField #:nodoc:
+    def element
+      @element ||= Mail::MessageIdsElement.new(value)
+    end
+
+    def message_id
+      element.message_id
+    end
+
+    def message_ids
+      element.message_ids
+    end
+
+    def default
+      ids = message_ids
+      ids.one? ? ids.first : ids
+    end
+
+    def to_s
+      decoded.to_s
+    end
+
+    private
+      def do_encode
+        %Q{#{name}: #{formatted_message_ids("\r\n ")}\r\n}
+      end
+
+      def do_decode
+        formatted_message_ids
+      end
+
+      def formatted_message_ids(join = ' ')
+        message_ids.map { |m| "<#{m}>" }.join(join) if message_ids.any?
+      end
+  end
+end

data/lib/mail/fields/content_description_field.rb

@@ -1,20 +1,13 @@
 # encoding: utf-8
 # frozen_string_literal: true
-# 
-# 
-# 
+require 'mail/fields/named_unstructured_field'
+
 module Mail
-  class ContentDescriptionField < UnstructuredField
-    
-    FIELD_NAME = 'content-description'
-    CAPITALIZED_FIELD = 'Content-Description'
-    
-    def initialize(value = nil, charset = 'utf-8')
-      self.charset = charset
-      super(CAPITALIZED_FIELD, value, charset)
-      self.parse
-      self
+  class ContentDescriptionField < NamedUnstructuredField #:nodoc:
+    NAME = 'Content-Description'
+
+    def self.singular?
+      true
     end
-    
   end
 end

data/lib/mail/fields/content_disposition_field.rb

@@ -1,25 +1,18 @@
 # encoding: utf-8
 # frozen_string_literal: true
-require 'mail/fields/common/parameter_hash'
+require 'mail/fields/named_structured_field'
+require 'mail/fields/parameter_hash'
 
 module Mail
-  class ContentDispositionField < StructuredField
+  class ContentDispositionField < NamedStructuredField #:nodoc:
+    NAME = 'Content-Disposition'
 
-    FIELD_NAME = 'content-disposition'
-    CAPITALIZED_FIELD = 'Content-Disposition'
-
-    def initialize(value = nil, charset = 'utf-8')
-      self.charset = charset
-      value = ensure_filename_quoted(value)
-      super(CAPITALIZED_FIELD, value, charset)
-      self.parse
-      self
+    def self.singular?
+      true
     end
 
-    def parse(val = value)
-      unless Utilities.blank?(val)
-        @element = Mail::ContentDispositionElement.new(val)
-      end
+    def initialize(value = nil, charset = nil)
+      super ensure_filename_quoted(value), charset
     end
 
     def element
@@ -37,35 +30,17 @@ module Mail
     end
 
     def filename
-      case
-      when parameters['filename']
-        @filename = parameters['filename']
-      when parameters['name']
-        @filename = parameters['name']
-      else
-        @filename = nil
-      end
-      @filename
+      @filename ||= parameters['filename'] || parameters['name']
     end
 
-    # TODO: Fix this up
     def encoded
-      if parameters.length > 0
-        p = ";\r\n\s#{parameters.encoded}\r\n"
-      else
-        p = "\r\n"
-      end
-      "#{CAPITALIZED_FIELD}: #{disposition_type}" + p
+      p = ";\r\n\s#{parameters.encoded}" if parameters.length > 0
+      "#{name}: #{disposition_type}#{p}\r\n"
     end
 
     def decoded
-      if parameters.length > 0
-        p = "; #{parameters.decoded}"
-      else
-        p = ""
-      end
-      "#{disposition_type}" + p
+      p = "; #{parameters.decoded}" if parameters.length > 0
+      "#{disposition_type}#{p}"
     end
-
   end
 end

data/lib/mail/fields/content_id_field.rb

@@ -1,63 +1,36 @@
 # encoding: utf-8
 # frozen_string_literal: true
-# 
-# 
-# 
+require 'mail/fields/named_structured_field'
+require 'mail/utilities'
+
 module Mail
-  class ContentIdField < StructuredField
-    
-    FIELD_NAME = 'content-id'
-    CAPITALIZED_FIELD = "Content-ID"
-    
-    def initialize(value = nil, charset = 'utf-8')
-      self.charset = charset
-      @uniq = 1
-      if Utilities.blank?(value)
-        value = generate_content_id
-      else
-        value = value.to_s
-      end
-      super(CAPITALIZED_FIELD, value, charset)
-      self.parse
-      self
-    end
-    
-    def parse(val = value)
-      unless Utilities.blank?(val)
-        @element = Mail::MessageIdsElement.new(val)
-      end
-    end
-    
+  class ContentIdField < NamedStructuredField #:nodoc:
+    NAME = 'Content-ID'
+
+    def self.singular?
+      true
+    end
+
+    def initialize(value = nil, charset = nil)
+      value = Mail::Utilities.generate_message_id if Utilities.blank?(value)
+      super value, charset
+    end
+
     def element
       @element ||= Mail::MessageIdsElement.new(value)
     end
-    
-    def name
-      'Content-ID'
-    end
-    
+
     def content_id
       element.message_id
     end
-    
-    def to_s
-      "<#{content_id}>"
-    end
-    
-    # TODO: Fix this up
-    def encoded
-      "#{CAPITALIZED_FIELD}: #{to_s}\r\n"
-    end
-    
-    def decoded
-      "#{to_s}"
-    end
-    
+
     private
-    
-    def generate_content_id
-      "<#{Mail.random_tag}@#{::Socket.gethostname}.mail>"
-    end
-    
+      def do_decode
+        "<#{content_id}>"
+      end
+
+      def do_encode
+        "#{name}: #{do_decode}\r\n"
+      end
   end
 end