mail 2.5.3 → 2.5.4

data/lib/mail/elements/envelope_from_element.rb

@@ -26,8 +26,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/encodings.rb

@@ -53,7 +53,7 @@ module Mail
     # 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,41 +114,40 @@ 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 =~ /\=\?[^?]+\?[QB]\?[^?]+?\?\=/xmi
 
-      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
+      lines.map do |line|
+        line.split(/([ \t])/).map do |text|
+          if text.index('=?').nil?
+            text
+          else
+            # 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
             end
           end
         end
-      end.join("")
+      end.flatten.join("")
     end
 
     # 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 +156,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 +193,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)
@@ -268,5 +267,39 @@ module Mail
     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.split_value_encoding_from_string(str)
+      match = str.match(/\=\?[^?]+?\?([QB])\?(.+)?\?\=/mi)
+      if match
+        match[1]
+      else
+        nil
+      end
+    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)
+      lines = str.split(/(\?=)\s*(=\?)/).each_slice(2).map(&:join)
+      results = []
+      previous_encoding = nil
+
+      lines.each do |line|
+        encoding = split_value_encoding_from_string(line)
+
+        if encoding == previous_encoding
+          line = results.pop + line
+          line.gsub!(/\?\=\=\?.+?\?[QqBb]\?/m, '')
+        end
+
+        previous_encoding = encoding
+        results << line
+      end
+
+      results
+    end
   end
 end

data/lib/mail/encodings/quoted_printable.rb

@@ -12,13 +12,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
+        str.gsub(/(?:=0D=0A|=0D|=0A)\r\n/, "\r\n").unpack("M*").first.to_lf
       end
 
       def self.encode(str)
-        [str].pack("M").to_crlf
+        [str.to_lf].pack("M").to_crlf
       end
 
       def self.cost(str)

data/lib/mail/field.rb

@@ -156,9 +156,11 @@ module Mail
     alias_method :==, :same
 
     def <=>( other )
-      self_order = FIELD_ORDER.rindex(self.name.to_s.downcase) || 100
-      other_order = FIELD_ORDER.rindex(other.name.to_s.downcase) || 100
-      self_order <=> other_order
+      self.field_order_id <=> other.field_order_id
+    end
+
+    def field_order_id
+      @field_order_id ||= (FIELD_ORDER_LOOKUP[self.name.to_s.downcase] || 100)
     end
 
     def method_missing(name, *args, &block)
@@ -174,10 +176,12 @@ module Mail
                       mime-version content-type content-transfer-encoding
                       content-location content-disposition content-description ]
 
+    FIELD_ORDER_LOOKUP = Hash[FIELD_ORDER.each_with_index.to_a]
+
     private
 
     def split(raw_field)
