Module Mail
In: lib/mail/attachments_list.rb
lib/mail/body.rb
lib/mail/configuration.rb
lib/mail/elements/address.rb
lib/mail/elements/address_list.rb
lib/mail/elements/content_disposition_element.rb
lib/mail/elements/content_location_element.rb
lib/mail/elements/content_transfer_encoding_element.rb
lib/mail/elements/content_type_element.rb
lib/mail/elements/date_time_element.rb
lib/mail/elements/envelope_from_element.rb
lib/mail/elements/message_ids_element.rb
lib/mail/elements/mime_version_element.rb
lib/mail/elements/phrase_list.rb
lib/mail/elements/received_element.rb
lib/mail/elements.rb
lib/mail/encodings/7bit.rb
lib/mail/encodings/8bit.rb
lib/mail/encodings/base64.rb
lib/mail/encodings/binary.rb
lib/mail/encodings/quoted_printable.rb
lib/mail/encodings/transfer_encoding.rb
lib/mail/encodings.rb
lib/mail/envelope.rb
lib/mail/field.rb
lib/mail/field_list.rb
lib/mail/fields/bcc_field.rb
lib/mail/fields/cc_field.rb
lib/mail/fields/comments_field.rb
lib/mail/fields/common/address_container.rb
lib/mail/fields/common/common_address.rb
lib/mail/fields/common/common_date.rb
lib/mail/fields/common/common_field.rb
lib/mail/fields/common/common_message_id.rb
lib/mail/fields/common/parameter_hash.rb
lib/mail/fields/content_description_field.rb
lib/mail/fields/content_disposition_field.rb
lib/mail/fields/content_id_field.rb
lib/mail/fields/content_location_field.rb
lib/mail/fields/content_transfer_encoding_field.rb
lib/mail/fields/content_type_field.rb
lib/mail/fields/date_field.rb
lib/mail/fields/from_field.rb
lib/mail/fields/in_reply_to_field.rb
lib/mail/fields/keywords_field.rb
lib/mail/fields/message_id_field.rb
lib/mail/fields/mime_version_field.rb
lib/mail/fields/optional_field.rb
lib/mail/fields/received_field.rb
lib/mail/fields/references_field.rb
lib/mail/fields/reply_to_field.rb
lib/mail/fields/resent_bcc_field.rb
lib/mail/fields/resent_cc_field.rb
lib/mail/fields/resent_date_field.rb
lib/mail/fields/resent_from_field.rb
lib/mail/fields/resent_message_id_field.rb
lib/mail/fields/resent_sender_field.rb
lib/mail/fields/resent_to_field.rb
lib/mail/fields/return_path_field.rb
lib/mail/fields/sender_field.rb
lib/mail/fields/structured_field.rb
lib/mail/fields/subject_field.rb
lib/mail/fields/to_field.rb
lib/mail/fields/unstructured_field.rb
lib/mail/fields.rb
lib/mail/header.rb
lib/mail/mail.rb
lib/mail/message.rb
lib/mail/network/delivery_methods/file_delivery.rb
lib/mail/network/delivery_methods/sendmail.rb
lib/mail/network/delivery_methods/smtp.rb
lib/mail/network/delivery_methods/test_mailer.rb
lib/mail/network/retriever_methods/base.rb
lib/mail/network/retriever_methods/imap.rb
lib/mail/network/retriever_methods/pop3.rb
lib/mail/network/retriever_methods/test_retriever.rb
lib/mail/network.rb
lib/mail/parsers/address_lists.rb
lib/mail/parsers/content_disposition.rb
lib/mail/parsers/content_location.rb
lib/mail/parsers/content_transfer_encoding.rb
lib/mail/parsers/content_type.rb
lib/mail/parsers/date_time.rb
lib/mail/parsers/envelope_from.rb
lib/mail/parsers/message_ids.rb
lib/mail/parsers/received.rb
lib/mail/parsers/mime_version.rb
lib/mail/parsers/phrase_lists.rb
lib/mail/parsers/rfc2045.rb
lib/mail/parsers/rfc2822.rb
lib/mail/parsers/rfc2822_obsolete.rb
lib/mail/part.rb
lib/mail/parts_list.rb
lib/mail/patterns.rb
lib/mail/utilities.rb
lib/mail/version.rb
lib/mail/version_specific/ruby_1_8.rb
lib/mail/version_specific/ruby_1_9.rb
lib/mail.rb

