mail 2.5.5 → 2.8.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 483ee321c6ec26a7fb20deb57c50254f916c5055
-  data.tar.gz: 49bbe456db7b901b8f9a17cc404ed6cdd4ac84f2
+SHA256:
+  metadata.gz: ea4015fe2858f6c1b123e04d4d407169567b1aeea1155b7b145fe75d9d3781b5
+  data.tar.gz: 20cdb386c2f878560b9f61ab63b4f0c264c9f9115af5c835b8c66f49486cb274
 SHA512:
-  metadata.gz: bc79fcc391b2358f8aecd403453c934399a561bd2cf0c3cb32bf850815a6c99086c47104e0680a7d77a62585453bef8ca27d885f0345d102e0191a1f5354973d
-  data.tar.gz: cd1ea707e1b61aa29bb452d3b2eaa7a245721b28d17448061cef63beff93c794f3a05d0c104afa79a9cb7026f0b20376f422b76747170d35fe72a59ed64e40e6
+  metadata.gz: b2eb55bc6f51b2d93e6d6abed5bb74876b3f96fd1eea00105047b3a211007b2b906ac89bcd1bed52603c211c595d439b6642bd897943decbcc9ac541f88e2049
+  data.tar.gz: 063dd68ef655b93d96412bdcf66ab6f191eaf0bfbafa10730ecfa99a447eb3d2a4469d6d1de67ae144bbaada65eaec4c7d8dbb5fe04509146dc1434a5c557fff

data/MIT-LICENSE

