mail 2.5.2 → 2.6.4

data/lib/mail/elements/content_disposition_element.rb

@@ -1,17 +1,14 @@
 # encoding: utf-8
+# frozen_string_literal: true
 module Mail
   class ContentDispositionElement # :nodoc:
     
     include Mail::Utilities
     
     def initialize( string )
-      parser = Mail::ContentDispositionParser.new
-      if tree = parser.parse(cleaned(string))
-        @disposition_type = tree.disposition_type.text_value.downcase
-        @parameters = tree.parameters
-      else
-        raise Mail::Field::ParseError.new(ContentDispositionElement, string, parser.failure_reason)
-      end
+      content_disposition = Mail::Parsers::ContentDispositionParser.new.parse(cleaned(string))
+      @disposition_type = content_disposition.disposition_type
+      @parameters = content_disposition.parameters
     end
     
     def disposition_type

data/lib/mail/elements/content_location_element.rb

@@ -1,25 +1,22 @@
 # encoding: utf-8
+# frozen_string_literal: true
 module Mail
   class ContentLocationElement # :nodoc:
-    
+
     include Mail::Utilities
-    
+
     def initialize( string )
-      parser = Mail::ContentLocationParser.new
-      if tree = parser.parse(string)
-        @location = tree.location.text_value
-      else
-        raise Mail::Field::ParseError.new(ContentLocationElement, string, parser.failure_reason)
-      end
+      content_location = Mail::Parsers::ContentLocationParser.new.parse(string)
+      @location = content_location.location
     end
-    
+
     def location
       @location
     end
-    
+
     def to_s(*args)
       location.to_s
     end
-    
+
   end
 end

data/lib/mail/elements/content_transfer_encoding_element.rb

@@ -1,19 +1,13 @@
 # encoding: utf-8
+# frozen_string_literal: true
 module Mail
   class ContentTransferEncodingElement
     
     include Mail::Utilities
     
-    def initialize( string )
-      parser = Mail::ContentTransferEncodingParser.new
-      case
-      when string.blank?
-        @encoding = ''
-      when tree = parser.parse(string.to_s.downcase)
-        @encoding = tree.encoding.text_value
-      else
-        raise Mail::Field::ParseError.new(ContentTransferEncodingElement, string, parser.failure_reason)
-      end
+    def initialize(string)
+      content_transfer_encoding = Mail::Parsers::ContentTransferEncodingParser.new.parse(string)
+      @encoding = content_transfer_encoding.encoding
     end
     
     def encoding

data/lib/mail/elements/content_type_element.rb

@@ -1,18 +1,15 @@
 # encoding: utf-8
+# frozen_string_literal: true
 module Mail
   class ContentTypeElement # :nodoc:
     
     include Mail::Utilities
     
     def initialize( string )
-      parser = Mail::ContentTypeParser.new
-      if tree = parser.parse(cleaned(string))
-        @main_type = tree.main_type.text_value.downcase
-        @sub_type = tree.sub_type.text_value.downcase
-        @parameters = tree.parameters
-      else
-        raise Mail::Field::ParseError.new(ContentTypeElement, string, parser.failure_reason)
-      end
+      content_type = Mail::Parsers::ContentTypeParser.new.parse(cleaned(string))
+      @main_type = content_type.main_type
+      @sub_type = content_type.sub_type
+      @parameters = content_type.parameters
     end
     
     def main_type

data/lib/mail/elements/date_time_element.rb

@@ -1,17 +1,14 @@
 # encoding: utf-8
+# frozen_string_literal: true
 module Mail
   class DateTimeElement # :nodoc:
     
     include Mail::Utilities
     
     def initialize( string )
-      parser = Mail::DateTimeParser.new
-      if tree = parser.parse(string)
-        @date_string = tree.date.text_value
-        @time_string = tree.time.text_value
-      else
-        raise Mail::Field::ParseError.new(DateTimeElement, string, parser.failure_reason)
-      end
+      date_time = Mail::Parsers::DateTimeParser.new.parse(string)
+      @date_string = date_time.date_string
+      @time_string = date_time.time_string
     end
     
     def date_string

data/lib/mail/elements/envelope_from_element.rb

