mail 2.2.13 → 2.2.14

data/CHANGELOG.rdoc

@@ -1,3 +1,14 @@
+== Mon  3 Jan 2011 12:48:59 UTC Mikel Lindsaar <mikel@rubyx.com>
+
+* Update field_spec to handle encodings, closes issues 44 and 120 (Luis Lopez)
+* Version bump to 2.2.14 and gem release
+
+== Mon  3 Jan 2011 00:09:27 UTC Mikel Lindsaar <mikel@rubyx.com>
+
+* Use default IANA port on the IMAP retriever_method (Adrian Silva)
+* Updated README to reflect latest ruby versions we test against (mikel)
+* Only remove tlsconnect if it exists (mikel)
+
 == Thu 23 Dec 2010 09:15:58 UTC Mikel Lindsaar <mikel@rubyx.com>
 
 * Added backport fix for net/smtp bug (Aaron Patterson)

data/README.rdoc

@@ -27,16 +27,11 @@ you are doing, you can fiddle with every last bit of your email directly.
 
 Mail is tested and works on the following platforms:
 
-* jruby-1.4.0 [ [x86_64-java] ]
-* ree-1.8.7-2010.01 [ x86_64 ]
+* jruby-1.5.2 [ [x86_64-java] ]
+* ree-1.8.7-2010.02 [ x86_64 ]
 * ruby-1.8.6-p399 [ x86_64 ]
-* ruby-1.8.7-p249 [ x86_64 ]
-* ruby-1.9.1-head [ x86_64 ] (10 April 2010)
-* ruby-1.9.2-head [ x86_64 ] (10 April 2010)
-
-Mail seems to work fine on JRuby as well, however there is some weird QP
-problem that only shows up while running the specs, running it directly
-works fine.... weird.  Any jRuby gurus who want to help out, please do.
+* ruby-1.8.7-p302 [ x86_64 ]
+* ruby-1.9.2-p0 [ x86_64 ]
 
 == Discussion
 
@@ -63,7 +58,7 @@ field and continue parsing.
 
 This means Mail won't (ever) crunch your data (I think).
 
-You can also create MIME emails.  There are helper methods for making a 
+You can also create MIME emails.  There are helper methods for making a
 multipart/alternate email for text/plain and text/html (the most common pair)
 and you can manually create any other type of MIME email.
 
@@ -73,7 +68,6 @@ Next TODO:
 
 * Improve MIME support for character sets in headers, currently works, mostly, needs
   refinement.
-* Add IMAP wrapper
 
 == Testing Policy
 
@@ -94,23 +88,10 @@ Also, all private or protected methods to be declared as such - though this is s
 
 == Installation
 
-Installation is fairly simple, I host mail on gemcutter, so you can just do:
+Installation is fairly simple, I host mail on rubygems, so you can just do:
 
  # gem install mail
 
-if you are on gemcutter, if you aren't, you can by doing:
-
- # gem install gemcutter
- # gem tumble
- # gem install mail
- 
-Warning though, the above will change your first gem repository to gemcutter, this
-may or may not be a problem for you.
-
-If you want to install mail manually, you can download the gem from github and do:
-
- # gem install mail-2.2.0.gem
- 
 == Encodings
 
 If you didn't know, handling encodings in Emails is not as straight forward as you
@@ -122,26 +103,26 @@ I have tried to simplify it some:
    return the object as a complete string ready to send in the mail system, that is,
    it will include the header field and value and CRLF at the end and wrapped as
    needed.
-   
+
 2. All objects that can render into an email, have a :decoded method.  Decoded will
    return the object's "value" only as a string.  This means it will not include
    the header fields (like 'To:' or 'Subject:').
-   
+
 3. By default, calling :to_s on a container object will call it's encoded method, while
    :to_s on a field object will call it's decoded method.  So calling :to_s on a Mail
    object will return the mail, all encoded ready to send, while calling :to_s on the
    From field or the body will return the decoded value of the object.  The header object
    of Mail is considered a container.  If you are in doubt, call :encoded, or :decoded
    explicitly, this is safer if you are not sure.
-   
+
 4. Structured fields that have parameter values that can be encoded (e.g. Content-Type) will
    provide decoded parameter values when you call the parameter names as methods against
    the object.
-   
+
 5. Structured fields that have parameter values that can be encoded (e.g. Content-Type) will
