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/encodings/base64.rb
lib/mail/encodings/encodings.rb
lib/mail/encodings/quoted_printable.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/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/imap.rb
lib/mail/network/retriever_methods/pop3.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/mime_version.rb
lib/mail/parsers/phrase_lists.rb
lib/mail/parsers/received.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


encoding: utf-8


encoding: utf-8


encoding: utf-8


encoding: utf-8


encoding: utf-8


encoding: utf-8


encoding: utf-8


encoding: utf-8


encoding: utf-8


encoding: utf-8


encoding: utf-8


encoding: utf-8


encoding: utf-8


encoding: utf-8


encoding: utf-8


encoding: utf-8

Mail Envelope

The Envelope class provides a field for the first line in an mbox file, that looks like “From mikel@test.lindsaar.net DATETIME“

This envelope class reads that line, and turns it into an Envelope.from and Envelope.date for your use.


encoding: utf-8


encoding: utf-8


encoding: utf-8

Blind Carbon Copy Field

The Bcc field inherits from StructuredField and handles the Bcc: header field in the email.

Sending bcc to a mail message will instantiate a Mail::Field object that has a BccField as it’s field type. This includes all Mail::CommonAddress module instance metods.

Only one Bcc field can appear in a header, though it can have multiple addresses and groups of addresses.

Examples:

 mail = Mail.new
 mail.bcc = 'Mikel Lindsaar <mikel@test.lindsaar.net>, ada@test.lindsaar.net'
 mail.bcc    #=> ['Mikel Lindsaar <mikel@test.lindsaar.net>', 'ada@test.lindsaar.net']
 mail[:bcc]  #=> '#<Mail::Field:0x180e5e8 @field=#<Mail::BccField:0x180e1c4
 mail['bcc'] #=> '#<Mail::Field:0x180e5e8 @field=#<Mail::BccField:0x180e1c4
 mail['Bcc'] #=> '#<Mail::Field:0x180e5e8 @field=#<Mail::BccField:0x180e1c4

 mail[:bcc].encoded   #=> ''      # Bcc field does not get output into an email
 mail[:bcc].decoded   #=> 'Mikel Lindsaar <mikel@test.lindsaar.net>, ada@test.lindsaar.net'
 mail[:bcc].addresses #=> ['mikel@test.lindsaar.net', 'ada@test.lindsaar.net']
 mail[:bcc].formatted #=> ['Mikel Lindsaar <mikel@test.lindsaar.net>', 'ada@test.lindsaar.net']

encoding: utf-8

Carbon Copy Field

The Cc field inherits from StructuredField and handles the Cc: header field in the email.

Sending cc to a mail message will instantiate a Mail::Field object that has a CcField as it’s field type. This includes all Mail::CommonAddress module instance metods.

Only one Cc field can appear in a header, though it can have multiple addresses and groups of addresses.

Examples:

 mail = Mail.new
 mail.cc = 'Mikel Lindsaar <mikel@test.lindsaar.net>, ada@test.lindsaar.net'
 mail.cc    #=> ['Mikel Lindsaar <mikel@test.lindsaar.net>', 'ada@test.lindsaar.net']
 mail[:cc]  #=> '#<Mail::Field:0x180e5e8 @field=#<Mail::CcField:0x180e1c4
 mail['cc'] #=> '#<Mail::Field:0x180e5e8 @field=#<Mail::CcField:0x180e1c4
 mail['Cc'] #=> '#<Mail::Field:0x180e5e8 @field=#<Mail::CcField:0x180e1c4

 mail[:cc].encoded   #=> 'Cc: Mikel Lindsaar <mikel@test.lindsaar.net>, ada@test.lindsaar.net\r\n'
 mail[:cc].decoded   #=> 'Mikel Lindsaar <mikel@test.lindsaar.net>, ada@test.lindsaar.net'
 mail[:cc].addresses #=> ['mikel@test.lindsaar.net', 'ada@test.lindsaar.net']
 mail[:cc].formatted #=> ['Mikel Lindsaar <mikel@test.lindsaar.net>', 'ada@test.lindsaar.net']

encoding: utf-8

Comments Field

