mail 2.1.3 → 2.1.5

data/lib/mail/mail.rb

@@ -231,4 +231,4 @@ module Mail
   
   @@uniq = Mail.something_random
   
-end
+end

data/lib/mail/message.rb

@@ -10,7 +10,7 @@ module Mail
   # 
   # * A Header object which contians all information and settings of the header of the email
   # * Body object which contains all parts of the email that are not part of the header, this
-  #   includes any attachments, body text, mime parts etc.
+  #   includes any attachments, body text, MIME parts etc.
   # 
   # ==Per RFC2822
   # 
@@ -99,6 +99,7 @@ module Mail
       @body = nil
       @text_part = nil
       @html_part = nil
+      @errors = nil
 
       @perform_deliveries = true
       @raise_delivery_errors = true
@@ -106,7 +107,9 @@ module Mail
       @delivery_handler = nil
       
       @delivery_method = Mail.delivery_method.dup
-      
+     
+      @transport_encoding = Mail::Encodings.get_encoding('7bit')
+ 
       if args.flatten.first.respond_to?(:each_pair)
         init_with_hash(args.flatten.first)
       else
@@ -374,6 +377,27 @@ module Mail
       end
     end
     
+    # Returns a list of parser errors on the header, each field that had an error
+    # will be reparsed as an unstructured field to preserve the data inside, but
+    # will not be used for further processing.
+    # 
+    # It returns a nested array of [field_name, value, original_error_message]
+    # per error found.
+    # 
+    # Example:
+    # 
+    #  message = Mail.new("Content-Transfer-Encoding: weirdo\r\n")
+    #  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>
+    # 
+    # 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.
+    def errors
+      header.errors
+    end
+    
     # Returns the Bcc value of the mail object as an array of strings of 
     # address specs.
     #
@@ -519,7 +543,19 @@ module Mail
     def date=( val )
       header[:date] = val
     end
-    
+   
+    def transport_encoding( val = nil)
+      if val
+        self.transport_encoding = val
+      else
+        @transport_encoding
+      end
+    end
+
+    def transport_encoding=( val )
+      @transport_encoding = Mail::Encodings.get_encoding(val)
+    end
+ 
     # Returns the From value of the mail object as an array of strings of 
     # address specs.
     #
@@ -603,14 +639,14 @@ module Mail
       header[:message_id] = val
     end
     
-    # Returns the mime version of the email as a string
+    # Returns the MIME version of the email as a string
     # 
     # Example:
     # 
     #  mail.mime_version = '1.0'
     #  mail.mime_version #=> '1.0'
     # 
-    # Also allows you to set the mime version by passing a string as a parameter.
+    # Also allows you to set the MIME version by passing a string as a parameter.
     # 
     # Example:
     # 
@@ -620,7 +656,7 @@ module Mail
       default :mime_version, val
     end
     
-    # Sets the mime version of the email by accepting a string
+    # Sets the MIME version of the email by accepting a string
     # 
     # Example:
     # 
@@ -1052,7 +1088,7 @@ module Mail
       case
       when value == nil
         @body = Mail::Body.new('')
-      when @body && !@body.parts.empty?
+      when @body && @body.multipart?
         @body << Mail::Part.new(value)
       else
         @body = Mail::Body.new(value)
@@ -1078,7 +1114,19 @@ module Mail
         @body
       end
     end
-     
+    
+    def body_encoding(value)
+      if value.nil?
+        body.encoding
+      else
+        body.encoding = value
+      end
+    end
+
+    def body_encoding=(value)
+        body.encoding = value
+    end
+ 
     # Returns the list of addresses this message should be sent to by
     # collecting the addresses off the to, cc and bcc fields.
     # 
@@ -1232,7 +1280,8 @@ module Mail
     end
     
     def has_content_transfer_encoding?
-      !!content_transfer_encoding
+      header[:content_transfer_encoding] && 
+      header[:content_transfer_encoding].errors.blank?
     end
     
     def has_transfer_encoding? # :nodoc:
@@ -1262,8 +1311,8 @@ module Mail
     
     # Creates a new empty Mime Version field and inserts it in the correct order
     # into the Header.  The MimeVersion object will automatically generate
-    # DateTime.now's date if you try and encode it or output it to_s without
-    # specifying a date yourself.
+    # set itself to '1.0' if you try and encode it or output it to_s without
+    # specifying a version yourself.
     # 
     # It will preserve any date you specify if you do.
     def add_mime_version(ver_val = '')
@@ -1281,9 +1330,9 @@ module Mail
     # 
     # Otherwise raises a warning
     def add_charset
