mail 2.7.1 → 2.9.1

data/lib/mail/elements/address.rb

@@ -1,27 +1,27 @@
 # encoding: utf-8
 # frozen_string_literal: true
 require 'mail/parsers/address_lists_parser'
+require 'mail/constants'
+require 'mail/utilities'
 
 module Mail
+  # Mail::Address handles all email addresses in Mail.  It takes an email address string
+  # and parses it, breaking it down into its component parts and allowing you to get the
+  # address, comments, display name, name, local part, domain part and fully formatted
+  # address.
+  #
+  # Mail::Address requires a correctly formatted email address per RFC2822 or RFC822.  It
+  # handles all obsolete versions including obsolete domain routing on the local part.
+  #
+  #  a = Address.new('Mikel Lindsaar (My email address) <mikel@test.lindsaar.net>')
+  #  a.format       #=> 'Mikel Lindsaar <mikel@test.lindsaar.net> (My email address)'
+  #  a.address      #=> 'mikel@test.lindsaar.net'
+  #  a.display_name #=> 'Mikel Lindsaar'
+  #  a.local        #=> 'mikel'
+  #  a.domain       #=> 'test.lindsaar.net'
+  #  a.comments     #=> ['My email address']
+  #  a.to_s         #=> 'Mikel Lindsaar <mikel@test.lindsaar.net> (My email address)'
   class Address
-    include Mail::Utilities
-
-    # Mail::Address handles all email addresses in Mail.  It takes an email address string
-    # and parses it, breaking it down into its component parts and allowing you to get the
-    # address, comments, display name, name, local part, domain part and fully formatted
-    # address.
-    #
-    # Mail::Address requires a correctly formatted email address per RFC2822 or RFC822.  It
-    # handles all obsolete versions including obsolete domain routing on the local part.
-    #
-    #  a = Address.new('Mikel Lindsaar (My email address) <mikel@test.lindsaar.net>')
-    #  a.format       #=> 'Mikel Lindsaar <mikel@test.lindsaar.net> (My email address)'
-    #  a.address      #=> 'mikel@test.lindsaar.net'
-    #  a.display_name #=> 'Mikel Lindsaar'
-    #  a.local        #=> 'mikel'
-    #  a.domain       #=> 'test.lindsaar.net'
-    #  a.comments     #=> ['My email address']
-    #  a.to_s         #=> 'Mikel Lindsaar <mikel@test.lindsaar.net> (My email address)'
     def initialize(value = nil)
       if value.nil?
         @parsed = false
@@ -47,11 +47,11 @@ module Mail
     def format(output_type = :decode)
       parse unless @parsed
       if @data.nil?
-        EMPTY
+        Constants::EMPTY
       elsif name = display_name(output_type)
-        [quote_phrase(name), "<#{address(output_type)}>", format_comments].compact.join(SPACE)
+        [Utilities.quote_phrase(name), "<#{address(output_type)}>", format_comments].compact.join(Constants::SPACE)
       elsif a = address(output_type)
-        [a, format_comments].compact.join(SPACE)
+        [a, format_comments].compact.join(Constants::SPACE)
       else
         raw
       end
@@ -135,7 +135,7 @@ module Mail
       if comments.nil? || comments.none?
         nil
       else
-        comments.map { |c| c.squeeze(SPACE) }
+        comments.map { |c| c.squeeze(Constants::SPACE) }
       end
     end
 
@@ -198,7 +198,7 @@ module Mail
     def strip_all_comments(string)
       unless Utilities.blank?(comments)
         comments.each do |comment|
-          string = string.gsub("(#{comment})", EMPTY)
+          string = string.gsub("(#{comment})", Constants::EMPTY)
         end
       end
       string.strip
@@ -208,7 +208,7 @@ module Mail
       unless Utilities.blank?(comments)
         comments.each do |comment|
           if @data.domain && @data.domain.include?("(#{comment})")
-            value = value.gsub("(#{comment})", EMPTY)
+            value = value.gsub("(#{comment})", Constants::EMPTY)
           end
         end
       end
@@ -228,15 +228,15 @@ module Mail
       if display_name
         str = display_name
       elsif comments
