mail 2.6.4 → 2.7.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: f91f133d2e44832ecef1cb4bfe9cc57391aedf84
-  data.tar.gz: 23d0cdbc09cdbaafee76b01d7c3820a6c0dfb6d1
+  metadata.gz: 0f77ef2d4e2ecc02b59f5431cd56e3c0a5569262
+  data.tar.gz: a6e4a0ee6b7d2d1a824578a43a5c73893ae3fa10
 SHA512:
-  metadata.gz: c788407da309561bee6a59ec746efeea7c0cc8633206eb2085f08ad6b161df92475109a988de748e554248d2ca47e6cd31c3fd0394d0eddac5950e7bb28783a8
-  data.tar.gz: 55b70f9d539420d254373c7abfccf6bc85228f34c38696086be363a36fb4f966415238aaa8e9ec9e6eed02207af2a3940b9f85c5f3076e735cd19e095764abc2
+  metadata.gz: 70f3d73bb71de6e3d6121df0e93cd3909fb35eef6716c0597803a67ee341445385951dc662901dce2e806840c399d1f6ea0015987b2944b9fb24f9973a8e97af
+  data.tar.gz: 0d7283e6e57f4600704b9d9e45ae17e77e8105db42a394174217c7f488e81ac4598fef6492e85e24a8e763ceb302ee3ee6754fa1bf3bf9777bfa37a707157d4b

data/README.md

