mail 2.2.15 → 2.3.0

data/CHANGELOG.rdoc

@@ -1,3 +1,41 @@
+== Tue Apr 26 09:59:56 UTC 2011 Mikel Lindsaar <mikel@rubyx.com>
+
+* Remove ActiveSupport from the dependencies, load Active Support if present, or use internals if not
+* Created v2.2 branch for all 2.2 related commits
+* Update activesupport require to use inflector - closes #217
+* Version bump to 2.3 and gem release
+
+== Tue Apr 26 06:18:19 UTC 2011 Mikel Lindsaar <mikel@rubyx.com>
+
+* Fixed charset warning issue with multipart messages - https://github.com/arvindsv
+* Version bump to 2.2.18 and gem release
+
+== Wed 20 Apr 2011 15:16:20 UTC Mikel Lindsaar <mikel@rubyx.com>
+
+* Mail::Field.new("Subject: foobar", 'iso-2022-jp') does not set charset - https://github.com/yalab
+
+== Tue Apr 19 00:20:54 UTC 2011 Mikel Lindsaar <mikel@rubyx.com>
+
+* Fixed an exception with nil in Reply-To and References field - https://github.com/dcormier
+* Version bump to 2.2.17 and gem release
+
+== 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
+* Version bump to 2.2.16 and gem release
+
 == Wed 26 Jan 2011 02:23:09 UTC Mikel Lindsaar <mikel@rubyx.com>
 
 * Update addresses passed into sendmail to escape them (Andy Lindeman)

data/Dependencies.txt

@@ -0,0 +1,3 @@
+treetop: we need to include this in the gem spec
+tlsmail: if ruby < 1.8.6... we could make it optional, or embed it in Mail
+mime/types: I think we embed a simplified version, or help maintain it, it is old (2006)

data/Gemfile

@@ -0,0 +1,29 @@
+source :rubygems
+
+gem "activesupport", ">= 2.3.6"
+gem "tlsmail" if RUBY_VERSION <= '1.8.6'
+gem "mime-types", "~> 1.16"
+gem "treetop", "~> 1.4.8"
+gem "i18n", ">= 0.4.0"
+
+if defined?(RUBY_ENGINE) && RUBY_ENGINE == 'jruby'
+  gem 'jruby-openssl'
+end
+
+group :test do
+  gem "ZenTest",    "~> 4.4.0"
+  gem "rake",       "~> 0.8.7"
+  gem "bundler"
+  gem "rspec",      "~> 1.3.0"
+  gem "diff-lcs"
+  case
+  when defined?(RUBY_ENGINE) && RUBY_ENGINE == 'rbx'
+    # Skip it
+  when RUBY_PLATFORM == 'java'
+    # Skip it
+  when RUBY_VERSION < '1.9'
+    gem "ruby-debug"
+  else
+    # Skip it
+  end
+end

data/Rakefile

@@ -59,7 +59,7 @@ Rake::RDocTask.new(:rdoc) do |rdoc|
   rdoc.rdoc_files.include('lib/**/*.rb')
   rdoc.rdoc_files.include('lib/network/**/*.rb')
   rdoc.rdoc_files.exclude('lib/parsers/*')
-  
+
 end
 
 # load custom rake tasks

data/lib/VERSION

@@ -1,4 +1,4 @@
-patch:15
 major:2
+minor:3
+patch:0
 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
@@ -196,10 +201,11 @@ module Mail
     end
     
     def encoding=( val )
-      if val == "text" || val.blank? then
-        val = "8bit"
+      @encoding = if val == "text" || val.blank?
+          (only_us_ascii? ? '7bit' : '8bit')
+      else
+          val
       end
-      @encoding = (val == "text") ? "8bit" : val
     end
 
     # Returns the preamble (any text that is before the first MIME boundary)

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/core_extensions/nil.rb

@@ -1,5 +1,7 @@
 # encoding: utf-8
 
+# This is not loaded if ActiveSupport is already loaded
+
 class NilClass #:nodoc:
   def to_crlf
     ''

data/lib/mail/core_extensions/object.rb

@@ -0,0 +1,13 @@
+# encoding: utf-8
+
+# This is not loaded if ActiveSupport is already loaded
+
+class Object
+  def blank?
+    if respond_to?(:empty?)
+      empty?
+    else
+     !self
+    end
+  end
+end

data/lib/mail/core_extensions/shellwords.rb

@@ -1,3 +1,5 @@
+# encoding: utf-8
+
 # The following is imported from ruby 1.9.2 shellwords.rb
 #
 module Shellwords

data/lib/mail/core_extensions/smtp.rb

