Module: TMail

Module | TMail
In: | lib/action_mailer/vendor/tmail-1.2.3/tmail/address.rb lib/action_mailer/vendor/tmail-1.2.3/tmail/attachments.rb lib/action_mailer/vendor/tmail-1.2.3/tmail/encode.rb lib/action_mailer/vendor/tmail-1.2.3/tmail/header.rb lib/action_mailer/vendor/tmail-1.2.3/tmail/interface.rb lib/action_mailer/vendor/tmail-1.2.3/tmail/mail.rb lib/action_mailer/vendor/tmail-1.2.3/tmail/mailbox.rb lib/action_mailer/vendor/tmail-1.2.3/tmail/net.rb lib/action_mailer/vendor/tmail-1.2.3/tmail/port.rb lib/action_mailer/vendor/tmail-1.2.3/tmail/quoting.rb lib/action_mailer/vendor/tmail-1.2.3/tmail/utils.rb lib/action_mailer/vendor/tmail.rb

# TMail - The EMail Swiss Army Knife for Ruby

The TMail library provides you with a very complete way to handle and manipulate EMails from within your Ruby programs.

Used as the backbone for email handling by the Ruby on Rails and Nitro web frameworks as well as a bunch of other Ruby apps including the Ruby-Talk mailing list to newsgroup email gateway, it is a proven and reliable email handler that won‘t let you down.

Originally created by Minero Aoki, TMail has been recently picked up by Mikel Lindsaar and is being actively maintained. Numerous backlogged bug fixes have been applied as well as Ruby 1.9 compatibility and a swath of documentation to boot.

TMail allows you to treat an email totally as an object and allow you to get on with your own programming without having to worry about crafting the perfect email address validation parser, or assembling an email from all it‘s component parts.

TMail handles the most complex part of the email - the header. It generates and parses headers and provides you with instant access to their innards through simple and logically named accessor and setter methods.

TMail also provides a wrapper to Net/SMTP as well as Unix Mailbox handling methods to directly read emails from your unix mailbox, parse them and use them.

Following is the comprehensive list of methods to access TMail::Mail objects. You can also check out TMail::Mail, TMail::Address and TMail::Headers for other lists.

### Methods

decoded encoded new_boundary new_message_id to_s

### Classes and Modules

Module TMail::MailFlags
Module TMail::TextUtils
Class TMail::Address
Class TMail::AddressGroup
Class TMail::AddressHeader
Class TMail::Attachment
Class TMail::ContentDispositionHeader
Class TMail::ContentTransferEncodingHeader
Class TMail::ContentTypeHeader
Class TMail::DateTimeHeader
Class TMail::EncryptedHeader
Class TMail::FilePort
Class TMail::HeaderField
Class TMail::KeywordsHeader
Class TMail::Mail
Class TMail::Maildir
Class TMail::MaildirPort
Class TMail::MessageIdHeader
Class TMail::MhMailbox
Class TMail::MhPort
Class TMail::MimeVersionHeader
Class TMail::Port
Class TMail::ReceivedHeader
Class TMail::ReferencesHeader
Class TMail::ReturnPathHeader
Class TMail::SingleAddressHeader
Class TMail::StringPort
Class TMail::StructuredHeader
Class TMail::SyntaxError
Class TMail::UNIXMbox
Class TMail::Unquoter
Class TMail::UnstructuredHeader

### Constants

MhLoader | = | MhMailbox
MboxLoader | = | UNIXMbox
MaildirLoader | = | Maildir

### Public Class methods

new_boundary()

Provides a new email boundary to separate parts of the email. This is a random string based off the current time, so should be fairly unique.

For Example:

     TMail.new_boundary
     #=> "mimepart_47bf656968207_25a8fbb80114"
     TMail.new_boundary
     #=> "mimepart_47bf66051de4_25a8fbb80240"

new_message_id( fqdn = nil )

Provides a new email message ID. You can use this to generate unique email message id‘s for your email so you can track them.

Optionally takes a fully qualified domain name (default to the current hostname returned by Socket.gethostname) that will be appended to the message ID.

For Example:

     email.message_id = TMail.new_message_id
     #=> "<47bf66845380e_25a8fbb80332@baci.local.tmail>"
     email.to_s
     #=> "Message-Id: <47bf668b633f1_25a8fbb80475@baci.local.tmail>\n\n"
     email.message_id = TMail.new_message_id("lindsaar.net")
     #=> "<47bf668b633f1_25a8fbb80475@lindsaar.net.tmail>"
     email.to_s
     #=> "Message-Id: <47bf668b633f1_25a8fbb80475@lindsaar.net.tmail>\n\n"

### Public Instance methods

decoded( eol = "\n", charset = 'e', dest = nil )

Returns the TMail object decoded and ready to be used by you, your program etc.

You should call this before you are packaging up your email to correctly escape all the values that need escaping in the email, line wrap the email etc.

For Example:

     email = TMail::Load(my_email_file)
     email_to_send = email.encoded

encoded( eol = "\r\n", charset = 'j', dest = nil )

You should call this before you are packaging up your email to correctly escape all the values that need escaping in the email, line wrap the email etc.

It is also a good idea to call this before you marshal or serialize a TMail object.

For Example:

     email = TMail::Load(my_email_file)
     email_to_send = email.encoded

to_s( eol = "\n", charset = 'e', dest = nil )

Alias for decoded

[Validate]