The Comments field inherits from UnstructuredField and handles the Comments: header field in the email.

Sending comments to a mail message will instantiate a Mail::Field object that has a CommentsField as it’s field type.

An email header can have as many comments fields as it wants. There is no upper limit, the comments field is also optional (that is, no comment is needed)

Examples:

 mail = Mail.new
 mail.comments = 'This is a comment'
 mail.comments    #=> 'This is a comment'
 mail[:comments]  #=> '#<Mail::Field:0x180e5e8 @field=#<Mail::CommentsField:0x180e1c4
 mail['comments'] #=> '#<Mail::Field:0x180e5e8 @field=#<Mail::CommentsField:0x180e1c4
 mail['comments'] #=> '#<Mail::Field:0x180e5e8 @field=#<Mail::CommentsField:0x180e1c4

 mail.comments = "This is another comment"
 mail[:comments].map { |c| c.to_s }
 #=> ['This is a comment', "This is another comment"]

encoding: utf-8


encoding: utf-8


encoding: utf-8


encoding: utf-8


encoding: utf-8


encoding: utf-8


encoding: utf-8


encoding: utf-8


encoding: utf-8


encoding: utf-8


encoding: utf-8


encoding: utf-8

Date Field

The Date field inherits from StructuredField and handles the Date: header field in the email.

Sending date to a mail message will instantiate a Mail::Field object that has a DateField as it’s field type. This includes all Mail::CommonAddress module instance methods.

There must be excatly one Date field in an RFC2822 email.

Examples:

 mail = Mail.new
 mail.date = 'Mon, 24 Nov 1997 14:22:01 -0800'
 mail.date       #=> #<DateTime: 211747170121/86400,-1/3,2299161>
 mail.date.to_s  #=> 'Mon, 24 Nov 1997 14:22:01 -0800'
 mail[:date]     #=> '#<Mail::Field:0x180e5e8 @field=#<Mail::DateField:0x180e1c4
 mail['date']    #=> '#<Mail::Field:0x180e5e8 @field=#<Mail::DateField:0x180e1c4
 mail['Date']    #=> '#<Mail::Field:0x180e5e8 @field=#<Mail::DateField:0x180e1c4

encoding: utf-8

From Field

The From field inherits from StructuredField and handles the From: header field in the email.

Sending from to a mail message will instantiate a Mail::Field object that has a FromField as it’s field type. This includes all Mail::CommonAddress module instance metods.

Only one From field can appear in a header, though it can have multiple addresses and groups of addresses.

Examples:

 mail = Mail.new
 mail.from = 'Mikel Lindsaar <mikel@test.lindsaar.net>, ada@test.lindsaar.net'
 mail.from    #=> ['Mikel Lindsaar <mikel@test.lindsaar.net>', 'ada@test.lindsaar.net']
 mail[:from]  #=> '#<Mail::Field:0x180e5e8 @field=#<Mail::FromField:0x180e1c4
 mail['from'] #=> '#<Mail::Field:0x180e5e8 @field=#<Mail::FromField:0x180e1c4
 mail['From'] #=> '#<Mail::Field:0x180e5e8 @field=#<Mail::FromField:0x180e1c4

 mail[:from].encoded   #=> 'from: Mikel Lindsaar <mikel@test.lindsaar.net>, ada@test.lindsaar.net\r\n'
 mail[:from].decoded   #=> 'Mikel Lindsaar <mikel@test.lindsaar.net>, ada@test.lindsaar.net'
 mail[:from].addresses #=> ['mikel@test.lindsaar.net', 'ada@test.lindsaar.net']
 mail[:from].formatted #=> ['Mikel Lindsaar <mikel@test.lindsaar.net>', 'ada@test.lindsaar.net']

encoding: utf-8

In-Reply-To Field

The In-Reply-To field inherits from StructuredField and handles the In-Reply-To: header field in the email.

Sending in_reply_to to a mail message will instantiate a Mail::Field object that has a InReplyToField as it’s field type. This includes all Mail::CommonMessageId module instance metods.

Note that, the message_ids method will return an array of message IDs without the enclosing angle brackets which per RFC are not syntactically part of the message id.

