mail 2.2.15 → 2.2.16

data/CHANGELOG.rdoc

@@ -1,3 +1,19 @@
+== Sat Apr 16 12:57:27 UTC 2011 Mikel Lindsaar <mikel@rubyx.com>
+
+* Added support for open SMTP connections and returning the Mail server's response - https://github.com/spiegela
+* RE: not appended to subject when replying to a reply - https://github.com/prateekdayal
+* Support not ascii compatible charset mail send - https://github.com/yalab
+* Fix for issue 208 "mail.body after mail.add_file truncates message body" - https://github.com/glongman
+* Handle bad subject encoding (or ":invalid => :replace" is ineffective for utf-8 to utf-8 encoding) - https://github.com/choonkeat
+* Handle blank Received header field - https://github.com/bcantin
+* Handle part with missing content type - https://github.com/bcantin
+* Handle a "<>" Return field - https://github.com/bcantin
+* Performance improvements for 1.9 - https://github.com/nobu
+* Fix heavy CPU issues when messages are missing a space - https://github.com/scsmith
+* Tighten up allowed encodings - https://github.com/scsmith
+* Added to_yaml & from_yaml (as well as to_hash & from_hash) - https://github.com/srushti
+* Fix up some comments - https://github.com/takahashim
+
 == Wed 26 Jan 2011 02:23:09 UTC Mikel Lindsaar <mikel@rubyx.com>
 
 * Update addresses passed into sendmail to escape them (Andy Lindeman)

data/lib/VERSION

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

data/lib/mail/body.rb

@@ -162,7 +162,12 @@ module Mail
         else
             # Decode then encode to normalize and allow transforming 
             # from base64 to Q-P and vice versa
-            enc.encode(dec.decode(raw_source))
+            decoded = dec.decode(raw_source)
+            if defined?(Encoding) && charset && charset != "US-ASCII"
+              decoded.encode!(charset)
+              decoded.force_encoding('BINARY') unless Encoding.find(charset).ascii_compatible?
+            end
+            enc.encode(decoded)
         end
       end
     end

data/lib/mail/configuration.rb

@@ -35,6 +35,8 @@ module Mail
         Mail::Sendmail
       when :file
         Mail::FileDelivery
+      when :smtp_connection
+        Mail::SMTPConnection
       when :test
         Mail::TestMailer
       else

data/lib/mail/encodings.rb

@@ -6,12 +6,12 @@ module Mail
   end
 
   module Encodings
-    
+
     include Mail::Patterns
     extend  Mail::Utilities
 
     @transfer_encodings = {}
-   
+
     # Register transfer encoding
     #
     # Example
@@ -20,23 +20,23 @@ module Mail
     def Encodings.register(name, cls)
         @transfer_encodings[get_name(name)] = cls
     end
- 
+
     # Is the encoding we want defined?
-    # 
+    #
     # Example:
-    # 
+    #
     #  Encodings.defined?(:base64) #=> true
     def Encodings.defined?( str )
       @transfer_encodings.include? get_name(str)
     end
-    
+
     # Gets a defined encoding type, QuotedPrintable or Base64 for now.
-    # 
-    # Each encoding needs to be defined as a Mail::Encodings::ClassName for 
+    #
+    # Each encoding needs to be defined as a Mail::Encodings::ClassName for
     # this to work, allows us to add other encodings in the future.
-    # 
+    #
     # Example:
-    # 
+    #
     #  Encodings.get_encoding(:base64) #=> Mail::Encodings::Base64
     def Encodings.get_encoding( str )
       @transfer_encodings[get_name(str)]
@@ -52,16 +52,16 @@ 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
     #    param_encode_language 'jp'
     #  end
     #
-    # The character set used for encoding will either be the value of $KCODE for 
+    # 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.
-    # 
+    #
     # Example:
-    # 
+    #
     #  Mail::Encodings.param_encode("This is fun") #=> "us-ascii'en'This%20is%20fun"
     def Encodings.param_encode(str)
       case
@@ -75,9 +75,9 @@ module Mail
     end
 
     # Decodes a parameter value using URI Escaping.
-    # 
+    #
     # Example:
-    # 
+    #
     #  Mail::Encodings.param_decode("This%20is%20fun", 'us-ascii') #=> "This is fun"
     #
     #  str = Mail::Encodings.param_decode("This%20is%20fun", 'iso-8559-1')
@@ -86,14 +86,14 @@ module Mail
     def Encodings.param_decode(str, encoding)
       RubyVer.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.
-    # 
+    #
     # On encoding, will only send out Base64 encoded strings.
     def Encodings.decode_encode(str, output_type)
       case