-      match_data = raw_field.mb_chars.match(/^(#{FIELD_NAME})\s*:\s*(#{FIELD_BODY})?$/)
+      match_data = raw_field.mb_chars.match(FIELD_SPLIT)
       [match_data[1].to_s.mb_chars.strip, match_data[2].to_s.mb_chars.strip]
     rescue
       STDERR.puts "WARNING: Could not parse (and so ignoring) '#{raw_field}'"
@@ -195,16 +199,11 @@ module Mail
 
     def new_field(name, value, charset)
       lower_case_name = name.to_s.downcase
-      header_name = nil
-      FIELDS_MAP.each do |field_name, _|
-        header_name = field_name if lower_case_name == field_name
-      end
-      if header_name
-        FIELDS_MAP[header_name].new(value, charset)
+      if field_klass = FIELDS_MAP[lower_case_name]
+        field_klass.new(value, charset)
       else
         OptionalField.new(name, value, charset)
       end
-
     end
 
   end

data/lib/mail/fields/bcc_field.rb

@@ -6,7 +6,7 @@
 # field in the email.
 # 
 # Sending bcc to a mail message will instantiate a Mail::Field object that
-# has a BccField as it's field type.  This includes all Mail::CommonAddress
+# has a BccField as its field type.  This includes all Mail::CommonAddress
 # module instance metods.
 # 
 # Only one Bcc field can appear in a header, though it can have multiple
@@ -16,7 +16,7 @@
 # 
 #  mail = Mail.new
 #  mail.bcc = 'Mikel Lindsaar <mikel@test.lindsaar.net>, ada@test.lindsaar.net'
-#  mail.bcc    #=> ['Mikel Lindsaar <mikel@test.lindsaar.net>', 'ada@test.lindsaar.net']
+#  mail.bcc    #=> ['mikel@test.lindsaar.net', 'ada@test.lindsaar.net']
 #  mail[:bcc]  #=> '#<Mail::Field:0x180e5e8 @field=#<Mail::BccField:0x180e1c4
 #  mail['bcc'] #=> '#<Mail::Field:0x180e5e8 @field=#<Mail::BccField:0x180e1c4
 #  mail['Bcc'] #=> '#<Mail::Field:0x180e5e8 @field=#<Mail::BccField:0x180e1c4

data/lib/mail/fields/cc_field.rb

@@ -6,7 +6,7 @@
 # field in the email.
 # 
 # Sending cc to a mail message will instantiate a Mail::Field object that
-# has a CcField as it's field type.  This includes all Mail::CommonAddress
+# has a CcField as its field type.  This includes all Mail::CommonAddress
 # module instance metods.
 # 
 # Only one Cc field can appear in a header, though it can have multiple
@@ -16,7 +16,7 @@
 # 
 #  mail = Mail.new
 #  mail.cc = 'Mikel Lindsaar <mikel@test.lindsaar.net>, ada@test.lindsaar.net'
-#  mail.cc    #=> ['Mikel Lindsaar <mikel@test.lindsaar.net>', 'ada@test.lindsaar.net']
+#  mail.cc    #=> ['mikel@test.lindsaar.net', 'ada@test.lindsaar.net']
 #  mail[:cc]  #=> '#<Mail::Field:0x180e5e8 @field=#<Mail::CcField:0x180e1c4
 #  mail['cc'] #=> '#<Mail::Field:0x180e5e8 @field=#<Mail::CcField:0x180e1c4
 #  mail['Cc'] #=> '#<Mail::Field:0x180e5e8 @field=#<Mail::CcField:0x180e1c4

data/lib/mail/fields/comments_field.rb

@@ -6,7 +6,7 @@
 # header field in the email.
 # 
 # Sending comments to a mail message will instantiate a Mail::Field object that
-# has a CommentsField as it's field type.
+# has a CommentsField as its field type.
 #  
 # An email header can have as many comments fields as it wants.  There is no upper
 # limit, the comments field is also optional (that is, no comment is needed)

data/lib/mail/fields/common/common_address.rb

@@ -62,7 +62,17 @@ module Mail
   
     # Returns the addresses that are part of groups
     def group_addresses
-      groups.map { |k,v| v.map { |a| a.format } }.flatten
+      decoded_group_addresses
+    end
+
+    # Returns a list of decoded group addresses
+    def decoded_group_addresses
+      groups.map { |k,v| v.map { |a| a.decoded } }.flatten
+    end
+
+    # Returns a list of encoded group addresses
+    def encoded_group_addresses
+      groups.map { |k,v| v.map { |a| a.encoded } }.flatten
     end
 
     # Returns the name of all the groups in a string
@@ -94,7 +104,7 @@ module Mail
   
     def do_encode(field_name)
       return '' if value.blank?
-      address_array = tree.addresses.reject { |a| group_addresses.include?(a.encoded) }.compact.map { |a| a.encoded }
+      address_array = tree.addresses.reject { |a| encoded_group_addresses.include?(a.encoded) }.compact.map { |a| a.encoded }
       address_text  = address_array.join(", \r\n\s")
       group_array = groups.map { |k,v| "#{k}: #{v.map { |a| a.encoded }.join(", \r\n\s")};" }
       group_text  = group_array.join(" \r\n\s")
@@ -104,7 +114,7 @@ module Mail
 
     def do_decode
       return nil if value.blank?
-      address_array = tree.addresses.reject { |a| group_addresses.include?(a.decoded) }.map { |a| a.decoded }
+      address_array = tree.addresses.reject { |a| decoded_group_addresses.include?(a.decoded) }.map { |a| a.decoded }
       address_text  = address_array.join(", ")
       group_array = groups.map { |k,v| "#{k}: #{v.map { |a| a.decoded }.join(", ")};" }
       group_text  = group_array.join(" ")

data/lib/mail/fields/common/common_field.rb

@@ -22,7 +22,7 @@ module Mail
     end
 
     def to_s
-      decoded
+      decoded.to_s
     end
 
     def default
@@ -47,11 +47,11 @@ module Mail
       end
     end
 
+    FILENAME_RE = /\b(filename|name)=([^;"\r\n]+\s[^;"\r\n]+)/
     def ensure_filename_quoted(value)
-      if !value.is_a?(Array) and /(.)*\s(filename|name)=[^"](.+\s)+[^"]/.match value
-        value.gsub!(/[^=]+$/, '"\\0"')
+      if value.is_a?(String)
+        value.sub! FILENAME_RE, '\1="\2"'
       end
     end
-
   end
 end

data/lib/mail/fields/content_id_field.rb

@@ -55,8 +55,7 @@ module Mail
     private
     
     def generate_content_id
-      fqdn = ::Socket.gethostname
-      "<#{Mail.random_tag}@#{fqdn}.mail>"
+      "<#{Mail.random_tag}@#{::Socket.gethostname}.mail>"
     end
     
   end

data/lib/mail/fields/content_transfer_encoding_field.rb

@@ -10,8 +10,8 @@ module Mail
     
     def initialize(value = nil, charset = 'utf-8')
       self.charset = charset
-      value = '7bit' if value.to_s =~ /7-bit/i
-      value = '8bit' if value.to_s =~ /8-bit/i
+      value = '7bit' if value.to_s =~ /7-?bits?/i
+      value = '8bit' if value.to_s =~ /8-?bits?/i
       super(CAPITALIZED_FIELD, strip_field(FIELD_NAME, value), charset)
       self.parse
       self

data/lib/mail/fields/content_type_field.rb

@@ -180,7 +180,7 @@ module Mail
         params = $2.to_s.split(/\s+/)
         params = params.map { |i| i.to_s.chomp.strip }
         params = params.map { |i| i.split(/\s*\=\s*/) }
-        params = params.map { |i| "#{i[0]}=#{dquote(i[1].to_s)}" }.join('; ')
+        params = params.map { |i| "#{i[0]}=#{dquote(i[1].to_s.gsub(/;$/,""))}" }.join('; ')
         "#{type}; #{params}"
       when val =~ /^\s*$/
         'text/plain'

data/lib/mail/fields/date_field.rb

@@ -6,7 +6,7 @@
 # field in the email.
 #
 # Sending date to a mail message will instantiate a Mail::Field object that
-# has a DateField as it's field type.  This includes all Mail::CommonAddress
+# has a DateField as its field type.  This includes all Mail::CommonAddress
 # module instance methods.
 #
 # There must be excatly one Date field in an RFC2822 email.

data/lib/mail/fields/from_field.rb

@@ -6,7 +6,7 @@
 # field in the email.
 # 
 # Sending from to a mail message will instantiate a Mail::Field object that
-# has a FromField as it's field type.  This includes all Mail::CommonAddress
+# has a FromField as its field type.  This includes all Mail::CommonAddress
 # module instance metods.
 # 
 # Only one From field can appear in a header, though it can have multiple
@@ -16,7 +16,7 @@
 # 
 #  mail = Mail.new
 #  mail.from = 'Mikel Lindsaar <mikel@test.lindsaar.net>, ada@test.lindsaar.net'
-#  mail.from    #=> ['Mikel Lindsaar <mikel@test.lindsaar.net>', 'ada@test.lindsaar.net']
+#  mail.from    #=> ['mikel@test.lindsaar.net', 'ada@test.lindsaar.net']
 #  mail[:from]  #=> '#<Mail::Field:0x180e5e8 @field=#<Mail::FromField:0x180e1c4
 #  mail['from'] #=> '#<Mail::Field:0x180e5e8 @field=#<Mail::FromField:0x180e1c4
 #  mail['From'] #=> '#<Mail::Field:0x180e5e8 @field=#<Mail::FromField:0x180e1c4

data/lib/mail/fields/in_reply_to_field.rb

@@ -6,7 +6,7 @@
 # In-Reply-To: header field in the email.
 # 
 # Sending in_reply_to to a mail message will instantiate a Mail::Field object that
-# has a InReplyToField as it's field type.  This includes all Mail::CommonMessageId
+# has a InReplyToField as its field type.  This includes all Mail::CommonMessageId
 # module instance metods.
 # 
 # Note that, the #message_ids method will return an array of message IDs without the
@@ -38,6 +38,7 @@ module Mail
     
     def initialize(value = nil, charset = 'utf-8')
       self.charset = charset
+      value = value.join("\r\n\s") if value.is_a?(Array)
       super(CAPITALIZED_FIELD, strip_field(FIELD_NAME, value), charset)
       self.parse
       self

data/lib/mail/fields/message_id_field.rb

@@ -6,7 +6,7 @@
 # Message-ID: header field in the email.
 # 
 # Sending message_id to a mail message will instantiate a Mail::Field object that
-# has a MessageIdField as it's field type.  This includes all Mail::CommonMessageId
+# has a MessageIdField as its field type.  This includes all Mail::CommonMessageId
 # module instance metods.
 # 
 # Only one MessageId field can appear in a header, and syntactically it can only have
@@ -75,8 +75,7 @@ module Mail
     private
     
     def generate_message_id
-      fqdn = ::Socket.gethostname
-      "<#{Mail.random_tag}@#{fqdn}.mail>"
+      "<#{Mail.random_tag}@#{::Socket.gethostname}.mail>"
     end
     
   end

data/lib/mail/fields/references_field.rb

@@ -6,7 +6,7 @@
 # field in the email.
 # 
 # Sending references to a mail message will instantiate a Mail::Field object that
-# has a ReferencesField as it's field type.  This includes all Mail::CommonAddress
+# has a ReferencesField as its field type.  This includes all Mail::CommonAddress
 # module instance metods.
 # 
 # Note that, the #message_ids method will return an array of message IDs without the
@@ -38,6 +38,7 @@ module Mail
     
     def initialize(value = nil, charset = 'utf-8')
       self.charset = charset
+      value = value.join("\r\n\s") if value.is_a?(Array)
       super(CAPITALIZED_FIELD, strip_field(FIELD_NAME, value), charset)
       self.parse
       self

data/lib/mail/fields/reply_to_field.rb

@@ -6,7 +6,7 @@
 # field in the email.
 # 
 # Sending reply_to to a mail message will instantiate a Mail::Field object that
-# has a ReplyToField as it's field type.  This includes all Mail::CommonAddress
+# has a ReplyToField as its field type.  This includes all Mail::CommonAddress
 # module instance metods.
 # 
 # Only one Reply-To field can appear in a header, though it can have multiple
@@ -16,7 +16,7 @@
 # 
 #  mail = Mail.new
 #  mail.reply_to = 'Mikel Lindsaar <mikel@test.lindsaar.net>, ada@test.lindsaar.net'
-#  mail.reply_to    #=> ['Mikel Lindsaar <mikel@test.lindsaar.net>', 'ada@test.lindsaar.net']
+#  mail.reply_to    #=> ['mikel@test.lindsaar.net', 'ada@test.lindsaar.net']
 #  mail[:reply_to]  #=> '#<Mail::Field:0x180e5e8 @field=#<Mail::ReplyToField:0x180e1c4
 #  mail['reply-to'] #=> '#<Mail::Field:0x180e5e8 @field=#<Mail::ReplyToField:0x180e1c4
 #  mail['Reply-To'] #=> '#<Mail::Field:0x180e5e8 @field=#<Mail::ReplyToField:0x180e1c4