-        str = "(#{comments.join(SPACE).squeeze(SPACE)})"
+        str = "(#{comments.join(Constants::SPACE).squeeze(Constants::SPACE)})"
       end
 
-      unparen(str) unless Utilities.blank?(str)
+      Utilities.unparen(str) unless Utilities.blank?(str)
     end
 
     def format_comments
       if comments
-        comment_text = comments.map {|c| escape_paren(c) }.join(SPACE).squeeze(SPACE)
+        comment_text = comments.map {|c| Utilities.escape_paren(c) }.join(Constants::SPACE).squeeze(Constants::SPACE)
         @format_comments ||= "(#{comment_text})"
       else
         nil

data/lib/mail/elements/address_list.rb

@@ -3,7 +3,7 @@
 require 'mail/parsers/address_lists_parser'
 
 module Mail
-  class AddressList # :nodoc:
+  class AddressList #:nodoc:
     attr_reader :addresses, :group_names
 
     # Mail::AddressList is the class that parses To, From and other address fields from

data/lib/mail/elements/content_disposition_element.rb

@@ -3,7 +3,7 @@
 require 'mail/parsers/content_disposition_parser'
 
 module Mail
-  class ContentDispositionElement # :nodoc:
+  class ContentDispositionElement #:nodoc:
     attr_reader :disposition_type, :parameters
 
     def initialize(string)

data/lib/mail/elements/content_location_element.rb

@@ -3,7 +3,7 @@
 require 'mail/parsers/content_location_parser'
 
 module Mail
-  class ContentLocationElement # :nodoc:
+  class ContentLocationElement #:nodoc:
     attr_reader :location
 
     def initialize(string)

data/lib/mail/elements/content_transfer_encoding_element.rb

@@ -3,7 +3,7 @@
 require 'mail/parsers/content_transfer_encoding_parser'
 
 module Mail
-  class ContentTransferEncodingElement
+  class ContentTransferEncodingElement #:nodoc:
     attr_reader :encoding
 
     def initialize(string)

data/lib/mail/elements/content_type_element.rb

@@ -3,7 +3,7 @@
 require 'mail/parsers/content_type_parser'
 
 module Mail
-  class ContentTypeElement # :nodoc:
+  class ContentTypeElement #:nodoc:
     attr_reader :main_type, :sub_type, :parameters
 
     def initialize(string)
@@ -14,8 +14,12 @@ module Mail
     end
 
     private
