mail 2.5.3 → 2.5.4

data/CHANGELOG.rdoc

@@ -1,5 +1,70 @@
 == HEAD
 
+
+== Version 2.5.4 - Tue May 14 14:45:00 +1100 2013 Mikel Lindsaar <mikel@lindsaar.net>
+
+Features:
+* Save settings passed to TestMailer#new (svanderbleek)
+* Allow the setting of envelope from directly (jeremy)
+* Accept other IETF/IANA-registered Content-Types and Content-Transfer-Encodings (jeremy)
+* Alias shift-jis charset to Shift_JIS Ruby encoding (jeremy)
+* Add support for ks_c_5601-1987 charset, aliased to CP949 Ruby encoding (jeremy)
+* Don't allow colons in header names (jeremy)
+* Can assign arrays of Message-IDs to References and In-Reply-To (jeremy)
+* Setting the html_ or text_part sets a default text/html or text/plain content type (jeremy)
+* Setting the html_ or text_part to nil removes it (jeremy)
+* Addresses without a parsable email or display name still format as their raw text (jeremy)
+* Close pull request 504 - Alias GB2312 charset to GB18030 Ruby encoding (bpot)
+* Close pull request 399 - Accept :ca_path and :ca_file options for SMTP delivery (ndbroadbent)
+* Close pull request 389 - Don't add superfluous message headers to MIME parts (djmaze, jeremy)
+
+Performance:
+* Close pull request 488 - Speed up field construction & comparison (bpot)
+
+Bugs:
+* Don't include separating semicolon in paramter value when sanitizing (bpot)
+* Fix fencepost encoding problem with binhex strings and only one token (drasch)
+* Fix sendmail delivery to addresses with a leading hyphen (lifo, jeremy)
+* Correctly format mbox From headers per RFC4155 (bpot, jeremy)
+* Fix bogus '=' at the end of some quoted-printable messages (jeremy)
+* Shouldn't be fooled into encoding strings on 1.8 by unrelated Encoding constant (emiellohr, jeremy)
+* Header encoding should be US-ASCII, not the default external encoding (jeremy)
+* Address elements should return decoded display names by default (jeremy)
+* Fix up tests that depend on utf-8 external encoding; read fixtures as binary (jeremy)
+* Capture stderr from Sendmail and Exim deliveries (jeremy)
+* RFC2822 quoted_string content may be empty (jeremy)
+* Calling #to_s on a field with a nil value returns an empty string instead of nil (jeremy)
+* The Received header may contain zero name/value pairs, qmail-style (jeremy)
+* Fix that setting an attachment with a :mime_type and :encoding would override the :encoding (jeremy)
+* Fix that declaring an html_part but no text_part would use multipart/alternative anyway (jeremy)
+* Close pull request 508 - Don't add an extra CRLF to MIME parts; split MIME parts on correct CRLF boundaries (Aalanar)
+* Close pull request 506 - Escape backslashes in quoted strings (ConradIrwin)
+* Close pull request 496 - Correctly handle quoted-printable line breaks (jeremy)
+* Close pull request 493 - Repair misencoded quoted-printable line breaks (jeremy)
+* Close pull request 487 - Extract comments from group email addresses (bpot)
+* Close pull request 481 - Correctly quote filename attributes (bpot)
+* Close pull request 480 - Support mixed encodings in a single header body (adamvaughan)
+* Close pull request 471 - Fix Ruby 1.8 build when UTF16/32 default to little-endian (kennyj)
+
+Coping with third-party bugs:
+* Parse multipart boundary from Content-Type headers containing extra semicolons (jeremy)
+* Close pull request 389 - Only add Content-ID to inline attachments to appease Outlook (djmaze, jeremy)
+
+Housekeeping:
+* Add development gem dependency on rdoc (jeremy)
+* Refresh Bundler dependencies & setup (jeremy)
+* Remove i18n dependency and last vestiges of activesupport dependency in specs (jeremy)
+* Clarify that Sender is a single address, not an address list (jeremy)
+* Add an MIT-LICENSE file to make licensing clear & obvious; update to 2013 (jeremy)
+* Close pull request 501 - Tighten up header/body whitespace splitting (ConradIrwin)
+* Close pull request 499 - Clean up some dead code (ConradIrwin)
+* Close pull request 489, 495 - Docs typos (JackDanger, francois)
+* Close pull request 485 - Be explicit about unsupported address parsing (bpot)
+* Close pull request 484 - Remove #tree specs in preparation for deprecation removal (bpot)
+* Close pull request 482 - Update address field specs to reflect to #initialize API (bpot)
+* Close pull request 475 - Shush warning on Object#blank? redefinition (amatsuda)
+* Close pull request 472 - Clean up UTF8/UTF-8 internals (kennyj)
+
 == Version 2.5.3 - Sun Dec 4 15:52:00 +1100 2012 Mikel Lindsaar <mikel@reinteractive.net>
 
 * Close pull request 468 - Remove debug output to STDOUT (tadman)