@@ -1,21 +1,14 @@
 # encoding: utf-8
+# frozen_string_literal: true
 module Mail
   class EnvelopeFromElement
     
     include Mail::Utilities
     
     def initialize( string )
-      parser = Mail::EnvelopeFromParser.new
-      if @tree = parser.parse(string)
-        @address = tree.addr_spec.text_value.strip
-        @date_time = ::DateTime.parse("#{tree.ctime_date.text_value}")
-      else
-        raise Mail::Field::ParseError.new(EnvelopeFromElement, string, parser.failure_reason)
-      end
-    end
-    
-    def tree
-      @tree
+      @envelope_from = Mail::Parsers::EnvelopeFromParser.new.parse(string)
+      @address = @envelope_from.address
+      @date_time = ::DateTime.parse(@envelope_from.ctime_date)
     end
     
     def date_time
@@ -26,8 +19,21 @@ module Mail
       @address
     end
     
-    def to_s(*args)
-      "#{@info}; #{@date_time.to_s(*args)}"
+    # RFC 4155:
+    #   a timestamp indicating the UTC date and time when the message
+    #   was originally received, conformant with the syntax of the
+    #   traditional UNIX 'ctime' output sans timezone (note that the
+    #   use of UTC precludes the need for a timezone indicator);
+    def formatted_date_time
+      if @date_time.respond_to?(:ctime)
+        @date_time.ctime
+      else
+        @date_time.strftime '%a %b %e %T %Y'
+      end
+    end
+
+    def to_s
+      "#{@address} #{formatted_date_time}"
     end
     
   end

data/lib/mail/elements/message_ids_element.rb

@@ -1,26 +1,23 @@
 # encoding: utf-8
+# frozen_string_literal: true
 module Mail
   class MessageIdsElement
-    
+
     include Mail::Utilities
-    
+
     def initialize(string)
-      parser = Mail::MessageIdsParser.new
-      if tree = parser.parse(string)
-        @message_ids = tree.message_ids.map { |msg_id| clean_msg_id(msg_id.text_value) }
-      else
-        raise Mail::Field::ParseError.new(MessageIdsElement, string, parser.failure_reason)
-      end
+      raise Mail::Field::ParseError.new(Mail::MessageIdsElement, string, 'nil is invalid') if string.nil?
+      @message_ids = Mail::Parsers::MessageIdsParser.new.parse(string).message_ids.map { |msg_id| clean_msg_id(msg_id) }
     end
-    
+
     def message_ids
       @message_ids
     end
-    
+
     def message_id
       @message_ids.first
     end
-    
+
     def clean_msg_id( val )
       val =~ /.*<(.*)>.*/ ; $1
     end

data/lib/mail/elements/mime_version_element.rb

@@ -1,17 +1,14 @@
 # encoding: utf-8
+# frozen_string_literal: true
 module Mail
   class MimeVersionElement
     
     include Mail::Utilities
     
     def initialize( string )
-      parser = Mail::MimeVersionParser.new
-      if tree = parser.parse(string)
-        @major = tree.major.text_value
-        @minor = tree.minor.text_value
-      else
-        raise Mail::Field::ParseError.new(MimeVersionElement, string, parser.failure_reason)
-      end
+      mime_version = Mail::Parsers::MimeVersionParser.new.parse(string)
+      @major = mime_version.major
+      @minor = mime_version.minor
     end
     
     def major

data/lib/mail/elements/phrase_list.rb

@@ -1,20 +1,16 @@
 # encoding: utf-8
+# frozen_string_literal: true
 module Mail
   class PhraseList
     
     include Mail::Utilities
     
     def initialize(string)
-      parser = Mail::PhraseListsParser.new
-      if tree = parser.parse(string)
-        @phrases = tree.phrases
-      else
-        raise Mail::Field::ParseError.new(PhraseList, string, parser.failure_reason)
-      end
+      @phrase_lists = Mail::Parsers::PhraseListsParser.new.parse(string)
     end
     
     def phrases
-      @phrases.map { |p| unquote(p.text_value) }
+      @phrase_lists.phrases.map { |p| unquote(p) }
     end
 
   end

