mail 2.2.5.1 → 2.2.5.2

data/CHANGELOG.rdoc

@@ -1,3 +1,21 @@
+== Sat Sep 11 01:56:59 UTC 2010 Mikel Lindsaar <mikel@rubyx.com>
+
+* Added new way to do versioning for rubygems
+* Added additional specs for Content-Disposition: inline which are not being encoded correctly - Shawn Pyle
+* Make sure Mail::Message#attachment? returns true/false - Simone Carletti
+* Replace hard-coded references to Mail with more generic self references to allow easier inheritance (closes #61) - Simone Carletti
+* Force encoding on Regexp for Ruby 1.9 to avoid encoding conflicts - Golubev Pavel
+* Added lazy evaluation to message body: body is not parsed until need. It greatly improves performance with big mails if you don't need to read the body (yet)
+* Added Mail.read_from_string as an explicit method (mcansky)
+* Fixed bounce detection for multipart reports that contain a human readable report status part
+* Closed Issue #65 found (incredibly) by quetz - major Kudos for bug hunting
+* Fixed missing trailing CRLF in content type field - Closes issue #57 - Kudos to Henry Flower for finding it
+
+== Sat Sep 11 01:32:13 UTC 2010 Mikel Lindsaar <mikel@rubyx.com>
+
+* Closed issue #58 - Content Type not parsing unless lower case.
+* Version bump to 2.2.5.1
+
 == Thu 17 Jun 2010 22:13:18 UTC Mikel Lindsaar <mikel@rubyx.com>
 
 * Added Mail::POP3.delete_all, including specs (Martijn Storck)

data/lib/VERSION

@@ -1,4 +1,4 @@
 patch:5
 major:2
-build:1
+build:2
 minor:2

data/lib/mail.rb

@@ -22,10 +22,10 @@ module Mail # :doc:
 
   if RUBY_VERSION >= "1.9.1"
     require 'mail/version_specific/ruby_1_9'
-    RubyVer = Mail::Ruby19
+    RubyVer = Ruby19
   else
     require 'mail/version_specific/ruby_1_8'
-    RubyVer = Mail::Ruby18
+    RubyVer = Ruby18
   end
 
   require 'mail/version'

data/lib/mail/body.rb

@@ -130,7 +130,6 @@ module Mail
         @parts.sort!(@part_sort_order)
         p.body.sort_parts!
       end
-#      @parts.sort!(@part_sort_order)
     end
     
     # Returns the raw source that the body was initialized with, without

data/lib/mail/field_list.rb

@@ -9,7 +9,7 @@ module Mail
     include Enumerable
 
     def <<( new_field )
-      current_entry = self.rindex(new_field.name)
+      current_entry = self.rindex(new_field)
       if current_entry
         self.insert((current_entry + 1), new_field)
       else

data/lib/mail/fields/content_disposition_field.rb

@@ -51,7 +51,7 @@ module Mail
       if parameters.length > 0
         p = ";\r\n\s#{parameters.encoded}\r\n"
       else
-        p = ""
+        p = "\r\n"
       end
       "#{CAPITALIZED_FIELD}: #{disposition_type}" + p
     end

data/lib/mail/fields/content_type_field.rb

@@ -3,10 +3,10 @@ require 'mail/fields/common/parameter_hash'
 
 module Mail
   class ContentTypeField < StructuredField
-    
+
     FIELD_NAME = 'content-type'
     CAPITALIZED_FIELD = 'Content-Type'
-    
+
     def initialize(value = nil, charset = 'utf-8')
       self.charset = charset
       if value.class == Array
@@ -23,15 +23,15 @@ module Mail
       self.parse
       self
     end
-    
+
     def parse(val = value)
       unless val.blank?
-        self.value = val 
+        self.value = val
         @element = nil
         element
       end
     end
-    
+
     def element
       begin
         @element ||= Mail::ContentTypeElement.new(value)
@@ -39,7 +39,7 @@ module Mail
         attempt_to_clean
       end
     end
-    
+
     def attempt_to_clean
       # Sanitize the value, handle special cases
       @element ||= Mail::ContentTypeElement.new(sanatize(value))
@@ -47,7 +47,7 @@ module Mail
       # All else fails, just get the MIME media type
       @element ||= Mail::ContentTypeElement.new(get_mime_type(value))
     end
-    
+
     def main_type
       @main_type ||= element.main_type
     end
@@ -55,17 +55,17 @@ module Mail
     def sub_type
       @sub_type ||= element.sub_type
     end
-    
+
     def string
       "#{main_type}/#{sub_type}"
     end
-    
+
     def default
       decoded
     end
-    
+
     alias :content_type :string
-    
+
     def parameters
       unless @parameters
         @parameters = ParameterHash.new
@@ -77,7 +77,7 @@ module Mail
     def ContentTypeField.with_boundary(type)
       new("#{type}; boundary=#{generate_boundary}")
     end
-    
+
     def ContentTypeField.generate_boundary
       "--==_mimepart_#{Mail.random_tag}"
     end
@@ -89,7 +89,7 @@ module Mail
         @value
       end
     end
-    
+
     def stringify(params)
       params.map { |k,v| "#{k}=#{Encodings.param_encode(v)}" }.join("; ")
     end
@@ -100,22 +100,22 @@ module Mail
         @filename = parameters['filename']
       when parameters['name']
         @filename = parameters['name']
-      else 
+      else
         @filename = nil
       end
       @filename
     end
-    
+
     # TODO: Fix this up
     def encoded
       if parameters.length > 0
-        p = ";\r\n\s#{parameters.encoded}\r\n"
+        p = ";\r\n\s#{parameters.encoded}"
       else
         p = ""
       end
-      "#{CAPITALIZED_FIELD}: #{content_type}" + p
+      "#{CAPITALIZED_FIELD}: #{content_type}#{p}\r\n"
     end
-    
+
     def decoded
       if parameters.length > 0
         p = "; #{parameters.decoded}"
@@ -126,7 +126,7 @@ module Mail
     end
 
     private
-    
+
     def method_missing(name, *args, &block)
       if name.to_s =~ /([\w_]+)=/
         self.parameters[$1] = args.first
@@ -135,15 +135,28 @@ module Mail
         super
       end
     end
-    
+
     # Various special cases from random emails found that I am not going to change
     # the parser for
     def sanatize( val )
+
+      # TODO: check if there are cases where whitespace is not a separator
+      val = val.tr(' ',';').
+        squeeze(';').
+        gsub(';', '; '). #use '; ' as a separator (or EOL)
+        gsub(/;\s*$/,'') #remove trailing to keep examples below
+
+      if val =~ /(boundary=(\S*))/i
+        val = "#{$`.downcase}boundary=#{$2}#{$'.downcase}"
+      else
+        val.downcase!
+      end
+
       case
       when val.chomp =~ /^\s*([\w\d\-_]+)\/([\w\d\-_]+)\s*;;+(.*)$/i
         # Handles 'text/plain;; format="flowed"' (double semi colon)
         "#{$1}/#{$2}; #{$3}"
-      when val.chomp =~ /^\s*([\w\d\-_]+)\/([\w\d\-_]+)\s*;(ISO[\w\d\-_]+)$/i
+      when val.chomp =~ /^\s*([\w\d\-_]+)\/([\w\d\-_]+)\s*;\s?(ISO[\w\d\-_]+)$/i
         # Microsoft helper:
         # Handles 'type/subtype;ISO-8559-1'
         "#{$1}/#{$2}; charset=#{quote_atom($3)}"
@@ -172,12 +185,12 @@ module Mail
         ''
       end
     end
-    
+
     def get_mime_type( val )
       case
       when val =~ /^([\w\d\-_]+)\/([\w\d\-_]+);.+$/i
         "#{$1}/#{$2}"
-      else 
+      else
         'text/plain'
       end
     end

data/lib/mail/mail.rb

@@ -1,6 +1,6 @@
 # encoding: utf-8
 module Mail
-  
+
   # Allows you to create a new Mail::Message object.
   # 
   # You can make an email via passing a string or passing a block.
@@ -15,11 +15,11 @@ module Mail
   #  string << 'Subject: This is an email\r\n'
   #  string << '\r\n'
   #  string << 'This is the body'
-  #  Mail.new(string)
+  #  self.new(string)
   # 
   # Or creating via a block:
   # 
-  #  message = Mail.new do
+  #  message = self.new do
   #    to 'mikel@test.lindsaar.net'
   #    from 'bob@test.lindsaar.net'
   #    subject 'This is an email'
@@ -28,7 +28,7 @@ module Mail
   # 
   # Or creating via a hash (or hash like object):
   # 
-  #  message = Mail.new({:to => 'mikel@test.lindsaar.net',
+  #  message = self.new({:to => 'mikel@test.lindsaar.net',
   #                      'from' => 'bob@test.lindsaar.net',
   #                       :subject 'This is an email',
   #                       :body 'This is the body' })
@@ -41,13 +41,13 @@ module Mail
   # a Mail::Message object directly and then passing in values via string,
   # symbol or direct method calls.  See Mail::Message for more information.
   # 
-  #  mail = Mail.new
+  #  mail = self.new
   #  mail.to = 'mikel@test.lindsaar.net'
   #  mail[:from] = 'bob@test.lindsaar.net'
   #  mail['subject'] = 'This is an email'
   #  mail.body = 'This is the body'
-  def Mail.new(*args, &block)
-    Mail::Message.new(args, &block)
+  def self.new(*args, &block)
+    Message.new(args, &block)
   end
 
   # Sets the default delivery method and retriever method for all new Mail objects.
@@ -57,7 +57,7 @@ module Mail
   # So sending a new email, if you have an SMTP server running on localhost is
   # as easy as:
   # 
-  #   Mail.deliver do
+  #   self.deliver do
   #     to      'mikel@test.lindsaar.net'
   #     from    'bob@test.lindsaar.net'
   #     subject 'hi there!'
@@ -67,7 +67,7 @@ module Mail
   # If you do not specify anything, you will get the following equivalent code set in
   # every new mail object:
   # 
-  #   Mail.defaults do
+  #   self.defaults do
   #     delivery_method :smtp, { :address              => "localhost",
   #                              :port                 => 25,
   #                              :domain               => 'localhost.localdomain',
@@ -83,10 +83,10 @@ module Mail
   #                               :enable_ssl          => true }
   #   end
   # 
-  #   Mail.delivery_method.new  #=> Mail::SMTP instance
-  #   Mail.retriever_method.new #=> Mail::POP3 instance
+  #   self.delivery_method.new  #=> Mail::SMTP instance
+  #   self.retriever_method.new #=> Mail::POP3 instance
   #
-  # Each mail object inherits the default set in Mail.delivery_method, however, on
+  # Each mail object inherits the default set in self.delivery_method, however, on
   # a per email basis, you can override the method:
   #
   #   mail.delivery_method :sendmail
@@ -102,27 +102,27 @@ module Mail
   # The passed in hash is just merged against the defaults with +merge!+ and the result
   # assigned the mail object.  So the above example will change only the :address value
   # of the global smtp_settings to be 'some.host', keeping all other values
-  def Mail.defaults(&block)
-    Mail::Configuration.instance.instance_eval(&block)
+  def self.defaults(&block)
+    Configuration.instance.instance_eval(&block)
   end
-  
+
   # Returns the delivery method selected, defaults to an instance of Mail::SMTP
-  def Mail.delivery_method
-    Mail::Configuration.instance.delivery_method
+  def self.delivery_method
+    Configuration.instance.delivery_method
   end
 
   # Returns the retriever method selected, defaults to an instance of Mail::POP3
-  def Mail.retriever_method
-    Mail::Configuration.instance.retriever_method
+  def self.retriever_method
+    Configuration.instance.retriever_method
   end
 
   # Send an email using the default configuration.  You do need to set a default
-  # configuration first before you use Mail.deliver, if you don't, an appropriate
+  # configuration first before you use self.deliver, if you don't, an appropriate
   # error will be raised telling you to.
   # 
   # If you do not specify a delivery type, SMTP will be used.
   # 
-  #  Mail.deliver do
+  #  self.deliver do
   #   to 'mikel@test.lindsaar.net'
   #   from 'ada@test.lindsaar.net'
   #   subject 'This is a test email'
@@ -131,62 +131,66 @@ module Mail
   # 
   # You can also do:
   # 
-  #  mail = Mail.read('email.eml')
+  #  mail = self.read('email.eml')
   #  mail.deliver!
   # 
   # And your email object will be created and sent.
-  def Mail.deliver(*args, &block)
-    mail = Mail.new(args, &block)
+  def self.deliver(*args, &block)
+    mail = self.new(args, &block)
     mail.deliver
     mail
   end
 
   # Find emails in a POP3 server.
   # See Mail::POP3 for a complete documentation.
-  def Mail.find(*args, &block)
+  def self.find(*args, &block)
     retriever_method.find(*args, &block)
   end
 
   # Receive the first email(s) from a Pop3 server.
   # See Mail::POP3 for a complete documentation.
-  def Mail.first(*args, &block)
+  def self.first(*args, &block)
     retriever_method.first(*args, &block)
   end
 
   # Receive the first email(s) from a Pop3 server.
   # See Mail::POP3 for a complete documentation.
-  def Mail.last(*args, &block)
+  def self.last(*args, &block)
     retriever_method.last(*args, &block)
   end
 
   # Receive all emails from a POP3 server.
   # See Mail::POP3 for a complete documentation.
-  def Mail.all(*args, &block)
+  def self.all(*args, &block)
     retriever_method.all(*args, &block)
   end
 
   # Reads in an email message from a path and instantiates it as a new Mail::Message
-  def Mail.read(filename)
-    Mail.new(File.read(filename))
+  def self.read(filename)
+    self.new(File.read(filename))
   end
-  
+
   # Delete all emails from a POP3 server.
   # See Mail::POP3 for a complete documentation.
-  def Mail.delete_all(*args, &block)
+  def self.delete_all(*args, &block)
     retriever_method.delete_all(*args, &block)
   end
-  
-  
+
+  # Instantiates a new Mail::Message using a string
+  def Mail.read_from_string(mail_as_string)
+    Mail.new(mail_as_string)
+  end
+
   # Initialize the observers and interceptors arrays
   @@delivery_notification_observers = []
   @@delivery_interceptors = []
-  
+
   # You can register an object to be informed of every email that is sent through
   # this method.
   # 
   # Your object needs to respond to a single method #delivered_email(mail)
   # which receives the email that is sent.
-  def Mail.register_observer(observer)
+  def self.register_observer(observer)
     unless @@delivery_notification_observers.include?(observer)
       @@delivery_notification_observers << observer
     end
@@ -199,43 +203,43 @@ module Mail
   # Your object needs to respond to a single method #delivering_email(mail)
   # which receives the email that is about to be sent.  Make your modifications
   # directly to this object.
-  def Mail.register_interceptor(interceptor)
+  def self.register_interceptor(interceptor)
     unless @@delivery_interceptors.include?(interceptor)
       @@delivery_interceptors << interceptor
     end
   end
-  
-  def Mail.inform_observers(mail)
+
+  def self.inform_observers(mail)
     @@delivery_notification_observers.each do |observer|
       observer.delivered_email(mail)
     end
   end
-  
-  def Mail.inform_interceptors(mail)
+
+  def self.inform_interceptors(mail)
     @@delivery_interceptors.each do |interceptor|
       interceptor.delivering_email(mail)
     end
   end
 
   protected
-  
-  def Mail.random_tag
+
+  def self.random_tag
     t = Time.now
     sprintf('%x%x_%x%x%d%x',
             t.to_i, t.tv_usec,
-            $$, Thread.current.object_id.abs, Mail.uniq, rand(255))
+            $$, Thread.current.object_id.abs, self.uniq, rand(255))
   end
-  
+
   private
 
-  def Mail.something_random
+  def self.something_random
     (Thread.current.object_id * rand(255) / Time.now.to_f).to_s.slice(-3..-1).to_i
   end
-  
-  def Mail.uniq
+
+  def self.uniq
     @@uniq += 1
   end
-  
-  @@uniq = Mail.something_random
-  
+
+  @@uniq = self.something_random
+
 end