mail 2.8.1 → 2.9.0.beta1

data/lib/mail/fields/content_type_field.rb

@@ -1,7 +1,5 @@
 # encoding: utf-8
 # frozen_string_literal: true
-require 'mail/fields/named_structured_field'
-require 'mail/fields/parameter_hash'
 
 module Mail
   class ContentTypeField < NamedStructuredField #:nodoc:
@@ -129,15 +127,16 @@ module Mail
         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=#{Utilities.quote_atom($3)}"
-      when val.chomp =~ /^text;?$/i
+      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
@@ -153,7 +152,7 @@ module Mail
         params = params.map { |i| i.split(/\s*\=\s*/, 2) }
         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

data/lib/mail/fields/date_field.rb

@@ -1,6 +1,5 @@
 # encoding: utf-8
 # frozen_string_literal: true
-require 'mail/fields/common_date_field'
 
 module Mail
   # = Date Field

data/lib/mail/fields/from_field.rb

@@ -1,6 +1,5 @@
 # encoding: utf-8
 # frozen_string_literal: true
-require 'mail/fields/common_address_field'
 
 module Mail
   # = From Field

data/lib/mail/fields/in_reply_to_field.rb

@@ -1,6 +1,5 @@
 # encoding: utf-8
 # frozen_string_literal: true
-require 'mail/fields/common_message_id_field'
 
 module Mail
   # = In-Reply-To Field

data/lib/mail/fields/keywords_field.rb

@@ -1,6 +1,5 @@
 # encoding: utf-8
 # frozen_string_literal: true
-require 'mail/fields/named_structured_field'
 
 module Mail
   # keywords        =       "Keywords:" phrase *("," phrase) CRLF

data/lib/mail/fields/message_id_field.rb

@@ -1,6 +1,5 @@
 # encoding: utf-8
 # frozen_string_literal: true
-require 'mail/fields/common_message_id_field'
 require 'mail/utilities'
 
 module Mail

data/lib/mail/fields/mime_version_field.rb

@@ -1,11 +1,10 @@
 # encoding: utf-8
 # frozen_string_literal: true
-require 'mail/fields/named_structured_field'
 require 'mail/utilities'
 
 module Mail
   class MimeVersionField < NamedStructuredField #:nodoc:
-    NAME = 'Mime-Version'
+    NAME = 'MIME-Version'
 
     def self.singular?
       true

data/lib/mail/fields/named_structured_field.rb

@@ -1,6 +1,5 @@
 # encoding: utf-8
 # frozen_string_literal: true
-require 'mail/fields/structured_field'
 
 module Mail
   class NamedStructuredField < StructuredField #:nodoc:

data/lib/mail/fields/named_unstructured_field.rb

@@ -1,6 +1,5 @@
 # encoding: utf-8
 # frozen_string_literal: true
-require 'mail/fields/unstructured_field'
 
 module Mail
   class NamedUnstructuredField < UnstructuredField #:nodoc:

data/lib/mail/fields/optional_field.rb

@@ -1,6 +1,5 @@
 # encoding: utf-8
 # frozen_string_literal: true
-require 'mail/fields/unstructured_field'
 
 module Mail
   # The field names of any optional-field MUST NOT be identical to any

data/lib/mail/fields/received_field.rb

@@ -1,6 +1,5 @@
 # encoding: utf-8
 # frozen_string_literal: true
-require 'mail/fields/named_structured_field'
 
 module Mail
   # trace           =       [return]

data/lib/mail/fields/references_field.rb

@@ -1,6 +1,5 @@
 # encoding: utf-8
 # frozen_string_literal: true
-require 'mail/fields/common_message_id_field'
 
 module Mail
   # = References Field

data/lib/mail/fields/reply_to_field.rb

@@ -1,6 +1,5 @@
 # encoding: utf-8
 # frozen_string_literal: true
-require 'mail/fields/common_address_field'
 
 module Mail
   # = Reply-To Field

data/lib/mail/fields/resent_bcc_field.rb

@@ -1,6 +1,5 @@
 # encoding: utf-8
 # frozen_string_literal: true
-require 'mail/fields/common_address_field'
 
 module Mail
   # = Resent-Bcc Field

data/lib/mail/fields/resent_cc_field.rb

@@ -1,6 +1,5 @@
 # encoding: utf-8
 # frozen_string_literal: true