data/CONTRIBUTING.md

@@ -12,12 +12,12 @@ pull request merged quickly:
 5. Add a spec for your change. Only refactoring and documentation changes
    require no new specs. If you are adding functionality or fixing a bug, we need
    a spec!
-6. Test the spec _at_ _least_ against MRI-1.9.2 and MRI-1.8.7
+6. Test the spec _at_ _least_ against MRI-1.9.3 and MRI-1.8.7
 7. Update the README if needed to reflect your change / addition
 8. With all specs passing push your changes back to your fork
 9. Send me a pull request
 
-Note, specs that break MRI 1.8.7 will not be accepted.
+Note, specs that break MRI 1.8.7 or 1.9.3 will not be accepted.
 
 At this point you're waiting on us. We like to at least comment on, if not
 accept, pull requests within three business days (and, typically, one business
@@ -28,7 +28,7 @@ taken straight from the Ruby on Rails guide:
 
 * Tell me you have tested it against more than one version of Ruby, RVM is great for
   this. I test against 7 rubies before I push into master.
-* Use good, idiomatic, strcutred and modular code
+* Use good, idiomatic, structured and modular code
 * Include tests that fail without your code, and pass with it
 * Update the documentation, the surrounding one, examples elsewhere, guides,
   whatever is affected by your contribution
@@ -42,4 +42,4 @@ Syntax:
 * a = b and not a=b.
 * Follow the conventions you see used in the source already.
 
-And in case we didn't emphasize it enough: we love specs!
+And in case we didn't emphasize it enough: we love specs!

data/Gemfile

@@ -1,26 +1,13 @@
-source :rubygems
+source 'https://rubygems.org'
+
+gemspec
 
-gem "activesupport", ">= 2.3.6"
-gem "tlsmail" if RUBY_VERSION <= '1.8.6'
-gem "mime-types", "~> 1.16"
 gem "treetop", "~> 1.4.10"
-gem "i18n", ">= 0.4.0"
+gem "mime-types", "~> 1.16"
+gem "tlsmail" if RUBY_VERSION <= '1.8.6'
 
-if defined?(RUBY_ENGINE) && RUBY_ENGINE == 'jruby'
-  gem 'jruby-openssl'
-end
+gem 'jruby-openssl', :platform => :jruby
 
 group :test do
-  gem "rake",       "> 0.8.7"
-  gem "rspec",      "~> 2.12.0"
-  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
+  gem "ruby-debug", :platform => :mri_18
 end

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2009-2013 Mikel Lindsaar
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+'Software'), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED 'AS IS', WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
+IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY
+CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
+TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
+SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -1,4 +1,4 @@
-Mail
+Mail [![Build Status](https://travis-ci.org/mikel/mail.png?branch=master)](https://travis-ci.org/mikel/mail)
 ====
 
 Introduction
@@ -42,11 +42,12 @@ me a nice email :)
 Compatibility
 -------------
 
-Mail is tested by Travis ([![Travis Build Status](https://travis-ci.org/mikel/mail.png "Build Status")](https://travis-ci.org/mikel/mail)) and works on the [following platforms](https://github.com/mikel/mail/blob/master/.travis.yml)
+Every Mail commit is tested by Travis on the [following platforms](https://github.com/mikel/mail/blob/master/.travis.yml)
 
 * ruby-1.8.7-p370 [ i686 ]
 * ruby-1.9.2-p290 [ x86_64 ]
 * ruby-1.9.3-p327 [ x86_64 ]
+* ruby-2.0.0-rc1 [ x86_64 ]
 * jruby-1.6.8 [ x86_64 ]
 * jruby-1.7.0 [ x86_64 ]
 * rbx-d18 [ x86_64 ]
@@ -130,12 +131,12 @@ I have tried to simplify it some:
    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
+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 <code>#to_s</code> on a container object will call its encoded
-   method, while <code>#to_s</code> on a field object will call it's decoded method.
+   method, while <code>#to_s</code> on a field object will call its decoded method.
    So calling <code>#to_s</code> on a Mail object will return the mail, all encoded
    ready to send, while calling <code>#to_s</code> on the From field or the body will
    return the decoded value of the object. The header object of Mail is considered a
@@ -202,7 +203,7 @@ 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>
+    <4a7ff76d7016_13a81ab802e1@local.host.mail>
 
 ### Or do worry about Message-IDs:
 
@@ -265,7 +266,7 @@ mail.delivery_method :sendmail
 mail.deliver
 ```
 
-Exim requires it's own delivery manager, and can be used like so:
+Exim requires its own delivery manager, and can be used like so:
 
 ```ruby
 mail.delivery_method :exim, :location => "/usr/bin/exim"
@@ -338,8 +339,8 @@ mail = Mail.read('multipart_email')
 
 mail.multipart?          #=> true
 mail.parts.length        #=> 2
-mail.preamble            #=> "Text before the first part"
-mail.epilogue            #=> "Text after the last part"
+mail.body.preamble       #=> "Text before the first part"
+mail.body.epilogue       #=> "Text after the last part"
 mail.parts.map { |p| p.content_type }  #=> ['text/plain', 'application/pdf']
 mail.parts.map { |p| p.class }         #=> [Mail::Message, Mail::Message]
 mail.parts[0].content_type_parameters  #=> {'charset' => 'ISO-8859-1'}
@@ -642,7 +643,7 @@ License
 
 (The MIT License)
 
-Copyright (c) 2009, 2010, 2011, 2012 Mikel Lindsaar
+Copyright (c) 2009-2013 Mikel Lindsaar
 
 Permission is hereby granted, free of charge, to any person obtaining
 a copy of this software and associated documentation files (the

data/Rakefile

@@ -1,23 +1,6 @@
-begin
-  require "rubygems"
-  require "bundler"
-rescue LoadError
-  raise "Could not load the bundler gem. Install it with `gem install bundler`."
-end
-
-if Gem::Version.new(Bundler::VERSION) <= Gem::Version.new("1.0.0")
-  raise RuntimeError, "Your bundler version is too old for Mail" +
-   "Run `gem install bundler` to upgrade."
-end
-
-begin
-  # Set up load paths for all bundled gems
-  ENV["BUNDLE_GEMFILE"] = File.expand_path("../Gemfile", __FILE__)
-  Bundler.setup
-rescue Bundler::GemNotFound
-  raise RuntimeError, "Bundler couldn't find some gems." +
-    "Did you run `bundle install`?"
-end
+ENV['BUNDLE_GEMFILE'] = File.expand_path('../Gemfile', __FILE__)
+require 'rubygems'
+require 'bundler/setup'
 
 require 'rake/testtask'
 require 'rspec/core/rake_task'

data/lib/VERSION

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

data/lib/mail.rb

@@ -29,7 +29,6 @@ module Mail # :doc:
   require 'mail/core_extensions/nil'
   require 'mail/core_extensions/object'
   require 'mail/core_extensions/string'
-  require 'mail/core_extensions/shell_escape'
   require 'mail/core_extensions/smtp' if RUBY_VERSION < '1.9.3'
   require 'mail/indifferent_hash'
 

data/lib/mail/attachments_list.rb

@@ -60,7 +60,7 @@ module Mail
         if value[:mime_type]
           default_values[:content_type] = value.delete(:mime_type)
           @mime_type = MIME::Types[default_values[:content_type]].first
-          default_values[:content_transfer_encoding] = guess_encoding
+          default_values[:content_transfer_encoding] ||= guess_encoding
         end
 
         hash = default_values.merge(value)
@@ -94,7 +94,7 @@ module Mail
     def set_mime_type(filename)
       # Have to do this because MIME::Types is not Ruby 1.9 safe yet
       if RUBY_VERSION >= '1.9'
-         filename   = filename.encode(Encoding::UTF_8) if filename.respond_to?(:encode)
+        filename = filename.encode(Encoding::UTF_8) if filename.respond_to?(:encode)
       end
 
       @mime_type = MIME::Types.type_for(filename).first

data/lib/mail/body.rb

@@ -5,7 +5,7 @@ module Mail
   # 
   # The body is where the text of the email is stored.  Mail treats the body
   # as a single object.  The body itself has no information about boundaries
-  # used in the MIME standard, it just looks at it's content as either a single
+  # used in the MIME standard, it just looks at its content as either a single
   # block of text, or (if it is a multipart message) as an array of blocks of text.
   # 
   # A body has to be told to split itself up into a multipart message by calling
@@ -257,7 +257,7 @@ module Mail
     
     def split!(boundary)
       self.boundary = boundary
-      parts = raw_source.split(/--#{Regexp.escape(boundary)}(?=(?:--)?\s*$)/)
+      parts = raw_source.split(/(?:\A|\r\n)--#{Regexp.escape(boundary)}(?=(?:--)?\s*$)/)
       # Make the preamble equal to the preamble (if any)
       self.preamble = parts[0].to_s.strip
       # Make the epilogue equal to the epilogue (if any)
@@ -277,11 +277,11 @@ module Mail
     private
     
     def crlf_boundary
-      "\r\n\r\n--#{boundary}\r\n"
+      "\r\n--#{boundary}\r\n"
     end
     
     def end_boundary
-      "\r\n\r\n--#{boundary}--\r\n"
+      "\r\n--#{boundary}--\r\n"
     end
     
     def set_charset

data/lib/mail/check_delivery_params.rb

@@ -1,30 +1,20 @@
 module Mail
-
   module CheckDeliveryParams
+    def check_delivery_params(mail)
+      if mail.smtp_envelope_from.blank?
+        raise ArgumentError.new('An SMTP From address is required to send a message. Set the message smtp_envelope_from, return_path, sender, or from address.')
+      end
 
-    def self.included(klass)
-      klass.class_eval do
-
-        def check_params(mail)
-          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
-
-          [envelope_from, destinations, message]
-        end
+      if mail.smtp_envelope_to.blank?
+        raise ArgumentError.new('An SMTP To address is required to send a message. Set the message smtp_envelope_to, to, cc, or bcc address.')
+      end
 
+      message = mail.encoded if mail.respond_to?(:encoded)
+      if message.blank?
+        raise ArgumentError.new('An encoded message is required to send an email')
       end
+
+      [mail.smtp_envelope_from, mail.smtp_envelope_to, message]
     end
   end
 end

data/lib/mail/core_extensions/object.rb

@@ -1,13 +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
+unless Object.method_defined? :blank?
+  class Object
+    def blank?
+      if respond_to?(:empty?)
+        empty?
+      else
+        !self
+      end
     end
   end
 end

data/lib/mail/core_extensions/smtp.rb

@@ -5,21 +5,20 @@ module Net
     # http://svn.ruby-lang.org/cgi-bin/viewvc.cgi?view=rev&revision=30294
     #
     # 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)
+    begin
+      alias_method :original_tlsconnect, :tlsconnect
 
-    def tlsconnect(s)
-      verified = false
-      s = OpenSSL::SSL::SSLSocket.new s, @ssl_context
-      logging "TLS connection started"
-      s.sync_close = true
-      s.connect
-      if @ssl_context.verify_mode != OpenSSL::SSL::VERIFY_NONE
-        s.post_connection_check(@address)
+      def tlsconnect(s)
+        verified = false
+        begin
+          original_tlsconnect(s).tap { verified = true }
+        ensure
+          unless verified
+            s.close rescue nil
+          end
+        end
       end
-      verified = true
-      s
-    ensure
-      s.close unless verified
+    rescue NameError
     end
   end
 end

data/lib/mail/core_extensions/string.rb

@@ -15,12 +15,12 @@ class String #:nodoc:
   end
 
   unless method_defined?(:ascii_only?)
-    # Provides all strings with the Ruby 1.9 method of .ascii_only? and
-    # returns true or false
-    US_ASCII_REGEXP = %Q{\x00-\x7f}
+    # Backport from Ruby 1.9 checks for non-us-ascii characters.
     def ascii_only?
-      !(self =~ /[^#{US_ASCII_REGEXP}]/)
+      self !~ MATCH_NON_US_ASCII
     end
+
+    MATCH_NON_US_ASCII = /[^\x00-\x7f]/
   end
 
   def not_ascii_only?

data/lib/mail/elements/address.rb

@@ -5,7 +5,7 @@ module Mail
     include Mail::Utilities
     
     # Mail::Address handles all email addresses in Mail.  It takes an email address string
-    # and parses it, breaking it down into it's component parts and allowing you to get the
+    # and parses it, breaking it down into its component parts and allowing you to get the
     # address, comments, display name, name, local part, domain part and fully formatted
     # address.
     # 
@@ -21,7 +21,7 @@ module Mail
     #  a.comments     #=> ['My email address']
     #  a.to_s         #=> 'Mikel Lindsaar <mikel@test.lindsaar.net> (My email address)'
     def initialize(value = nil)
-      @output_type = nil
+      @output_type = :decode
       @tree = nil
       @raw_text = value
       case
@@ -40,7 +40,7 @@ module Mail
     end
 
     # Returns a correctly formatted address for the email going out.  If given
-    # an incorrectly formatted address as input, Mail::Address will do it's best
+    # an incorrectly formatted address as input, Mail::Address will do its best
     # to format it correctly.  This includes quoting display names as needed and
     # putting the address in angle brackets etc.
     #
@@ -53,8 +53,10 @@ module Mail
         ''
       when display_name
         [quote_phrase(display_name), "<#{address}>", format_comments].compact.join(" ")
-      else
+      when address
         [address, format_comments].compact.join(" ")
+      else
+        tree.text_value
       end
     end
 
@@ -296,6 +298,12 @@ module Mail
         tree.angle_addr.addr_spec.local_part.text_value
       when tree.respond_to?(:addr_spec) && tree.addr_spec.respond_to?(:local_part)
         tree.addr_spec.local_part.text_value
+      when tree.respond_to?(:angle_addr) && tree.angle_addr.respond_to?(:addr_spec) && tree.angle_addr.addr_spec.respond_to?(:local_dot_atom_text)
+        # Ignore local dot atom text when in angle brackets
+        nil
+      when tree.respond_to?(:addr_spec) && tree.addr_spec.respond_to?(:local_dot_atom_text)
+        # Ignore local dot atom text when in angle brackets
+        nil
       else
         tree && tree.respond_to?(:local_part) ? tree.local_part.text_value : nil
       end
@@ -303,4 +311,4 @@ module Mail
     
  
   end
-end
+end