@@ -1,3 +1,4 @@
+# encoding: utf-8
 module Net
   class SMTP
     # This is a backport of r30294 from ruby trunk because of a bug in net/smtp.

data/lib/mail/core_extensions/string/access.rb

@@ -0,0 +1,104 @@
+# encoding: utf-8
+
+# This is not loaded if ActiveSupport is already loaded
+
+# This is an almost cut and paste from ActiveSupport v3.0.6, copied in here so that Mail
+# itself does not depend on ActiveSupport to avoid versioning conflicts
+
+class String
+  unless '1.9'.respond_to?(:force_encoding)
+    # Returns the character at the +position+ treating the string as an array (where 0 is the first character).
+    #
+    # Examples:
+    #   "hello".at(0)  # => "h"
+    #   "hello".at(4)  # => "o"
+    #   "hello".at(10) # => ERROR if < 1.9, nil in 1.9
+    def at(position)
+      mb_chars[position, 1].to_s
+    end
+
+    # Returns the remaining of the string from the +position+ treating the string as an array (where 0 is the first character).
+    #
+    # Examples:
+    #   "hello".from(0)  # => "hello"
+    #   "hello".from(2)  # => "llo"
+    #   "hello".from(10) # => "" if < 1.9, nil in 1.9
+    def from(position)
+      mb_chars[position..-1].to_s
+    end
+
+    # Returns the beginning of the string up to the +position+ treating the string as an array (where 0 is the first character).
+    #
+    # Examples:
+    #   "hello".to(0)  # => "h"
+    #   "hello".to(2)  # => "hel"
+    #   "hello".to(10) # => "hello"
+    def to(position)
+      mb_chars[0..position].to_s
+    end
+
+    # Returns the first character of the string or the first +limit+ characters.
+    #
+    # Examples:
+    #   "hello".first     # => "h"
+    #   "hello".first(2)  # => "he"
+    #   "hello".first(10) # => "hello"
+    def first(limit = 1)
+      if limit == 0
+        ''
+      elsif limit >= size
+        self
+      else
+        mb_chars[0...limit].to_s
+      end
+    end
+
+    # Returns the last character of the string or the last +limit+ characters.
+    #
+    # Examples:
+    #   "hello".last     # => "o"
+    #   "hello".last(2)  # => "lo"
+    #   "hello".last(10) # => "hello"
+    def last(limit = 1)
+      if limit == 0
+        ''
+      elsif limit >= size
+        self
+      else
+        mb_chars[(-limit)..-1].to_s
+      end
+    end
+  else
+    def at(position)
+      self[position]
+    end
+
+    def from(position)
+      self[position..-1]
+    end
+
+    def to(position)
+      self[0..position]
+    end
+
+    def first(limit = 1)
+      if limit == 0
+        ''
+      elsif limit >= size
+        self
+      else
+        to(limit - 1)
+      end
+    end
+
+    def last(limit = 1)
+      if limit == 0
+        ''
+      elsif limit >= size
+        self
+      else
+        from(-limit)
+      end
+    end
+  end
+end

data/lib/mail/core_extensions/string/multibyte.rb

@@ -0,0 +1,78 @@
+# encoding: utf-8
+
+# This is not loaded if ActiveSupport is already loaded
+
+# This is an almost cut and paste from ActiveSupport v3.0.6, copied in here so that Mail
+# itself does not depend on ActiveSupport to avoid versioning conflicts
+
+require 'mail/multibyte'
+
+class String
+  if RUBY_VERSION >= "1.9"
+    # == Multibyte proxy
+    #
+    # +mb_chars+ is a multibyte safe proxy for string methods.
+    #
+    # In Ruby 1.8 and older it creates and returns an instance of the Mail::Multibyte::Chars class which
+    # encapsulates the original string. A Unicode safe version of all the String methods are defined on this proxy
+    # class. If the proxy class doesn't respond to a certain method, it's forwarded to the encapsuled string.
+    #
+    #   name = 'Claus Müller'
+    #   name.reverse # => "rell??M sualC"
+    #   name.length  # => 13
+    #
+    #   name.mb_chars.reverse.to_s # => "rellüM sualC"
+    #   name.mb_chars.length       # => 12
+    #
+    # In Ruby 1.9 and newer +mb_chars+ returns +self+ because String is (mostly) encoding aware. This means that
+    # it becomes easy to run one version of your code on multiple Ruby versions.
+    #
+    # == Method chaining
+    #
+    # All the methods on the Chars proxy which normally return a string will return a Chars object. This allows
+    # method chaining on the result of any of these methods.
+    #
+    #   name.mb_chars.reverse.length # => 12
+    #
+    # == Interoperability and configuration
+    #
+    # The Chars object tries to be as interchangeable with String objects as possible: sorting and comparing between
+    # String and Char work like expected. The bang! methods change the internal string representation in the Chars
+    # object. Interoperability problems can be resolved easily with a +to_s+ call.
+    #
+    # For more information about the methods defined on the Chars proxy see Mail::Multibyte::Chars. For
+    # information about how to change the default Multibyte behaviour see Mail::Multibyte.
+    def mb_chars
+      if Mail::Multibyte.proxy_class.consumes?(self)
+        Mail::Multibyte.proxy_class.new(self)
+      else
+        self
+      end
+    end
+
+    def is_utf8? #:nodoc
+      case encoding
+      when Encoding::UTF_8
+        valid_encoding?
+      when Encoding::ASCII_8BIT, Encoding::US_ASCII
+        dup.force_encoding(Encoding::UTF_8).valid_encoding?
+      else
+        false
+      end
+    end
+  else
+    def mb_chars
+      if Mail::Multibyte.proxy_class.wants?(self)
+        Mail::Multibyte.proxy_class.new(self)
+      else
+        self
+      end
+    end
+
+    # Returns true if the string has UTF-8 semantics (a String used for purely byte resources is unlikely to have
+    # them), returns false otherwise.
+    def is_utf8?
+      Mail::Multibyte::Chars.consumes?(self)
+    end
+  end
+end