-require 'mail/fields/common_address_field'
 
 module Mail
   # = Resent-Cc Field

data/lib/mail/fields/resent_date_field.rb

@@ -1,6 +1,5 @@
 # encoding: utf-8
 # frozen_string_literal: true
-require 'mail/fields/common_date_field'
 
 module Mail
   #

data/lib/mail/fields/resent_from_field.rb

@@ -1,6 +1,5 @@
 # encoding: utf-8
 # frozen_string_literal: true
-require 'mail/fields/common_address_field'
 
 module Mail
   # = Resent-From Field

data/lib/mail/fields/resent_message_id_field.rb

@@ -1,6 +1,5 @@
 # encoding: utf-8
 # frozen_string_literal: true
-require 'mail/fields/common_message_id_field'
 
 module Mail
   #

data/lib/mail/fields/resent_sender_field.rb

@@ -1,6 +1,5 @@
 # encoding: utf-8
 # frozen_string_literal: true
-require 'mail/fields/common_address_field'
 
 module Mail
   # = Resent-Sender Field

data/lib/mail/fields/resent_to_field.rb

@@ -1,6 +1,5 @@
 # encoding: utf-8
 # frozen_string_literal: true
-require 'mail/fields/common_address_field'
 
 module Mail
   # = Resent-To Field

data/lib/mail/fields/return_path_field.rb

@@ -1,6 +1,5 @@
 # encoding: utf-8
 # frozen_string_literal: true
-require 'mail/fields/common_address_field'
 
 module Mail
   # 4.4.3.  REPLY-TO / RESENT-REPLY-TO

data/lib/mail/fields/sender_field.rb

@@ -1,6 +1,5 @@
 # encoding: utf-8
 # frozen_string_literal: true
-require 'mail/fields/common_address_field'
 
 module Mail
   # = Sender Field

data/lib/mail/fields/structured_field.rb

@@ -1,6 +1,5 @@
 # encoding: utf-8
 # frozen_string_literal: true
-require 'mail/fields/common_field'
 
 module Mail
   # Provides access to a structured header field

data/lib/mail/fields/subject_field.rb

@@ -1,6 +1,5 @@
 # encoding: utf-8
 # frozen_string_literal: true
-require 'mail/fields/named_unstructured_field'
 
 module Mail
   #

data/lib/mail/fields/to_field.rb

@@ -1,6 +1,5 @@
 # encoding: utf-8
 # frozen_string_literal: true
-require 'mail/fields/common_address_field'
 
 module Mail
   # = To Field

data/lib/mail/fields/unstructured_field.rb

@@ -1,6 +1,5 @@
 # encoding: utf-8
 # frozen_string_literal: true
-require 'mail/fields/common_field'
 require 'mail/utilities'
 
 module Mail

data/lib/mail/fields.rb

@@ -1,6 +1,12 @@
 # frozen_string_literal: true
 module Mail
+  register_autoload :CommonField, 'mail/fields/common_field'
+  register_autoload :CommonAddressField, 'mail/fields/common_address_field'
+  register_autoload :CommonMessageIdField, 'mail/fields/common_message_id_field'
+  register_autoload :CommonDateField, 'mail/fields/common_date_field'
+
   register_autoload :UnstructuredField, 'mail/fields/unstructured_field'
+  register_autoload :NamedUnstructuredField, 'mail/fields/named_unstructured_field'
   register_autoload :StructuredField, 'mail/fields/structured_field'
   register_autoload :OptionalField, 'mail/fields/optional_field'
 
@@ -19,6 +25,7 @@ module Mail
   register_autoload :KeywordsField, 'mail/fields/keywords_field'
   register_autoload :MessageIdField, 'mail/fields/message_id_field'
   register_autoload :MimeVersionField, 'mail/fields/mime_version_field'
+  register_autoload :NamedStructuredField, 'mail/fields/named_structured_field'
   register_autoload :ReceivedField, 'mail/fields/received_field'
   register_autoload :ReferencesField, 'mail/fields/references_field'
   register_autoload :ReplyToField, 'mail/fields/reply_to_field'
@@ -33,4 +40,6 @@ module Mail
   register_autoload :SenderField, 'mail/fields/sender_field'
   register_autoload :SubjectField, 'mail/fields/subject_field'
   register_autoload :ToField, 'mail/fields/to_field'
