README.rdoc

TMail

RUBY 1.9 COMPATIBILITY

Note… as of 1.2.5, TMail is not compatible with Ruby 1.9.1. For 1.9.1 +
compatibility, I suggest you look at Mail (github.com/mikel/mail). Mail is
used by ActionMailer in Rails 3.0 and beyond and is ready to handle your
email sending and parsing needs.

DESCRIPTION:

TMail is a mail handling library for Ruby. It abstracts a mail message
into a usable object allowing you to read, set, add and delete headers and
the mail body.

TMail is used by the Ruby on Rails web framework as the Email abstraction
layer for their ActionMailer module. It is also used by the Nitro
framework and many other applications on and off the web.

The goal of the TMail handling library is to be able to parse and handle
raw Email sources and produce RFC compliant Emails as a result. If you
find something that TMail does that violates an RFC, we want to know and
we'll get it fixed fast.

DOCUMENTATION:

The place you will want to look first is the TMail::Mail class. This has
the vast majority of methods you will be using to talk to your TMail
object.

FEATURES/PROBLEMS:

TMail is fairly RFC compliant on the handling of emails.

There are also some problems in the header handling, but for 99.9% of
email, you will be fine. Usually, the problems revolve around parsing
incomming emails and making sense of them.

I really welcome any examples of Emails that “didn't work” with TMail
so I can use them as test cases.

SYNOPSIS:

TMail is very easy to use. You simply require the library and then pass a
raw email text message into the TMail::Mail.parse method. This returns a
TMail::Mail object which you can now query and run methods against to
modify, inspect or add to the Email.

You can find almost all of the methods that you will use to talk to and
update a TMail instance in the TMail::Mail class. I am constantly updating
this code, with comments, added a fair bit and have a lot more to go!.

REQUIREMENTS:

INSTALLATION:

LICENSE:

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.