mail 2.7.1 → 2.8.1

data/lib/mail/fields/from_field.rb

@@ -1,55 +1,34 @@
 # encoding: utf-8
 # frozen_string_literal: true
-# 
-# = From Field
-# 
-# The From field inherits from StructuredField and handles the From: header
-# field in the email.
-# 
-# Sending from to a mail message will instantiate a Mail::Field object that
-# has a FromField as its field type.  This includes all Mail::CommonAddress
-# module instance metods.
-# 
-# Only one From field can appear in a header, though it can have multiple
-# addresses and groups of addresses.
-# 
-# == Examples:
-# 
-#  mail = Mail.new
-#  mail.from = 'Mikel Lindsaar <mikel@test.lindsaar.net>, ada@test.lindsaar.net'
-#  mail.from    #=> ['mikel@test.lindsaar.net', 'ada@test.lindsaar.net']
-#  mail[:from]  #=> '#<Mail::Field:0x180e5e8 @field=#<Mail::FromField:0x180e1c4
-#  mail['from'] #=> '#<Mail::Field:0x180e5e8 @field=#<Mail::FromField:0x180e1c4
-#  mail['From'] #=> '#<Mail::Field:0x180e5e8 @field=#<Mail::FromField:0x180e1c4
-# 
-#  mail[:from].encoded   #=> 'from: Mikel Lindsaar <mikel@test.lindsaar.net>, ada@test.lindsaar.net\r\n'
-#  mail[:from].decoded   #=> 'Mikel Lindsaar <mikel@test.lindsaar.net>, ada@test.lindsaar.net'
-#  mail[:from].addresses #=> ['mikel@test.lindsaar.net', 'ada@test.lindsaar.net']
-#  mail[:from].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 FromField < StructuredField
-    
-    include Mail::CommonAddress
-    
-    FIELD_NAME = 'from'
-    CAPITALIZED_FIELD = 'From'
-    
-    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
-
+  # = From Field
+  #
+  # The From field inherits from StructuredField and handles the From: header
+  # field in the email.
+  #
+  # Sending from to a mail message will instantiate a Mail::Field object that
+  # has a FromField as its field type.  This includes all Mail::CommonAddress
+  # module instance metods.
+  #
+  # Only one From field can appear in a header, though it can have multiple
+  # addresses and groups of addresses.
+  #
+  # == Examples:
+  #
+  #  mail = Mail.new
+  #  mail.from = 'Mikel Lindsaar <mikel@test.lindsaar.net>, ada@test.lindsaar.net'
+  #  mail.from    #=> ['mikel@test.lindsaar.net', 'ada@test.lindsaar.net']
+  #  mail[:from]  #=> '#<Mail::Field:0x180e5e8 @field=#<Mail::FromField:0x180e1c4
+  #  mail['from'] #=> '#<Mail::Field:0x180e5e8 @field=#<Mail::FromField:0x180e1c4
+  #  mail['From'] #=> '#<Mail::Field:0x180e5e8 @field=#<Mail::FromField:0x180e1c4
+  #
+  #  mail[:from].encoded   #=> 'from: Mikel Lindsaar <mikel@test.lindsaar.net>, ada@test.lindsaar.net\r\n'
+  #  mail[:from].decoded   #=> 'Mikel Lindsaar <mikel@test.lindsaar.net>, ada@test.lindsaar.net'
+  #  mail[:from].addresses #=> ['mikel@test.lindsaar.net', 'ada@test.lindsaar.net']
+  #  mail[:from].formatted #=> ['Mikel Lindsaar <mikel@test.lindsaar.net>', 'ada@test.lindsaar.net']
+  class FromField < CommonAddressField #:nodoc:
+    NAME = 'From'
   end
 end

data/lib/mail/fields/in_reply_to_field.rb

@@ -1,57 +1,46 @@
 # encoding: utf-8
 # frozen_string_literal: true