+
+  register_autoload :ParameterHash, 'mail/fields/parameter_hash'
 end

data/lib/mail/header.rb

@@ -217,7 +217,7 @@ module Mail
 
     # Returns true if the header has a MIME version defined (empty or not)
     def has_mime_version?
-      fields.has_field? 'Mime-Version'
+      fields.has_field? 'MIME-Version'
     end
 
     private

data/lib/mail/mail.rb

@@ -3,45 +3,45 @@
 module Mail
 
   # Allows you to create a new Mail::Message object.
-  # 
+  #
   # You can make an email via passing a string or passing a block.
-  # 
+  #
   # For example, the following two examples will create the same email
   # message:
-  # 
+  #
   # Creating via a string:
-  # 
+  #
   #  string = "To: mikel@test.lindsaar.net\r\n"
   #  string << "From: bob@test.lindsaar.net\r\n"
   #  string << "Subject: This is an email\r\n"
   #  string << "\r\n"
   #  string << "This is the body"
   #  Mail.new(string)
-  # 
+  #
   # Or creating via a block:
-  # 
+  #
   #  message = Mail.new do
   #    to 'mikel@test.lindsaar.net'
   #    from 'bob@test.lindsaar.net'
   #    subject 'This is an email'
   #    body 'This is the body'
   #  end
-  # 
+  #
   # Or creating via a hash (or hash like object):
-  # 
+  #
   #  message = Mail.new({:to => 'mikel@test.lindsaar.net',
   #                      'from' => 'bob@test.lindsaar.net',
   #                      :subject => 'This is an email',
   #                      :body => 'This is the body' })
-  # 
+  #
   # Note, the hash keys can be strings or symbols, the passed in object
   # does not need to be a hash, it just needs to respond to :each_pair
   # and yield each key value pair.
-  # 
+  #
   # As a side note, you can also create a new email through creating
   # a Mail::Message object directly and then passing in values via string,
   # symbol or direct method calls.  See Mail::Message for more information.
-  # 
+  #
   #  mail = Mail.new
   #  mail.to = 'mikel@test.lindsaar.net'
   #  mail[:from] = 'bob@test.lindsaar.net'
@@ -54,20 +54,20 @@ module Mail
   # Sets the default delivery method and retriever method for all new Mail objects.
   # The delivery_method and retriever_method default to :smtp and :pop3, with defaults
   # set.
-  # 
+  #
   # So sending a new email, if you have an SMTP server running on localhost is
   # as easy as:
-  # 
+  #
   #   Mail.deliver do
   #     to      'mikel@test.lindsaar.net'
   #     from    'bob@test.lindsaar.net'
   #     subject 'hi there!'
   #     body    'this is a body'
   #   end
-  # 
+  #
   # If you do not specify anything, you will get the following equivalent code set in
   # every new mail object:
-  # 
+  #
   #   Mail.defaults do
   #     delivery_method :smtp, { :address              => "localhost",
   #                              :port                 => 25,
@@ -76,14 +76,14 @@ module Mail
   #                              :password             => nil,
   #                              :authentication       => nil,
   #                              :enable_starttls_auto => true  }
-  # 
+  #
   #     retriever_method :pop3, { :address             => "localhost",
   #                               :port                => 995,
   #                               :user_name           => nil,
   #                               :password            => nil,
   #                               :enable_ssl          => true }
   #   end
-  # 
+  #
   #   Mail.delivery_method.new  #=> Mail::SMTP instance
   #   Mail.retriever_method.new #=> Mail::POP3 instance
   #
@@ -91,9 +91,9 @@ module Mail
   # a per email basis, you can override the method:
   #
   #   mail.delivery_method :smtp
-  # 
+  #
   # Or you can override the method and pass in settings:
-  # 
+  #
   #   mail.delivery_method :smtp, :address => 'some.host'
   def self.defaults(&block)
     Configuration.instance.instance_eval(&block)
@@ -112,21 +112,21 @@ module Mail
   # Send an email using the default configuration.  You do need to set a default
   # configuration first before you use self.deliver, if you don't, an appropriate
   # error will be raised telling you to.
-  # 
+  #
   # If you do not specify a delivery type, SMTP will be used.