-   provide encoded parameter values when you call the parameter names through the 
+   provide encoded parameter values when you call the parameter names through the
    object.parameters['<parameter_name>'] method call.
- 
+
 == Contributing
 
 Please do!  Contributing is easy in Mail:
@@ -163,7 +144,7 @@ So, you should be able to just "require 'mail'" to get started.
 === Making an email
 
  require 'mail'
- 
+
  mail = Mail.new do
       from 'mikel@test.lindsaar.net'
         to 'you@test.lindsaar.net'
@@ -176,7 +157,7 @@ So, you should be able to just "require 'mail'" to get started.
 === Making an email, have it your way:
 
  require 'mail'
- 
+
  mail = Mail.new do
    body File.read('body.txt')
  end
@@ -184,35 +165,35 @@ So, you should be able to just "require 'mail'" to get started.
  mail['from'] = 'mikel@test.lindsaar.net'
  mail[:to]    = 'you@test.lindsaar.net'
  mail.subject = 'This is a test email'
- 
+
  mail.to_s #=> "From: mikel@test.lindsaar.net\r\nTo: you@...
 
 === Don't Worry About Message IDs:
 
  require 'mail'
- 
+
  mail = Mail.new do
      to 'you@test.lindsaar.net'
    body 'Some simple body'
  end
 
  mail.to_s =~ /Message\-ID: <[\d\w_]+@.+.mail/ #=> 27
- 
+
 Mail will automatically add a Message-ID field if it is missing and
 give it a unique, random Message-ID along the lines of:
 
  <4a7ff76d7016_13a81ab802e1@local.fqdn.mail>
- 
+
 === Or do worry about Message-IDs:
 
  require 'mail'
- 
+
  mail = Mail.new do
           to 'you@test.lindsaar.net'
   message_id '<ThisIsMyMessageId@some.domain.com>'
         body 'Some simple body'
  end
- 
+
  mail.to_s =~ /Message\-ID: <ThisIsMyMessageId@some.domain.com>/ #=> 27
 
 Mail will take the message_id you assign to it trusting that you know
@@ -220,7 +201,7 @@ what you are doing.
 
 === Sending an email:
 
-Mail defaults to sending via SMTP to local host port 25.  If you have a 
+Mail defaults to sending via SMTP to local host port 25.  If you have a
 sendmail or postfix daemon running on on this port, sending email is as
 easy as:
 
@@ -233,7 +214,7 @@ easy as:
  end
 
 or
- 
+
  mail = Mail.new do
        from 'me@test.lindsaar.net'
          to 'you@test.lindsaar.net'
@@ -241,7 +222,7 @@ or
        body File.read('body.txt')
    add_file {:filename => 'somefile.png', :content => File.read('/somefile.png')}
  end
- 
+
  mail.deliver!
 
 Sending via sendmail can be done like so:
@@ -253,9 +234,9 @@ Sending via sendmail can be done like so:
         body File.read('body.txt')
     add_file {:filename => 'somefile.png', :content => File.read('/somefile.png')}
   end
-  
+
   mail.delivery_method :sendmail
-  
+
   mail.deliver
 
 {Learn more about SMTP Delivery}[link:classes/Mail/SMTP.html]
@@ -318,9 +299,9 @@ Or even all emails:
 === Reading an Email
 
  require 'mail'
- 
+
  mail = Mail.read('/path/to/message.eml')
- 
+
  mail.envelope.from   #=> 'mikel@test.lindsaar.net'
  mail.from.addresses  #=> ['mikel@test.lindsaar.net', 'ada@test.lindsaar.net']
  mail.sender.address  #=> 'mikel@test.lindsaar.net'
@@ -336,9 +317,9 @@ Many more methods available.
 === Reading a Multipart Email
 
  require 'mail'
- 
+
  mail = Mail.read('multipart_email')
- 
+
  mail.multipart?          #=> true
  mail.parts.length        #=> 2
  mail.preamble            #=> "Text before the first part"
@@ -356,7 +337,7 @@ content type and has a boundary defined.
 
 === Writing and sending a multipart/alternative (html and text) email
 
-Mail makes some basic assumptions and makes doing the common thing as 
+Mail makes some basic assumptions and makes doing the common thing as
 simple as possible.... (asking a lot from a mail library)
 
  require 'mail'