@@ -110,12 +110,12 @@ module Mail
 
     # Decodes a given string as Base64 or Quoted Printable, depending on what
     # type it is.
-    # 
+    #
     # 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("=?")
-      
+
       str = str.gsub(/\?=(\s*)=\?/, '?==?') # Remove whitespaces between 'encoded-word's
 
       # Split on white-space boundaries with capture, so we capture the white-space as well
@@ -125,18 +125,18 @@ module Mail
         else
           # Join QP encoded-words that are adjacent to avoid decoding partial chars
           text.gsub!(/\?\=\=\?.+?\?[Qq]\?/m, '') if text =~ /\?==\?/
-        
+
           # Separate encoded-words with a space, so we can treat them one by one
           text.gsub!(/\?\=\=\?/, '?= =?')
           text.split(/ /).map do |word|
             word.to_str.
-              gsub(/=\?.+\?[Bb]\?.+\?=/m) {|substr| b_value_decode(substr)}.
-              gsub(/=\?.+\?[Qq]\?.+\?=/m) {|substr| q_value_decode(substr)}
+              gsub( /=\?.+\?[Bb]\?.+\?=/m ) { |substr| b_value_decode(substr) }.
+              gsub( /=\?.+\?[Qq]\?.+\?=/m ) { |substr| q_value_decode(substr) }
             end
         end
       end.join("")
     end
-    
+
     # Takes an encoded string of the format =?<encoding>?[QB]?<string>?=
     def Encodings.unquote_and_convert_to(str, to_encoding)
       original_encoding, string = split_encoding_from_string( str )
@@ -166,7 +166,7 @@ module Mail
         output
       end
     end
-    
+
     def Encodings.address_encode(address, charset = 'utf-8')
       if address.is_a?(Array)
         # loop back through for each element
@@ -196,13 +196,13 @@ module Mail
         end
       end.join(' ')
     end
-    
+
     # Encode a string with Base64 Encoding and returns it ready to be inserted
     # as a value for a field, that is, in the =?<charset>?B?<string>?= format
     #
     # Example:
-    # 
-    #  Encodings.b_value_encode('This is あ string', 'UTF-8') 
+    #
+    #  Encodings.b_value_encode('This is あ string', 'UTF-8')
     #  #=> "=?UTF-8?B?VGhpcyBpcyDjgYIgc3RyaW5n?="
     def Encodings.b_value_encode(str, encoding = nil)
       return str if str.to_s.ascii_only?
@@ -211,13 +211,13 @@ module Mail
         "=?#{encoding}?B?#{str.chomp}?="
       end.join(" ")
     end
-    
+
     # Encode a string with Quoted-Printable Encoding and returns it ready to be inserted
     # as a value for a field, that is, in the =?<charset>?Q?<string>?= format
     #
     # Example:
-    # 
-    #  Encodings.q_value_encode('This is あ string', 'UTF-8') 
+    #
+    #  Encodings.q_value_encode('This is あ string', 'UTF-8')
     #  #=> "=?UTF-8?Q?This_is_=E3=81=82_string?="
     def Encodings.q_value_encode(str, encoding = nil)
       return str if str.to_s.ascii_only?
@@ -227,29 +227,29 @@ module Mail
         "=?#{encoding}?Q?#{str.chomp.gsub(/ /, '_')}?="
       end.join(" ")
     end
-    
+
     private
-    
+
     # Decodes a Base64 string from the "=?UTF-8?B?VGhpcyBpcyDjgYIgc3RyaW5n?=" format
-    # 
+    #
     # Example:
-    # 
-    #  Encodings.b_value_encode("=?UTF-8?B?VGhpcyBpcyDjgYIgc3RyaW5n?=") 
+    #
+    #  Encodings.b_value_decode("=?UTF-8?B?VGhpcyBpcyDjgYIgc3RyaW5n?=")
     #  #=> 'This is あ string'
     def Encodings.b_value_decode(str)
       RubyVer.b_value_decode(str)
     end
-    
+
     # Decodes a Quoted-Printable string from the "=?UTF-8?Q?This_is_=E3=81=82_string?=" format
-    # 
+    #
     # Example:
-    # 
-    #  Encodings.b_value_encode("=?UTF-8?Q?This_is_=E3=81=82_string?=") 
+    #
+    #  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).gsub(/_/, ' ')
     end
-    
+
     def Encodings.split_encoding_from_string( str )
       match = str.match(/\=\?([^?]+)?\?[QB]\?(.+)?\?\=/mi)
       if match
@@ -258,7 +258,7 @@ module Mail
         nil
       end
     end