-  # 
+  #
   #  Mail.deliver do
   #   to 'mikel@test.lindsaar.net'
   #   from 'ada@test.lindsaar.net'
   #   subject 'This is a test email'
   #   body 'Not much to say here'
   #  end
-  # 
+  #
   # You can also do:
-  # 
+  #
   #  mail = Mail.read('email.eml')
   #  mail.deliver!
-  # 
+  #
   # And your email object will be created and sent.
   def self.deliver(*args, &block)
     mail = self.new(args, &block)
@@ -152,7 +152,7 @@ module Mail
     retriever_method.first(*args, &block)
   end
 
-  # Receive the first email(s) from the default retriever
+  # Receive the last email(s) from the default retriever
   # See Mail::Retriever for a complete documentation.
   def self.last(*args, &block)
     retriever_method.last(*args, &block)
@@ -190,7 +190,7 @@ module Mail
 
   # You can register an object to be informed of every email that is sent through
   # this method.
-  # 
+  #
   # Your object needs to respond to a single method #delivered_email(mail)
   # which receives the email that is sent.
   def self.register_observer(observer)
@@ -208,7 +208,7 @@ module Mail
   # You can register an object to be given every mail object that will be sent,
   # before it is sent.  So if you want to add special headers or modify any
   # email that gets sent through the Mail library, you can do so.
-  # 
+  #
   # Your object needs to respond to a single method #delivering_email(mail)
   # which receives the email that is about to be sent.  Make your modifications
   # directly to this object.
@@ -236,6 +236,11 @@ module Mail
     end
   end
 
+  # Returns a list of registered delivery interceptors.
+  def self.delivery_interceptors
+    @@delivery_interceptors
+  end
+
   protected
 
   RANDOM_TAG='%x%x_%x%x%d%x'

data/lib/mail/message.rb

@@ -294,7 +294,7 @@ module Mail
           reply.references ||= bracketed_message_id
         end
         if subject
-          reply.subject = subject =~ /^Re:/i ? subject : "Re: #{subject}"
+          reply.subject = /^Re:/i.match?(subject) ? subject : "Re: #{subject}"
         end
         if reply_to || from
           reply.to = self[reply_to ? :reply_to : :from].to_s
@@ -349,6 +349,10 @@ module Mail
     # the same content, ignoring the Message-ID field, unless BOTH emails have a defined and
     # different Message-ID value, then they are false.
     #
+    # Note that Mail creates Date and Mime-Type fields if they don't exist.
+    # The Date field is derived from the current time, so this needs to be allowed for in comparisons.
+    # (Mime-type does not depend on dynamic data, so cannot affect equality)
+    #
     # So, in practice the == operator works like this:
     #
     #  m1 = Mail.new("Subject: Hello\r\n\r\nHello")
@@ -370,14 +374,17 @@ module Mail
     #  m1 = Mail.new("Message-ID: <1234@test>\r\nSubject: Hello\r\n\r\nHello")
     #  m2 = Mail.new("Message-ID: <DIFFERENT@test>\r\nSubject: Hello\r\n\r\nHello")
     #  m1 == m2 #=> false
-    def ==(other)
+    def ==(other) # TODO could be more efficient
       return false unless other.respond_to?(:encoded)
 
+      stamp = Mail::CommonDateField.normalize_datetime('')
+      # Note: must always dup the inputs so they are not altered by encoded
       if self.message_id && other.message_id
-        self.encoded == other.encoded
+        dup.tap { |m| m.date ||= stamp }.encoded ==
+          other.dup.tap { |m| m.date ||= stamp }.encoded
       else
-        dup.tap { |m| m.message_id = '<temp@test>' }.encoded ==
-          other.dup.tap { |m| m.message_id = '<temp@test>' }.encoded
+        dup.tap { |m| m.message_id = '<temp@test>'; m.date ||= stamp }.encoded ==
+          other.dup.tap { |m| m.message_id = '<temp@test>'; m.date ||= stamp }.encoded
       end
     end
 
@@ -464,7 +471,7 @@ module Mail
     #  message.errors.size #=> 1
     #  message.errors.first[0] #=> "Content-Transfer-Encoding"
     #  message.errors.first[1] #=> "weirdo"
-    #  message.errors.first[3] #=> <The original error message exception>
+    #  message.errors.first[2] #=> <The original error message exception>
     #
     # This is a good first defence on detecting spam by the way.  Some spammers send
     # invalid emails to try and get email parsers to give up parsing them.