-# 
-# = In-Reply-To Field
-# 
-# The In-Reply-To field inherits from StructuredField and handles the 
-# In-Reply-To: header field in the email.
-# 
-# Sending in_reply_to to a mail message will instantiate a Mail::Field object that
-# has a InReplyToField as its field type.  This includes all Mail::CommonMessageId
-# module instance metods.
-# 
-# Note that, the #message_ids method will return an array of message IDs without the
-# enclosing angle brackets which per RFC are not syntactically part of the message id.
-# 
-# Only one InReplyTo field can appear in a header, though it can have multiple
-# Message IDs.
-# 
-# == Examples:
-# 
-#  mail = Mail.new
-#  mail.in_reply_to = '<F6E2D0B4-CC35-4A91-BA4C-C7C712B10C13@test.me.dom>'
-#  mail.in_reply_to    #=> '<F6E2D0B4-CC35-4A91-BA4C-C7C712B10C13@test.me.dom>'
-#  mail[:in_reply_to]  #=> '#<Mail::Field:0x180e5e8 @field=#<Mail::InReplyToField:0x180e1c4
-#  mail['in_reply_to'] #=> '#<Mail::Field:0x180e5e8 @field=#<Mail::InReplyToField:0x180e1c4
-#  mail['In-Reply-To'] #=> '#<Mail::Field:0x180e5e8 @field=#<Mail::InReplyToField:0x180e1c4
-# 
-#  mail[:in_reply_to].message_ids #=> ['F6E2D0B4-CC35-4A91-BA4C-C7C712B10C13@test.me.dom']
-# 
-require 'mail/fields/common/common_message_id'
+require 'mail/fields/common_message_id_field'
 
 module Mail
-  class InReplyToField < StructuredField
-    
-    include Mail::CommonMessageId
-    
-    FIELD_NAME = 'in-reply-to'
-    CAPITALIZED_FIELD = 'In-Reply-To'
-    
-    def initialize(value = nil, charset = 'utf-8')
-      self.charset = charset
-      value = value.join("\r\n\s") if value.is_a?(Array)
-      super(CAPITALIZED_FIELD, value, charset)
-      self.parse
-      self
-    end
-    
-    def encoded
-      do_encode(CAPITALIZED_FIELD)
+  # = In-Reply-To Field
+  #
+  # The In-Reply-To field inherits from StructuredField and handles the
+  # In-Reply-To: header field in the email.
+  #
+  # Sending in_reply_to to a mail message will instantiate a Mail::Field object that
+  # has a InReplyToField as its field type.  This includes all Mail::CommonMessageId
+  # module instance metods.
+  #
+  # Note that, the #message_ids method will return an array of message IDs without the
+  # enclosing angle brackets which per RFC are not syntactically part of the message id.
+  #
+  # Only one InReplyTo field can appear in a header, though it can have multiple
+  # Message IDs.
+  #
+  # == Examples:
+  #
+  #  mail = Mail.new
+  #  mail.in_reply_to = '<F6E2D0B4-CC35-4A91-BA4C-C7C712B10C13@test.me.dom>'
+  #  mail.in_reply_to    #=> '<F6E2D0B4-CC35-4A91-BA4C-C7C712B10C13@test.me.dom>'
+  #  mail[:in_reply_to]  #=> '#<Mail::Field:0x180e5e8 @field=#<Mail::InReplyToField:0x180e1c4
+  #  mail['in_reply_to'] #=> '#<Mail::Field:0x180e5e8 @field=#<Mail::InReplyToField:0x180e1c4
+  #  mail['In-Reply-To'] #=> '#<Mail::Field:0x180e5e8 @field=#<Mail::InReplyToField:0x180e1c4
+  #
+  #  mail[:in_reply_to].message_ids #=> ['F6E2D0B4-CC35-4A91-BA4C-C7C712B10C13@test.me.dom']
+  class InReplyToField < CommonMessageIdField #:nodoc:
+    NAME = 'In-Reply-To'
+
+    def self.singular?
+      true
     end