@@ -1,8 +1,6 @@
-Mail [![Build Status](https://travis-ci.org/mikel/mail.png?branch=master)](https://travis-ci.org/mikel/mail)
-====
+# Mail [![Build Status](https://travis-ci.org/mikel/mail.png?branch=master)](https://travis-ci.org/mikel/mail)
 
-Introduction
-------------
+## Introduction
 
 Mail is an internet library for Ruby that is designed to handle emails
 generation, parsing and sending in a simple, rubyesque manner.
@@ -25,8 +23,7 @@ Finally, Mail has been designed with a very simple object oriented system
 that really opens up the email messages you are parsing, if you know what
 you are doing, you can fiddle with every last bit of your email directly.
 
-Donations
--------------
+## Donations
 
 Mail has been downloaded millions of times, by people around the world, in fact,
 it represents more than 1% of *all* gems downloaded.
@@ -38,52 +35,48 @@ me a nice email :)
 
 <a href='http://www.pledgie.com/campaigns/8790'><img alt='Click here to lend your support to: mail and make a donation at www.pledgie.com !' src='http://www.pledgie.com/campaigns/8790.png?skin_name=chrome' border='0' /></a>
 
+# Contents
+* [Compatibility](#compatibility)
+* [Discussion](#discussion)
+* [Current Capabilities of Mail](#current-capabilities-of-mail)
+* [Roadmap](#roadmap)
+* [Testing Policy](#testing-policy)
+* [API Policy](#api-policy)
+* [Installation](#installation)
+* [Encodings](#encodings)
+* [Contributing](#contributing)
+* [Usage](#usage)
+* [Core Extensions](#core-extensions)
+* [Excerpts from TREC Span Corpus 2005](#excerpts-from-trec-span-corpus-2005)
+* [License](#license)
 
-Compatibility
--------------
+## Compatibility
 
-Every Mail commit is tested by Travis on the [following platforms](https://github.com/mikel/mail/blob/master/.travis.yml)
+Mail supports Ruby 1.8.7+, including JRuby and Rubinius.
 
-* ruby-1.8.7 [ i686 ]
-* ruby-1.9.2 [ x86_64 ]
-* ruby-1.9.3 [ x86_64 ]
-* ruby-2.0.0 [ x86_64 ]
-* ruby-2.1.2 [ x86_64 ]
-* ruby-head [ x86_64 ]
-* jruby [ x86_64 ]
-* jruby-head [ x86_64 ]
-* rbx-2 [ x86_64 ]
+Every Mail commit is tested by Travis on [all supported Ruby versions](https://github.com/mikel/mail/blob/master/.travis.yml).
 
-Testing a specific mime type (needed for 1.8.7 for example) can be done manually with:
-
-```sh
-BUNDLE_GEMFILE=gemfiles/mime_types_1.16.gemfile (bundle check || bundle) && rake
-```
-
-Discussion
-----------
+## Discussion
 
 If you want to discuss mail with like minded individuals, please subscribe to
 the [Google Group](http://groups.google.com/group/mail-ruby).
 
-Current Capabilities of Mail
-----------------------------
+## Current Capabilities of Mail
 
-* RFC2822 Support, Reading and Writing
+* RFC5322 Support, Reading and Writing
+* RFC6532 Support, reading UTF-8 headers
 * RFC2045-2049 Support for multipart emails
 * Support for creating multipart alternate emails
 * Support for reading multipart/report emails &amp; getting details from such
-* Support for multibyte emails - needs quite a lot of work and testing
 * Wrappers for File, Net/POP3, Net/SMTP
-* Auto encoding of non US-ASCII header fields
-* Auto encoding of non US-ASCII bodies
+* Auto-encoding of non-US-ASCII bodies and header fields
 
-Mail is RFC2822 compliant now, that is, it can parse and generate valid US-ASCII
-emails.  There are a few obsoleted syntax emails that it will have problems with, but
-it also is quite robust, meaning, if it finds something it doesn't understand it will
-not crash, instead, it will skip the problem and keep parsing.  In the case of a header
-it doesn't understand, it will initialise the header as an optional unstructured
-field and continue parsing.
+Mail is RFC5322 and RFC6532 compliant now, that is, it can parse US-ASCII and UTF-8
+emails and generate US-ASCII emails. There are a few obsoleted syntax emails that
+it will have problems with, but it also is quite robust, meaning, if it finds something
+it doesn't understand it will not crash, instead, it will skip the problem and keep
+parsing. In the case of a header it doesn't understand, it will initialise the header
+as an optional unstructured field and continue parsing.
 
 This means Mail won't (ever) crunch your data (I think).
 
@@ -91,16 +84,14 @@ 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.
 
-Roadmap
--------
+## Roadmap
 
 Next TODO:
 
 * Improve MIME support for character sets in headers, currently works, mostly, needs
   refinement.
 
-Testing Policy
---------------
+## Testing Policy
 
 Basically... we do BDD on Mail.  No method gets written in Mail without a
 corresponding or covering spec.  We expect as a minimum 100% coverage
@@ -112,23 +103,20 @@ It also means you can be sure Mail will behave correctly.
 
 Note: If you care about core extensions (aka "monkey-patching"), please read the Core Extensions section near the end of this README.
 
-API Policy
-----------
+## API Policy
 
 No API removals within a single point release.  All removals to be deprecated with
 warnings for at least one MINOR point release before removal.
 
 Also, all private or protected methods to be declared as such - though this is still I/P.
 
-Installation
-------------
+## Installation
 
 Installation is fairly simple, I host mail on rubygems, so you can just do:
 
     # gem install mail
 
-Encodings
----------
+## Encodings
 
 If you didn't know, handling encodings in Emails is not as straight forward as you
 would hope.
@@ -160,13 +148,11 @@ I have tried to simplify it some:
    provide encoded parameter values when you call the parameter names through the
    <code>object.parameters['<parameter_name>']</code> method call.
 
-Contributing
-------------
+## Contributing
 
 Please do!  Contributing is easy in Mail.  Please read the CONTRIBUTING.md document for more info
 
-Usage
------
+## Usage
 
 All major mail functions should be able to happen from the Mail module.
 So, you should be able to just <code>require 'mail'</code> to get started.
@@ -234,7 +220,7 @@ what you are doing.
 ### Sending an email:
 
 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
+sendmail or postfix daemon running on this port, sending email is as
 easy as:
 
 ```ruby
@@ -294,7 +280,17 @@ mail.delivery_method :exim, :location => "/usr/bin/exim"
 mail.deliver
 ```
 
-### Getting emails from a pop server:
+Mail may be "delivered" to a logfile, too, for development and testing:
+
+```ruby
+# Delivers by logging the encoded message to $stdout
+mail.delivery_method :logger
+
+# Delivers to an existing logger at :debug severity
+mail.delivery_method :logger, logger: other_logger, severity: :debug
+```
+
+### Getting Emails from a POP Server:
 
 You can configure Mail to receive email using <code>retriever_method</code>
 within <code>Mail.defaults</code>:
@@ -347,7 +343,7 @@ mail.cc              #=> 'sam@test.lindsaar.net'
 mail.subject         #=> "This is the subject"
 mail.date.to_s       #=> '21 Nov 1997 09:55:06 -0600'
 mail.message_id      #=> '<4D6AA7EB.6490534@xxx.xxx>'
-mail.body.decoded    #=> 'This is the body of the email...
+mail.decoded         #=> 'This is the body of the email...
 ```
 
 Many more methods available.
@@ -373,7 +369,7 @@ is another message which can have many or no parts.
 A message will only have parts if it is a multipart/mixed or multipart/related
 content type and has a boundary defined.
 
-### Testing and extracting attachments
+### Testing and Extracting Attachments
 ```ruby
 mail.attachments.each do | attachment |
   # Attachments is an AttachmentsList object containing a
@@ -382,14 +378,14 @@ mail.attachments.each do | attachment |
     # extracting images for example...
     filename = attachment.filename
     begin
-      File.open(images_dir + filename, "w+b", 0644) {|f| f.write attachment.body.decoded}
+      File.open(images_dir + filename, "w+b", 0644) {|f| f.write attachment.decoded}
     rescue => e
       puts "Unable to save data for #{filename} because #{e.message}"
     end
   end
 end
 ```
-### Writing and sending a multipart/alternative (html and text) email
+### Writing and Sending a Multipart/Alternative (HTML and Text) Email
 
 Mail makes some basic assumptions and makes doing the common thing as
 simple as possible.... (asking a lot from a mail library)
@@ -455,7 +451,7 @@ Mail assumes that if your text in the body is only us-ascii, that your
 transfer encoding is 7bit and it is text/plain.  You can override this
 by explicitly declaring it.
 
-### Making Multipart/Alternate, without a block
+### Making Multipart/Alternate, Without a Block
 
 You don't have to use a block with the text and html part included, you
 can just do it declaratively.  However, you need to add Mail::Parts to
@@ -483,7 +479,7 @@ mail.html_part = html_part
 
 Results in the same email as done using the block form
 
-### Getting error reports from an email:
+### Getting Error Reports from an Email:
 
 ```ruby
 @mail = Mail.read('/path/to/bounce_message.eml')
@@ -527,7 +523,6 @@ than mail (this should be rarely needed)
 
 ```ruby
 @mail = Mail.new
-file_data = File.read('path/to/myfile.pdf')
 @mail.attachments['myfile.pdf'] = { :mime_type => 'application/x-pdf',
                                     :content => File.read('path/to/myfile.pdf') }
 @mail.parts.first.mime_type #=> 'application/x-pdf'
@@ -560,8 +555,7 @@ end
 ```
 See "Testing and extracting attachments" above for more details.
 
-Using Mail with Testing or Spec'ing Libraries
----------------------------------------------
+## Using Mail with Testing or Spec'ing Libraries
 
 If mail is part of your system, you'll need a way to test it without actually
 sending emails, the TestMailer can do this for you.
@@ -611,70 +605,53 @@ describe "sending an email" do
     end
   end
 
-  it { should have_sent_email } # passes if any email at all was sent
+  it { is_expected.to have_sent_email } # passes if any email at all was sent
 
-  it { should have_sent_email.from('you@you.com') }
-  it { should have_sent_email.to('mike1@me.com') }
+  it { is_expected.to have_sent_email.from('you@you.com') }
+  it { is_expected.to have_sent_email.to('mike1@me.com') }
 
   # can specify a list of recipients...
-  it { should have_sent_email.to(['mike1@me.com', 'mike2@me.com']) }
+  it { is_expected.to have_sent_email.to(['mike1@me.com', 'mike2@me.com']) }
 
   # ...or chain recipients together
-  it { should have_sent_email.to('mike1@me.com').to('mike2@me.com') }
+  it { is_expected.to have_sent_email.to('mike1@me.com').to('mike2@me.com') }
 
-  it { should have_sent_email.with_subject('testing') }
+  it { is_expected.to have_sent_email.with_subject('testing') }
 
-  it { should have_sent_email.with_body('hello') }
+  it { is_expected.to have_sent_email.with_body('hello') }
 
   # Can match subject or body with a regex
   # (or anything that responds_to? :match)
 
-  it { should have_sent_email.matching_subject(/test(ing)?/) }
-  it { should have_sent_email.matching_body(/h(a|e)llo/) }
+  it { is_expected.to have_sent_email.matching_subject(/test(ing)?/) }
+  it { is_expected.to have_sent_email.matching_body(/h(a|e)llo/) }
 
   # Can chain together modifiers
   # Note that apart from recipients, repeating a modifier overwrites old value.
 
-  it { should have_sent_email.from('you@you.com').to('mike1@me.com').matching_body(/hell/)
+  it { is_expected.to have_sent_email.from('you@you.com').to('mike1@me.com').matching_body(/hell/)
 
   # test for attachments
 
   # ... by specific attachment
-  it { should_have_sent_email.with_attachments(my_attachment) }
+  it { is_expected.to have_sent_email.with_attachments(my_attachment) }
 
   # ... or any attachment
-  it { should_have_sent_email.with_attachments(any_attachment) }
+  it { is_expected.to have_sent_email.with_attachments(any_attachment) }
 
   # ... by array of attachments
-  it { should_have_sent_email.with_attachments([my_attachment1, my_attachment2]) } #note that order is important
+  it { is_expected.to have_sent_email.with_attachments([my_attachment1, my_attachment2]) } #note that order is important
 
   #... by presence
-  it { should_have_sent_email.with_any_attachments }
+  it { is_expected.to have_sent_email.with_any_attachments }
 
   #... or by absence
-  it { should_have_sent_email.with_no_attachments }
+  it { is_expected.to have_sent_email.with_no_attachments }
 
 end
 ```
 
-Core Extensions
----------------
-
-The mail gem adds several constants and methods to Ruby's core objects (similar to the activesupport gem from the Rails project).  For example:
-
-    NilClass::blank?
-    NilClass::to_crlf
-    NilClass::to_lf
-    Object::blank?
-    String::to_crlf
-    String::to_lf
-    String::blank?
-    ...etc...
-
-For all the details, check out lib/mail/core_extensions/.
-
-Excerpts from TREC Spam Corpus 2005
------------------------------------
+## Excerpts from TREC Spam Corpus 2005
 
 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
@@ -692,8 +669,7 @@ They are used as allowed by 'Permitted Uses, Clause 3':
 
      -- http://plg.uwaterloo.ca/~gvcormac/treccorpus/
 
-License
--------
+## License
 
 (The MIT License)
 

data/lib/mail/attachments_list.rb

@@ -6,8 +6,8 @@ module Mail
       @parts_list = parts_list
       @content_disposition_type = 'attachment'
       parts_list.map { |p|
-        if p.content_type == "message/rfc822"
-          Mail.new(p.body).attachments
+        if p.mime_type == 'message/rfc822'
+          Mail.new(p.body.encoded).attachments
         elsif p.parts.empty?
           p if p.attachment?
         else
@@ -30,7 +30,7 @@ module Mail
     # mail.attachments['test.png'].filename #=> 'test.png'
     # mail.attachments[1].filename          #=> 'test.jpg'
     def [](index_value)
-      if index_value.is_a?(Fixnum)
+      if index_value.is_a?(Integer)
         self.fetch(index_value)
       else
         self.select { |a| a.filename == index_value }.first
@@ -44,6 +44,9 @@ module Mail
                          :content_disposition => "#{@content_disposition_type}; filename=\"#{encoded_name}\"" }
 
       if value.is_a?(Hash)
+        if path = value.delete(:filename)
+          value[:content] ||= File.open(path, 'rb') { |f| f.read }
+        end
 
         default_values[:body] = value.delete(:content) if value[:content]
 
@@ -60,7 +63,7 @@ module Mail
 
         if value[:mime_type]
           default_values[:content_type] = value.delete(:mime_type)
-          @mime_type = MIME::Types[default_values[:content_type]].first
+          @mime_type = MiniMime.lookup_by_content_type(default_values[:content_type])
           default_values[:content_transfer_encoding] ||= guess_encoding
         end
 
@@ -99,7 +102,8 @@ module Mail
         filename = filename.encode(Encoding::UTF_8) if filename.respond_to?(:encode)
       end
 
-      @mime_type = MIME::Types.type_for(filename).first
+      @mime_type = MiniMime.lookup_by_filename(filename)
+      @mime_type && @mime_type.content_type
     end
 
   end

data/lib/mail/body.rb

@@ -32,7 +32,7 @@ module Mail
       @preamble = nil
       @epilogue = nil
       @charset  = nil
-      @part_sort_order = [ "text/plain", "text/enriched", "text/html" ]
+      @part_sort_order = [ "text/plain", "text/enriched", "text/html", "multipart/alternative" ]
       @parts = Mail::PartsList.new
       if Utilities.blank?(string)
         @raw_source = ''
@@ -46,10 +46,10 @@ module Mail
           raise "You can only assign a string or an object that responds_to? :join or :to_s to a body."
         end
       end
-      @encoding = (only_us_ascii? ? '7bit' : '8bit')
+      @encoding = default_encoding
       set_charset
     end
-    
+
     # Matches this body with another body.  Also matches the decoded value of this
     # body with a string.
     # 
@@ -115,8 +115,8 @@ module Mail
     end
 
     # Allows you to set the sort order of the parts, overriding the default sort order.
-    # Defaults to 'text/plain', then 'text/enriched', then 'text/html' with any other content
-    # type coming after.
+    # Defaults to 'text/plain', then 'text/enriched', then 'text/html', then 'multipart/alternative'
+    # with any other content type coming after.
     def set_sort_order(order)
       @part_sort_order = order
     end
@@ -138,41 +138,39 @@ module Mail
     def raw_source
       @raw_source
     end
-   
-    def get_best_encoding(target)
-      target_encoding = Mail::Encodings.get_encoding(target)
-      target_encoding.get_best_compatible(encoding, raw_source)
+
+    def negotiate_best_encoding(message_encoding, allowed_encodings = nil)
+      Mail::Encodings::TransferEncoding.negotiate(message_encoding, encoding, raw_source, allowed_encodings)
     end
- 
+
     # Returns a body encoded using transfer_encoding.  Multipart always uses an
     # identiy encoding (i.e. no encoding).
     # Calling this directly is not a good idea, but supported for compatibility
     # TODO: Validate that preamble and epilogue are valid for requested encoding
-    def encoded(transfer_encoding = '8bit')
+    def encoded(transfer_encoding = nil)
       if multipart?
         self.sort_parts!
         encoded_parts = parts.map { |p| p.encoded }
         ([preamble] + encoded_parts).join(crlf_boundary) + end_boundary + epilogue.to_s
       else
-        be = get_best_encoding(transfer_encoding)
-        dec = Mail::Encodings::get_encoding(encoding)
-        enc = Mail::Encodings::get_encoding(be)
+        dec = Mail::Encodings.get_encoding(encoding)
+        enc = negotiate_best_encoding(transfer_encoding)
         if dec.nil?
-            # Cannot decode, so skip normalization
-            raw_source
+          # Cannot decode, so skip normalization
+          raw_source
         else
-            # Decode then encode to normalize and allow transforming 
-            # from base64 to Q-P and vice versa
-            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)
+          # Decode then encode to normalize and allow transforming 
+          # from base64 to Q-P and vice versa
+          decoded = dec.decode(raw_source)
+          if defined?(Encoding) && charset && charset != "US-ASCII"
+            decoded = decoded.encode(charset)
+            decoded.force_encoding('BINARY') unless Encoding.find(charset).ascii_compatible?
+          end
+          enc.encode(decoded)
         end
       end
     end
-    
+
     def decoded
       if !Encodings.defined?(encoding)
         raise UnknownEncodingType, "Don't know how to decode #{encoding}, please call #encoded and decode it yourself."
@@ -200,13 +198,14 @@ module Mail
         @encoding
       end
     end
-    
+
     def encoding=( val )
-      @encoding = if val == "text" || Utilities.blank?(val)
-          (only_us_ascii? ? '7bit' : '8bit')
-      else
+      @encoding =
+        if val == "text" || Utilities.blank?(val)
+          default_encoding
+        else
           val
-      end
+        end
     end
 
     # Returns the preamble (any text that is before the first MIME boundary)
@@ -268,14 +267,21 @@ module Mail
       self
     end
 
-    def only_us_ascii?
-      !(raw_source =~ /[^\x01-\x7f]/)
+    def ascii_only?
+      unless defined? @ascii_only
+        @ascii_only = raw_source.ascii_only?
+      end
+      @ascii_only
     end
-    
+
     def empty?
       !!raw_source.to_s.empty?
     end
-    
+
+    def default_encoding
+      ascii_only? ? '7bit' : '8bit'
+    end
+
     private
 
     # split parts by boundary, ignore first part if empty, append final part when closing boundary was missing
@@ -308,9 +314,9 @@ module Mail
     def end_boundary
       "\r\n--#{boundary}--\r\n"
     end
-    
+
     def set_charset
-      only_us_ascii? ? @charset = 'US-ASCII' : @charset = nil
+      @charset = ascii_only? ? 'US-ASCII' : nil
     end
   end
 end

data/lib/mail/check_delivery_params.rb

@@ -1,21 +1,60 @@
 # frozen_string_literal: true
 module Mail
-  module CheckDeliveryParams
-    def check_delivery_params(mail)
-      if Utilities.blank?(mail.smtp_envelope_from)
-        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.')
+  module CheckDeliveryParams #:nodoc:
+    class << self
+      def check(mail)
+        [ check_from(mail.smtp_envelope_from),
+          check_to(mail.smtp_envelope_to),
+          check_message(mail) ]
       end
 
-      if Utilities.blank?(mail.smtp_envelope_to)
-        raise ArgumentError.new('An SMTP To address is required to send a message. Set the message smtp_envelope_to, to, cc, or bcc address.')
+      def check_from(addr)
+        if Utilities.blank?(addr)
+          raise ArgumentError, "SMTP From address may not be blank: #{addr.inspect}"
+        end
+
+        check_addr 'From', addr
+      end
+
+      def check_to(addrs)
+        if Utilities.blank?(addrs)
+          raise ArgumentError, "SMTP To address may not be blank: #{addrs.inspect}"
+        end
+
+        Array(addrs).map do |addr|
+          check_addr 'To', addr
+        end
       end
 
-      message = mail.encoded if mail.respond_to?(:encoded)
-      if Utilities.blank?(message)
-        raise ArgumentError.new('An encoded message is required to send an email')
+      def check_addr(addr_name, addr)
+        validate_smtp_addr addr do |error_message|
+          raise ArgumentError, "SMTP #{addr_name} address #{error_message}: #{addr.inspect}"
+        end
       end
 
-      [mail.smtp_envelope_from, mail.smtp_envelope_to, message]
+      def validate_smtp_addr(addr)
+        if addr
+          if addr.bytesize > 2048
+            yield 'may not exceed 2kB'
+          end
+
+          if /[\r\n]/ =~ addr
+            yield 'may not contain CR or LF line breaks'
+          end
+        end
+
+        addr
+      end
+
+      def check_message(message)
+        message = message.encoded if message.respond_to?(:encoded)
+
+        if Utilities.blank?(message)
+          raise ArgumentError, 'An encoded message is required to send an email'
+        end
+
+        message
+      end
     end
   end
 end

data/lib/mail/configuration.rb

@@ -42,6 +42,8 @@ module Mail
         Mail::SMTPConnection
       when :test
         Mail::TestMailer
+      when :logger
+        Mail::LoggerDelivery
       else
         method
       end