mail 2.7.1 → 2.9.1

data/lib/mail/message.rb

@@ -1,6 +1,8 @@
 # encoding: utf-8
 # frozen_string_literal: true
-require "yaml"
+require 'mail/constants'
+require 'mail/utilities'
+require 'mail/yaml'
 
 module Mail
   # The Message class provides a single point of access to all things to do with an
@@ -46,10 +48,6 @@ module Mail
   #   follows the header and is separated from the header by an empty line
   #   (i.e., a line with nothing preceding the CRLF).
   class Message
-
-    include Constants
-    include Utilities
-
     # ==Making an email
     #
     # You can make an new mail object via a block, passing a string, file or direct assignment.
@@ -149,7 +147,7 @@ module Mail
       #     m.to 'recipient@example.com'
       #   end
       if block_given?
-        if block.arity.zero? || (RUBY_VERSION < '1.9' && block.arity < 1)
+        if block.arity.zero?
           instance_eval(&block)
         else
           yield self
@@ -235,11 +233,6 @@ module Mail
     def self.default_charset=(charset); @@default_charset = charset; end
     self.default_charset = 'UTF-8'
 
-    def register_for_delivery_notification(observer)
-      warn("Message#register_for_delivery_notification is deprecated, please call Mail.register_observer instead")
-      Mail.register_observer(observer)
-    end
-
     def inform_observers
       Mail.inform_observers(self)
     end
@@ -301,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
@@ -356,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")
@@ -377,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
 
@@ -406,9 +406,9 @@ module Mail
     end
 
     # Sets the envelope from for the email
-    def set_envelope( val )
+    def set_envelope(val)
       @raw_envelope = val
-      @envelope = Mail::Envelope.new( val )
+      @envelope = Mail::Envelope.parse(val) rescue nil
     end
 
     # The raw_envelope is the From mikel@test.lindsaar.net Mon May  2 16:07:05 2009
@@ -471,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.
@@ -1323,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
@@ -1339,7 +1339,7 @@ module Mail
     #  mail['foo'] = '1234'
     #  mail['foo'].to_s #=> '1234'
     def [](name)
-      header[underscoreize(name)]
+      header[Utilities.underscoreize(name)]
     end
 
     # Method Missing in this implementation allows you to set any of the
@@ -1385,7 +1385,7 @@ module Mail
       #:nodoc:
       # Only take the structured fields, as we could take _anything_ really
       # as it could become an optional field... "but therin lies the dark side"
-      field_name = underscoreize(name).chomp("=")
+      field_name = Utilities.underscoreize(name).chomp("=")
       if Mail::Field::KNOWN_FIELDS.include?(field_name)
         if args.empty?
           header[field_name]
@@ -1416,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?
@@ -1436,11 +1436,6 @@ module Mail
       header[:content_transfer_encoding] && Utilities.blank?(header[:content_transfer_encoding].errors)
     end
 
-    def has_transfer_encoding? # :nodoc:
-      warn(":has_transfer_encoding? is deprecated in Mail 1.4.3.  Please use has_content_transfer_encoding?\n#{caller}")
-      has_content_transfer_encoding?
-    end
-
     # Creates a new empty Message-ID field and inserts it in the correct order
     # into the Header.  The MessageIdField object will automatically generate
     # a unique message ID if you try and encode it or output it to_s without
@@ -1489,7 +1484,9 @@ module Mail
           warning = "Non US-ASCII detected and no charset defined.\nDefaulting to UTF-8, set your own if this is incorrect.\n"
           warn(warning)
         end
-        header[:content_type].parameters['charset'] = @charset
+        if @charset
+          header[:content_type].parameters['charset'] = @charset
+        end
       end
     end
 
@@ -1498,30 +1495,15 @@ module Mail
       header[:content_transfer_encoding] ||= body.default_encoding
     end
 
-    def add_transfer_encoding # :nodoc:
-      warn(":add_transfer_encoding is deprecated in Mail 1.4.3.  Please use add_content_transfer_encoding\n#{caller}")
-      add_content_transfer_encoding
-    end
-
-    def transfer_encoding # :nodoc:
-      warn(":transfer_encoding is deprecated in Mail 1.4.3.  Please use content_transfer_encoding\n#{caller}")
-      content_transfer_encoding
-    end
-
     # Returns the MIME media type of part we are on, this is taken from the content-type header
     def mime_type
       has_content_type? ? header[:content_type].string : nil rescue nil
     end
 
-    def message_content_type
-      warn(":message_content_type is deprecated in Mail 1.4.3.  Please use mime_type\n#{caller}")
-      mime_type
-    end
-
     # Returns the character set defined in the content type field
     def charset
       if @header