-    
-    def decoded
-      do_decode
+
+    def initialize(value = nil, charset = nil)
+      if value.is_a?(Array)
+        super value.join("\r\n\s"), charset
+      else
+        super
+      end
     end
-    
   end
 end

data/lib/mail/fields/keywords_field.rb

@@ -1,44 +1,31 @@
 # encoding: utf-8
 # frozen_string_literal: true
-# 
-# keywords        =       "Keywords:" phrase *("," phrase) CRLF
+require 'mail/fields/named_structured_field'
+
 module Mail
-  class KeywordsField < StructuredField
-    
-    FIELD_NAME = 'keywords'
-    CAPITALIZED_FIELD = 'Keywords'
-    
-    def initialize(value = nil, charset = 'utf-8')
-      self.charset = charset
-      super(CAPITALIZED_FIELD, value, charset)
-      self
-    end
+  # keywords        =       "Keywords:" phrase *("," phrase) CRLF
+  class KeywordsField < NamedStructuredField #:nodoc:
+    NAME = 'Keywords'
 
-    def parse(val = value)
-      unless Utilities.blank?(val)
-        @phrase_list ||= PhraseList.new(value)
-      end
+    def element
+      @element ||= PhraseList.new(value)
     end
-    
-    def phrase_list
-      @phrase_list ||= PhraseList.new(value)
-    end
-      
+
     def keywords
-      phrase_list.phrases
-    end
-    
-    def encoded
-      "#{CAPITALIZED_FIELD}: #{keywords.join(",\r\n ")}\r\n"
-    end
-    
-    def decoded
-      keywords.join(', ')
+      element.phrases
     end
 
     def default
       keywords
     end
-    
+
+    private
+      def do_decode
+        keywords.join(', ')
+      end
+
+      def do_encode
+        "#{name}: #{keywords.join(",\r\n ")}\r\n"
+      end
   end
 end

data/lib/mail/fields/message_id_field.rb

@@ -1,83 +1,37 @@
 # encoding: utf-8
 # frozen_string_literal: true
-# 
-# = Message-ID Field
-# 
-# The Message-ID field inherits from StructuredField and handles the 
-# Message-ID: header field in the email.
-# 
-# Sending message_id to a mail message will instantiate a Mail::Field object that
-# has a MessageIdField as its field type.  This includes all Mail::CommonMessageId
-# module instance metods.
-# 
-# Only one MessageId field can appear in a header, and syntactically it can only have
-# one Message ID.  The message_ids method call has been left in however as it will only
-# return the one message id, ie, an array of length 1.
-# 
-# Note that, the #message_ids method will return an array of message IDs without the
-# enclosing angle brackets which per RFC are not syntactically part of the message id.
-# 
-# == Examples:
-# 
-#  mail = Mail.new
-#  mail.message_id = '<F6E2D0B4-CC35-4A91-BA4C-C7C712B10C13@test.me.dom>'
-#  mail.message_id    #=> '<F6E2D0B4-CC35-4A91-BA4C-C7C712B10C13@test.me.dom>'
-#  mail[:message_id]  #=> '#<Mail::Field:0x180e5e8 @field=#<Mail::MessageIdField:0x180e1c4
-#  mail['message_id'] #=> '#<Mail::Field:0x180e5e8 @field=#<Mail::MessageIdField:0x180e1c4
-#  mail['Message-ID'] #=> '#<Mail::Field:0x180e5e8 @field=#<Mail::MessageIdField:0x180e1c4
-# 
-#  mail[:message_id].message_id   #=> 'F6E2D0B4-CC35-4A91-BA4C-C7C712B10C13@test.me.dom'
-#  mail[:message_id].message_ids  #=> ['F6E2D0B4-CC35-4A91-BA4C-C7C712B10C13@test.me.dom']
-# 
-require 'mail/fields/common/common_message_id'
+require 'mail/fields/common_message_id_field'
+require 'mail/utilities'
 
 module Mail