Only one InReplyTo field can appear in a header, though it can have multiple Message IDs.

Examples:

 mail = Mail.new
 mail.in_reply_to = '<F6E2D0B4-CC35-4A91-BA4C-C7C712B10C13@test.me.dom>'
 mail.in_reply_to    #=> '<F6E2D0B4-CC35-4A91-BA4C-C7C712B10C13@test.me.dom>'
 mail[:in_reply_to]  #=> '#<Mail::Field:0x180e5e8 @field=#<Mail::InReplyToField:0x180e1c4
 mail['in_reply_to'] #=> '#<Mail::Field:0x180e5e8 @field=#<Mail::InReplyToField:0x180e1c4
 mail['In-Reply-To'] #=> '#<Mail::Field:0x180e5e8 @field=#<Mail::InReplyToField:0x180e1c4

 mail[:in_reply_to].message_ids #=> ['F6E2D0B4-CC35-4A91-BA4C-C7C712B10C13@test.me.dom']

encoding: utf-8

keywords = “Keywords:” phrase *(“,” phrase) CRLF


encoding: utf-8

Message-ID Field

The Message-ID field inherits from StructuredField and handles the Message-ID: header field in the email.

Sending message_id to a mail message will instantiate a Mail::Field object that has a MessageIdField as it’s field type. This includes all Mail::CommonMessageId module instance metods.

Only one MessageId field can appear in a header, and syntactically it can only have one Message ID. The message_ids method call has been left in however as it will only return the one message id, ie, an array of length 1.

Note that, the message_ids method will return an array of message IDs without the enclosing angle brackets which per RFC are not syntactically part of the message id.

Examples:

 mail = Mail.new
 mail.message_id = '<F6E2D0B4-CC35-4A91-BA4C-C7C712B10C13@test.me.dom>'
 mail.message_id    #=> '<F6E2D0B4-CC35-4A91-BA4C-C7C712B10C13@test.me.dom>'
 mail[:message_id]  #=> '#<Mail::Field:0x180e5e8 @field=#<Mail::MessageIdField:0x180e1c4
 mail['message_id'] #=> '#<Mail::Field:0x180e5e8 @field=#<Mail::MessageIdField:0x180e1c4
 mail['Message-ID'] #=> '#<Mail::Field:0x180e5e8 @field=#<Mail::MessageIdField:0x180e1c4

 mail[:message_id].message_id   #=> 'F6E2D0B4-CC35-4A91-BA4C-C7C712B10C13@test.me.dom'
 mail[:message_id].message_ids  #=> ['F6E2D0B4-CC35-4A91-BA4C-C7C712B10C13@test.me.dom']

encoding: utf-8


encoding: utf-8

   The field names of any optional-field MUST NOT be identical to any
   field name specified elsewhere in this standard.

optional-field = field-name “:” unstructured CRLF


encoding: utf-8

trace = [return]

                        1*received

return = “Return-Path:” path CRLF

path = ([CFWS] “<” ([CFWS] / addr-spec) “>” [CFWS]) /

                        obs-path

received = “Received:” name-val-list “;” date-time CRLF

name-val-list = [CFWS] [name-val-pair *(CFWS name-val-pair)]

name-val-pair = item-name CFWS item-value

item-name = ALPHA *([“-”] (ALPHA / DIGIT))

item-value = 1*angle-addr / addr-spec /

                         atom / domain / msg-id

encoding: utf-8

References Field

The References field inherits references StructuredField and handles the References: header field in the email.

Sending references to a mail message will instantiate a Mail::Field object that has a ReferencesField as it’s field type. This includes all Mail::CommonAddress module instance metods.

Note that, the message_ids method will return an array of message IDs without the enclosing angle brackets which per RFC are not syntactically part of the message id.

Only one References field can appear in a header, though it can have multiple Message IDs.

