mail 2.8.1 → 2.9.0.beta1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ea4015fe2858f6c1b123e04d4d407169567b1aeea1155b7b145fe75d9d3781b5
-  data.tar.gz: 20cdb386c2f878560b9f61ab63b4f0c264c9f9115af5c835b8c66f49486cb274
+  metadata.gz: b7d3d2a36ffc97d1a84f842a67d70c095c6b2533a31913dc5d9ba5d54730fbd4
+  data.tar.gz: 6f734ec59136e640ce168eecfc9b8b8a1f5800e7de58ccb1fe0549ad2b9f1954
 SHA512:
-  metadata.gz: b2eb55bc6f51b2d93e6d6abed5bb74876b3f96fd1eea00105047b3a211007b2b906ac89bcd1bed52603c211c595d439b6642bd897943decbcc9ac541f88e2049
-  data.tar.gz: 063dd68ef655b93d96412bdcf66ab6f191eaf0bfbafa10730ecfa99a447eb3d2a4469d6d1de67ae144bbaada65eaec4c7d8dbb5fe04509146dc1434a5c557fff
+  metadata.gz: 8f221754abf53c21e94c4c728e0b6a9fac5fdae869aea44167bd3fc43cce5e7f635c722bf477d1f54c9e0e01826be5b36321ea1f6b03ac4a922be0595976a519
+  data.tar.gz: aefd3c33fb35d873c8c8765ed1c89f890be4b4bdd9f8480f2df9ed743df2884506430d08c1ae7404fda483d6411b459cf382782210ee842baaec7cfed1c47ac2

data/README.md