data/lib/mail/elements/received_element.rb

@@ -1,17 +1,14 @@
 # encoding: utf-8
+# frozen_string_literal: true
 module Mail
   class ReceivedElement
     
     include Mail::Utilities
     
     def initialize( string )
-      parser = Mail::ReceivedParser.new
-      if tree = parser.parse(string)
-        @date_time = ::DateTime.parse("#{tree.date_time.date.text_value} #{tree.date_time.time.text_value}")
-        @info = tree.name_val_list.text_value
-      else
-        raise Mail::Field::ParseError.new(ReceivedElement, string, parser.failure_reason)
-      end
+      received = Mail::Parsers::ReceivedParser.new.parse(string)
+      @date_time = ::DateTime.parse("#{received.date} #{received.time}")
+      @info = received.info
     end
     
     def date_time

data/lib/mail/elements.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 module Mail
   register_autoload :Address, 'mail/elements/address'
   register_autoload :AddressList, 'mail/elements/address_list'

data/lib/mail/encodings/7bit.rb

@@ -1,4 +1,5 @@
 # encoding: utf-8
+# frozen_string_literal: true
 require 'mail/encodings/8bit'
 
 module Mail

data/lib/mail/encodings/8bit.rb

@@ -1,4 +1,5 @@
 # encoding: utf-8
+# frozen_string_literal: true
 require 'mail/encodings/binary'
 
 module Mail
@@ -12,12 +13,12 @@ module Mail
       
       # Decode the string
       def self.decode(str)
-        str.to_lf
+        ::Mail::Utilities.to_lf str
       end
     
       # Encode the string
       def self.encode(str)
-        str.to_crlf
+        ::Mail::Utilities.to_crlf str
       end
      
       # Idenity encodings have a fixed cost, 1 byte out per 1 byte in
@@ -25,6 +26,11 @@ module Mail
         1.0
       end
 
+      # Per RFC 2821 4.5.3.1, SMTP lines may not be longer than 1000 octets including the <CRLF>.
+      def self.compatible_input?(str)
+        !str.lines.find { |line| line.length > 998 }
+      end
+
       Encodings.register(NAME, self) 
     end
   end

data/lib/mail/encodings/base64.rb

@@ -1,4 +1,5 @@
 # encoding: utf-8
+# frozen_string_literal: true
 require 'mail/encodings/7bit'
 
 module Mail
@@ -19,7 +20,7 @@ module Mail
     
       # Encode the string to Base64
       def self.encode(str)
-        RubyVer.encode_base64( str ).to_crlf
+        ::Mail::Utilities.to_crlf(RubyVer.encode_base64( str ))
       end
 
       # Base64 has a fixed cost, 4 bytes out per 3 bytes in
@@ -27,6 +28,11 @@ module Mail
         4.0/3
       end
 
+      # Base64 inserts newlines automatically and cannot violate the SMTP spec.
+      def self.compatible_input?(str)
+        true
+      end
+
       Encodings.register(NAME, self)      
     end
   end

data/lib/mail/encodings/binary.rb

@@ -1,4 +1,5 @@
 # encoding: utf-8
+# frozen_string_literal: true
 require 'mail/encodings/transfer_encoding'
 
 module Mail

data/lib/mail/encodings/quoted_printable.rb

@@ -1,4 +1,5 @@
 # encoding: utf-8
+# frozen_string_literal: true
 require 'mail/encodings/7bit'
 
 module Mail
@@ -12,13 +13,14 @@ module Mail
         EightBit.can_encode? str
       end
 
-      # Decode the string from Quoted-Printable
+      # 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)
-        str.unpack("M*").first
+        ::Mail::Utilities.to_lf str.gsub(/(?:=0D=0A|=0D|=0A)\r\n/, "\r\n").unpack("M*").first
       end
 
       def self.encode(str)
-        [str].pack("M").to_crlf
+        ::Mail::Utilities.to_crlf([::Mail::Utilities.to_lf(str)].pack("M"))
       end
 
       def self.cost(str)
@@ -29,7 +31,12 @@ module Mail
         total = (str.bytesize - c)*3 + c
         total.to_f/str.bytesize
       end