-  class MessageIdField < StructuredField
-    
-    include Mail::CommonMessageId
-    
-    FIELD_NAME = 'message-id'
-    CAPITALIZED_FIELD = 'Message-ID'
-    
-    def initialize(value = nil, charset = 'utf-8')
-      self.charset = charset
-      @uniq = 1
-      if Utilities.blank?(value)
-        self.name = CAPITALIZED_FIELD
-        self.value = generate_message_id
-      else
-        super(CAPITALIZED_FIELD, value, charset)
-      end
-      self.parse
-      self
+  # Only one Message-ID field may appear in a header.
+  #
+  # Note that parsed Message IDs do not contain their enclosing angle
+  # brackets which, per RFC, are not part of the ID.
+  #
+  #  mail = Mail.new
+  #  mail.message_id = '<F6E2D0B4-CC35-4A91-BA4C-C7C712B10C13@test.me.dom>'
+  #  mail.message_id    #=> '<F6E2D0B4-CC35-4A91-BA4C-C7C712B10C13@test.me.dom>'
+  #  mail[:message_id]  #=> '#<Mail::Field:0x180e5e8 @field=#<Mail::MessageIdField:0x180e1c4
+  #  mail['message_id'] #=> '#<Mail::Field:0x180e5e8 @field=#<Mail::MessageIdField:0x180e1c4
+  #  mail['Message-ID'] #=> '#<Mail::Field:0x180e5e8 @field=#<Mail::MessageIdField:0x180e1c4
+  #
+  #  mail[:message_id].message_id   #=> 'F6E2D0B4-CC35-4A91-BA4C-C7C712B10C13@test.me.dom'
+  #  mail[:message_id].message_ids  #=> ['F6E2D0B4-CC35-4A91-BA4C-C7C712B10C13@test.me.dom']
+  class MessageIdField < CommonMessageIdField #:nodoc:
+    NAME = 'Message-ID'
 
+    def self.singular?
+      true
     end
-    
-    def name
-      'Message-ID'
+
+    def initialize(value = nil, charset = nil)
+      value = Mail::Utilities.generate_message_id if Utilities.blank?(value)
+      super value, charset
     end
-    
+
     def message_ids
       [message_id]
     end
-    
-    def to_s
-      "<#{message_id}>"
-    end
-    
-    def encoded
-      do_encode(CAPITALIZED_FIELD)
-    end
-    
-    def decoded
-      do_decode
-    end
-    
-    private
-    
-    def generate_message_id
-      "<#{Mail.random_tag}@#{::Socket.gethostname}.mail>"
-    end
-    
   end
 end

data/lib/mail/fields/mime_version_field.rb

@@ -1,35 +1,25 @@
 # encoding: utf-8
 # frozen_string_literal: true
-# 
-# 
-# 
+require 'mail/fields/named_structured_field'
+require 'mail/utilities'
+
 module Mail
-  class MimeVersionField < StructuredField
-    
-    FIELD_NAME = 'mime-version'
-    CAPITALIZED_FIELD = 'Mime-Version'
-
-    def initialize(value = nil, charset = 'utf-8')
-      self.charset = charset
-      if Utilities.blank?(value)
-        value = '1.0'
-      end
-      super(CAPITALIZED_FIELD, value, charset)
-      self.parse
-      self
-
-    end
-    
-    def parse(val = value)
-      unless Utilities.blank?(val)
-        @element = Mail::MimeVersionElement.new(val)
-      end
-    end
-    
+  class MimeVersionField < NamedStructuredField #:nodoc:
+    NAME = 'Mime-Version'
+
+    def self.singular?
+      true
+    end
+
+    def initialize(value = nil, charset = nil)
+      value = '1.0' if Utilities.blank?(value)
+      super value, charset
+    end
+
     def element
       @element ||= Mail::MimeVersionElement.new(value)
     end