-        has_content_type? ? content_type_parameters['charset'] : @charset
+        has_content_type? && !multipart? ? content_type_parameters['charset'] : @charset
       else
         @charset
       end
@@ -1544,12 +1526,6 @@ module Mail
       has_content_type? ? header[:content_type].sub_type : nil rescue nil
     end
 
-    # Returns the content type parameters
-    def mime_parameters
-      warn(':mime_parameters is deprecated in Mail 1.4.3, please use :content_type_parameters instead')
-      content_type_parameters
-    end
-
     # Returns the content type parameters
     def content_type_parameters
       has_content_type? ? header[:content_type].parameters : nil rescue nil
@@ -1557,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
@@ -1798,12 +1774,22 @@ module Mail
       self.attachments[basename] = filedata
     end
 
+    MULTIPART_CONVERSION_CONTENT_FIELDS = [ :content_description, :content_disposition, :content_transfer_encoding, :content_type ]
+    private_constant :MULTIPART_CONVERSION_CONTENT_FIELDS if respond_to?(:private_constant)
+
     def convert_to_multipart
-      text = body.decoded
-      self.body = ''
-      text_part = Mail::Part.new({:content_type => 'text/plain;',
-                                  :body => text})
+      text_part = Mail::Part.new(:content_type => 'text/plain;', :body => body.decoded)
+
+      MULTIPART_CONVERSION_CONTENT_FIELDS.each do |field_name|
+        if value = send(field_name)
+          writer = :"#{field_name}="
+          text_part.send writer, value
+          send writer, nil
+        end
+      end
       text_part.charset = charset unless @defaulted_charset
+
+      self.body = ''
       self.body << text_part
     end
 
@@ -1818,11 +1804,6 @@ module Mail
       add_required_fields
     end
 
-    def encode!
-      warn("Deprecated in 1.1.0 in favour of :ready_to_send! as it is less confusing with encoding and decoding.")
-      ready_to_send!
-    end
-
     # Outputs an encoded string representation of the mail message including
     # all headers, attachments, etc.  This is an encoded email in US-ASCII,
     # so it is able to be directly sent to an email server.
@@ -1836,7 +1817,7 @@ module Mail
 
     def without_attachments!
       if has_attachments?
-        parts.delete_if { |p| p.attachment? }
+        parts.delete_attachments
 
         reencoded = parts.empty? ? '' : body.encoded(content_transfer_encoding)
         @body = nil # So the new parts won't be added to the existing body
@@ -1867,7 +1848,7 @@ module Mail
     end
 
     def self.from_yaml(str)
-      hash = YAML.load(str)
+      hash = Mail::YAML.load(str)
       m = self.new(:headers => hash['headers'])
       hash.delete('headers')
       hash.each do |k,v|
@@ -1881,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
@@ -1900,6 +1881,15 @@ module Mail
       "#<#{self.class}:#{self.object_id}, Multipart: #{multipart?}, Headers: #{header.field_summary}>"
     end
 
+    def inspect_structure
+      inspect +
+      if self.multipart?
+        "\n" + parts.inspect_structure
+      else
+        ''
+      end
+    end
+
     def decoded
       case
       when self.text?
@@ -1909,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
 
@@ -1979,12 +1969,12 @@ module Mail
     end
 
     def text?
-      has_content_type? ? !!(main_type =~ /^text$/i) : false
+      has_content_type? ? /^text$/i.match?(main_type) : false
     end
 
   private
 
-    HEADER_SEPARATOR = /#{Constants::CRLF}#{Constants::CRLF}/
+    HEADER_SEPARATOR = /#{Constants::LAX_CRLF}#{Constants::LAX_CRLF}/
 
     #  2.1. General Description
     #   A message consists of header fields (collectively called "the header
@@ -2029,7 +2019,7 @@ module Mail
 
     def set_envelope_header
       raw_string = raw_source.to_s