-        
+
+      # QP inserts newlines automatically and cannot violate the SMTP spec.
+      def self.compatible_input?(str)
+        true
+      end
+
       private
 
       Encodings.register(NAME, self)

data/lib/mail/encodings/transfer_encoding.rb

@@ -1,4 +1,5 @@
 # encoding: utf-8
+# frozen_string_literal: true
 module Mail
   module Encodings
     class TransferEncoding
@@ -23,30 +24,39 @@ module Mail
         raise "Unimplemented"
       end
 
+      def self.compatible_input?(str)
+        true
+      end
+
       def self.to_s
         self::NAME
       end
 
       def self.get_best_compatible(source_encoding, str)
-        if self.can_transport? source_encoding then
-            source_encoding 
+        if self.can_transport?(source_encoding) && self.compatible_input?(str)
+          source_encoding
         else
-            choices = []
-            Encodings.get_all.each do |enc|
-                choices << enc if self.can_transport? enc and enc.can_encode? source_encoding
-            end
-            best = nil 
-            best_cost = 100
-            choices.each do |enc|
-                this_cost = enc.cost str
-                if this_cost < best_cost then
-                    best_cost = this_cost
-                    best = enc
-                elsif this_cost == best_cost then 
-                    best = enc if enc::PRIORITY < best::PRIORITY
-                end
+          choices = Encodings.get_all.select do |enc|
+            self.can_transport?(enc) && enc.can_encode?(source_encoding)
+          end
+
+          best = nil
+          best_cost = nil
+
+          choices.each do |enc|
+            # If the current choice cannot be transported safely,
+            # give priority to other choices but allow it to be used as a fallback.
+            this_cost = enc.cost(str) if enc.compatible_input?(str)
+
+            if !best_cost || (this_cost && this_cost < best_cost)
+              best_cost = this_cost
+              best = enc
+            elsif this_cost == best_cost
+              best = enc if enc::PRIORITY < best::PRIORITY
             end
-            best
+          end
+
+          best
         end
       end
 

data/lib/mail/encodings/unix_to_unix.rb

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+module Mail
+  module Encodings
+    module UnixToUnix
+      NAME = "x-uuencode"
+
+      def self.decode(str)
+        str.sub(/\Abegin \d+ [^\n]*\n/, '').unpack('u').first
+      end
+
+      def self.encode(str)
+        [str].pack("u")
+      end
+
+      Encodings.register(NAME, self)
+    end
+  end
+end

data/lib/mail/encodings.rb

@@ -1,4 +1,5 @@
 # encoding: utf-8
+# frozen_string_literal: true
 
 module Mail
   # Raised when attempting to decode an unknown encoding type
@@ -7,7 +8,7 @@ module Mail
 
   module Encodings
 
-    include Mail::Patterns
+    include Mail::Constants
     extend  Mail::Utilities
 
     @transfer_encodings = {}
@@ -47,13 +48,21 @@ module Mail
     end
 
     def Encodings.get_name(enc)
-      enc = enc.to_s.gsub("-", "_").downcase
+      underscoreize(enc).downcase
+    end
+
+    def Encodings.transcode_charset(str, from_charset, to_charset = 'UTF-8')
+      if from_charset
+        RubyVer.transcode_charset str, from_charset, to_charset
+      else
+        str
+      end
     end
 
     # Encodes a parameter value using URI Escaping, note the language field 'en' can
     # be set using Mail::Configuration, like so:
     #
-    #  Mail.defaults.do
+    #  Mail.defaults do
     #    param_encode_language 'jp'
     #  end
     #
@@ -114,32 +123,16 @@ 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.index("=?")
+      return str unless str =~ ENCODED_VALUE
 
-      str = str.gsub(/\?=(\s*)=\?/, '?==?') # Remove whitespaces between 'encoded-word's
+      lines = collapse_adjacent_encodings(str)
 
       # Split on white-space boundaries with capture, so we capture the white-space as well