@@ -1,4 +1,4 @@
-Copyright (c) 2009-2013 Mikel Lindsaar
+Copyright (c) 2009-2016 Mikel Lindsaar
 
 Permission is hereby granted, free of charge, to any person obtaining
 a copy of this software and associated documentation files (the

data/README.md

@@ -1,81 +1,93 @@
-Mail [![Build Status](https://travis-ci.org/mikel/mail.png?branch=master)](https://travis-ci.org/mikel/mail)
-====
+# Mail [![Build Status](https://github.com/mikel/mail/actions/workflows/test.yml/badge.svg)](https://github.com/mikel/mail/actions/workflows/test.yml)
 
-Introduction
-------------
+## Introduction
 
-Mail is an internet library for Ruby that is designed to handle emails
+Mail is an internet library for Ruby that is designed to handle email
 generation, parsing and sending in a simple, rubyesque manner.
 
 The purpose of this library is to provide a single point of access to handle
-all email functions, including sending and receiving emails.  All network
+all email functions, including sending and receiving email.  All network
 type actions are done through proxy methods to Net::SMTP, Net::POP3 etc.
 
 Built from my experience with TMail, it is designed to be a pure ruby
-implementation that makes generating, sending and parsing emails a no
+implementation that makes generating, sending and parsing email a no
 brainer.
 
-It is also designed form the ground up to work with the more modern versions
-of Ruby.  This is because Ruby > 1.9 handles text encodings much more wonderfully
-than Ruby 1.8.x and so these features have been taken full advantage of in this
-library allowing Mail to handle a lot more messages more cleanly than TMail.
-Mail does run on Ruby 1.8.x... it's just not as fun to code.
+It is also designed from the ground up to work with the more modern versions
+of Ruby.  Modern Rubies handle text encodings much more wonderfully than before
+so these features have been taken full advantage of in this library allowing
+Mail to handle a lot more messages more cleanly than TMail.
 
 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
--------------
-
-Mail has been downloaded millions of times, by people around the world, in fact,
-it represents more than 1% of *all* gems downloaded.
-
-It is (like all open source software) a labour of love and something I am doing
-with my own free time.  If you would like to say thanks, please feel free to
-[make a donation](http://www.pledgie.com/campaigns/8790) and feel free to send
-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>
-
-
-Compatibility
--------------
-
-Mail supports Ruby 1.8.7+, including JRuby and Rubinius.
-
-Every Mail commit is tested by Travis on [all supported Ruby versions](https://github.com/mikel/mail/blob/master/.travis.yml).
-
-Testing a specific version of mime-types (needed for Ruby 1.8.7, for example) can be done manually with:
-
-```sh
-BUNDLE_GEMFILE=gemfiles/mime_types_1.16.gemfile bundle && rake
-```
-
-Discussion
-----------
+## You can contribute to this library
+
+Yes, you! Mail is used in countless apps by people around the world. It is,
+like all open source software, a labour of love borne from our free time.
+If you would like to say thanks, please dig in and contribute alongside us!
+Triage and fix [GitHub issues](https://github.com/mikel/mail/issues), improve
+our documentation, add new features—up to you! Thank you for pitching in.
+
+
+# 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)
+* [Excerpts from TREC Span Corpus 2005](#excerpts-from-trec-span-corpus-2005)
+* [License](#license)
+
+## Compatibility
+
+Mail is tested against:
+
+* Ruby: 2.5
+* Ruby: 2.6
+* Ruby: 2.7
+* Ruby: 3.0
+* Ruby: 3.1
+* Ruby: 3.2
+* JRuby: 9.2
+* JRuby: 9.3
+* JRuby: 9.4
+* JRuby: stable
+* JRuby: head
+* Truffleruby: stable
+* Truffleruby: head
+
+As new versions of Ruby are released, Mail will be compatible with support for the "preview" and all "normal maintenance", "security maintenance" and the two most recent "end of life" versions listed at the [Ruby Maintenance Branches](https://www.ruby-lang.org/en/downloads/branches/) page.  Pull requests to assist in adding support for new preview releases are more than welcome.
+
+Every Mail commit is tested by GitHub Actions on [all supported Ruby versions](https://github.com/mikel/mail/blob/master/.github/workflows/test.yml).
+
+## 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
-* 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
+* RFC5322 Support, Reading and Writing
+* RFC6532 Support, reading UTF-8 headers
+* RFC2045-2049 Support for multipart email
+* Support for creating multipart alternate email
+* Support for reading multipart/report email &amp; getting details from such
 * 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
+email and generate US-ASCII email. There are a few obsoleted email syntax 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).
 
@@ -83,16 +95,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
@@ -102,23 +112,24 @@ the gem gets released.
 
 It also means you can be sure Mail will behave correctly.
 
-API Policy
-----------
+You can run tests locally by running `bundle exec rspec`.
+
+You can run tests on all supported Ruby versions by using [act](https://github.com/nektos/act).
+
+## 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.
@@ -150,17 +161,17 @@ 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
+Please do!  Contributing is easy in Mail.  Please read the [CONTRIBUTING.md](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.
 
+`mail` is pretty well documented in its Ruby code.  You can look it up e.g. at [rubydoc.info](https://www.rubydoc.info/gems/mail).
+
 ### Making an email
 
 ```ruby
@@ -185,6 +196,8 @@ mail['from'] = 'mikel@test.lindsaar.net'
 mail[:to]    = 'you@test.lindsaar.net'
 mail.subject = 'This is a test email'
 
+mail.header['X-Custom-Header'] = 'custom value'
+
 mail.to_s #=> "From: mikel@test.lindsaar.net\r\nTo: you@...
 ```
 
@@ -222,15 +235,15 @@ 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
 Mail.deliver do
-   from    'me@test.lindsaar.net'
-   to      'you@test.lindsaar.net'
-   subject 'Here is the image you wanted'
-   body    File.read('body.txt')
+  from     'me@test.lindsaar.net'
+  to       'you@test.lindsaar.net'
+  subject  'Here is the image you wanted'
+  body     File.read('body.txt')
   add_file '/full/path/to/somefile.png'
 end
 ```
@@ -265,6 +278,15 @@ mail.delivery_method :sendmail
 mail.deliver
 ```
 
+Sending via smtp (for example to [mailcatcher](https://github.com/sj26/mailcatcher))
+```ruby
+
+Mail.defaults do
+  delivery_method :smtp, address: "localhost", port: 1025
+end
+```
+
+
 Exim requires its own delivery manager, and can be used like so:
 
 ```ruby
@@ -273,12 +295,23 @@ 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 or IMAP Server:
 
 You can configure Mail to receive email using <code>retriever_method</code>
 within <code>Mail.defaults</code>:
 
 ```ruby
+# e.g. POP3
 Mail.defaults do
   retriever_method :pop3, :address    => "pop.gmail.com",
                           :port       => 995,
@@ -286,6 +319,15 @@ Mail.defaults do
                           :password   => '<password>',
                           :enable_ssl => true
 end
+
+# IMAP
+Mail.defaults do
+  retriever_method :imap, :address    => "imap.mailbox.org",
+                          :port       => 993,
+                          :user_name  => '<username>',
+                          :password   => '<password>',
+                          :enable_ssl => true
+end
 ```
 
 You can access incoming email in a number of ways.
@@ -318,7 +360,7 @@ emails.length #=> LOTS!
 ```ruby
 mail = Mail.read('/path/to/message.eml')
 
-mail.envelope.from   #=> 'mikel@test.lindsaar.net'
+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'
 mail.to              #=> 'bob@test.lindsaar.net'
@@ -326,7 +368,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.
@@ -349,10 +391,10 @@ mail.parts[1].content_type_parameters  #=> {'name' => 'my.pdf'}
 Mail generates a tree of parts.  Each message has many or no parts.  Each part
 is another message which can have many or no parts.
 
-A message will only have parts if it is a multipart/mixed or related/mixed
+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
@@ -361,14 +403,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}
-    rescue Exception => e
+      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)
@@ -428,13 +470,13 @@ Content-Transfer-Encoding: 7bit
 ```
 
 Mail inserts the content transfer encoding, the mime version,
-the content-id's and handles the content-type and boundary.
+the content-IDs and handles the content-type and boundary.
 
 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
@@ -462,7 +504,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')
@@ -506,7 +548,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'
@@ -539,13 +580,12 @@ 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.
 
-```
+```ruby
 require 'mail'
 => true
 Mail.defaults do
@@ -569,9 +609,9 @@ Mail::TestMailer.deliveries.clear
 => []
 ```
 
-There is also a set of RSpec matchers stolen fr^H^H^H^H^H^H^H^H inspired by Shoulda's ActionMailer matchers (you'll want to set <code>delivery_method</code> as above too):
+There is also a set of RSpec matchers stolen/inspired by Shoulda's ActionMailer matchers (you'll want to set <code>delivery_method</code> as above too):
 
-```
+```ruby
 Mail.defaults do
   delivery_method :test # in practice you'd do this in spec_helper.rb
 end
@@ -590,36 +630,59 @@ 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 { is_expected.to have_sent_email.with_attachments(my_attachment) }
+
+  # ... or any attachment
+  it { is_expected.to have_sent_email.with_attachments(any_attachment) }
+
+  # ... or attachment with filename
+  it { is_expected.to have_sent_email.with_attachments(an_attachment_with_filename('file.txt')) }
+
+  # ... or attachment with mime_type
+  it { is_expected.to have_sent_email.with_attachments(an_attachment_with_mime_type('application/pdf')) }
+
+  # ... by array of attachments
+  it { is_expected.to have_sent_email.with_attachments([my_attachment1, my_attachment2]) } #note that order is important
+
+  #... by presence
+  it { is_expected.to have_sent_email.with_any_attachments }
+
+  #... or by absence
+  it { is_expected.to have_sent_email.with_no_attachments }
+
 end
 ```
 
-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
@@ -637,12 +700,11 @@ They are used as allowed by 'Permitted Uses, Clause 3':
 
      -- http://plg.uwaterloo.ca/~gvcormac/treccorpus/
 
-License
--------
+## License
 
 (The MIT License)
 
-Copyright (c) 2009-2013 Mikel Lindsaar
+Copyright (c) 2009-2016 Mikel Lindsaar
 
 Permission is hereby granted, free of charge, to any person obtaining
 a copy of this software and associated documentation files (the

data/lib/mail/attachments_list.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 module Mail
   class AttachmentsList < Array
 
@@ -5,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
@@ -29,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
@@ -43,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]
 
@@ -59,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
 
@@ -70,7 +74,8 @@ module Mail
       end
 
       if hash[:body].respond_to? :force_encoding and hash[:body].respond_to? :valid_encoding?
-        if not hash[:body].valid_encoding? and default_values[:content_transfer_encoding].downcase == "binary"
+        if not hash[:body].valid_encoding? and default_values[:content_transfer_encoding].casecmp('binary').zero?
+          hash[:body] = hash[:body].dup if hash[:body].frozen?
           hash[:body].force_encoding("BINARY")
         end
       end
@@ -92,12 +97,10 @@ module Mail
     end
 
     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)
-      end
+      filename = filename.encode(Encoding::UTF_8) if filename.respond_to?(:encode)
 
-      @mime_type = MIME::Types.type_for(filename).first
+      @mime_type = MiniMime.lookup_by_filename(filename)
+      @mime_type && @mime_type.content_type
     end
 
   end