-    
+
     def version
       "#{element.major}.#{element.minor}"
     end
@@ -41,14 +31,13 @@ module Mail
     def minor
       element.minor.to_i
     end
-    
+
     def encoded
-      "#{CAPITALIZED_FIELD}: #{version}\r\n"
+      "#{name}: #{version}\r\n"
     end
-    
+
     def decoded
       version
     end
-    
   end
 end

data/lib/mail/fields/named_structured_field.rb

@@ -0,0 +1,11 @@
+# encoding: utf-8
+# frozen_string_literal: true
+require 'mail/fields/structured_field'
+
+module Mail
+  class NamedStructuredField < StructuredField #:nodoc:
+    def initialize(value = nil, charset = nil)
+      super self.class::NAME, value, charset
+    end
+  end
+end

data/lib/mail/fields/named_unstructured_field.rb

@@ -0,0 +1,11 @@
+# encoding: utf-8
+# frozen_string_literal: true
+require 'mail/fields/unstructured_field'
+
+module Mail
+  class NamedUnstructuredField < UnstructuredField #:nodoc:
+    def initialize(value = nil, charset = nil)
+      super self.class::NAME, value, charset
+    end
+  end
+end

data/lib/mail/fields/optional_field.rb

@@ -1,14 +1,13 @@
 # encoding: utf-8
 # frozen_string_literal: true
-# 
-#    The field names of any optional-field MUST NOT be identical to any
-#    field name specified elsewhere in this standard.
-# 
-# optional-field  =       field-name ":" unstructured CRLF
 require 'mail/fields/unstructured_field'
 
 module Mail
-  class OptionalField < UnstructuredField
+  # The field names of any optional-field MUST NOT be identical to any
+  # field name specified elsewhere in this standard.
+  #
+  # optional-field  =       field-name ":" unstructured CRLF
+  class OptionalField < UnstructuredField #:nodoc:
     private
       def do_encode
         "#{wrapped_value}\r\n"

data/lib/mail/fields/{common/parameter_hash.rb → parameter_hash.rb}

@@ -1,31 +1,33 @@
 # encoding: utf-8
 # frozen_string_literal: true
-module Mail
+require 'mail/constants'
+require 'mail/indifferent_hash'
+require 'mail/encodings'
 
+module Mail
   # ParameterHash is an intelligent Hash that allows you to add
   # parameter values including the MIME extension paramaters that
   # have the name*0="blah", name*1="bleh" keys, and will just return
   # a single key called name="blahbleh" and do any required un-encoding
   # to make that happen
-  # Parameters are defined in RFC2045, split keys are in RFC2231
-
-  class ParameterHash < IndifferentHash
-
-    include Mail::Utilities
-
+  #
+  # Parameters are defined in RFC2045. Split keys are in RFC2231.
+  class ParameterHash < IndifferentHash #:nodoc:
     def [](key_name)
       key_pattern = Regexp.escape(key_name.to_s)
       pairs = []
       exact = nil
+
       each do |k,v|
         if k =~ /^#{key_pattern}(\*|$)/i
-          if $1 == ASTERISK
+          if $1 == Constants::ASTERISK
             pairs << [k, v]
           else
             exact = k
           end
         end
       end
+
       if pairs.empty? # Just dealing with a single value pair
         super(exact || key_name)
       else # Dealing with a multiple value pair or a single encoded value pair
@@ -46,13 +48,13 @@ module Mail
           value = Mail::Encodings.param_encode(value)
           key_name = "#{key_name}*"
         end