-      if match_data = raw_string.match(/\AFrom\s(#{TEXT}+)#{Constants::CRLF}/m)
+      if match_data = raw_string.match(/\AFrom\s+([^:\s]#{Constants::TEXT}*)#{Constants::LAX_CRLF}/m)
         set_envelope(match_data[1])
         self.raw_source = raw_string.sub(match_data[0], "")
       end
@@ -2053,10 +2043,12 @@ module Mail
     end
 
     def identify_and_set_transfer_encoding
-      if body && body.multipart?
-        self.content_transfer_encoding = @transport_encoding
-      else
-        self.content_transfer_encoding = body.negotiate_best_encoding(@transport_encoding, allowed_encodings).to_s
+      if body
+        if body.multipart?
+          self.content_transfer_encoding = @transport_encoding
+        else
+          self.content_transfer_encoding = body.negotiate_best_encoding(@transport_encoding, allowed_encodings).to_s
+        end
       end
     end
 
@@ -2076,7 +2068,6 @@ module Mail
 
     def add_multipart_alternate_header
       header['content-type'] = ContentTypeField.with_boundary('multipart/alternative').value
-      header['content_type'].parameters[:charset] = @charset
       body.boundary = boundary
     end
 
@@ -2084,7 +2075,6 @@ module Mail
       unless body.boundary && boundary
         header['content-type'] = 'multipart/mixed' unless header['content-type']
         header['content-type'].parameters[:boundary] = ContentTypeField.generate_boundary
-        header['content_type'].parameters[:charset] = @charset
         body.boundary = boundary
       end
     end
@@ -2092,7 +2082,6 @@ module Mail
     def add_multipart_mixed_header
       unless header['content-type']
         header['content-type'] = ContentTypeField.with_boundary('multipart/mixed').value
-        header['content_type'].parameters[:charset] = @charset
         body.boundary = boundary
       end
     end
@@ -2109,7 +2098,7 @@ module Mail
       body_content = nil
 
       passed_in_options.each_pair do |k,v|
-        k = underscoreize(k).to_sym if k.class == String
+        k = Utilities.underscoreize(k).to_sym if k.class == String
         if k == :headers
           self.headers(v)
         elsif k == :body

data/lib/mail/multibyte/chars.rb

@@ -38,21 +38,15 @@ module Mail #:nodoc:
       alias to_s wrapped_string
       alias to_str wrapped_string
 
-      if RUBY_VERSION >= "1.9"
-        # Creates a new Chars instance by wrapping _string_.
-        def initialize(string)
-          @wrapped_string = string.dup
-          @wrapped_string.force_encoding(Encoding::UTF_8) unless @wrapped_string.frozen?
-        end
-      else
-        def initialize(string) #:nodoc:
-          @wrapped_string = string
-        end
+      # Creates a new Chars instance by wrapping _string_.
+      def initialize(string)
+        @wrapped_string = string.dup
+        @wrapped_string.force_encoding(Encoding::UTF_8) unless @wrapped_string.frozen?
       end
 
       # 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
@@ -72,15 +66,6 @@ module Mail #:nodoc:
         true
       end
 
-      # Returns +true+ when the proxy class can handle the string. Returns +false+ otherwise.
-      def self.consumes?(string)
-        # Unpack is a little bit faster than regular expressions.
-        string.unpack('U*')
-        true
-      rescue ArgumentError
-        false
-      end
-
       include Comparable
 
       # Returns -1, 0, or 1, depending on whether the Chars object is to be sorted before,
@@ -94,151 +79,8 @@ module Mail #:nodoc:
         @wrapped_string <=> other.to_s
       end
 
-      if RUBY_VERSION < "1.9"
-        # Returns +true+ if the Chars class can and should act as a proxy for the string _string_. Returns
-        # +false+ otherwise.
-        def self.wants?(string)
-          $KCODE == 'UTF8' && consumes?(string)
-        end
-
-        # Returns a new Chars object containing the _other_ object concatenated to the string.
-        #
-        # Example:
-        #   (Mail::Multibyte.mb_chars('Café') + ' périferôl').to_s # => "Café périferôl"
-        def +(other)
-          chars(@wrapped_string + other)
-        end
-
-        # Like <tt>String#=~</tt> only it returns the character offset (in codepoints) instead of the byte offset.
-        #
-        # Example:
-        #   Mail::Multibyte.mb_chars('Café périferôl') =~ /ô/ # => 12
-        def =~(other)
-          translate_offset(@wrapped_string =~ other)
-        end
-
-        # Inserts the passed string at specified codepoint offsets.
-        #
-        # Example:
-        #   Mail::Multibyte.mb_chars('Café').insert(4, ' périferôl').to_s # => "Café périferôl"
-        def insert(offset, fragment)
-          unpacked = Unicode.u_unpack(@wrapped_string)
-          unless offset > unpacked.length
-            @wrapped_string.replace(
-              Unicode.u_unpack(@wrapped_string).insert(offset, *Unicode.u_unpack(fragment)).pack('U*')
-            )
-          else
-            raise IndexError, "index #{offset} out of string"
-          end
-          self
-        end
-
-        # Returns +true+ if contained string contains _other_. Returns +false+ otherwise.
-        #
-        # Example:
-        #   Mail::Multibyte.mb_chars('Café').include?('é') # => true
-        def include?(other)
-          # We have to redefine this method because Enumerable defines it.
-          @wrapped_string.include?(other)
-        end
-
-        # Returns the position _needle_ in the string, counting in codepoints. Returns +nil+ if _needle_ isn't found.
-        #
-        # Example:
-        #   Mail::Multibyte.mb_chars('Café périferôl').index('ô')   # => 12
-        #   Mail::Multibyte.mb_chars('Café périferôl').index(/\w/u) # => 0
-        def index(needle, offset=0)
-          wrapped_offset = first(offset).wrapped_string.length
-          index = @wrapped_string.index(needle, wrapped_offset)
-          index ? (Unicode.u_unpack(@wrapped_string.slice(0...index)).size) : nil
-        end
-
-        # Returns the position _needle_ in the string, counting in
-        # codepoints, searching backward from _offset_ or the end of the
-        # string. Returns +nil+ if _needle_ isn't found.
-        #
-        # Example:
-        #   Mail::Multibyte.mb_chars('Café périferôl').rindex('é')   # => 6
-        #   Mail::Multibyte.mb_chars('Café périferôl').rindex(/\w/u) # => 13
-        def rindex(needle, offset=nil)
-          offset ||= length
-          wrapped_offset = first(offset).wrapped_string.length
-          index = @wrapped_string.rindex(needle, wrapped_offset)
-          index ? (Unicode.u_unpack(@wrapped_string.slice(0...index)).size) : nil
-        end
-
-        # Returns the number of codepoints in the string
-        def size
-          Unicode.u_unpack(@wrapped_string).size
-        end
-        alias_method :length, :size
-
-        # Strips entire range of Unicode whitespace from the right of the string.
-        def rstrip
-          chars(@wrapped_string.gsub(Unicode::TRAILERS_PAT, ''))
-        end
-
-        # Strips entire range of Unicode whitespace from the left of the string.
-        def lstrip
-          chars(@wrapped_string.gsub(Unicode::LEADERS_PAT, ''))
-        end
-
-        # Strips entire range of Unicode whitespace from the right and left of the string.
-        def strip
-          rstrip.lstrip
-        end
-
-        # Returns the codepoint of the first character in the string.
-        #
-        # Example:
-        #   Mail::Multibyte.mb_chars('こんにちは').ord # => 12371
-        def ord
-          Unicode.u_unpack(@wrapped_string)[0]
-        end
-
-        # Works just like <tt>String#rjust</tt>, only integer specifies characters instead of bytes.
-        #
-        # Example:
-        #
-        #   Mail::Multibyte.mb_chars("¾ cup").rjust(8).to_s
-        #   # => "   ¾ cup"
-        #
-        #   Mail::Multibyte.mb_chars("¾ cup").rjust(8, " ").to_s # Use non-breaking whitespace
-        #   # => "   ¾ cup"
-        def rjust(integer, padstr=' ')
-          justify(integer, :right, padstr)
-        end
-
-        # Works just like <tt>String#ljust</tt>, only integer specifies characters instead of bytes.
-        #
-        # Example:
-        #
-        #   Mail::Multibyte.mb_chars("¾ cup").rjust(8).to_s
-        #   # => "¾ cup   "
-        #
-        #   Mail::Multibyte.mb_chars("¾ cup").rjust(8, " ").to_s # Use non-breaking whitespace
-        #   # => "¾ cup   "
-        def ljust(integer, padstr=' ')
-          justify(integer, :left, padstr)
-        end
-
-        # Works just like <tt>String#center</tt>, only integer specifies characters instead of bytes.
-        #
-        # Example:
-        #
-        #   Mail::Multibyte.mb_chars("¾ cup").center(8).to_s
-        #   # => " ¾ cup  "
-        #
-        #   Mail::Multibyte.mb_chars("¾ cup").center(8, " ").to_s # Use non-breaking whitespace
-        #   # => " ¾ cup  "
-        def center(integer, padstr=' ')
-          justify(integer, :center, padstr)
-        end
-
-      else
-        def =~(other)
-          @wrapped_string =~ other
-        end
+      def =~(other)
+        @wrapped_string =~ other
       end
 
       # Works just like <tt>String#split</tt>, with the exception that the items in the resulting list are Chars
@@ -331,7 +173,7 @@ module Mail #:nodoc:
       #
       # Example:
       #   s = 'こんにちは'
-      #   s.mb_chars.limit(7) # => "こに"
+      #   s.mb_chars.limit(7) # => "こん"
       def limit(limit)
         slice(0...translate_offset(limit))
       end
@@ -419,7 +261,7 @@ module Mail #:nodoc:
         # exclude lstrip!, rstrip! and strip! because they are already work as expected on multibyte strings.
         if public_method_defined?(method)
           define_method("#{method}!") do |*args|
-            @wrapped_string = send(args.nil? ? method : method, *args).to_s
+            @wrapped_string = send(method, *args).to_s
             self
           end
         end

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