mail 2.7.1 → 2.9.1

data/lib/mail/fields/content_type_field.rb

@@ -1,53 +1,53 @@
 # encoding: utf-8
 # frozen_string_literal: true
-require 'mail/fields/common/parameter_hash'
 
 module Mail
-  class ContentTypeField < StructuredField
+  class ContentTypeField < NamedStructuredField #:nodoc:
+    NAME = 'Content-Type'
 
-    FIELD_NAME = 'content-type'
-    CAPITALIZED_FIELD = 'Content-Type'
+    class << self
+      def singular?
+        true
+      end
+
+      def with_boundary(type)
+        new "#{type}; boundary=#{generate_boundary}"
+      end
+
+      def generate_boundary
+        "--==_mimepart_#{Mail.random_tag}"
+      end
+    end
 
-    def initialize(value = nil, charset = 'utf-8')
-      self.charset = charset
-      if value.class == Array
+    def initialize(value = nil, charset = nil)
+      if value.is_a? Array
         @main_type = value[0]
         @sub_type = value[1]
         @parameters = ParameterHash.new.merge!(value.last)
       else
         @main_type = nil
         @sub_type = nil
-        @parameters = nil
         value = value.to_s
       end
-      value = ensure_filename_quoted(value)
-      super(CAPITALIZED_FIELD, value, charset)
-      self.parse
-      self
-    end
 
-    def parse(val = value)
-      unless Utilities.blank?(val)
-        self.value = val
-        @element = nil
-        element
-      end
+      super ensure_filename_quoted(value), charset
     end
 
     def element
-      begin
-        @element ||= Mail::ContentTypeElement.new(value)
-      rescue
-        attempt_to_clean
-      end
+      @element ||=
+        begin
+          Mail::ContentTypeElement.new(value)
+        rescue Mail::Field::ParseError
+          attempt_to_clean
+        end
     end
 
     def attempt_to_clean
       # Sanitize the value, handle special cases
-      @element ||= Mail::ContentTypeElement.new(sanatize(value))
-    rescue
+      Mail::ContentTypeElement.new(sanitize(value))
+    rescue Mail::Field::ParseError
       # All else fails, just get the MIME media type
-      @element ||= Mail::ContentTypeElement.new(get_mime_type(value))
+      Mail::ContentTypeElement.new(get_mime_type(value))
     end
 
     def main_type
@@ -61,31 +61,22 @@ module Mail
     def string
       "#{main_type}/#{sub_type}"
     end
+    alias_method :content_type, :string
 
     def default
       decoded
     end
 
-    alias :content_type :string
-
     def parameters
-      unless @parameters
+      unless defined? @parameters
         @parameters = ParameterHash.new
         element.parameters.each { |p| @parameters.merge!(p) }
       end
       @parameters
     end
 
-    def ContentTypeField.with_boundary(type)
-      new("#{type}; boundary=#{generate_boundary}")
-    end
-
-    def ContentTypeField.generate_boundary
-      "--==_mimepart_#{Mail.random_tag}"
-    end
-
     def value
-      if @value.class == Array
+      if @value.is_a? Array
         "#{@main_type}/#{@sub_type}; #{stringify(parameters)}"
       else
         @value
@@ -97,34 +88,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}"
-      else
-        p = ""
-      end
-      "#{CAPITALIZED_FIELD}: #{content_type}#{p}\r\n"
+      p = ";\r\n\s#{parameters.encoded}" if parameters && parameters.length > 0
+      "#{name}: #{content_type}#{p}\r\n"
     end
 
     def decoded
-      if parameters.length > 0
-        p = "; #{parameters.decoded}"
-      else
-        p = ""
-      end
-      "#{content_type}" + p
+      p = "; #{parameters.decoded}" if parameters && parameters.length > 0
+      "#{content_type}#{p}"
     end
 
     private
@@ -140,34 +114,34 @@ module Mail
 
     # Various special cases from random emails found that I am not going to change
     # the parser for
-    def sanatize( val )
-
+    def sanitize(val)
       # TODO: check if there are cases where whitespace is not a separator
       val = val.
         gsub(/\s*=\s*/,'='). # remove whitespaces around equal sign
         gsub(/[; ]+/, '; '). #use '; ' as a separator (or EOL)
         gsub(/;\s*$/,'') #remove trailing to keep examples below
 
-      if val =~ /(boundary=(\S*))/i
-        val = "#{$`.downcase}boundary=#{$2}#{$'.downcase}"
+      if val =~ /((boundary|name|filename)=(\S*))/i
+        val = "#{$`.downcase}#{$2}=#{$3}#{$'.downcase}"
       else
         val.downcase!
       end
 
+      val_chomp = val.chomp
       case
-      when val.chomp =~ /^\s*([\w\-]+)\/([\w\-]+)\s*;\s?(ISO[\w\-]+)$/i
+      when val_chomp =~ /^\s*([\w\-]+)\/([\w\-]+)\s*;\s?(ISO[\w\-]+)$/i
         # Microsoft helper:
         # Handles 'type/subtype;ISO-8559-1'
-        "#{$1}/#{$2}; charset=#{quote_atom($3)}"
-      when val.chomp =~ /^text;?$/i
+        "#{$1}/#{$2}; charset=#{Utilities.quote_atom($3)}"
+      when /^text;?$/i.match?(val_chomp)
         # Handles 'text;' and 'text'
         "text/plain;"