Examples:

 mail = Mail.new
 mail.references = '<F6E2D0B4-CC35-4A91-BA4C-C7C712B10C13@test.me.dom>'
 mail.references    #=> '<F6E2D0B4-CC35-4A91-BA4C-C7C712B10C13@test.me.dom>'
 mail[:references]  #=> '#<Mail::Field:0x180e5e8 @field=#<Mail::ReferencesField:0x180e1c4
 mail['references'] #=> '#<Mail::Field:0x180e5e8 @field=#<Mail::ReferencesField:0x180e1c4
 mail['References'] #=> '#<Mail::Field:0x180e5e8 @field=#<Mail::ReferencesField:0x180e1c4

 mail[:references].message_ids #=> ['F6E2D0B4-CC35-4A91-BA4C-C7C712B10C13@test.me.dom']

encoding: utf-8

Reply-To Field

The Reply-To field inherits reply-to StructuredField and handles the Reply-To: header field in the email.

Sending reply_to to a mail message will instantiate a Mail::Field object that has a ReplyToField as it’s field type. This includes all Mail::CommonAddress module instance metods.

Only one Reply-To field can appear in a header, though it can have multiple addresses and groups of addresses.

Examples:

 mail = Mail.new
 mail.reply_to = 'Mikel Lindsaar <mikel@test.lindsaar.net>, ada@test.lindsaar.net'
 mail.reply_to    #=> ['Mikel Lindsaar <mikel@test.lindsaar.net>', 'ada@test.lindsaar.net']
 mail[:reply_to]  #=> '#<Mail::Field:0x180e5e8 @field=#<Mail::ReplyToField:0x180e1c4
 mail['reply-to'] #=> '#<Mail::Field:0x180e5e8 @field=#<Mail::ReplyToField:0x180e1c4
 mail['Reply-To'] #=> '#<Mail::Field:0x180e5e8 @field=#<Mail::ReplyToField:0x180e1c4

 mail[:reply_to].encoded   #=> 'Reply-To: Mikel Lindsaar <mikel@test.lindsaar.net>, ada@test.lindsaar.net\r\n'
 mail[:reply_to].decoded   #=> 'Mikel Lindsaar <mikel@test.lindsaar.net>, ada@test.lindsaar.net'
 mail[:reply_to].addresses #=> ['mikel@test.lindsaar.net', 'ada@test.lindsaar.net']
 mail[:reply_to].formatted #=> ['Mikel Lindsaar <mikel@test.lindsaar.net>', 'ada@test.lindsaar.net']

encoding: utf-8

Resent-Bcc Field

The Resent-Bcc field inherits resent-bcc StructuredField and handles the Resent-Bcc: header field in the email.

Sending resent_bcc to a mail message will instantiate a Mail::Field object that has a ResentBccField as it’s field type. This includes all Mail::CommonAddress module instance metods.

Only one Resent-Bcc field can appear in a header, though it can have multiple addresses and groups of addresses.

Examples:

 mail = Mail.new
 mail.resent_bcc = 'Mikel Lindsaar <mikel@test.lindsaar.net>, ada@test.lindsaar.net'
 mail.resent_bcc    #=> ['Mikel Lindsaar <mikel@test.lindsaar.net>', 'ada@test.lindsaar.net']
 mail[:resent_bcc]  #=> '#<Mail::Field:0x180e5e8 @field=#<Mail::ResentBccField:0x180e1c4
 mail['resent-bcc'] #=> '#<Mail::Field:0x180e5e8 @field=#<Mail::ResentBccField:0x180e1c4
 mail['Resent-Bcc'] #=> '#<Mail::Field:0x180e5e8 @field=#<Mail::ResentBccField:0x180e1c4

 mail[:resent_bcc].encoded   #=> 'Resent-Bcc: Mikel Lindsaar <mikel@test.lindsaar.net>, ada@test.lindsaar.net\r\n'
 mail[:resent_bcc].decoded   #=> 'Mikel Lindsaar <mikel@test.lindsaar.net>, ada@test.lindsaar.net'
 mail[:resent_bcc].addresses #=> ['mikel@test.lindsaar.net', 'ada@test.lindsaar.net']
 mail[:resent_bcc].formatted #=> ['Mikel Lindsaar <mikel@test.lindsaar.net>', 'ada@test.lindsaar.net']

encoding: utf-8

Resent-Cc Field

The Resent-Cc field inherits resent-cc StructuredField and handles the Resent-Cc: header field in the email.

