mail 2.7.1 → 2.8.0

data/lib/mail/fields/return_path_field.rb

@@ -1,65 +1,61 @@
 # encoding: utf-8
 # frozen_string_literal: true
-# 
-# 4.4.3.  REPLY-TO / RESENT-REPLY-TO
-# 
-#    Note:  The "Return-Path" field is added by the mail  transport
-#           service,  at the time of final deliver.  It is intended
-#           to identify a path back to the orginator  of  the  mes-
-#           sage.   The  "Reply-To"  field  is added by the message
-#           originator and is intended to direct replies.
-# 
-# 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/common/common_address'
+require 'mail/fields/common_address_field'
 
 module Mail
-  class ReturnPathField < StructuredField
-    
-    include Mail::CommonAddress
-    
-    FIELD_NAME = 'return-path'
-    CAPITALIZED_FIELD = 'Return-Path'
-    
-    def initialize(value = nil, charset = 'utf-8')
-      value = nil if value == '<>'
-      self.charset = charset
-      super(CAPITALIZED_FIELD, value, charset)
-      self
-    end
-    
-    def encoded
-      "#{CAPITALIZED_FIELD}: <#{address}>\r\n"
-    end
-    
-    def decoded
-      do_decode
+  # 4.4.3.  REPLY-TO / RESENT-REPLY-TO
+  #
+  #    Note:  The "Return-Path" field is added by the mail  transport
+  #           service,  at the time of final deliver.  It is intended
+  #           to identify a path back to the orginator  of  the  mes-
+  #           sage.   The  "Reply-To"  field  is added by the message
+  #           originator and is intended to direct replies.
+  #
+  # 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 ReturnPathField < CommonAddressField #:nodoc:
+    NAME = 'Return-Path'
+
+    def self.singular?
+      true
     end
-    
-    def address
-      addresses.first
+
+    def initialize(value = nil, charset = nil)
+      if value == '<>'
+        super nil, charset
+      else
+        super
+      end
     end
-    
+
     def default
       address
     end
-    
+
+    private
+      def do_encode
+        "#{name}: <#{address}>\r\n"
+      end
+
+      def do_decode
+        address
+      end
   end
 end

data/lib/mail/fields/sender_field.rb

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

data/lib/mail/fields/structured_field.rb

@@ -1,13 +1,13 @@
 # encoding: utf-8
 # frozen_string_literal: true
-require 'mail/fields/common/common_field'
+require 'mail/fields/common_field'
 
 module Mail
   # Provides access to a structured header field
   #
   # ===Per RFC 2822:
   #  2.2.2. Structured Header Field Bodies
-  #  
+  #
   #     Some field bodies in this standard have specific syntactical
   #     structure more restrictive than the unstructured field bodies
   #     described above. These are referred to as "structured" field bodies.
@@ -20,33 +20,6 @@ module Mail
   #     characters are subject to header "folding" and "unfolding" as
   #     described in section 2.2.3.  Semantic analysis of structured field
   #     bodies is given along with their syntax.
-  class StructuredField
-    
-    include Mail::CommonField
-    include Mail::Utilities
-    
-    def initialize(name = nil, value = nil, charset = nil)
-      self.name    = name
-      self.value   = value
-      self.charset = charset
-      self
-    end
-    
-    def charset
-      @charset
-    end
-    
-    def charset=(val)
-      @charset = val
-    end
-    
-    def default
-      decoded
-    end
-    
-    def errors
-      []
-    end
-
+  class StructuredField < CommonField #:nodoc:
   end
 end

data/lib/mail/fields/subject_field.rb

@@ -1,17 +1,15 @@
 # encoding: utf-8
 # frozen_string_literal: true
-# 
-# subject         =       "Subject:" unstructured CRLF
+require 'mail/fields/named_unstructured_field'
+
 module Mail
