mail 2.5.5 → 2.8.1

data/lib/mail/fields/mime_version_field.rb

@@ -1,34 +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 value.blank?
-        value = '1.0'
-      end
-      super(CAPITALIZED_FIELD, strip_field(FIELD_NAME, value), charset)
-      self.parse
-      self
-
-    end
-    
-    def parse(val = value)
-      unless val.blank?
-        @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
@@ -40,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,13 +1,16 @@
 # encoding: utf-8
-# 
-#    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
+# frozen_string_literal: true
 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"
+      end
   end
 end

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

@@ -1,35 +1,38 @@
 # encoding: utf-8
-module Mail
+# frozen_string_literal: true
+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 == '*'
+          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
         string = pairs.sort { |a,b| a.first.to_s <=> b.first.to_s }.map { |v| v.last }.join('')
-        if mt = string.match(/([\w\-]+)'(\w\w)'(.*)/)
+        if mt = string.match(/([\w\-]+)?'(\w\w)?'(.*)/)
           string = mt[3]
           encoding = mt[1]
         else
@@ -40,18 +43,18 @@ 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}*"
         end
-        %Q{#{key_name}=#{quote_token(value)}}
+        %Q{#{key_name}=#{Utilities.quote_token(value)}}
       end.join(";\r\n\s")
     end
 
     def decoded
-      map.sort { |a,b| a.first.to_s <=> b.first.to_s }.map do |key_name, value|
-        %Q{#{key_name}=#{quote_token(value)}}
+      map.sort_by { |a| a.first.to_s }.map! do |key_name, value|
+        %Q{#{key_name}=#{Utilities.quote_token(value)}}
       end.join("; ")
     end
   end

data/lib/mail/fields/received_field.rb

@@ -1,75 +1,62 @@
 # encoding: utf-8
-# 
-# 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
-# 
+# frozen_string_literal: true
+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, strip_field(FIELD_NAME, 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 val.blank?
-        @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 value.blank?
-        "#{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 value.blank?
-        ""
-      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

data/lib/mail/fields/references_field.rb

@@ -1,56 +1,43 @@
 # encoding: utf-8
-# 
-# = References Field
-# 
-# The References field inherits references StructuredField and handles the References: header
-# field in the email.
-# 
-# Sending references to a mail message will instantiate a Mail::Field object that
-# has a ReferencesField as its field type.  This includes all Mail::CommonAddress
-# 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 References field can appear in a header, though it can have multiple
-# Message IDs.
-# 
-# == Examples:
-# 
-#  mail = Mail.new
-#  mail.references = '<F6E2D0B4-CC35-4A91-BA4C-C7C712B10C13@test.me.dom>'
-#  mail.references    #=> '<F6E2D0B4-CC35-4A91-BA4C-C7C712B10C13@test.me.dom>'
-#  mail[:references]  #=> '#<Mail::Field:0x180e5e8 @field=#<Mail::ReferencesField:0x180e1c4
-#  mail['references'] #=> '#<Mail::Field:0x180e5e8 @field=#<Mail::ReferencesField:0x180e1c4
-#  mail['References'] #=> '#<Mail::Field:0x180e5e8 @field=#<Mail::ReferencesField:0x180e1c4
-# 
-#  mail[:references].message_ids #=> ['F6E2D0B4-CC35-4A91-BA4C-C7C712B10C13@test.me.dom']
-# 
-require 'mail/fields/common/common_message_id'
+# frozen_string_literal: true
+require 'mail/fields/common_message_id_field'
 
 module Mail
-  class ReferencesField < StructuredField
-    
-    include CommonMessageId
-    
-    FIELD_NAME = 'references'
-    CAPITALIZED_FIELD = 'References'
-    
-    def initialize(value = nil, charset = 'utf-8')
-      self.charset = charset
-      value = value.join("\r\n\s") if value.is_a?(Array)
-      super(CAPITALIZED_FIELD, strip_field(FIELD_NAME, value), charset)
-      self.parse
-      self
-    end
-    
-    def encoded
-      do_encode(CAPITALIZED_FIELD)
+  # = References Field
+  #
+  # The References field inherits references StructuredField and handles the References: header
+  # field in the email.
+  #
+  # Sending references to a mail message will instantiate a Mail::Field object that
+  # has a ReferencesField as its field type.  This includes all Mail::CommonAddress
+  # 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 References field can appear in a header, though it can have multiple
+  # Message IDs.
+  #
+  # == Examples:
+  #
+  #  mail = Mail.new
+  #  mail.references = '<F6E2D0B4-CC35-4A91-BA4C-C7C712B10C13@test.me.dom>'
+  #  mail.references    #=> '<F6E2D0B4-CC35-4A91-BA4C-C7C712B10C13@test.me.dom>'
+  #  mail[:references]  #=> '#<Mail::Field:0x180e5e8 @field=#<Mail::ReferencesField:0x180e1c4
+  #  mail['references'] #=> '#<Mail::Field:0x180e5e8 @field=#<Mail::ReferencesField:0x180e1c4
+  #  mail['References'] #=> '#<Mail::Field:0x180e5e8 @field=#<Mail::ReferencesField:0x180e1c4
+  #
+  #  mail[:references].message_ids #=> ['F6E2D0B4-CC35-4A91-BA4C-C7C712B10C13@test.me.dom']
+  class ReferencesField < CommonMessageIdField #:nodoc:
+    NAME = 'References'
+
+    def self.singular?
+      true
     end
-    
-    def decoded
-      do_decode
+
+    def initialize(value = nil, charset = nil)
+      value = value.join("\r\n\s") if value.is_a?(Array)
+      super value, charset
     end
-    
   end
 end

data/lib/mail/fields/reply_to_field.rb

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

data/lib/mail/fields/resent_bcc_field.rb

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

data/lib/mail/fields/resent_cc_field.rb

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