encoding: utf-8

Methods

Classes and Modules

Module Mail::AddressLists
Module Mail::ContentDisposition
Module Mail::ContentLocation
Module Mail::ContentTransferEncoding
Module Mail::ContentType
Module Mail::DateTime
Module Mail::Encodings
Module Mail::EnvelopeFrom
Module Mail::MessageIds
Module Mail::MimeVersion
Module Mail::Patterns
Module Mail::PhraseLists
Module Mail::RFC2045
Module Mail::RFC2822
Module Mail::RFC2822Obsolete
Module Mail::Received
Module Mail::Utilities
Module Mail::VERSION
Class Mail::Address
Class Mail::AddressContainer
Class Mail::AddressListsParser
Class Mail::AttachmentsList
Class Mail::BccField
Class Mail::Body
Class Mail::CcField
Class Mail::CommentsField
Class Mail::Configuration
Class Mail::ContentDescriptionField
Class Mail::ContentDispositionField
Class Mail::ContentDispositionParser
Class Mail::ContentIdField
Class Mail::ContentLocationField
Class Mail::ContentLocationParser
Class Mail::ContentTransferEncodingElement
Class Mail::ContentTransferEncodingField
Class Mail::ContentTransferEncodingParser
Class Mail::ContentTypeField
Class Mail::ContentTypeParser
Class Mail::DateField
Class Mail::DateTimeParser
Class Mail::Envelope
Class Mail::EnvelopeFromElement
Class Mail::EnvelopeFromParser
Class Mail::Field
Class Mail::FieldList
Class Mail::FileDelivery
Class Mail::FromField
Class Mail::Header
Class Mail::IMAP
Class Mail::InReplyToField
Class Mail::KeywordsField
Class Mail::Message
Class Mail::MessageIdField
Class Mail::MessageIdsElement
Class Mail::MessageIdsParser
Class Mail::MimeVersionElement
Class Mail::MimeVersionField
Class Mail::MimeVersionParser
Class Mail::OptionalField
Class Mail::POP3
Class Mail::ParameterHash
Class Mail::Part
Class Mail::PartsList
Class Mail::PhraseList
Class Mail::PhraseListsParser
Class Mail::RFC2045Parser
Class Mail::RFC2822ObsoleteParser
Class Mail::RFC2822Parser
Class Mail::ReceivedElement
Class Mail::ReceivedField
Class Mail::ReceivedParser
Class Mail::ReferencesField
Class Mail::ReplyToField
Class Mail::ResentBccField
Class Mail::ResentCcField
Class Mail::ResentDateField
Class Mail::ResentFromField
Class Mail::ResentMessageIdField
Class Mail::ResentSenderField
Class Mail::ResentToField
Class Mail::Retriever
Class Mail::ReturnPathField
Class Mail::Ruby18
Class Mail::Ruby19
Class Mail::SMTP
Class Mail::SenderField
Class Mail::Sendmail
Class Mail::StructuredField
Class Mail::SubjectField
Class Mail::TestMailer
Class Mail::TestRetriever
Class Mail::ToField
Class Mail::UnstructuredField

Constants

RubyVer = Ruby19
RubyVer = Ruby18

Public Class methods

Receive all emails from the default retriever See Mail::Retriever for a complete documentation.

Sets the default delivery method and retriever method for all new Mail objects. The delivery_method and retriever_method default to :smtp and :pop3, with defaults set.

So sending a new email, if you have an SMTP server running on localhost is as easy as:

  Mail.deliver do
    to      'mikel@test.lindsaar.net'
    from    'bob@test.lindsaar.net'
    subject 'hi there!'
    body    'this is a body'
  end