-    
+
     def Encodings.find_encoding(str)
       RUBY_VERSION >= '1.9' ? str.encoding : $KCODE
     end

data/lib/mail/fields/received_field.rb

@@ -52,15 +52,23 @@ module Mail
     end
    
     def formatted_date
-        date_time.strftime("%a, %d %b %Y %H:%M:%S ") + date_time.zone.delete(':')
+      date_time.strftime("%a, %d %b %Y %H:%M:%S ") + date_time.zone.delete(':')
     end
  
     def encoded
-      "#{CAPITALIZED_FIELD}: #{info}; #{formatted_date}\r\n"
+      if value.blank?
+        "#{CAPITALIZED_FIELD}: \r\n"
+      else
+        "#{CAPITALIZED_FIELD}: #{info}; #{formatted_date}\r\n"
+      end
     end
     
     def decoded
-      "#{info}; #{formatted_date}" 
+      if value.blank?
+        ""
+      else
+        "#{info}; #{formatted_date}" 
+      end
     end
     
   end

data/lib/mail/fields/return_path_field.rb

@@ -38,6 +38,7 @@ module Mail
     CAPITALIZED_FIELD = 'Return-Path'
     
     def initialize(value = nil, charset = 'utf-8')
+      value = nil if value == '<>'
       self.charset = charset
       super(CAPITALIZED_FIELD, strip_field(FIELD_NAME, value), charset)
       self.parse

data/lib/mail/fields/unstructured_field.rb

@@ -166,6 +166,7 @@ module Mail
     end
         
     def encode(value)
+      value.encode!(charset) if defined?(Encoding) && charset
       (value.not_ascii_only? ? [value].pack("M").gsub("=\n", '') : value).gsub("\r", "=0D").gsub("\n", "=0A")
     end
     

data/lib/mail/header.rb

@@ -73,7 +73,8 @@ module Mail
     #  h.fields = ['From: mikel@me.com', 'To: bob@you.com']
     def fields=(unfolded_fields)
       @fields = Mail::FieldList.new
-      unfolded_fields.each do |field|
+      warn "Warning: more than 1000 header fields only using the first 1000" if unfolded_fields.length > 1000
+      unfolded_fields[0..1000].each do |field|
 
         field = Field.new(field, nil, charset)
         field.errors.each { |error| self.errors << error }

data/lib/mail/message.rb

@@ -1,4 +1,6 @@
 # encoding: utf-8
+require "yaml"
+
 module Mail
   # The Message class provides a single point of access to all things to do with an
   # email message.
@@ -240,9 +242,9 @@ module Mail
     #
     # Returns self
     def deliver!
-      delivery_method.deliver!(self)
+      response = delivery_method.deliver!(self)
       inform_observers
-      self
+      delivery_method.settings[:return_response] ? response : self
     end
 
     def delivery_method(method = nil, settings = {})
@@ -268,7 +270,7 @@ module Mail
           reply.references ||= bracketed_message_id
         end
         if subject
-          reply.subject = "RE: #{subject}"
+          reply.subject = subject =~ /^Re:/i ? subject : "RE: #{subject}"
         end
         if reply_to || from
           reply.to = self[reply_to ? :reply_to : :from].to_s
@@ -1708,6 +1710,25 @@ module Mail
       buffer
     end
 
+    def to_yaml
+      ready_to_send!
+      hash = {}
+      header.fields.each do |field|
+        hash[field.name] = field.value
+      end
+      hash['subject'] = subject
+      hash['body'] = body.encoded(content_transfer_encoding)
+      hash.to_yaml
+    end
+
+    def self.from_yaml(str)
+      from_hash(YAML::load(str))
+    end
+
+    def self.from_hash(hash)
+      Mail::Message.new(hash)
+    end
+
     def to_s
       encoded
     end

data/lib/mail/network.rb

@@ -4,6 +4,7 @@ module Mail
   autoload :SMTP, 'mail/network/delivery_methods/smtp'
   autoload :FileDelivery, 'mail/network/delivery_methods/file_delivery'
   autoload :Sendmail, 'mail/network/delivery_methods/sendmail'
+  autoload :SMTPConnection, 'mail/network/delivery_methods/smtp_connection'
   autoload :TestMailer, 'mail/network/delivery_methods/test_mailer'
 
   autoload :POP3, 'mail/network/retriever_methods/pop3'

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

@@ -124,11 +124,12 @@ module Mail
         end
       end
       
+      response = nil
       smtp.start(settings[:domain], settings[:user_name], settings[:password], settings[:authentication]) do |smtp|