Sending resent_cc to a mail message will instantiate a Mail::Field object that has a ResentCcField as it’s field type. This includes all Mail::CommonAddress module instance metods.

Only one Resent-Cc field can appear in a header, though it can have multiple addresses and groups of addresses.

Examples:

 mail = Mail.new
 mail.resent_cc = 'Mikel Lindsaar <mikel@test.lindsaar.net>, ada@test.lindsaar.net'
 mail.resent_cc    #=> ['Mikel Lindsaar <mikel@test.lindsaar.net>', 'ada@test.lindsaar.net']
 mail[:resent_cc]  #=> '#<Mail::Field:0x180e5e8 @field=#<Mail::ResentCcField:0x180e1c4
 mail['resent-cc'] #=> '#<Mail::Field:0x180e5e8 @field=#<Mail::ResentCcField:0x180e1c4
 mail['Resent-Cc'] #=> '#<Mail::Field:0x180e5e8 @field=#<Mail::ResentCcField:0x180e1c4

 mail[:resent_cc].encoded   #=> 'Resent-Cc: Mikel Lindsaar <mikel@test.lindsaar.net>, ada@test.lindsaar.net\r\n'
 mail[:resent_cc].decoded   #=> 'Mikel Lindsaar <mikel@test.lindsaar.net>, ada@test.lindsaar.net'
 mail[:resent_cc].addresses #=> ['mikel@test.lindsaar.net', 'ada@test.lindsaar.net']
 mail[:resent_cc].formatted #=> ['Mikel Lindsaar <mikel@test.lindsaar.net>', 'ada@test.lindsaar.net']

encoding: utf-8

resent-date = “Resent-Date:” date-time CRLF


encoding: utf-8

Resent-From Field

The Resent-From field inherits resent-from StructuredField and handles the Resent-From: header field in the email.

Sending resent_from to a mail message will instantiate a Mail::Field object that has a ResentFromField as it’s field type. This includes all Mail::CommonAddress module instance metods.

Only one Resent-From field can appear in a header, though it can have multiple addresses and groups of addresses.

Examples:

 mail = Mail.new
 mail.resent_from = 'Mikel Lindsaar <mikel@test.lindsaar.net>, ada@test.lindsaar.net'
 mail.resent_from    #=> ['Mikel Lindsaar <mikel@test.lindsaar.net>', 'ada@test.lindsaar.net']
 mail[:resent_from]  #=> '#<Mail::Field:0x180e5e8 @field=#<Mail::ResentFromField:0x180e1c4
 mail['resent-from'] #=> '#<Mail::Field:0x180e5e8 @field=#<Mail::ResentFromField:0x180e1c4
 mail['Resent-From'] #=> '#<Mail::Field:0x180e5e8 @field=#<Mail::ResentFromField:0x180e1c4

 mail[:resent_from].encoded   #=> 'Resent-From: Mikel Lindsaar <mikel@test.lindsaar.net>, ada@test.lindsaar.net\r\n'
 mail[:resent_from].decoded   #=> 'Mikel Lindsaar <mikel@test.lindsaar.net>, ada@test.lindsaar.net'
 mail[:resent_from].addresses #=> ['mikel@test.lindsaar.net', 'ada@test.lindsaar.net']
 mail[:resent_from].formatted #=> ['Mikel Lindsaar <mikel@test.lindsaar.net>', 'ada@test.lindsaar.net']

encoding: utf-8

resent-msg-id = “Resent-Message-ID:” msg-id CRLF


encoding: utf-8

Resent-Sender Field

The Resent-Sender field inherits resent-sender StructuredField and handles the Resent-Sender: header field in the email.

Sending resent_sender to a mail message will instantiate a Mail::Field object that has a ResentSenderField as it’s field type. This includes all Mail::CommonAddress module instance metods.

Only one Resent-Sender field can appear in a header, though it can have multiple addresses and groups of addresses.