-      if body.only_us_ascii?
+      if body.only_us_ascii? and !body.empty?
         header[:content_type].parameters['charset'] = 'US-ASCII'
-      else
+      elsif !body.empty?
         warning = "Non US-ASCII detected and no charset defined.\nDefaulting to UTF-8, set your own if this is incorrect.\n"
         STDERR.puts(warning)
         header[:content_type].parameters['charset'] = 'UTF-8'
@@ -1313,7 +1362,7 @@ module Mail
       content_transfer_encoding
     end
     
-    # Returns the mime type of part we are on, this is taken from the content-type header
+    # Returns the MIME media type of part we are on, this is taken from the content-type header
     def mime_type
       content_type ? header[:content_type].string : nil
     end
@@ -1425,7 +1474,7 @@ module Mail
     # 
     #  mail.attachments['filename.jpg'] = File.read('/path/to/filename.jpg')
     # 
-    # If you do this, then Mail will take the file name and work out the mime type
+    # If you do this, then Mail will take the file name and work out the MIME media type
     # set the Content-Type, Content-Disposition, Content-Transfer-Encoding and 
     # base64 encode the contents of the attachment all for you.
     # 
@@ -1509,7 +1558,7 @@ module Mail
 
     # Adds a part to the parts list or creates the part list
     def add_part(part)
-      if body.parts.empty? && !self.body.decoded.blank?
+      if !body.multipart? && !self.body.decoded.blank?
          @text_part = Mail::Part.new('Content-Type: text/plain;')
          @text_part.body = body.decoded
          self.body << @text_part
@@ -1537,7 +1586,7 @@ module Mail
     
     # Adds a file to the message.  You have two options with this method, you can
     # just pass in the absolute path to the file you want and Mail will read the file,
-    # get the filename from the path you pass in and guess the mime type, or you
+    # get the filename from the path you pass in and guess the MIME media type, or you
     # can pass in the filename as a string, and pass in the file content as a blob.
     # 
     # Example:
@@ -1588,10 +1637,14 @@ module Mail
     # Encodes the message, calls encode on all it's parts, gets an email message
     # ready to send
     def ready_to_send!
-      parts.each { |part| part.ready_to_send! }
+      identify_and_set_transfer_encoding
+      parts.each do |part| 
+        part.transport_encoding = transport_encoding
+        part.ready_to_send!
+      end
       add_required_fields
     end
-    
+
     def encode!
       STDERR.puts("Deprecated in 1.1.0 in favour of :ready_to_send! as it is less confusing with encoding and decoding.")
       ready_to_send!
@@ -1604,7 +1657,7 @@ module Mail
       ready_to_send!
       buffer = header.encoded
       buffer << "\r\n"
-      buffer << body.encoded
+      buffer << body.encoded(content_transfer_encoding)
       buffer
     end
     
@@ -1617,8 +1670,11 @@ module Mail
     end
 
     def decoded
-      if self.attachment?
+      case
+      when self.attachment?
         decode_body
+      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.'
       end
@@ -1633,11 +1689,7 @@ module Mail
     end
 
     def decode_body
-      if Mail::Encodings.defined?(content_transfer_encoding)
-        Mail::Encodings.get_encoding(content_transfer_encoding).decode(body.encoded)
-      else
-        raise UnknownEncodingType, "Don't know how to decode #{content_transfer_encoding}, please call #encoded and decode it yourself."
-      end
+        body.decoded
     end
     
     # Returns true if this part is an attachment
@@ -1697,13 +1749,21 @@ module Mail
     end
     
     def add_encoding_to_body
-      unless content_transfer_encoding.blank?
+      if has_content_transfer_encoding?
         body.encoding = content_transfer_encoding
       end
     end
+
+    def identify_and_set_transfer_encoding
+        if body.multipart?
+            self.content_transfer_encoding = @transport_encoding
+        else
+            self.content_transfer_encoding = body.get_best_encoding(@transport_encoding)
+        end
+    end
     
     def add_required_fields
-      add_multipart_mixed_header    unless parts.empty?
+      add_multipart_mixed_header    unless !body.multipart?
       @body = Mail::Body.new('')    if body.nil?
       add_message_id                unless (has_message_id? || self.class == Mail::Part)
       add_date                      unless has_date?
@@ -1739,14 +1799,26 @@ module Mail
       @header = Mail::Header.new
       @body = Mail::Body.new
 
+      # We need to store the body until last, as we need all headers added first
+      body_content = nil
+
       passed_in_options.each_pair do |k,v|
         k = underscoreize(k).to_sym if k.class == String
         if k == :headers
           self.headers(v)
+        elsif k == :body
+          body_content = v
         else
           self[k] = v
         end
       end