-        smtp.sendmail(message, envelope_from, destinations)
+        response = smtp.sendmail(message, envelope_from, destinations)
       end
-      
-      self
+
+      return settings[:return_response] ? response : self
     end
     
     

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

@@ -0,0 +1,74 @@
+module Mail
+  # == Sending Email with SMTP
+  # 
+  # Mail allows you to send emails using an open SMTP connection.  This is done by
+  # passing a created Net::SMTP object.  This way we can get better performance to
+  # our local mail server by reducing the number of connections at any one time.
+  #
+  # === Sending via SMTP server on Localhost
+  # 
+  # To send mail open a connection with Net::Smtp using any options you like
+  # === Delivering the email
+  # 
+  # Once you have the settings right, sending the email is done by:
+  #
+  #   smtp_conn = Net::SMTP.start(settings[:address], settings[:port])
+  #   Mail.defaults do
+  #     delivery_method :smtp_connection, { :connection => smtp_conn }
+  #   end
+  # 
+  #   Mail.deliver do
+  #     to 'mikel@test.lindsaar.net'
+  #     from 'ada@test.lindsaar.net'
+  #     subject 'testing sendmail'
+  #     body 'testing sendmail'
+  #   end
+  # 
+  # Or by calling deliver on a Mail message
+  # 
+  #   mail = Mail.new do
+  #     to 'mikel@test.lindsaar.net'
+  #     from 'ada@test.lindsaar.net'
+  #     subject 'testing sendmail'
+  #     body 'testing sendmail'
+  #   end
+  # 
+  #   mail.deliver!
+  class SMTPConnection
+
+    def initialize(values)
+      raise ArgumentError.new('A Net::SMTP object is required for this delivery method') if values[:connection].nil?
+      self.smtp = values[:connection]
+      self.settings = values
+    end
+    
+    attr_accessor :smtp
+    attr_accessor :settings
+    
+    # Send the message via SMTP.
+    # The from and to attributes are optional. If not set, they are retrieve from the Message.
+    def deliver!(mail)
+
+      # Set the envelope from to be either the return-path, the sender or the first from address
+      envelope_from = mail.return_path || mail.sender || mail.from_addrs.first
+      if envelope_from.blank?
+        raise ArgumentError.new('A sender (Return-Path, Sender or From) required to send a message') 
+      end
+      
+      destinations ||= mail.destinations if mail.respond_to?(:destinations) && mail.destinations
+      if destinations.blank?
+        raise ArgumentError.new('At least one recipient (To, Cc or Bcc) is required to send a message') 
+      end
+      
+      message ||= mail.encoded if mail.respond_to?(:encoded)
+      if message.blank?
+        raise ArgumentError.new('A encoded content is required to send a message')
+      end
+            
+      response = smtp.sendmail(message, envelope_from, destinations)
+      
+      settings[:return_response] ? response : self 
+    end
+        
+  end
+end

data/lib/mail/part.rb

@@ -103,7 +103,7 @@ module Mail
         self.body   = body_part
       else
         self.header = "Content-Type: text/plain\r\n"
-        self.body   = header_part
+        self.body   = raw_source
       end
     end
     

data/lib/mail/parts_list.rb

@@ -1,6 +1,6 @@
 module Mail
   class PartsList < Array
-    
+
     def attachments
       Mail::AttachmentsList.new(self)
     end
@@ -14,30 +14,38 @@ module Mail
         to_a
       end
     end
-    
+
     undef :map
     alias_method :map, :collect
 
     def map!
       raise NoMethodError, "#map! is not defined, please call #collect and create a new PartsList"
     end
-    
+
     def collect!
       raise NoMethodError, "#collect! is not defined, please call #collect and create a new PartsList"
     end
-    
+
     def sort!(order)
       sorted = self.sort do |a, b|
         # OK, 10000 is arbitrary... if anyone actually wants to explicitly sort 10000 parts of a
         # single email message... please show me a use case and I'll put more work into this method,
         # in the meantime, it works :)
-        a_order = order.index(a[:content_type].string.downcase) || 10000
-        b_order = order.index(b[:content_type].string.downcase) || 10000
-        a_order <=> b_order
+        get_order_value(a, order) <=> get_order_value(b, order)
       end
       self.clear
       sorted.each { |p| self << p }
     end
-    
+
+  private
+
+    def get_order_value(part, order)
+      if part.respond_to?(:content_type)
+        order.index(part[:content_type].string.downcase) || 10000
+      else
+        10000
+      end
+    end
+
   end
 end

data/lib/mail/version_specific/ruby_1_9.rb