If you do not specify anything, you will get the following equivalent code set in every new mail object:

  Mail.defaults do
    delivery_method :smtp, { :address              => "localhost",
                             :port                 => 25,
                             :domain               => 'localhost.localdomain',
                             :user_name            => nil,
                             :password             => nil,
                             :authentication       => nil,
                             :enable_starttls_auto => true  }

    retriever_method :pop3, { :address             => "localhost",
                              :port                => 995,
                              :user_name           => nil,
                              :password            => nil,
                              :enable_ssl          => true }
  end

  Mail.delivery_method.new  #=> Mail::SMTP instance
  Mail.retriever_method.new #=> Mail::POP3 instance

Each mail object inherits the default set in Mail.delivery_method, however, on a per email basis, you can override the method:

  mail.delivery_method :sendmail

Or you can override the method and pass in settings:

  mail.delivery_method :sendmail, { :address => 'some.host' }

You can also just modify the settings:

  mail.delivery_settings = { :address => 'some.host' }

The passed in hash is just merged against the defaults with +merge!+ and the result assigned the mail object. So the above example will change only the :address value of the global smtp_settings to be ‘some.host’, keeping all other values

Delete all emails from the default retriever See Mail::Retriever for a complete documentation.

Send an email using the default configuration. You do need to set a default configuration first before you use self.deliver, if you don‘t, an appropriate error will be raised telling you to.

If you do not specify a delivery type, SMTP will be used.

 Mail.deliver do
  to 'mikel@test.lindsaar.net'
  from 'ada@test.lindsaar.net'
  subject 'This is a test email'
  body 'Not much to say here'
 end

You can also do:

 mail = Mail.read('email.eml')
 mail.deliver!

And your email object will be created and sent.

Returns the delivery method selected, defaults to an instance of Mail::SMTP

Find emails from the default retriever See Mail::Retriever for a complete documentation.

Finds and then deletes retrieved emails from the default retriever See Mail::Retriever for a complete documentation.

Receive the first email(s) from the default retriever See Mail::Retriever for a complete documentation.

Receive the first email(s) from the default retriever See Mail::Retriever for a complete documentation.

Allows you to create a new Mail::Message object.

You can make an email via passing a string or passing a block.

For example, the following two examples will create the same email message:

Creating via a string:

 string = 'To: mikel@test.lindsaar.net\r\n'
 string << 'From: bob@test.lindsaar.net\r\n\r\n'
 string << 'Subject: This is an email\r\n'
 string << '\r\n'
 string << 'This is the body'
 Mail.new(string)

Or creating via a block:

 message = Mail.new do
   to 'mikel@test.lindsaar.net'
   from 'bob@test.lindsaar.net'
   subject 'This is an email'
   body 'This is the body'
 end

Or creating via a hash (or hash like object):

 message = Mail.new({:to => 'mikel@test.lindsaar.net',
                     'from' => 'bob@test.lindsaar.net',
                      :subject 'This is an email',
                      :body 'This is the body' })

Note, the hash keys can be strings or symbols, the passed in object does not need to be a hash, it just needs to respond to :each_pair and yield each key value pair.

As a side note, you can also create a new email through creating a Mail::Message object directly and then passing in values via string, symbol or direct method calls. See Mail::Message for more information.

 mail = Mail.new
 mail.to = 'mikel@test.lindsaar.net'
 mail[:from] = 'bob@test.lindsaar.net'
 mail['subject'] = 'This is an email'
 mail.body = 'This is the body'

Reads in an email message from a path and instantiates it as a new Mail::Message

You can register an object to be given every mail object that will be sent, before it is sent. So if you want to add special headers or modify any email that gets sent through the Mail library, you can do so.

Your object needs to respond to a single method delivering_email(mail) which receives the email that is about to be sent. Make your modifications directly to this object.

You can register an object to be informed of every email that is sent through this method.

Your object needs to respond to a single method delivered_email(mail) which receives the email that is sent.

Returns the retriever method selected, defaults to an instance of Mail::POP3

Protected Class methods

[Validate]