Examples:

 mail = Mail.new
 mail.resent_sender = 'Mikel Lindsaar <mikel@test.lindsaar.net>, ada@test.lindsaar.net'
 mail.resent_sender    #=> '#<Mail::Field:0x180e5e8 @field=#<Mail::ResentSenderField:0x180e1c4
 mail[:resent_sender]  #=> '#<Mail::Field:0x180e5e8 @field=#<Mail::ResentSenderField:0x180e1c4
 mail['resent-sender'] #=> '#<Mail::Field:0x180e5e8 @field=#<Mail::ResentSenderField:0x180e1c4
 mail['Resent-Sender'] #=> '#<Mail::Field:0x180e5e8 @field=#<Mail::ResentSenderField:0x180e1c4

 mail.resent_sender.to_s  #=> 'Mikel Lindsaar <mikel@test.lindsaar.net>, ada@test.lindsaar.net'
 mail.resent_sender.addresses #=> ['mikel@test.lindsaar.net', 'ada@test.lindsaar.net']
 mail.resent_sender.formatted #=> ['Mikel Lindsaar <mikel@test.lindsaar.net>', 'ada@test.lindsaar.net']

encoding: utf-8

Resent-To Field

The Resent-To field inherits resent-to StructuredField and handles the Resent-To: header field in the email.

Sending resent_to to a mail message will instantiate a Mail::Field object that has a ResentToField as it’s field type. This includes all Mail::CommonAddress module instance metods.

Only one Resent-To field can appear in a header, though it can have multiple addresses and groups of addresses.

Examples:

 mail = Mail.new
 mail.resent_to = 'Mikel Lindsaar <mikel@test.lindsaar.net>, ada@test.lindsaar.net'
 mail.resent_to    #=> ['Mikel Lindsaar <mikel@test.lindsaar.net>', 'ada@test.lindsaar.net']
 mail[:resent_to]  #=> '#<Mail::Field:0x180e5e8 @field=#<Mail::ResentToField:0x180e1c4
 mail['resent-to'] #=> '#<Mail::Field:0x180e5e8 @field=#<Mail::ResentToField:0x180e1c4
 mail['Resent-To'] #=> '#<Mail::Field:0x180e5e8 @field=#<Mail::ResentToField:0x180e1c4

 mail[:resent_to].encoded   #=> 'Resent-To: Mikel Lindsaar <mikel@test.lindsaar.net>, ada@test.lindsaar.net\r\n'
 mail[:resent_to].decoded   #=> 'Mikel Lindsaar <mikel@test.lindsaar.net>, ada@test.lindsaar.net'
 mail[:resent_to].addresses #=> ['mikel@test.lindsaar.net', 'ada@test.lindsaar.net']
 mail[:resent_to].formatted #=> ['Mikel Lindsaar <mikel@test.lindsaar.net>', 'ada@test.lindsaar.net']

encoding: utf-8

4.4.3. REPLY-TO / RESENT-REPLY-TO

   Note:  The "Return-Path" field is added by the mail  transport
          service,  at the time of final deliver.  It is intended
          to identify a path back to the orginator  of  the  mes-
          sage.   The  "Reply-To"  field  is added by the message
          originator and is intended to direct replies.

trace = [return]

                        1*received

return = “Return-Path:” path CRLF

path = ([CFWS] “<” ([CFWS] / addr-spec) “>” [CFWS]) /

                        obs-path

received = “Received:” name-val-list “;” date-time CRLF

name-val-list = [CFWS] [name-val-pair *(CFWS name-val-pair)]

name-val-pair = item-name CFWS item-value

item-name = ALPHA *([“-”] (ALPHA / DIGIT))

item-value = 1*angle-addr / addr-spec /

                         atom / domain / msg-id

encoding: utf-8

Sender Field

The Sender field inherits sender StructuredField and handles the Sender: header field in the email.

Sending sender to a mail message will instantiate a Mail::Field object that has a SenderField as it’s field type. This includes all Mail::CommonAddress module instance metods.

Only one Sender field can appear in a header, though it can have multiple addresses and groups of addresses.