-  class SubjectField < UnstructuredField
-    
-    FIELD_NAME = 'subject'
-    CAPITALIZED_FIELD = "Subject"
-    
-    def initialize(value = nil, charset = 'utf-8')
-      self.charset = charset
-      super(CAPITALIZED_FIELD, value, charset)
+  #
+  # subject         =       "Subject:" unstructured CRLF
+  class SubjectField < NamedUnstructuredField #:nodoc:
+    NAME = 'Subject'
+
+    def self.singular?
+      true
     end
-    
   end
 end

data/lib/mail/fields/to_field.rb

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

data/lib/mail/fields/unstructured_field.rb

@@ -1,6 +1,7 @@
 # encoding: utf-8
 # frozen_string_literal: true
-require 'mail/fields/common/common_field'
+require 'mail/fields/common_field'
+require 'mail/utilities'
 
 module Mail
   # Provides access to an unstructured header field
@@ -15,58 +16,28 @@ module Mail
   #     field bodies are simply to be treated as a single line of characters
   #     with no further processing (except for header "folding" and
   #     "unfolding" as described in section 2.2.3).
-  class UnstructuredField
-
-    include Mail::CommonField
-    include Mail::Utilities
-
-    attr_accessor :charset
-    attr_reader :errors
-
+  class UnstructuredField < CommonField #:nodoc:
     def initialize(name, value, charset = nil)
-      @errors = []
-
       if value.is_a?(Array)
         # Probably has arrived here from a failed parse of an AddressList Field
         value = value.join(', ')
-      else
-        # Ensure we are dealing with a string
-        value = value.to_s
 
-        # Mark UTF-8 strings parsed from ASCII-8BIT
-        if value.respond_to?(:force_encoding) && value.encoding == Encoding::ASCII_8BIT
-          utf8 = value.dup.force_encoding(Encoding::UTF_8)
-          value = utf8 if utf8.valid_encoding?
-        end
+      # Mark UTF-8 strings parsed from ASCII-8BIT
+      elsif value.respond_to?(:force_encoding) && value.encoding == Encoding::ASCII_8BIT
+        utf8 = value.dup.force_encoding(Encoding::UTF_8)
+        value = utf8 if utf8.valid_encoding?
       end
 
-      if charset
-        self.charset = charset
-      else
+      charset ||=
         if value.respond_to?(:encoding)
-          self.charset = value.encoding
-        else
-          self.charset = $KCODE
+          value.encoding
         end
-      end
-      self.name = name
-      self.value = value
-      self
-    end
-
-    def encoded
-      do_encode
-    end
 
-    def decoded
-      do_decode
+      super name, value.to_s, charset
     end
 
-    def default
-      decoded
-    end
-
-    def parse # An unstructured field does not parse
+    # An unstructured field does not parse
+    def parse
       self
     end
 
@@ -196,7 +167,7 @@ module Mail
     end
 
     def encode(value)
-      value = [value].pack(CAPITAL_M).gsub(EQUAL_LF, EMPTY)
+      value = [value].pack(Constants::CAPITAL_M).gsub(Constants::EQUAL_LF, Constants::EMPTY)
       value.gsub!(/"/,  '=22')
       value.gsub!(/\(/, '=28')
       value.gsub!(/\)/, '=29')
@@ -207,16 +178,13 @@ module Mail
     end
 
     def encode_crlf(value)
-      value.gsub!(CR, CR_ENCODED)
-      value.gsub!(LF, LF_ENCODED)
+      value.gsub!(Constants::CR, Constants::CR_ENCODED)
+      value.gsub!(Constants::LF, Constants::LF_ENCODED)
       value
     end
 
     def normalized_encoding
-      encoding = charset.to_s.upcase.gsub('_', '-')
-      encoding = 'UTF-8' if encoding == 'UTF8' # Ruby 1.8.x and $KCODE == 'u'
-      encoding
+      charset.to_s.upcase.gsub('_', '-')
     end
-
   end
 end