-      when val.chomp =~ /^(\w+);\s(.*)$/i
+      when val_chomp =~ /^(\w+);\s(.*)$/i
         # Handles 'text; <parameters>'
         "text/plain; #{$2}"
       when val =~ /([\w\-]+\/[\w\-]+);\scharset="charset="(\w+)""/i
         # Handles text/html; charset="charset="GB2312""
-        "#{$1}; charset=#{quote_atom($2)}"
+        "#{$1}; charset=#{Utilities.quote_atom($2)}"
       when val =~ /([\w\-]+\/[\w\-]+);\s+(.*)/i
         type = $1
         # Handles misquoted param values
@@ -176,18 +150,18 @@ module Mail
         params = $2.to_s.split(/\s+/)
         params = params.map { |i| i.to_s.chomp.strip }
         params = params.map { |i| i.split(/\s*\=\s*/, 2) }
-        params = params.map { |i| "#{i[0]}=#{dquote(i[1].to_s.gsub(/;$/,""))}" }.join('; ')
+        params = params.map { |i| "#{i[0]}=#{Utilities.dquote(i[1].to_s.gsub(/;$/,""))}" }.join('; ')
         "#{type}; #{params}"
-      when val =~ /^\s*$/
+      when /^\s*$/.match?(val)
         'text/plain'
       else
         val
       end
     end
 
-    def get_mime_type( val )
-      case
-      when val =~ /^([\w\-]+)\/([\w\-]+);.+$/i
+    def get_mime_type(val)
+      case val
+      when /^([\w\-]+)\/([\w\-]+);.+$/i
         "#{$1}/#{$2}"
       else
         'text/plain'

data/lib/mail/fields/date_field.rb

@@ -1,57 +1,28 @@
 # encoding: utf-8
 # frozen_string_literal: true
-#
-# = Date Field
-#
-# The Date field inherits from StructuredField and handles the Date: header
-# field in the email.
-#
-# Sending date to a mail message will instantiate a Mail::Field object that
-# has a DateField as its field type.  This includes all Mail::CommonAddress
-# module instance methods.
-#
-# There must be excatly one Date field in an RFC2822 email.
-#
-# == Examples:
-#
-#  mail = Mail.new
-#  mail.date = 'Mon, 24 Nov 1997 14:22:01 -0800'
-#  mail.date       #=> #<DateTime: 211747170121/86400,-1/3,2299161>
-#  mail.date.to_s  #=> 'Mon, 24 Nov 1997 14:22:01 -0800'
-#  mail[:date]     #=> '#<Mail::Field:0x180e5e8 @field=#<Mail::DateField:0x180e1c4
-#  mail['date']    #=> '#<Mail::Field:0x180e5e8 @field=#<Mail::DateField:0x180e1c4
-#  mail['Date']    #=> '#<Mail::Field:0x180e5e8 @field=#<Mail::DateField:0x180e1c4
-#
-require 'mail/fields/common/common_date'
 
 module Mail
-  class DateField < StructuredField
-
-    include Mail::CommonDate
-
-    FIELD_NAME = 'date'
-    CAPITALIZED_FIELD = "Date"
-
-    def initialize(value = nil, charset = 'utf-8')
-      self.charset = charset
-      if Utilities.blank?(value)
-        value = ::DateTime.now.strftime('%a, %d %b %Y %H:%M:%S %z')
-      else
-        value = value.to_s.gsub(/\(.*?\)/, '').squeeze(' ')
-        value = ::DateTime.parse(value).strftime('%a, %d %b %Y %H:%M:%S %z')
-      end
-      super(CAPITALIZED_FIELD, value, charset)
-    rescue ArgumentError => e
-      raise e unless "invalid date"==e.message
-    end
-
-    def encoded
-      do_encode(CAPITALIZED_FIELD)
-    end
-
-    def decoded
-      do_decode
-    end
-
+  # = Date Field
+  #
+  # The Date field inherits from StructuredField and handles the Date: header
+  # field in the email.
+  #
+  # Sending date to a mail message will instantiate a Mail::Field object that
+  # has a DateField as its field type.  This includes all Mail::CommonAddress
+  # module instance methods.
+  #
+  # There must be excatly one Date field in an RFC2822 email.
+  #
+  # == Examples:
+  #
+  #  mail = Mail.new
+  #  mail.date = 'Mon, 24 Nov 1997 14:22:01 -0800'
+  #  mail.date       #=> #<DateTime: 211747170121/86400,-1/3,2299161>
+  #  mail.date.to_s  #=> 'Mon, 24 Nov 1997 14:22:01 -0800'
+  #  mail[:date]     #=> '#<Mail::Field:0x180e5e8 @field=#<Mail::DateField:0x180e1c4
+  #  mail['date']    #=> '#<Mail::Field:0x180e5e8 @field=#<Mail::DateField:0x180e1c4
+  #  mail['Date']    #=> '#<Mail::Field:0x180e5e8 @field=#<Mail::DateField:0x180e1c4
+  class DateField < CommonDateField #:nodoc:
+    NAME = 'Date'
   end
 end

data/lib/mail/fields/from_field.rb

@@ -1,55 +1,33 @@
 # 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'
 
 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,45 @@
 # 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'
 
 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,30 @@
 # encoding: utf-8
 # frozen_string_literal: true
-# 
-# keywords        =       "Keywords:" phrase *("," phrase) CRLF
+
 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,36 @@
 # 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/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