+
+      if body_content
+        self.body = body_content
+        if has_content_transfer_encoding?
+            body.encoding = content_transfer_encoding
+        end
+      end
     end
     
     def init_with_string(string)

data/lib/mail/network/delivery_methods/smtp.rb

@@ -27,7 +27,7 @@ module Mail
   #   Mail.defaults do
   #     delivery_method :smtp, { :address              => "smtp.gmail.com",
   #                              :port                 => 587,
-  #                              :domain               => 'baci.lindsaar.net',
+  #                              :domain               => 'your.host.name',
   #                              :user_name            => '<username>',
   #                              :password             => '<password>',
   #                              :authentication       => 'plain',

data/lib/mail/parsers/address_lists.rb

@@ -27,7 +27,10 @@ module Mail
       start_index = index
       if node_cache[:primary_address].has_key?(index)
         cached = node_cache[:primary_address][index]
-        @index = cached.interval.end if cached
+        if cached
+          cached = SyntaxNode.new(input, index...(index + 1)) if cached == true
+          @index = cached.interval.end
+        end
         return cached
       end
 

data/lib/mail/parsers/content_disposition.rb

@@ -49,7 +49,10 @@ module Mail
       start_index = index
       if node_cache[:content_disposition].has_key?(index)
         cached = node_cache[:content_disposition][index]
-        @index = cached.interval.end if cached
+        if cached
+          cached = SyntaxNode.new(input, index...(index + 1)) if cached == true
+          @index = cached.interval.end
+        end
         return cached
       end
 
@@ -114,7 +117,10 @@ module Mail
       start_index = index
       if node_cache[:disposition_type].has_key?(index)
         cached = node_cache[:disposition_type][index]
-        @index = cached.interval.end if cached
+        if cached
+          cached = SyntaxNode.new(input, index...(index + 1)) if cached == true
+          @index = cached.interval.end
+        end
         return cached
       end
 
@@ -169,7 +175,10 @@ module Mail
       start_index = index
       if node_cache[:extension_token].has_key?(index)
         cached = node_cache[:extension_token][index]
-        @index = cached.interval.end if cached
+        if cached
+          cached = SyntaxNode.new(input, index...(index + 1)) if cached == true
+          @index = cached.interval.end
+        end
         return cached
       end
 
@@ -213,7 +222,10 @@ module Mail
       start_index = index
       if node_cache[:parameter].has_key?(index)
         cached = node_cache[:parameter][index]
-        @index = cached.interval.end if cached
+        if cached
+          cached = SyntaxNode.new(input, index...(index + 1)) if cached == true
+          @index = cached.interval.end
+        end
         return cached
       end
 
@@ -270,7 +282,10 @@ module Mail
       start_index = index
       if node_cache[:attribute].has_key?(index)
         cached = node_cache[:attribute][index]
-        @index = cached.interval.end if cached
+        if cached
+          cached = SyntaxNode.new(input, index...(index + 1)) if cached == true
+          @index = cached.interval.end
+        end
         return cached
       end
 
@@ -305,7 +320,10 @@ module Mail
       start_index = index
       if node_cache[:value].has_key?(index)
         cached = node_cache[:value][index]
-        @index = cached.interval.end if cached
+        if cached
+          cached = SyntaxNode.new(input, index...(index + 1)) if cached == true
+          @index = cached.interval.end
+        end
         return cached
       end
 

data/lib/mail/parsers/content_location.rb

@@ -31,7 +31,10 @@ module Mail
       start_index = index
       if node_cache[:primary].has_key?(index)
         cached = node_cache[:primary][index]
-        @index = cached.interval.end if cached
+        if cached
+          cached = SyntaxNode.new(input, index...(index + 1)) if cached == true
+          @index = cached.interval.end
+        end
         return cached
       end
 
@@ -69,7 +72,10 @@ module Mail
       start_index = index
       if node_cache[:location].has_key?(index)
         cached = node_cache[:location][index]
-        @index = cached.interval.end if cached
+        if cached
+          cached = SyntaxNode.new(input, index...(index + 1)) if cached == true
+          @index = cached.interval.end
+        end
         return cached
       end
 

data/lib/mail/parsers/content_transfer_encoding.rb

@@ -25,13 +25,20 @@ module Mail
       def CFWS2
         elements[2]
       end
+
+      def CFWS3
+        elements[4]
+      end
     end
 
     def _nt_primary
       start_index = index
       if node_cache[:primary].has_key?(index)
         cached = node_cache[:primary][index]
-        @index = cached.interval.end if cached
+        if cached
+          cached = SyntaxNode.new(input, index...(index + 1)) if cached == true
+          @index = cached.interval.end
+        end
         return cached
       end
 