@@ -373,7 +354,7 @@ simple as possible.... (asking a lot from a mail library)
      body '<h1>This is HTML</h1>'
    end
  end
- 
+
 Mail then delivers the email at the end of the block and returns the
 resulting Mail::Message object, which you can then inspect if you
 so desire...
@@ -409,7 +390,7 @@ so desire...
  <h1>This is HTML</h1>
  ----==_mimepart_4a914f0c911be_6f0f1ab8026659--
 
-Mail inserts the content transfer encoding, the mime version, 
+Mail inserts the content transfer encoding, the mime version,
 the content-id's and handles the content-type and boundary.
 
 Mail assumes that if your text in the body is only us-ascii, that your
@@ -423,7 +404,7 @@ can just do it declaratively.  However, you need to add Mail::Parts to
 an email, not Mail::Messages.
 
  require 'mail'
- 
+
  mail = Mail.new do
    to 'nicolas@test.lindsaar.net.au'
    from 'Mikel Lindsaar <mikel@test.lindsaar.net.au>'
@@ -433,12 +414,12 @@ an email, not Mail::Messages.
  text_part = Mail::Part.new do
    body 'This is plain text'
  end
- 
+
  html_part = Mail::Part.new do
    content_type 'text/html; charset=UTF-8'
    body '<h1>This is HTML</h1>'
  end
- 
+
  mail.text_part = text_part
  mail.html_part = html_part
 
@@ -447,14 +428,14 @@ Results in the same email as done using the block form
 === Getting error reports from an email:
 
  require 'mail'
- 
+
  @mail = Mail.read('/path/to/bounce_message.eml')
- 
+
  @mail.bounced?         #=> true
  @mail.final_recipient  #=> rfc822;mikel@dont.exist.com
  @mail.action           #=> failed
  @mail.error_status     #=> 5.5.0
- @mail.diagnostic_code  #=> smtp;550 Requested action not taken: mailbox unavailable 
+ @mail.diagnostic_code  #=> smtp;550 Requested action not taken: mailbox unavailable
  @mail.retryable?       #=> false
 
 === Attaching and Detaching Files
@@ -463,7 +444,7 @@ Results in the same email as done using the block form
 
 You can just read the file off an absolute path, Mail will try
 to guess the mime_type and will encode the file in Base64 for you.
-  
+
   @mail = Mail.new
   @mail.add_file("/path/to/file.jpg")
   @mail.parts.first.attachment? #=> true
@@ -474,7 +455,7 @@ to guess the mime_type and will encode the file in Base64 for you.
 
 Or You can pass in file_data and give it a filename, again, mail
 will try and guess the mime_type for you.
-  
+
   @mail = Mail.new
   @mail.attachments['myfile.pdf'] = File.read('path/to/myfile.pdf')
   @mail.parts.first.attachment? #=> true
@@ -507,7 +488,7 @@ Of course... Mail will round trip an attachment as well
   end
 
   @round_tripped_mail = Mail.new(@mail.encoded)
-  
+
   @round_tripped_mail.attachments.length #=> 1
   @round_tripped_mail.attachments.first.filename #=> 'myfile.pdf'
 
@@ -540,9 +521,9 @@ sending emails, the TestMailer can do this for you.
 
 == Excerpts from TREC Spam Corpus 2005
 
-The spec fixture files in spec/fixtures/emails/from_trec_2005 are from the 
+The spec fixture files in spec/fixtures/emails/from_trec_2005 are from the
 2005 TREC Public Spam Corpus. They remain copyrighted under the terms of
-that project and license agreement. They are used in this project to verify 
+that project and license agreement. They are used in this project to verify
 and describe the development of this email parser implementation.
 
 http://plg.uwaterloo.ca/~gvcormac/treccorpus/
@@ -553,14 +534,14 @@ They are used as allowed by 'Permitted Uses, Clause 3':
      or published in a scientific or technical context, solely for
      the purpose of describing the research and development and
      related issues."
-     
+
      -- http://plg.uwaterloo.ca/~gvcormac/treccorpus/
 
 == License:
 
 (The MIT License)
 
