A Really Ruby Mail Library (my commits are usually merged into the original repo from Mikel, so go there to get the latest stable version!)
Ruby
Pull request Compare This branch is 1370 commits behind mikel:master.
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Failed to load latest commit information.
lib
reference
spec
.gitignore
CHANGELOG.rdoc
Dependencies.txt
Gemfile
README.rdoc
ROADMAP
Rakefile
TODO.rdoc

README.rdoc

Mail

Introduction

Mail is an internet library for Ruby that is designed to handle emails 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 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 brainer.

It is also designed form the ground up to work with Ruby 1.9. This is because Ruby 1.9 handles text encodings much more magically 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.

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.

Discussion

If you want to discuss mail with like minded individuals, please subscribe to the Google Group groups.google.com/group/mail-ruby

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 & getting details from such

  • Support for multibyte emails - needs quite a lot of work and testing

  • Wrappers for File, Net/POP3, Net/SMTP

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.

This means Mail won't (ever) crunch your data (I think).

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

Next TODO:

  • Improve MIME support for character sets in headers, currently works, mostly, needs refinement.

  • Add IMAP wrapper

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 measured by RCov. While this is not perfect by any measure, it is pretty good. Additionally, all functional tests from TMail are to be passing before the gem gets released.

It also means you can be sure Mail will behave correctly.

API Policy

No API removals within a single point release. All removals to be depreciated 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 is fairly simple, I host mail on gemcutter, 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-1.2.1.gem

Encodings

If you didn't know, handling encodings in Emails is not as straight forward as you would hope.

I have tried to simplify it some:

  1. All objects that can render into an email, have an :encoded method. Encoded will 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 an object will call it's encoded method, that is, make it ready to send in an email.

  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 plg.uwaterloo.ca/~gvcormac/treccorpus/

    They are used as allowed by 'Permitted Uses, Clause 3':

    "Small excerpts of the information may be displayed to others
     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 © 2009

    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.