@@ -27,7 +27,7 @@ module Mail
     end
 
     def Ruby19.decode_base64(str)
-      str.unpack( 'm' ).first.force_encoding(Encoding::BINARY)
+      str.unpack( 'm' ).first
     end
     
     def Ruby19.encode_base64(str)
@@ -35,11 +35,11 @@ module Mail
     end
     
     def Ruby19.has_constant?(klass, string)
-      klass.constants.include?( string.to_sym )
+      klass.const_defined?( string, false )
     end
     
     def Ruby19.get_constant(klass, string)
-      klass.const_get( string.to_sym )
+      klass.const_get( string )
     end
     
     def Ruby19.b_value_encode(str, encoding = nil)
@@ -54,7 +54,8 @@ module Mail
         str = Ruby19.decode_base64(match[2])
         str.force_encoding(fix_encoding(encoding))
       end
-      str.encode("utf-8", :invalid => :replace, :replace => "") 
+      decoded = str.encode("utf-8", :invalid => :replace, :replace => "")
+      decoded.valid_encoding? ? decoded : decoded.encode("utf-16le", :invalid => :replace, :replace => "").encode("utf-8")
     end
     
     def Ruby19.q_value_encode(str, encoding = nil)
@@ -69,7 +70,8 @@ module Mail
         str = Encodings::QuotedPrintable.decode(match[2])
         str.force_encoding(fix_encoding(encoding))
       end
-      str.encode("utf-8", :invalid => :replace, :replace => "") 
+      decoded = str.encode("utf-8", :invalid => :replace, :replace => "")
+      decoded.valid_encoding? ? decoded : decoded.encode("utf-16le", :invalid => :replace, :replace => "").encode("utf-8")
     end
 
     def Ruby19.param_decode(str, encoding)
@@ -94,8 +96,8 @@ module Mail
         when /iso-?(\d{4})-?(\w{1,2})/i then return "ISO-#{$1}-#{$2}"
         # "ISO-2022-JP-KDDI"  and alike
         when /iso-?(\d{4})-?(\w{1,2})-?(\w*)/i then return "ISO-#{$1}-#{$2}-#{$3}"
-        # utf-8 and alike
-        when /utf-?(.*)/i then return "UTF-#{$1}"
+        # UTF-8, UTF-32BE and alike
+        when /utf-?(\d{1,2})?(\w{1,2})/i then return "UTF-#{$1}#{$2}"
         # Windows-1252 and alike
         when /Windows-?(.*)/i then return "Windows-#{$1}"
         #more aliases to be added if needed

metadata

@@ -1,12 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: mail
 version: !ruby/object:Gem::Version 
-  prerelease: false
+  hash: 39
+  prerelease: 
   segments: 
   - 2
   - 2
-  - 15
-  version: 2.2.15
+  - 16
+  version: 2.2.16
 platform: ruby
 authors: 
 - Mikel Lindsaar
@@ -14,7 +15,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-01-26 00:00:00 +11:00
+date: 2011-04-16 00:00:00 +10:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -25,6 +26,7 @@ dependencies:
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
+        hash: 15
         segments: 
         - 2
         - 3
@@ -40,6 +42,7 @@ dependencies:
     requirements: 
     - - ~>
       - !ruby/object:Gem::Version 
+        hash: 47
         segments: 
         - 1
         - 16
@@ -54,6 +57,7 @@ dependencies:
     requirements: 
     - - ~>
       - !ruby/object:Gem::Version 
+        hash: 23
         segments: 
         - 1
         - 4
@@ -69,6 +73,7 @@ dependencies:
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
+        hash: 15
         segments: 
         - 0
         - 4
@@ -165,6 +170,7 @@ files:
 - lib/mail/network/delivery_methods/file_delivery.rb
 - lib/mail/network/delivery_methods/sendmail.rb
 - lib/mail/network/delivery_methods/smtp.rb
+- lib/mail/network/delivery_methods/smtp_connection.rb
 - lib/mail/network/delivery_methods/test_mailer.rb
 - lib/mail/network/retriever_methods/base.rb
 - lib/mail/network/retriever_methods/imap.rb
@@ -225,6 +231,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
+      hash: 3
       segments: 
       - 0
       version: "0"
@@ -233,13 +240,14 @@ required_rubygems_version: !ruby/object:Gem::Requirement
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
+      hash: 3
       segments: 
       - 0
       version: "0"
 requirements: []
 
 rubyforge_project: 
-rubygems_version: 1.3.7
+rubygems_version: 1.6.1
 signing_key: 
 specification_version: 3
 summary: Mail provides a nice Ruby DSL for making, sending and reading emails.