-    def cleaned(string)
-      string =~ /(.+);\s*$/ ? $1 : string
-    end
+      def cleaned(string)
+        if string =~ /;\s*$/
+          $`
+        else
+          string
+        end
+      end
   end
 end

data/lib/mail/elements/date_time_element.rb

@@ -3,7 +3,7 @@
 require 'mail/parsers/date_time_parser'
 
 module Mail
-  class DateTimeElement # :nodoc:
+  class DateTimeElement #:nodoc:
     attr_reader :date_string, :time_string
 
     def initialize(string)

data/lib/mail/elements/envelope_from_element.rb

@@ -4,13 +4,13 @@ require 'mail/parsers/envelope_from_parser'
 require 'date'
 
 module Mail
-  class EnvelopeFromElement
+  class EnvelopeFromElement #:nodoc:
     attr_reader :date_time, :address
 
     def initialize(string)
       envelope_from = Mail::Parsers::EnvelopeFromParser.parse(string)
       @address = envelope_from.address
-      @date_time = ::DateTime.parse(envelope_from.ctime_date)
+      @date_time = ::DateTime.parse(envelope_from.ctime_date) if envelope_from.ctime_date
     end
 
     # RFC 4155:
@@ -19,15 +19,21 @@ module Mail
     #   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'
+      if date_time
+        if date_time.respond_to?(:ctime)
+          date_time.ctime
+        else
+          date_time.strftime '%a %b %e %T %Y'
+        end
       end
     end
 
     def to_s
-      "#{address} #{formatted_date_time}"
+      if date_time
+        "#{address} #{formatted_date_time}"
+      else
+        address
+      end
     end
   end
 end

data/lib/mail/elements/message_ids_element.rb

@@ -1,13 +1,18 @@
 # encoding: utf-8
 # frozen_string_literal: true
 require 'mail/parsers/message_ids_parser'
+require 'mail/utilities'
 
 module Mail
-  class MessageIdsElement
+  class MessageIdsElement #:nodoc:
+    def self.parse(string)
+      new(string).tap(&:message_ids)
+    end
+
     attr_reader :message_ids
 
     def initialize(string)
-      @message_ids = Mail::Parsers::MessageIdsParser.parse(string).message_ids.map { |msg_id| clean_msg_id(msg_id) }
+      @message_ids = parse(string)
     end
 
     def message_id
@@ -15,8 +20,12 @@ module Mail
     end
 
     private
-    def clean_msg_id(val)
-      val =~ /.*<(.*)>.*/ ? $1 : val
-    end
+      def parse(string)
+        if Utilities.blank? string
+          []
+        else
+          Mail::Parsers::MessageIdsParser.parse(string).message_ids
+        end
+      end
   end
 end

data/lib/mail/elements/mime_version_element.rb

@@ -3,7 +3,7 @@
 require 'mail/parsers/mime_version_parser'
 
 module Mail
-  class MimeVersionElement
+  class MimeVersionElement #:nodoc:
     attr_reader :major, :minor
 
     def initialize(string)

data/lib/mail/elements/phrase_list.rb

@@ -4,11 +4,16 @@ require 'mail/parsers/phrase_lists_parser'
 require 'mail/utilities'
 
 module Mail
-  class PhraseList
+  class PhraseList #:nodoc:
     attr_reader :phrases
 
     def initialize(string)
-      @phrases = Mail::Parsers::PhraseListsParser.parse(string).phrases.map { |p| Mail::Utilities.unquote(p) }
+      @phrases =
+        if Utilities.blank? string
+          []
+        else
+          Mail::Parsers::PhraseListsParser.parse(string).phrases.map { |p| Mail::Utilities.unquote(p) }
+        end
     end
   end
 end

data/lib/mail/elements/received_element.rb

@@ -1,21 +1,35 @@
 # encoding: utf-8
 # frozen_string_literal: true
 require 'mail/parsers/received_parser'
+require 'mail/utilities'
 require 'date'
 
 module Mail
-  class ReceivedElement
-    include Mail::Utilities
-    attr_reader :date_time, :info
+  class ReceivedElement #:nodoc:
+    attr_reader :info, :date_time
 
     def initialize(string)
-      received = Mail::Parsers::ReceivedParser.parse(string)
-      @date_time = ::DateTime.parse("#{received.date} #{received.time}")
-      @info = received.info
+      if Utilities.blank? string
+        @date_time = nil
+        @info = nil
+      else
+        received = Mail::Parsers::ReceivedParser.parse(string)
+        @date_time = datetime_for(received)
+        @info = received.info
+      end
     end
 
     def to_s(*args)
       "#{info}; #{date_time.to_s(*args)}"
     end
+
+    private
+      def datetime_for(received)
+        ::DateTime.parse("#{received.date} #{received.time}")
+      rescue ArgumentError => e
+        raise e unless e.message == 'invalid date'
+        warn "WARNING: Invalid date field for received element (#{received.date} #{received.time}): #{e.class}: #{e.message}"
+        nil
+      end
   end
 end

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

@@ -17,6 +17,11 @@ module Mail
       def self.encode(str)
         ::Mail::Utilities.binary_unsafe_to_crlf str
       end
+
+      # Per RFC 2045 2.7. 7bit Data, No octets with decimal values greater than 127 are allowed.
+      def self.compatible_input?(str)
+        str.ascii_only? && super
+      end
     end
   end
 end

data/lib/mail/encodings/base64.rb

@@ -16,11 +16,11 @@ module Mail
       end
 
       def self.decode(str)
-        RubyVer.decode_base64(str)
+        Utilities.decode_base64(str)
       end
 
       def self.encode(str)
-        ::Mail::Utilities.binary_unsafe_to_crlf(RubyVer.encode_base64(str))
+        ::Mail::Utilities.binary_unsafe_to_crlf(Utilities.encode_base64(str))
       end
 
       # 3 bytes in -> 4 bytes out

data/lib/mail/encodings/quoted_printable.rb

@@ -16,11 +16,11 @@ 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)
-        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)
-        [str].pack("M")
+        ::Mail::Utilities.to_crlf [::Mail::Utilities.to_lf(str)].pack("M")
       end
 
       def self.cost(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

@@ -52,7 +52,7 @@ module Mail
 
     def Encodings.transcode_charset(str, from_charset, to_charset = 'UTF-8')
       if from_charset
-        RubyVer.transcode_charset str, from_charset, to_charset
+        Utilities.transcode_charset str, from_charset, to_charset
       else
         str
       end
@@ -65,20 +65,19 @@ module Mail
     #    param_encode_language 'jp'
     #  end
     #
-    # The character set used for encoding will either be the value of $KCODE for
-    # Ruby < 1.9 or the encoding on the string passed in.
+    # The character set used for encoding will be the encoding on the string passed in.
     #
     # Example:
     #
     #  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
       else
-        RubyVer.param_encode(str)
+        Utilities.param_encode(str)
       end
     end
 
@@ -92,15 +91,15 @@ module Mail
     #  str.encoding #=> 'ISO-8859-1'      ## Only on Ruby 1.9
     #  str #=> "This is fun"
     def Encodings.param_decode(str, encoding)
-      RubyVer.param_decode(str, encoding)
+      Utilities.param_decode(str, encoding)
     end
 
     # Decodes or encodes a string as needed for either Base64 or QP encoding types in
     # the =?<encoding>?[QB]?<string>?=" format.
     #
     # The output type needs to be :decode to decode the input string or :encode to
-    # encode the input string.  The character set used for encoding will either be
-    # the value of $KCODE for Ruby < 1.9 or the encoding on the string passed in.
+    # encode the input string.  The character set used for encoding will be the
+    # encoding on the string passed in.
     #
     # On encoding, will only send out Base64 encoded strings.
     def Encodings.decode_encode(str, output_type)
@@ -111,7 +110,7 @@ module Mail
         if str.ascii_only?
           str
         else
-          Encodings.b_value_encode(str, find_encoding(str))
+          Encodings.b_value_encode(str, str.encoding)
         end
       end
     end
@@ -122,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)
 
@@ -145,13 +144,8 @@ module Mail
         output
       elsif to_encoding
         begin
-          if RUBY_VERSION >= '1.9'
-            output.encode(to_encoding)
-          else
-            require 'iconv'
-            Iconv.iconv(to_encoding, 'UTF-8', output).first
-          end
-        rescue Iconv::IllegalSequence, Iconv::InvalidEncoding, Errno::EINVAL
+          output.encode(to_encoding)
+        rescue Errno::EINVAL
           # the 'from' parameter specifies a charset other than what the text
           # actually is...not much we can do in this case but just return the
           # unconverted text.
@@ -176,42 +170,23 @@ module Mail
     def Encodings.encode_non_usascii(address, charset)
       return address if address.ascii_only? or charset.nil?
 
-      # With KCODE=u we can't use regexps on other encodings. Go ASCII.
-      with_ascii_kcode do
-        # Encode all strings embedded inside of quotes
-        address = address.gsub(/("[^"]*[^\/]")/) { |s| Encodings.b_value_encode(unquote(s), charset) }
-
-        # Then loop through all remaining items and encode as needed
-        tokens = address.split(/\s/)
-
-        map_with_index(tokens) do |word, i|
-          if word.ascii_only?
-            word
-          else
-            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)
-          end
-        end.join(' ')
-      end
-    end
+      # Encode all strings embedded inside of quotes
+      address = address.gsub(/("[^"]*[^\/]")/) { |s| Encodings.b_value_encode(unquote(s), charset) }
+
+      # Then loop through all remaining items and encode as needed
+      tokens = address.split(/\s/)
 
-    if RUBY_VERSION < '1.9'
-      # With KCODE=u we can't use regexps on other encodings. Go ASCII.
-      def Encodings.with_ascii_kcode #:nodoc:
-        if $KCODE
-          $KCODE, original_kcode = '', $KCODE
+      map_with_index(tokens) do |word, i|
+        if word.ascii_only?
+          word
+        else
+          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)
         end
-        yield
-      ensure
-        $KCODE = original_kcode if original_kcode
-      end
-    else
-      def Encodings.with_ascii_kcode #:nodoc:
-        yield
-      end
+      end.join(' ')
     end
 
     # Encode a string with Base64 Encoding and returns it ready to be inserted
@@ -226,7 +201,7 @@ module Mail
         string
       else
         Encodings.each_base64_chunk_byterange(string, 60).map do |chunk|
-          str, encoding = RubyVer.b_value_encode(chunk, encoding)
+          str, encoding = Utilities.b_value_encode(chunk, encoding)
           "=?#{encoding}?B?#{str.chomp}?="
         end.join(" ")
       end
@@ -241,7 +216,7 @@ module Mail
     #  #=> "=?UTF-8?Q?This_is_=E3=81=82_string?="
     def Encodings.q_value_encode(encoded_str, encoding = nil)
       return encoded_str if encoded_str.to_s.ascii_only?
-      string, encoding = RubyVer.q_value_encode(encoded_str, encoding)
+      string, encoding = Utilities.q_value_encode(encoded_str, encoding)
       string.gsub!("=\r\n", '') # We already have limited the string to the length we want
       map_lines(string) do |str|
         "=?#{encoding}?Q?#{str.chomp.gsub(/ /, '_')}?="
@@ -257,7 +232,7 @@ module Mail
     #  Encodings.b_value_decode("=?UTF-8?B?VGhpcyBpcyDjgYIgc3RyaW5n?=")
     #  #=> 'This is あ string'
     def Encodings.b_value_decode(str)
-      RubyVer.b_value_decode(str)
+      Utilities.b_value_decode(str)
     end
 
     # Decodes a Quoted-Printable string from the "=?UTF-8?Q?This_is_=E3=81=82_string?=" format
@@ -267,11 +242,7 @@ module Mail
     #  Encodings.q_value_decode("=?UTF-8?Q?This_is_=E3=81=82_string?=")
     #  #=> 'This is あ string'
     def Encodings.q_value_decode(str)
-      RubyVer.q_value_decode(str)
-    end
-
-    def Encodings.find_encoding(str)
-      RUBY_VERSION >= '1.9' ? str.encoding : $KCODE
+      Utilities.q_value_decode(str)
     end
 
     # Gets the encoding type (Q or B) from the string.
@@ -329,7 +300,7 @@ module Mail
         charsize = chr.bytesize
 
         if chunksize + charsize > max_bytesize_per_chunk
-          yield RubyVer.string_byteslice(str, offset, chunksize)
+          yield Utilities.string_byteslice(str, offset, chunksize)
           offset += chunksize
           chunksize = charsize
         else
@@ -337,7 +308,7 @@ module Mail
         end
       end
 
-      yield RubyVer.string_byteslice(str, offset, chunksize)
+      yield Utilities.string_byteslice(str, offset, chunksize)
     end
   end
 end

data/lib/mail/envelope.rb

@@ -1,31 +1,28 @@
 # encoding: utf-8
 # frozen_string_literal: true
-# 
+#
 # = Mail Envelope
-# 
+#
 # The Envelope class provides a field for the first line in an
 # mbox file, that looks like "From mikel@test.lindsaar.net DATETIME"
-# 
+#
 # This envelope class reads that line, and turns it into an
 # Envelope.from and Envelope.date for your use.
+
 module Mail
-  class Envelope < StructuredField
-    
-    def initialize(*args)
-      super(FIELD_NAME, args.last.to_s)
-    end
-    
+  class Envelope < NamedStructuredField
+    NAME = 'Envelope-From'
+
     def element
       @element ||= Mail::EnvelopeFromElement.new(value)
     end
-    
-    def date
-      ::DateTime.parse("#{element.date_time}")
-    end
 
     def from
       element.address
     end
-    
+
+    def date
+      element.date_time
+    end
   end
 end