-        %Q{#{key_name}=#{quote_token(value)}}
+        %Q{#{key_name}=#{Utilities.quote_token(value)}}
       end.join(";\r\n\s")
     end
 
     def decoded
       map.sort_by { |a| a.first.to_s }.map! do |key_name, value|
-        %Q{#{key_name}=#{quote_token(value)}}
+        %Q{#{key_name}=#{Utilities.quote_token(value)}}
       end.join("; ")
     end
   end

data/lib/mail/fields/received_field.rb

@@ -1,76 +1,62 @@
 # encoding: utf-8
 # frozen_string_literal: true
-# 
-# trace           =       [return]
-#                         1*received
-# 
-# return          =       "Return-Path:" path CRLF
-# 
-# path            =       ([CFWS] "<" ([CFWS] / addr-spec) ">" [CFWS]) /
-#                         obs-path
-# 
-# received        =       "Received:" name-val-list ";" date-time CRLF
-# 
-# name-val-list   =       [CFWS] [name-val-pair *(CFWS name-val-pair)]
-# 
-# name-val-pair   =       item-name CFWS item-value
-# 
-# item-name       =       ALPHA *(["-"] (ALPHA / DIGIT))
-# 
-# item-value      =       1*angle-addr / addr-spec /
-#                          atom / domain / msg-id
-# 
+require 'mail/fields/named_structured_field'
+
 module Mail
-  class ReceivedField < StructuredField
-    
-    FIELD_NAME = 'received'
-    CAPITALIZED_FIELD = 'Received'
-    
-    def initialize(value = nil, charset = 'utf-8')
-      self.charset = charset
-      super(CAPITALIZED_FIELD, value, charset)
-      self.parse
-      self
+  # trace           =       [return]
+  #                         1*received
+  #
+  # return          =       "Return-Path:" path CRLF
+  #
+  # path            =       ([CFWS] "<" ([CFWS] / addr-spec) ">" [CFWS]) /
+  #                         obs-path
+  #
+  # received        =       "Received:" name-val-list ";" date-time CRLF
+  #
+  # name-val-list   =       [CFWS] [name-val-pair *(CFWS name-val-pair)]
+  #
+  # name-val-pair   =       item-name CFWS item-value
+  #
+  # item-name       =       ALPHA *(["-"] (ALPHA / DIGIT))
+  #
+  # item-value      =       1*angle-addr / addr-spec /
+  #                          atom / domain / msg-id
+  class ReceivedField < NamedStructuredField #:nodoc:
+    NAME = 'Received'
 
-    end
-    
-    def parse(val = value)
-      unless Utilities.blank?(val)
-        @element = Mail::ReceivedElement.new(val)
-      end
-    end
-    
     def element
       @element ||= Mail::ReceivedElement.new(value)
     end
-    
+
     def date_time
-      @datetime ||= ::DateTime.parse("#{element.date_time}")
+      @datetime ||= element.date_time
     end
 
     def info
       element.info
     end
-   
+
     def formatted_date
-      date_time.strftime("%a, %d %b %Y %H:%M:%S ") + date_time.zone.delete(':')
-    end
- 
-    def encoded
-      if Utilities.blank?(value)
-        "#{CAPITALIZED_FIELD}: \r\n"
-      else
-        "#{CAPITALIZED_FIELD}: #{info}; #{formatted_date}\r\n"
+      if date_time.respond_to? :strftime and date_time.respond_to? :zone
+        date_time.strftime("%a, %d %b %Y %H:%M:%S ") + date_time.zone.delete(':')
       end
     end
-    
-    def decoded
-      if Utilities.blank?(value)
-        ""
-      else
-        "#{info}; #{formatted_date}" 
+
+    private
+      def do_encode
+        if Utilities.blank?(value)
+          "#{name}: \r\n"
+        else
+          "#{name}: #{info}; #{formatted_date}\r\n"
+        end
+      end
+
+      def do_decode
+        if Utilities.blank?(value)
+          ""
+        else
+          "#{info}; #{formatted_date}"
+        end
       end
-    end
-    
   end
 end