@@ -1316,7 +1323,7 @@ module Mail
     def []=(name, value)
       if name.to_s == 'body'
         self.body = value
-      elsif name.to_s =~ /content[-_]type/i
+      elsif /content[-_]type/i.match?(name.to_s)
         header[name] = value
       elsif name.to_s == 'charset'
         self.charset = value
@@ -1409,7 +1416,7 @@ module Mail
       header.has_date?
     end
 
-    # Returns true if the message has a Mime-Version field, the field may or may
+    # Returns true if the message has a MIME-Version field, the field may or may
     # not have a value, but the field exists or not.
     def has_mime_version?
       header.has_mime_version?
@@ -1526,17 +1533,17 @@ module Mail
 
     # Returns true if the message is multipart
     def multipart?
-      has_content_type? ? !!(main_type =~ /^multipart$/i) : false
+      has_content_type? ? /^multipart$/i.match?(main_type) : false
     end
 
     # Returns true if the message is a multipart/report
     def multipart_report?
-      multipart? && sub_type =~ /^report$/i
+      multipart? && /^report$/i.match?(sub_type)
     end
 
     # Returns true if the message is a multipart/report; report-type=delivery-status;
     def delivery_status_report?
-      multipart_report? && content_type_parameters['report-type'] =~ /^delivery-status$/i
+      multipart_report? && /^delivery-status$/i.match?(content_type_parameters['report-type'])
     end
 
     # returns the part in a multipart/report email that has the content-type delivery-status
@@ -1855,7 +1862,7 @@ module Mail
           m.transport_encoding(v)
         when k == 'multipart_body'
           v.map {|part| m.add_part Mail::Part.from_yaml(part) }
-        when k =~ /^@/
+        when k.start_with?('@')
           m.instance_variable_set(k.to_sym, v)
         end
       end
@@ -1892,7 +1899,7 @@ module Mail
       when !self.multipart?
         body.decoded
       else
-        raise NoMethodError, 'Can not decode an entire message, try calling #decoded on the various fields and body or parts if it is a multipart message.'
+        raise NoMethodError, 'This message cannot be decoded as _entire_ message, try calling #decoded on the various fields and body or parts if it is a multipart message.'
       end
     end
 
@@ -1962,7 +1969,7 @@ module Mail
     end
 
     def text?
-      has_content_type? ? !!(main_type =~ /^text$/i) : false
+      has_content_type? ? /^text$/i.match?(main_type) : false
     end
 
   private
@@ -2066,11 +2073,7 @@ module Mail
 
     def add_boundary
       unless body.boundary && boundary
-        unless header['content-type']
-          _charset = charset
-          header['content-type'] = 'multipart/mixed'
-          header['content-type'].parameters[:charset] = _charset
-        end
+        header['content-type'] = 'multipart/mixed' unless header['content-type']
         header['content-type'].parameters[:boundary] = ContentTypeField.generate_boundary
         body.boundary = boundary
       end

data/lib/mail/multibyte/chars.rb

@@ -46,7 +46,7 @@ module Mail #:nodoc:
 
       # Forward all undefined methods to the wrapped string.
       def method_missing(method, *args, &block)
-        if method.to_s =~ /!$/
+        if method.to_s.end_with?('!')
           @wrapped_string.__send__(method, *args, &block)
           self
         else

data/lib/mail/multibyte/unicode.rb

@@ -375,7 +375,7 @@ module Mail
 
         # Returns the directory in which the data files are stored
         def self.dirname
-          File.dirname(__FILE__) + '/../values/'
+          __dir__ + '/../values/'
         end
 
         # Returns the filename for the data file for this version

data/lib/mail/network/delivery_methods/file_delivery.rb

@@ -4,12 +4,12 @@ require 'mail/smtp_envelope'
 module Mail
   # FileDelivery class delivers emails into multiple files based on the destination
   # address.  Each file is appended to if it already exists.
-  # 
+  #
   # So if you have an email going to fred@test, bob@test, joe@anothertest, and you
   # set your location path to /path/to/mails then FileDelivery will create the directory
   # if it does not exist, and put one copy of the email in three files, called
   # by their message id
-  # 
+  #
   # Make sure the path you specify with :location is writable by the Ruby process
   # running Mail.
   class FileDelivery