@@ -42,7 +42,7 @@ our documentation, add new features—up to you! Thank you for pitching in.
 * [Encodings](#encodings)
 * [Contributing](#contributing)
 * [Usage](#usage)
-* [Excerpts from TREC Span Corpus 2005](#excerpts-from-trec-span-corpus-2005)
+* [Excerpts from TREC Spam Corpus 2005](#excerpts-from-trec-spam-corpus-2005)
 * [License](#license)
 
 ## Compatibility
@@ -417,18 +417,21 @@ simple as possible.... (asking a lot from a mail library)
 
 ```ruby
 mail = Mail.deliver do
-  to      'nicolas@test.lindsaar.net.au'
-  from    'Mikel Lindsaar <mikel@test.lindsaar.net.au>'
-  subject 'First multipart email sent with Mail'
-
-  text_part do
-    body 'This is plain text'
-  end
-
-  html_part do
-    content_type 'text/html; charset=UTF-8'
-    body '<h1>This is HTML</h1>'
+  part :content_type => "multipart/mixed" do |p1|
+    p1.part :content_type => "multipart/related" do |p2|
+      p2.part :content_type => "multipart/alternative",
+              :content_disposition => "inline" do |p3|
+        p3.part :content_type => "text/plain; charset=utf-8",
+                :body => "Here is the attachment you wanted\n"
+        p3.part :content_type => "text/html; charset=utf-8",
+                :body => "<h1>Funky Title</h1><p>Here is the attachment you wanted</p>\n"
+      end
+    end
+    add_file '/path/to/myfile.pdf'
   end
+  from      "Mikel Lindsaar <mikel@test.lindsaar.net.au>"
+  to        "nicolas@test.lindsaar.net.au"
+  subject   "First multipart email sent with Mail"
 end
 ```
 
@@ -439,34 +442,76 @@ so desire...
 ```
 puts mail.to_s #=>
 
-To: nicolas@test.lindsaar.net.au
+Date: Tue, 26 Apr 2022 20:12:07 +0200
 From: Mikel Lindsaar <mikel@test.lindsaar.net.au>
+To: nicolas@test.lindsaar.net.au
+Message-ID: <626835f736e19_10873fdfa3c2ffd4947a3@sender.at.mail>
 Subject: First multipart email sent with Mail
+MIME-Version: 1.0
+Content-Type: multipart/mixed;
+ boundary=\"--==_mimepart_626835f733867_10873fdfa3c2ffd494636\";
+ charset=UTF-8
+Content-Transfer-Encoding: 7bit
+
+
+----==_mimepart_626835f733867_10873fdfa3c2ffd494636
+Content-Type: multipart/mixed;
+ boundary=\"--==_mimepart_626835f73382a_10873fdfa3c2ffd494518\";
+ charset=UTF-8
+Content-Transfer-Encoding: 7bit
+
+
+----==_mimepart_626835f73382a_10873fdfa3c2ffd494518
+Content-Type: multipart/related;
+ boundary=\"--==_mimepart_626835f7337f5_10873fdfa3c2ffd494438\";
+ charset=UTF-8
+Content-Transfer-Encoding: 7bit
+
+
+----==_mimepart_626835f7337f5_10873fdfa3c2ffd494438
 Content-Type: multipart/alternative;
-  boundary=--==_mimepart_4a914f0c911be_6f0f1ab8026659
-Message-ID: <4a914f12ac7e_6f0f1ab80267d1@baci.local.mail>
-Date: Mon, 24 Aug 2009 00:15:46 +1000
-Mime-Version: 1.0
+ boundary=\"--==_mimepart_626835f733702_10873fdfa3c2ffd494376\";
+ charset=UTF-8
+Content-Transfer-Encoding: 7bit
+Content-Disposition: inline
+Content-ID: <626835f738373_10873fdfa3c2ffd49488b@sender.at.mail>
+
+
+----==_mimepart_626835f733702_10873fdfa3c2ffd494376
+Content-Type: text/plain;
+ charset=utf-8
 Content-Transfer-Encoding: 7bit
 
+Here is the attachment you wanted
 
-----==_mimepart_4a914f0c911be_6f0f1ab8026659
-Content-ID: <4a914f12c8c4_6f0f1ab80268d6@baci.local.mail>
-Date: Mon, 24 Aug 2009 00:15:46 +1000
-Mime-Version: 1.0
-Content-Type: text/plain
+----==_mimepart_626835f733702_10873fdfa3c2ffd494376
+Content-Type: text/html;
+ charset=utf-8
 Content-Transfer-Encoding: 7bit
 
-This is plain text
-----==_mimepart_4a914f0c911be_6f0f1ab8026659
-Content-Type: text/html; charset=UTF-8
-Content-ID: <4a914f12cf86_6f0f1ab802692c@baci.local.mail>
-Date: Mon, 24 Aug 2009 00:15:46 +1000
-Mime-Version: 1.0
+<h1>Funky Title</h1><p>Here is the attachment you wanted</p>
+
+----==_mimepart_626835f733702_10873fdfa3c2ffd494376--
+
+----==_mimepart_626835f7337f5_10873fdfa3c2ffd494438--
+
+----==_mimepart_626835f73382a_10873fdfa3c2ffd494518--
+
+----==_mimepart_626835f733867_10873fdfa3c2ffd494636
+Content-Type: text/plain;
+ charset=UTF-8;
+ filename=myfile.txt
 Content-Transfer-Encoding: 7bit
+Content-Disposition: attachment;
+ filename=myfile.txt
+Content-ID: <6
+26835f7386ab_10873fdfa3c2ffd4949b8@sender.at.mail>
+
+Hallo,
+Test
+End
 
-<h1>This is HTML</h1>
-----==_mimepart_4a914f0c911be_6f0f1ab8026659--
+----==_mimepart_626835f733867_10873fdfa3c2ffd494636--
 ```
 
 Mail inserts the content transfer encoding, the mime version,
@@ -616,7 +661,7 @@ Mail.defaults do
   delivery_method :test # in practice you'd do this in spec_helper.rb
 end
 
-describe "sending an email" do
+RSpec.describe "sending an email" do
   include Mail::Matchers
 
   before(:each) do

data/lib/mail/attachments_list.rb

@@ -7,7 +7,9 @@ module Mail
       @content_disposition_type = 'attachment'
       parts_list.map { |p|
         if p.mime_type == 'message/rfc822'
-          Mail.new(p.body.encoded).attachments
+          parts = []
+          parts << p if p.attachment?
+          parts.concat Mail.new(p.body.encoded).attachments
         elsif p.parts.empty?
           p if p.attachment?
         else

data/lib/mail/body.rb

@@ -1,28 +1,28 @@
 # encoding: utf-8
 # frozen_string_literal: true
 module Mail
-  
+
   # = Body
-  # 
+  #
   # The body is where the text of the email is stored.  Mail treats the body
   # as a single object.  The body itself has no information about boundaries
   # used in the MIME standard, it just looks at its content as either a single
   # block of text, or (if it is a multipart message) as an array of blocks of text.
-  # 
+  #
   # A body has to be told to split itself up into a multipart message by calling
   # #split with the correct boundary.  This is because the body object has no way
   # of knowing what the correct boundary is for itself (there could be many
   # boundaries in a body in the case of a nested MIME text).
-  # 
+  #
   # Once split is called, Mail::Body will slice itself up on this boundary,
   # assigning anything that appears before the first part to the preamble, and
   # anything that appears after the closing boundary to the epilogue, then
   # each part gets initialized into a Mail::Part object.
-  # 
+  #
   # The boundary that is used to split up the Body is also stored in the Body
-  # object for use on encoding itself back out to a string.  You can 
+  # object for use on encoding itself back out to a string.  You can
   # overwrite this if it needs to be changed.
-  # 
+  #
   # On encoding, the body will return the preamble, then each part joined by
   # the boundary, followed by a closing boundary string and then the epilogue.
   class Body
@@ -39,9 +39,9 @@ module Mail
       else
         # Do join first incase we have been given an Array in Ruby 1.9
         if string.respond_to?(:join)
-          @raw_source = ::Mail::Utilities.to_crlf(string.join(''))
+          @raw_source = string.join('')
         elsif string.respond_to?(:to_s)
-          @raw_source = ::Mail::Utilities.to_crlf(string.to_s)
+          @raw_source = string.to_s
         else
           raise "You can only assign a string or an object that responds_to? :join or :to_s to a body."
         end
@@ -57,15 +57,15 @@ module Mail
 
     # Matches this body with another body.  Also matches the decoded value of this
     # body with a string.
-    # 
+    #
     # Examples:
-    # 
+    #
     #   body = Mail::Body.new('The body')
     #   body == body #=> true
-    #   
+    #
     #   body = Mail::Body.new('The body')
     #   body == 'The body' #=> true
-    #   
+    #
     #   body = Mail::Body.new("VGhlIGJvZHk=\n")
     #   body.encoding = 'base64'
     #   body == "The body" #=> true
@@ -76,28 +76,28 @@ module Mail
         super
       end
     end
-    
+
     # Accepts a string and performs a regular expression against the decoded text
-    # 
+    #
     # Examples:
-    # 
+    #
     #   body = Mail::Body.new('The body')
     #   body =~ /The/ #=> 0
-    #   
+    #
     #   body = Mail::Body.new("VGhlIGJvZHk=\n")
     #   body.encoding = 'base64'
     #   body =~ /The/ #=> 0
     def =~(regexp)
       self.decoded =~ regexp
     end
-    
+
     # Accepts a string and performs a regular expression against the decoded text
-    # 
+    #
     # Examples:
-    # 
+    #
     #   body = Mail::Body.new('The body')
     #   body.match(/The/) #=> #<MatchData "The">
-    #   
+    #
     #   body = Mail::Body.new("VGhlIGJvZHk=\n")
     #   body.encoding = 'base64'
     #   body.match(/The/) #=> #<MatchData "The">
@@ -125,7 +125,7 @@ module Mail
     def set_sort_order(order)
       @part_sort_order = order
     end
-    
+
     # Allows you to sort the parts according to the default sort order, or the sort order you
     # set with :set_sort_order.
     #
@@ -137,7 +137,7 @@ module Mail
       end
       @parts.sort!(@part_sort_order)
     end
-    
+
     def negotiate_best_encoding(message_encoding, allowed_encodings = nil)
       Mail::Encodings::TransferEncoding.negotiate(message_encoding, encoding, raw_source, allowed_encodings)
     end
@@ -164,7 +164,7 @@ module Mail
           # Cannot decode, so skip normalization
           raw_source
         else
-          # Decode then encode to normalize and allow transforming 
+          # Decode then encode to normalize and allow transforming
           # from base64 to Q-P and vice versa
           decoded = dec.decode(raw_source)
           if defined?(Encoding) && charset && charset != "US-ASCII"
@@ -183,7 +183,7 @@ module Mail
         Encodings.get_encoding(encoding).decode(raw_source)
       end
     end
-    
+
     def to_s
       decoded
     end
@@ -272,7 +272,7 @@ module Mail
       parts_regex = /
         (?:                    # non-capturing group
           \A                |  # start of string OR
-          \r\n                 # line break
+          \r?\n                # line break with optional CR
          )
         (
           --#{Regexp.escape(boundary || "")}  # boundary delimiter
@@ -289,11 +289,11 @@ module Mail
       end
       parts.map(&:first)
     end
-    
+
     def crlf_boundary
       "\r\n--#{boundary}\r\n"
     end
-    
+
     def end_boundary
       "\r\n--#{boundary}--\r\n"
     end

data/lib/mail/encodings/quoted_printable.rb

@@ -16,7 +16,7 @@ module Mail
       # Decode the string from Quoted-Printable. Cope with hard line breaks
       # that were incorrectly encoded as hex instead of literal CRLF.
       def self.decode(str)
-        ::Mail::Utilities.to_lf ::Mail::Utilities.to_crlf(str).gsub(/(?:=0D=0A|=0D|=0A)\r\n/, "\r\n").unpack("M*").first
+        ::Mail::Utilities.to_lf ::Mail::Utilities.to_crlf(str).gsub(/(?:=0D=0A|=0D|=0A)\r\n/, "\r\n").unpack1("M*")
       end
 
       def self.encode(str)

data/lib/mail/encodings/unix_to_unix.rb

@@ -5,7 +5,7 @@ module Mail
       NAME = "x-uuencode"
 
       def self.decode(str)
-        str.sub(/\Abegin \d+ [^\n]*\n/, '').unpack('u').first
+        str.sub(/\Abegin \d+ [^\n]*\n/, '').unpack1('u')
       end
 
       def self.encode(str)

data/lib/mail/encodings.rb

@@ -72,7 +72,7 @@ module Mail
     #  Mail::Encodings.param_encode("This is fun") #=> "us-ascii'en'This%20is%20fun"
     def Encodings.param_encode(str)
       case
-      when str.ascii_only? && str =~ TOKEN_UNSAFE
+      when str.ascii_only? && TOKEN_UNSAFE.match?(str)
         %Q{"#{str}"}
       when str.ascii_only?
         str
@@ -121,7 +121,7 @@ module Mail
     # String has to be of the format =?<encoding>?[QB]?<string>?=
     def Encodings.value_decode(str)
       # Optimization: If there's no encoded-words in the string, just return it
-      return str unless str =~ ENCODED_VALUE
+      return str unless ENCODED_VALUE.match?(str)
 
       lines = collapse_adjacent_encodings(str)
 

data/lib/mail/field.rb

@@ -36,40 +36,68 @@ module Mail
     KNOWN_FIELDS = STRUCTURED_FIELDS + ['comments', 'subject']
 
     FIELDS_MAP = {
-      "to" => ToField,
-      "cc" => CcField,
-      "bcc" => BccField,
-      "message-id" => MessageIdField,
-      "in-reply-to" => InReplyToField,
-      "references" => ReferencesField,
-      "subject" => SubjectField,
-      "comments" => CommentsField,
-      "keywords" => KeywordsField,
-      "date" => DateField,
-      "from" => FromField,
-      "sender" => SenderField,
-      "reply-to" => ReplyToField,
-      "resent-date" => ResentDateField,
-      "resent-from" => ResentFromField,
-      "resent-sender" =>  ResentSenderField,
-      "resent-to" => ResentToField,
-      "resent-cc" => ResentCcField,
-      "resent-bcc" => ResentBccField,
-      "resent-message-id" => ResentMessageIdField,
-      "return-path" => ReturnPathField,
-      "received" => ReceivedField,
-      "mime-version" => MimeVersionField,
-      "content-transfer-encoding" => ContentTransferEncodingField,
-      "content-description" => ContentDescriptionField,
-      "content-disposition" => ContentDispositionField,
-      "content-type" => ContentTypeField,
-      "content-id" => ContentIdField,
-      "content-location" => ContentLocationField,
+      "to" => "ToField",
+      "cc" => "CcField",
+      "bcc" => "BccField",
+      "message-id" => "MessageIdField",
+      "in-reply-to" => "InReplyToField",
+      "references" => "ReferencesField",
+      "subject" => "SubjectField",
+      "comments" => "CommentsField",
+      "keywords" => "KeywordsField",
+      "date" => "DateField",
+      "from" => "FromField",
+      "sender" => "SenderField",
+      "reply-to" => "ReplyToField",
+      "resent-date" => "ResentDateField",
+      "resent-from" => "ResentFromField",
+      "resent-sender" => "ResentSenderField",
+      "resent-to" => "ResentToField",
+      "resent-cc" => "ResentCcField",
+      "resent-bcc" => "ResentBccField",
+      "resent-message-id" => "ResentMessageIdField",
+      "return-path" => "ReturnPathField",
+      "received" => "ReceivedField",
+      "mime-version" => "MimeVersionField",
+      "content-transfer-encoding" => "ContentTransferEncodingField",
+      "content-description" => "ContentDescriptionField",
+      "content-disposition" => "ContentDispositionField",
+      "content-type" => "ContentTypeField",
+      "content-id" => "ContentIdField",
+      "content-location" => "ContentLocationField",
     }
 
-    FIELD_NAME_MAP = FIELDS_MAP.inject({}) do |map, (field, field_klass)|
-      map.update(field => field_klass::NAME)
-    end
+    FIELD_NAME_MAP = {
+      "to" => "To",
+      "cc" => "Cc",
+      "bcc" => "Bcc",
+      "message-id" => "Message-ID",
+      "in-reply-to" => "In-Reply-To",
+      "references" => "References",
+      "subject" => "Subject",
+      "comments" => "Comments",
+      "keywords" => "Keywords",
+      "date" => "Date",
+      "from" => "From",
+      "sender" => "Sender",
+      "reply-to" => "Reply-To",
+      "resent-date" => "Resent-Date",
+      "resent-from" => "Resent-From",
+      "resent-sender" => "Resent-Sender",
+      "resent-to" => "Resent-To",
+      "resent-cc" => "Resent-Cc",
+      "resent-bcc" => "Resent-Bcc",
+      "resent-message-id" => "Resent-Message-ID",
+      "return-path" => "Return-Path",
+      "received" => "Received",
+      "mime-version" => "MIME-Version",
+      "content-transfer-encoding" => "Content-Transfer-Encoding",
+      "content-description" => "Content-Description",
+      "content-disposition" => "Content-Disposition",
+      "content-type" => "Content-Type",
+      "content-id" => "Content-ID",
+      "content-location" => "Content-Location",
+    }
 
     # Generic Field Exception
     class FieldError < StandardError
@@ -130,7 +158,7 @@ module Mail
         if raw_field.index(Constants::COLON)
           name, value = raw_field.split(Constants::COLON, 2)
           name.rstrip!
-          if name =~ /\A#{Constants::FIELD_NAME}\z/
+          if /\A#{Constants::FIELD_NAME}\z/.match?(name)
             [ name.rstrip, value.strip ]
           else
             Kernel.warn "WARNING: Ignoring unparsable header #{raw_field.inspect}: invalid header name syntax: #{name.inspect}"
@@ -145,7 +173,8 @@ module Mail
       end
 
       def field_class_for(name) #:nodoc:
-        FIELDS_MAP[name.to_s.downcase]
+        class_name = FIELDS_MAP[name.to_s.downcase]
+        Mail.const_get(class_name) if class_name
       end
     end
 
@@ -176,7 +205,8 @@ module Mail
         @unparsed_value = value
         @charset = charset
       end
-      @name = FIELD_NAME_MAP[@name.to_s.downcase] || @name
+      klass = self.class.field_class_for(@name)
+      @name = klass ? klass::NAME : @name
     end
 
     def field=(field)

data/lib/mail/field_list.rb

@@ -2,7 +2,7 @@
 # frozen_string_literal: true
 module Mail
 
-  # Field List class provides an enhanced array that keeps a list of 
+  # Field List class provides an enhanced array that keeps a list of
   # email fields in order.  And allows you to insert new fields without
   # having to worry about the order they will appear in.
   class FieldList < Array

data/lib/mail/fields/bcc_field.rb

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

data/lib/mail/fields/cc_field.rb

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

data/lib/mail/fields/comments_field.rb

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

data/lib/mail/fields/common_address_field.rb

@@ -1,6 +1,5 @@
 # encoding: utf-8
 # frozen_string_literal: true
-require 'mail/fields/named_structured_field'
 
 module Mail
   class AddressContainer < Array #:nodoc:
@@ -118,22 +117,15 @@ module Mail
     end
 
     private
-      if 'string'.respond_to?(:encoding)
-        # Pass through UTF-8 addresses
-        def utf8_if_needed(val, val_charset)
-          if val_charset =~ /\AUTF-?8\z/i
-            val
-          elsif val.encoding == Encoding::UTF_8
-            val
-          elsif (utf8 = val.dup.force_encoding(Encoding::UTF_8)).valid_encoding?
-            utf8
-          end
-        end
-      else
-        def utf8_if_needed(val, val_charset)
-          if val_charset =~ /\AUTF-?8\z/i
-            val
-          end
+
+      # Pass through UTF-8 addresses
+      def utf8_if_needed(val, val_charset)
+        if /\AUTF-?8\z/i.match?(val_charset)
+          val
+        elsif val.encoding == Encoding::UTF_8
+          val
+        elsif (utf8 = val.dup.force_encoding(Encoding::UTF_8)).valid_encoding?
+          utf8
         end
       end
 

data/lib/mail/fields/common_date_field.rb

@@ -1,5 +1,3 @@
-require 'mail/fields/named_structured_field'
-require 'mail/elements/date_time_element'
 require 'mail/utilities'
 
 module Mail

data/lib/mail/fields/common_message_id_field.rb

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

data/lib/mail/fields/content_description_field.rb

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

data/lib/mail/fields/content_disposition_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 ContentDispositionField < NamedStructuredField #:nodoc:

data/lib/mail/fields/content_id_field.rb

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

data/lib/mail/fields/content_location_field.rb

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

data/lib/mail/fields/content_transfer_encoding_field.rb

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