-Copyright (c) 2009
+Copyright (c) 2009, 2010, 2011
 
 Permission is hereby granted, free of charge, to any person obtaining
 a copy of this software and associated documentation files (the

data/lib/VERSION

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

data/lib/mail/core_extensions/smtp.rb

@@ -3,8 +3,8 @@ module Net
     # This is a backport of r30294 from ruby trunk because of a bug in net/smtp.
     # http://svn.ruby-lang.org/cgi-bin/viewvc.cgi?view=rev&revision=30294
     #
-    # Fixed in what will be Ruby 1.9.3
-    remove_method :tlsconnect
+    # Fixed in what will be Ruby 1.9.3 - tlsconnect also does not exist in some early versions of ruby
+    remove_method :tlsconnect if defined?(Net::SMTP.new.tlsconnect)
 
     def tlsconnect(s)
       verified = false

data/lib/mail/encodings.rb

@@ -120,7 +120,7 @@ module Mail
 
       # Split on white-space boundaries with capture, so we capture the white-space as well
       str.split(/([ \t])/).map do |text|
-        if text.index('=?') != 0
+        if text.index('=?') .nil?
           text
         else
           # Join QP encoded-words that are adjacent to avoid decoding partial chars
@@ -128,17 +128,11 @@ module Mail
         
           # Separate encoded-words with a space, so we can treat them one by one
           text.gsub!(/\?\=\=\?/, '?= =?')
-
           text.split(/ /).map do |word|
-            case 
-            when word.to_str =~ /=\?.+\?[Bb]\?/m
-              b_value_decode(word)
-            when text.to_str =~ /=\?.+\?[Qq]\?/m
-              q_value_decode(word)
-            else
-              word.to_str
+            word.to_str.
+              gsub(/=\?.+\?[Bb]\?.+\?=/m) {|substr| b_value_decode(substr)}.
+              gsub(/=\?.+\?[Qq]\?.+\?=/m) {|substr| q_value_decode(substr)}
             end
-          end
         end
       end.join("")
     end
@@ -153,8 +147,12 @@ module Mail
         output
       elsif original_encoding && to_encoding
         begin
-          require 'iconv'
-          Iconv.iconv(to_encoding, original_encoding, output).first
+          if RUBY_VERSION >= '1.9'
+            output.encode(to_encoding)
+          else
+            require 'iconv'
+            Iconv.iconv(to_encoding, original_encoding, output).first
+          end
         rescue Iconv::IllegalSequence, Iconv::InvalidEncoding, Errno::EINVAL
           # the 'from' parameter specifies a charset other than what the text
           # actually is...not much we can do in this case but just return the

data/lib/mail/fields/unstructured_field.rb

@@ -71,7 +71,9 @@ module Mail
     end
     
     def do_decode
-      value.blank? ? nil : Encodings.decode_encode(value, :decode)
+      result = value.blank? ? nil : Encodings.decode_encode(value, :decode)
+      result.encode!(value.encoding || "UTF-8") if RUBY_VERSION >= '1.9' && !result.blank?
+      result
     end
     
     # 2.2.3. Long Header Fields

data/lib/mail/message.rb

@@ -1957,6 +1957,7 @@ module Mail
       else
         filename = nil
       end
+      filename = Mail::Encodings.decode_encode(filename, :decode) if filename rescue filename
       filename
     end
 

data/lib/mail/network/retriever_methods/imap.rb

@@ -37,7 +37,7 @@ module Mail
     
     def initialize(values)
       self.settings = { :address              => "localhost",
-                        :port                 => 110,
+                        :port                 => 143,
                         :user_name            => nil,
                         :password             => nil,
                         :authentication       => nil,

data/lib/mail/version_specific/ruby_1_9.rb

@@ -14,7 +14,7 @@ module Mail
       str = escape_paren( str )
       '(' + str + ')'
     end
-
+    
     def Ruby19.escape_bracket( str )
       re = /(?<!\\)([\<\>])/          # Only match unescaped brackets
       str.gsub(re) { |s| '\\' + s }
@@ -29,34 +29,34 @@ module Mail
     def Ruby19.decode_base64(str)
       str.unpack( 'm' ).first.force_encoding(Encoding::BINARY)
     end
-
+    
     def Ruby19.encode_base64(str)
       [str].pack( 'm' )
     end
-
+    
     def Ruby19.has_constant?(klass, string)
       klass.constants.include?( string.to_sym )
     end
-
+    
     def Ruby19.get_constant(klass, string)
       klass.const_get( string.to_sym )
     end
-
+    
     def Ruby19.b_value_encode(str, encoding = nil)
       encoding = str.encoding.to_s
       [Ruby19.encode_base64(str), encoding]
     end
-
+    
     def Ruby19.b_value_decode(str)
       match = str.match(/\=\?(.+)?\?[Bb]\?(.+)?\?\=/m)
       if match
         encoding = match[1]
-        str = Ruby19.decode_base64(match[2].to_s)
-        str.force_encoding(encoding)
+        str = Ruby19.decode_base64(match[2])
+        str.force_encoding(fix_encoding(encoding))
       end
-      str
+      str.encode("utf-8", :invalid => :replace, :replace => "") 
     end
-
+    
     def Ruby19.q_value_encode(str, encoding = nil)
       encoding = str.encoding.to_s
       [Encodings::QuotedPrintable.encode(str), encoding]
@@ -67,9 +67,9 @@ module Mail
       if match
         encoding = match[1]
         str = Encodings::QuotedPrintable.decode(match[2])
-        str.force_encoding(encoding)
+        str.force_encoding(fix_encoding(encoding))
       end
-      str
+      str.encode("utf-8", :invalid => :replace, :replace => "") 
     end
 
     def Ruby19.param_decode(str, encoding)
@@ -83,5 +83,24 @@ module Mail
       language = Configuration.instance.param_encode_language
       "#{encoding}'#{language}'#{URI.escape(str)}"
     end
+
+     # mails somtimes includes invalid encodings like iso885915 or utf8 so we transform them to iso885915 or utf8 
+     # TODO: add this as a test somewhere 
+     # Encoding.list.map{|e| [e.to_s.upcase==fix_encoding(e.to_s.downcase.gsub("-", "")), e.to_s] }.select {|a,b| !b}
+     #  Encoding.list.map{|e| [e.to_s==fix_encoding(e.to_s), e.to_s] }.select {|a,b| !b}
+    def Ruby19.fix_encoding(encoding)
+      case encoding
+        # ISO-8859-15, ISO-2022-JP and alike
+        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}"
+        # Windows-1252 and alike
+        when /Windows-?(.*)/i then return "Windows-#{$1}"
+        #more aliases to be added if needed
+        else return encoding
+      end
+    end
   end
 end

metadata

@@ -1,13 +1,12 @@
 --- !ruby/object:Gem::Specification 
 name: mail
 version: !ruby/object:Gem::Version 
-  hash: 29
   prerelease: false
   segments: 
   - 2
   - 2
-  - 13
-  version: 2.2.13
+  - 14
+  version: 2.2.14
 platform: ruby
 authors: 
 - Mikel Lindsaar
@@ -15,18 +14,16 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-12-23 00:00:00 +11:00
+date: 2011-01-05 00:00:00 +11:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
   name: activesupport
   prerelease: false
   requirement: &id001 !ruby/object:Gem::Requirement 
-    none: false
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
-        hash: 15
         segments: 
         - 2
         - 3
@@ -38,11 +35,9 @@ dependencies:
   name: mime-types
   prerelease: false
   requirement: &id002 !ruby/object:Gem::Requirement 
-    none: false
     requirements: 
     - - ~>
       - !ruby/object:Gem::Version 
-        hash: 47
         segments: 
         - 1
         - 16
@@ -53,11 +48,9 @@ dependencies:
   name: treetop
   prerelease: false
   requirement: &id003 !ruby/object:Gem::Requirement 
-    none: false
     requirements: 
     - - ~>
       - !ruby/object:Gem::Version 
-        hash: 23
         segments: 
         - 1
         - 4
@@ -69,11 +62,9 @@ dependencies:
   name: i18n
   prerelease: false
   requirement: &id004 !ruby/object:Gem::Requirement 
-    none: false
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
-        hash: 15
         segments: 
         - 0
         - 4
@@ -225,27 +216,23 @@ rdoc_options: []
 require_paths: 
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement 
-  none: false
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
-      hash: 3
       segments: 
       - 0
       version: "0"
 required_rubygems_version: !ruby/object:Gem::Requirement 
-  none: false
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
-      hash: 3
       segments: 
       - 0
       version: "0"
 requirements: []
 
 rubyforge_project: 
-rubygems_version: 1.3.7
+rubygems_version: 1.3.6
 signing_key: 
 specification_version: 3
 summary: Mail provides a nice Ruby DSL for making, sending and reading emails.