-      str.split(/([ \t])/).map do |text|
-        if text.index('=?') .nil?
-          text
-        else
-          # Join QP encoded-words that are adjacent to avoid decoding partial chars
-          text.gsub!(/\?\=\=\?.+?\?[Qq]\?/m, '') if text =~ /\?==\?/
-
-          # Search for occurences of quoted strings or plain strings
-          text.scan(/(                                  # Group around entire regex to include it in matches
-                       \=\?[^?]+\?([QB])\?[^?]+?\?\=  # Quoted String with subgroup for encoding method
-                       |                                # or
-                       .+?(?=\=\?|$)                    # Plain String
-                     )/xmi).map do |matches|
-            string, method = *matches
-            if    method == 'b' || method == 'B'
-              b_value_decode(string)
-            elsif method == 'q' || method == 'Q'
-              q_value_decode(string)
-            else
-              string
-            end
+      lines.each do |line|
+        line.gsub!(ENCODED_VALUE) do |string|
+          case $2
+          when *B_VALUES then b_value_decode(string)
+          when *Q_VALUES then q_value_decode(string)
           end
         end
       end.join("")
@@ -148,7 +141,7 @@ module Mail
     # Takes an encoded string of the format =?<encoding>?[QB]?<string>?=
     def Encodings.unquote_and_convert_to(str, to_encoding)
       output = value_decode( str ).to_s # output is already converted to UTF-8
-      
+
       if 'utf8' == to_encoding.to_s.downcase.gsub("-", "")
         output
       elsif to_encoding
@@ -157,7 +150,7 @@ module Mail
             output.encode(to_encoding)
           else
             require 'iconv'
-            Iconv.iconv(to_encoding, 'UTF-8', output).first 
+            Iconv.iconv(to_encoding, 'UTF-8', output).first
           end
         rescue Iconv::IllegalSequence, Iconv::InvalidEncoding, Errno::EINVAL
           # the 'from' parameter specifies a charset other than what the text
@@ -194,8 +187,8 @@ module Mail
         if word.ascii_only?
           word
         else
-          previous_non_ascii = tokens[i-1] && !tokens[i-1].ascii_only?
-          if previous_non_ascii
+          previous_non_ascii = i>0 && tokens[i-1] && !tokens[i-1].ascii_only?
+          if previous_non_ascii #why are we adding an extra space here?
             word = " #{word}"
           end
           Encodings.b_value_encode(word, charset)
@@ -256,17 +249,39 @@ module Mail
       RubyVer.q_value_decode(str)
     end
 
-    def Encodings.split_encoding_from_string( str )
-      match = str.match(/\=\?([^?]+)?\?[QB]\?(.+)?\?\=/mi)
-      if match
-        match[1]
-      else
-        nil
-      end
-    end
-
     def Encodings.find_encoding(str)
       RUBY_VERSION >= '1.9' ? str.encoding : $KCODE
     end
+
+    # Gets the encoding type (Q or B) from the string.
+    def Encodings.value_encoding_from_string(str)
+      str[ENCODED_VALUE, 1]
+    end
+
+    # When the encoded string consists of multiple lines, lines with the same
+    # encoding (Q or B) can be joined together.
+    #
+    # String has to be of the format =?<encoding>?[QB]?<string>?=
+    def Encodings.collapse_adjacent_encodings(str)
+      results = []
+      previous_encoding = nil
+      lines = str.split(FULL_ENCODED_VALUE)
+      lines.each_slice(2) do |unencoded, encoded|
+        if encoded
+          encoding = value_encoding_from_string(encoded)
+          if encoding == previous_encoding && Utilities.blank?(unencoded)
+            results.last << encoded
+          else
+            results << unencoded unless unencoded == EMPTY
+            results << encoded
+          end
+          previous_encoding = encoding
+        else
+          results << unencoded
+        end
+      end
+
+      results
+    end
   end
 end

data/lib/mail/envelope.rb

@@ -1,4 +1,5 @@
 # encoding: utf-8
+# frozen_string_literal: true
 # 
 # = Mail Envelope
 # 
@@ -14,11 +15,6 @@ module Mail
       super(FIELD_NAME, strip_field(FIELD_NAME, args.last))
     end
     
-    def tree
-      @element ||= Mail::EnvelopeFromElement.new(value)
-      @tree ||= @element.tree
-    end
-    
     def element
       @element ||= Mail::EnvelopeFromElement.new(value)
     end