@@ -44,6 +51,25 @@ module Mail
         if r2
           r3 = _nt_CFWS
           s0 << r3
+          if r3
+            if has_terminal?(";", false, index)
+              r5 = instantiate_node(SyntaxNode,input, index...(index + 1))
+              @index += 1
+            else
+              terminal_parse_failure(";")
+              r5 = nil
+            end
+            if r5
+              r4 = r5
+            else
+              r4 = instantiate_node(SyntaxNode,input, index...index)
+            end
+            s0 << r4
+            if r4
+              r6 = _nt_CFWS
+              s0 << r6
+            end
+          end
         end
       end
       if s0.last
@@ -60,8 +86,21 @@ module Mail
     end
 
     module Encoding0
-      def encoding
-        known_tokens.text_value || ietf_token.text_value || x_token.text_value
+      def ietf_token
+        elements[0]
+      end
+
+    end
+
+    module Encoding1
+      def text_value
+        ietf_token.text_value
+      end
+    end
+
+    module Encoding2
+      def text_value
+        x_token.text_value
       end
     end
 
@@ -69,103 +108,54 @@ module Mail
       start_index = index
       if node_cache[:encoding].has_key?(index)
         cached = node_cache[:encoding][index]
-        @index = cached.interval.end if cached
+        if cached
+          cached = SyntaxNode.new(input, index...(index + 1)) if cached == true
+          @index = cached.interval.end
+        end
         return cached
       end
 
       i0 = index
-      r1 = _nt_known_tokens
-      if r1
-        r0 = r1
-      else
-        r2 = _nt_ietf_token
-        if r2
-          r0 = r2
+      i1, s1 = index, []
+      r2 = _nt_ietf_token
+      s1 << r2
+      if r2
+        if has_terminal?("s", false, index)
+          r4 = instantiate_node(SyntaxNode,input, index...(index + 1))
+          @index += 1
         else
-          r3 = _nt_x_token
-          r3.extend(Encoding0)
-          if r3
-            r0 = r3
-          else
-            @index = i0
-            r0 = nil
-          end
+          terminal_parse_failure("s")
+          r4 = nil
         end
+        if r4
+          r3 = r4
+        else
+          r3 = instantiate_node(SyntaxNode,input, index...index)
+        end
+        s1 << r3
       end
-
-      node_cache[:encoding][start_index] = r0
-
-      r0
-    end
-
-    def _nt_known_tokens
-      start_index = index
-      if node_cache[:known_tokens].has_key?(index)
-        cached = node_cache[:known_tokens][index]
-        @index = cached.interval.end if cached
-        return cached
-      end
-
-      i0 = index
-      if has_terminal?("7bit", false, index)
-        r1 = instantiate_node(SyntaxNode,input, index...(index + 4))
-        @index += 4
+      if s1.last
+        r1 = instantiate_node(SyntaxNode,input, i1...index, s1)
+        r1.extend(Encoding0)
+        r1.extend(Encoding1)
       else
-        terminal_parse_failure("7bit")
+        @index = i1
         r1 = nil
       end
       if r1
         r0 = r1
       else
-        if has_terminal?("8bit", false, index)
-          r2 = instantiate_node(SyntaxNode,input, index...(index + 4))
-          @index += 4
+        r5 = _nt_x_token
+        r5.extend(Encoding2)
+        if r5
+          r0 = r5
         else
-          terminal_parse_failure("8bit")
-          r2 = nil
-        end
-        if r2
-          r0 = r2
-        else
-          if has_terminal?("binary", false, index)
-            r3 = instantiate_node(SyntaxNode,input, index...(index + 6))
-            @index += 6
-          else
-            terminal_parse_failure("binary")
-            r3 = nil
-          end
-          if r3
-            r0 = r3
-          else
-            if has_terminal?("quoted-printable", false, index)
-              r4 = instantiate_node(SyntaxNode,input, index...(index + 16))
-              @index += 16
-            else
-              terminal_parse_failure("quoted-printable")
-              r4 = nil
-            end
-            if r4
-              r0 = r4
-            else
-              if has_terminal?("base64", false, index)
-                r5 = instantiate_node(SyntaxNode,input, index...(index + 6))
-                @index += 6
-              else
-                terminal_parse_failure("base64")
-                r5 = nil
-              end
-              if r5
-                r0 = r5
-              else
-                @index = i0
-                r0 = nil
-              end
-            end
-          end
+          @index = i0
+          r0 = nil
         end
       end
 
-      node_cache[:known_tokens][start_index] = r0
+      node_cache[:encoding][start_index] = r0
 
       r0
     end