data/lib/mail/core_extensions/string.rb

@@ -8,6 +8,10 @@ class String #:nodoc:
     gsub(/\n|\r\n|\r/) { "\n" }
   end
 
+  def blank?
+    self !~ /\S/
+  end
+
   unless method_defined?(:ascii_only?)
     # Provides all strings with the Ruby 1.9 method of .ascii_only? and
     # returns true or false
@@ -16,7 +20,7 @@ class String #:nodoc:
       !(self =~ /[^#{US_ASCII_REGEXP}]/)
     end
   end
-  
+
   def not_ascii_only?
     !ascii_only?
   end

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/field.rb

@@ -69,7 +69,8 @@ module Mail
     #  Field.new('content-type', ['text', 'plain', {:charset => 'UTF-8'}])
     def initialize(name, value = nil, charset = 'utf-8')
       case
-      when name =~ /:/ && value.blank?   # Field.new("field-name: field data")
+      when name =~ /:/                  # Field.new("field-name: field data")
+        charset = value unless value.blank?
         name, value = split(name)
         create_field(name, value, charset)
       when name !~ /:/ && value.blank?  # Field.new("field-name")

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

@@ -37,7 +37,7 @@ module Mail
     end
     
     def do_decode
-      "#{message_ids.map { |m| "<#{m}>" }.join(' ')}"
+      "#{message_ids.map { |m| "<#{m}>" }.join(' ')}" if message_ids
     end
     
   end

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

@@ -8,7 +8,7 @@ module Mail
   # to make that happen
   # Parameters are defined in RFC2045, split keys are in RFC2231
 
-  class ParameterHash < HashWithIndifferentAccess
+  class ParameterHash < IndifferentHash
 
     include Mail::Utilities
 
@@ -28,8 +28,8 @@ module Mail
       if pairs.empty? # Just dealing with a single value pair
         super(exact || key_name)
       else # Dealing with a multiple value pair or a single encoded value pair
-        string = pairs.sort { |a,b| a.first <=> b.first }.map { |v| v.last }.join('')
-        if mt = string.match(/([\w\-]+)'(\w\w)'(.*)/)
+        string = pairs.sort { |a,b| a.first.to_s <=> b.first.to_s }.map { |v| v.last }.join('')
+        if mt = string.match(/([\w\d\-]+)'(\w\w)'(.*)/)
           string = mt[3]
           encoding = mt[1]
         else
@@ -40,7 +40,7 @@ module Mail
     end
 
     def encoded
-      map.sort { |a,b| a.first <=> b.first }.map do |key_name, value|
+      map.sort { |a,b| a.first.to_s <=> b.first.to_s }.map do |key_name, value|
         unless value.ascii_only?
           value = Mail::Encodings.param_encode(value)
           key_name = "#{key_name}*"
@@ -50,7 +50,7 @@ module Mail
     end
 
     def decoded
-      map.sort { |a,b| a.first <=> b.first }.map do |key_name, value|
+      map.sort { |a,b| a.first.to_s <=> b.first.to_s }.map do |key_name, value|
         %Q{#{key_name}=#{quote_token(value)}}
       end.join("; ")
     end