Examples:

 mail = Mail.new
 mail.sender = 'Mikel Lindsaar <mikel@test.lindsaar.net>, ada@test.lindsaar.net'
 mail.sender    #=> ['Mikel Lindsaar <mikel@test.lindsaar.net>', 'ada@test.lindsaar.net']
 mail[:sender]  #=> '#<Mail::Field:0x180e5e8 @field=#<Mail::SenderField:0x180e1c4
 mail['sender'] #=> '#<Mail::Field:0x180e5e8 @field=#<Mail::SenderField:0x180e1c4
 mail['Sender'] #=> '#<Mail::Field:0x180e5e8 @field=#<Mail::SenderField:0x180e1c4

 mail[:sender].encoded   #=> 'Sender: Mikel Lindsaar <mikel@test.lindsaar.net>, ada@test.lindsaar.net\r\n'
 mail[:sender].decoded   #=> 'Mikel Lindsaar <mikel@test.lindsaar.net>, ada@test.lindsaar.net'
 mail[:sender].addresses #=> ['mikel@test.lindsaar.net', 'ada@test.lindsaar.net']
 mail[:sender].formatted #=> ['Mikel Lindsaar <mikel@test.lindsaar.net>', 'ada@test.lindsaar.net']

encoding: utf-8


encoding: utf-8

subject = “Subject:” unstructured CRLF


encoding: utf-8

To Field

The To field inherits to StructuredField and handles the To: header field in the email.

Sending to to a mail message will instantiate a Mail::Field object that has a ToField as it’s field type. This includes all Mail::CommonAddress module instance metods.

Only one To field can appear in a header, though it can have multiple addresses and groups of addresses.

Examples:

 mail = Mail.new
 mail.to = 'Mikel Lindsaar <mikel@test.lindsaar.net>, ada@test.lindsaar.net'
 mail.to    #=> ['Mikel Lindsaar <mikel@test.lindsaar.net>', 'ada@test.lindsaar.net']
 mail[:to]  #=> '#<Mail::Field:0x180e5e8 @field=#<Mail::ToField:0x180e1c4
 mail['to'] #=> '#<Mail::Field:0x180e5e8 @field=#<Mail::ToField:0x180e1c4
 mail['To'] #=> '#<Mail::Field:0x180e5e8 @field=#<Mail::ToField:0x180e1c4

 mail[:to].encoded   #=> 'To: Mikel Lindsaar <mikel@test.lindsaar.net>, ada@test.lindsaar.net\r\n'
 mail[:to].decoded   #=> 'Mikel Lindsaar <mikel@test.lindsaar.net>, ada@test.lindsaar.net'
 mail[:to].addresses #=> ['mikel@test.lindsaar.net', 'ada@test.lindsaar.net']
 mail[:to].formatted #=> ['Mikel Lindsaar <mikel@test.lindsaar.net>', 'ada@test.lindsaar.net']

encoding: utf-8


encoding: utf-8


encoding: utf-8


encoding: utf-8


encoding: utf-8


Autogenerated from a Treetop grammar. Edits may be lost.


Autogenerated from a Treetop grammar. Edits may be lost.


Autogenerated from a Treetop grammar. Edits may be lost.


Autogenerated from a Treetop grammar. Edits may be lost.


Autogenerated from a Treetop grammar. Edits may be lost.


Autogenerated from a Treetop grammar. Edits may be lost.


Autogenerated from a Treetop grammar. Edits may be lost.


Autogenerated from a Treetop grammar. Edits may be lost.


Autogenerated from a Treetop grammar. Edits may be lost.


Autogenerated from a Treetop grammar. Edits may be lost.


Autogenerated from a Treetop grammar. Edits may be lost.


Autogenerated from a Treetop grammar. Edits may be lost.


Autogenerated from a Treetop grammar. Edits may be lost.


Autogenerated from a Treetop grammar. Edits may be lost.


encoding: utf-8


encoding: utf-8


encoding: utf-8


encoding: utf-8


encoding: utf-8


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::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::ToField
Class Mail::UnstructuredField

Constants

RubyVer = Mail::Ruby19
RubyVer = Mail::Ruby18

Public Class methods

Receive all emails from a POP3 server. See Mail::POP3 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

Send an email using the default configuration. You do need to set a default configuration first before you use Mail.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 in a POP3 server. See Mail::POP3 for a complete documentation.

Receive the first email(s) from a Pop3 server. See Mail::POP3 for a complete documentation.

Receive the first email(s) from a Pop3 server. See Mail::POP3 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]