Class Mail::Message
In: lib/mail/message.rb
Parent: Object

The Message class provides a single point of access to all things to do with an email message.

You create a new email message by calling the Mail::Message.new method, or just Mail.new

A Message object by default has the following objects inside it:

Per RFC2822

 2.1. General Description

  At the most basic level, a message is a series of characters.  A
  message that is conformant with this standard is comprised of
  characters with values in the range 1 through 127 and interpreted as
  US-ASCII characters [ASCII].  For brevity, this document sometimes
  refers to this range of characters as simply "US-ASCII characters".

  Note: This standard specifies that messages are made up of characters
  in the US-ASCII range of 1 through 127.  There are other documents,
  specifically the MIME document series [RFC2045, RFC2046, RFC2047,
  RFC2048, RFC2049], that extend this standard to allow for values
  outside of that range.  Discussion of those mechanisms is not within
  the scope of this standard.

  Messages are divided into lines of characters.  A line is a series of
  characters that is delimited with the two characters carriage-return
  and line-feed; that is, the carriage return (CR) character (ASCII
  value 13) followed immediately by the line feed (LF) character (ASCII
  value 10).  (The carriage-return/line-feed pair is usually written in
  this document as "CRLF".)

  A message consists of header fields (collectively called "the header
  of the message") followed, optionally, by a body.  The header is a
  sequence of lines of characters with special syntax as defined in
  this standard. The body is simply a sequence of characters that
  follows the header and is separated from the header by an empty line
  (i.e., a line with nothing preceding the CRLF).

Methods

<=>   ==   []   []=   action   add_charset   add_content_transfer_encoding   add_content_type   add_date   add_file   add_message_id   add_mime_version   add_part   all_parts   attachment   attachment?   attachments   bcc   bcc=   bcc_addrs   body   body=   body_encoding   body_encoding=   bounced?   boundary   cc   cc=   cc_addrs   charset   charset=   comments   comments=   content_description   content_description=   content_disposition   content_disposition=   content_id   content_id=   content_location   content_location=   content_transfer_encoding   content_transfer_encoding=   content_type   content_type=   content_type_parameters   convert_to_multipart   date   date=   decode_body   decoded   default   deliver   deliver!   delivery_method   delivery_status_part   delivery_status_report?   destinations   diagnostic_code   encode!   encoded   envelope_date   envelope_from   error_status   errors   filename   final_recipient   find_first_mime_type   from   from=   from_addrs   from_hash   from_yaml   has_attachments?   has_charset?   has_content_transfer_encoding?   has_content_type?   has_date?   has_message_id?   has_mime_version?   header   header=   header_fields   headers   html_part   html_part=   in_reply_to   in_reply_to=   inform_interceptors   inform_observers   inspect   is_marked_for_delete?   keywords   keywords=   main_type   mark_for_delete=   message_content_type   message_id   message_id=   method_missing   mime_parameters   mime_type   mime_version   mime_version=   multipart?   multipart_report?   new   part   parts   raw_envelope   raw_source   read   ready_to_send!   received   received=   references   references=   register_for_delivery_notification   remote_mta   reply   reply_to   reply_to=   resent_bcc   resent_bcc=   resent_cc   resent_cc=   resent_date   resent_date=   resent_from   resent_from=   resent_message_id   resent_message_id=   resent_sender   resent_sender=   resent_to   resent_to=   retryable?   return_path   return_path=   sender   sender=   set_envelope   skip_deletion   smtp_envelope_from   smtp_envelope_from=   smtp_envelope_to   smtp_envelope_to=   sub_type   subject   subject=   text?   text_part   text_part=   to   to=   to_addrs   to_s   to_yaml   transport_encoding   transport_encoding=   without_attachments!  

Included Modules

Patterns Utilities

Attributes

delivery_handler  [RW]  If you assign a delivery handler, mail will call :deliver_mail on the object you assign to delivery_handler, it will pass itself as the single argument.

If you define a delivery_handler, then you are responsible for the following actions in the delivery cycle:

  • Appending the mail object to Mail.deliveries as you see fit.
  • Checking the mail.perform_deliveries flag to decide if you should actually call :deliver! the mail object or not.
  • Checking the mail.raise_delivery_errors flag to decide if you should raise delivery errors if they occur.
  • Actually calling :deliver! (with the bang) on the mail object to get it to deliver itself.

A simplest implementation of a delivery_handler would be

  class MyObject

    def initialize
      @mail = Mail.new('To: mikel@test.lindsaar.net')
      @mail.delivery_handler = self
    end

    attr_accessor :mail

    def deliver_mail(mail)
      yield
    end
  end

Then doing:

  obj = MyObject.new
  obj.mail.deliver

Would cause Mail to call obj.deliver_mail passing itself as a parameter, which then can just yield and let Mail do its own private do_delivery method.

perform_deliveries  [RW]  If set to false, mail will go through the motions of doing a delivery, but not actually call the delivery method or append the mail object to the Mail.deliveries collection. Useful for testing.
  Mail.deliveries.size #=> 0
  mail.delivery_method :smtp
  mail.perform_deliveries = false
  mail.deliver                        # Mail::SMTP not called here
  Mail.deliveries.size #=> 0

If you want to test and query the Mail.deliveries collection to see what mail you sent, you should set perform_deliveries to true and use the :test mail delivery_method:

  Mail.deliveries.size #=> 0
  mail.delivery_method :test
  mail.perform_deliveries = true
  mail.deliver
  Mail.deliveries.size #=> 1

This setting is ignored by mail (though still available as a flag) if you define a delivery_handler

raise_delivery_errors  [RW]  If set to false, mail will silently catch and ignore any exceptions raised through attempting to deliver an email.

This setting is ignored by mail (though still available as a flag) if you define a delivery_handler

Public Class methods

Making an email

You can make an new mail object via a block, passing a string, file or direct assignment.

Making an email via a block

 mail = Mail.new do
      from 'mikel@test.lindsaar.net'
        to 'you@test.lindsaar.net'
   subject 'This is a test email'
      body File.read('body.txt')
 end

 mail.to_s #=> "From: mikel@test.lindsaar.net\r\nTo: you@...

Making an email via passing a string

 mail = Mail.new("To: mikel@test.lindsaar.net\r\nSubject: Hello\r\n\r\nHi there!")
 mail.body.to_s #=> 'Hi there!'
 mail.subject   #=> 'Hello'
 mail.to        #=> 'mikel@test.lindsaar.net'

Making an email from a file

 mail = Mail.read('path/to/file.eml')
 mail.body.to_s #=> 'Hi there!'
 mail.subject   #=> 'Hello'
 mail.to        #=> 'mikel@test.lindsaar.net'

Making an email via assignment

You can assign values to a mail object via four approaches:

  • Message#field_name=(value)
  • Message#field_name(value)
  • Message#[‘field_name’]=(value)
  • Message#[:field_name]=(value)

Examples:

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

 mail.to_s #=> "From: mikel@test.lindsaar.net\r\nTo: you@...

Public Instance methods

Provides the operator needed for sort et al.

Compares this mail object with another mail object, this is done by date, so an email that is older than another will appear first.

Example:

 mail1 = Mail.new do
   date(Time.now)
 end
 mail2 = Mail.new do
   date(Time.now - 86400) # 1 day older
 end
 [mail2, mail1].sort #=> [mail2, mail1]

Two emails are the same if they have the same fields and body contents. One gotcha here is that Mail will insert Message-IDs when calling encoded, so doing mail1.encoded == mail2.encoded is most probably not going to return what you think as the assigned Message-IDs by Mail (if not already defined as the same) will ensure that the two objects are unique, and this comparison will ALWAYS return false.

So the == operator has been defined like so: Two messages are the same if they have the same content, ignoring the Message-ID field, unless BOTH emails have a defined and different Message-ID value, then they are false.

So, in practice the == operator works like this:

 m1 = Mail.new("Subject: Hello\r\n\r\nHello")
 m2 = Mail.new("Subject: Hello\r\n\r\nHello")
 m1 == m2 #=> true

 m1 = Mail.new("Subject: Hello\r\n\r\nHello")
 m2 = Mail.new("Message-ID: <1234@test>\r\nSubject: Hello\r\n\r\nHello")
 m1 == m2 #=> true

 m1 = Mail.new("Message-ID: <1234@test>\r\nSubject: Hello\r\n\r\nHello")
 m2 = Mail.new("Subject: Hello\r\n\r\nHello")
 m1 == m2 #=> true

 m1 = Mail.new("Message-ID: <1234@test>\r\nSubject: Hello\r\n\r\nHello")
 m2 = Mail.new("Message-ID: <1234@test>\r\nSubject: Hello\r\n\r\nHello")
 m1 == m2 #=> true

 m1 = Mail.new("Message-ID: <1234@test>\r\nSubject: Hello\r\n\r\nHello")
 m2 = Mail.new("Message-ID: <DIFFERENT@test>\r\nSubject: Hello\r\n\r\nHello")
 m1 == m2 #=> false

Allows you to read an arbitrary header

Example:

 mail['foo'] = '1234'
 mail['foo'].to_s #=> '1234'

Allows you to add an arbitrary header

Example:

 mail['foo'] = '1234'
 mail['foo'].to_s #=> '1234'

Adds a content type and charset if the body is US-ASCII

Otherwise raises a warning

Adds a content transfer encoding

Otherwise raises a warning

Adds a content type and charset if the body is US-ASCII

Otherwise raises a warning

Creates a new empty Date field and inserts it in the correct order into the Header. The DateField object will automatically generate DateTime.now‘s date if you try and encode it or output it to_s without specifying a date yourself.

It will preserve any date you specify if you do.

Adds a file to the message. You have two options with this method, you can just pass in the absolute path to the file you want and Mail will read the file, get the filename from the path you pass in and guess the MIME media type, or you can pass in the filename as a string, and pass in the file content as a blob.

Example:

 m = Mail.new
 m.add_file('/path/to/filename.png')

 m = Mail.new
 m.add_file(:filename => 'filename.png', :content => File.read('/path/to/file.jpg'))

Note also that if you add a file to an existing message, Mail will convert that message to a MIME multipart email, moving whatever plain text body you had into its own text plain part.

Example:

 m = Mail.new do
   body 'this is some text'
 end
 m.multipart? #=> false
 m.add_file('/path/to/filename.png')
 m.multipart? #=> true
 m.parts.first.content_type.content_type #=> 'text/plain'
 m.parts.last.content_type.content_type #=> 'image/png'

See also attachments

Creates a new empty Message-ID field and inserts it in the correct order into the Header. The MessageIdField object will automatically generate a unique message ID if you try and encode it or output it to_s without specifying a message id.

It will preserve the message ID you specify if you do.

Creates a new empty Mime Version field and inserts it in the correct order into the Header. The MimeVersion object will automatically generate set itself to ‘1.0’ if you try and encode it or output it to_s without specifying a version yourself.

It will preserve any date you specify if you do.

Adds a part to the parts list or creates the part list

Returns the attachment data if there is any

Returns true if this part is an attachment, false otherwise.

Returns an AttachmentsList object, which holds all of the attachments in the receiver object (either the entier email or a part within) and all of its descendants.

It also allows you to add attachments to the mail object directly, like so:

 mail.attachments['filename.jpg'] = File.read('/path/to/filename.jpg')

If you do this, then Mail will take the file name and work out the MIME media type set the Content-Type, Content-Disposition, Content-Transfer-Encoding and base64 encode the contents of the attachment all for you.

You can also specify overrides if you want by passing a hash instead of a string:

 mail.attachments['filename.jpg'] = {:mime_type => 'application/x-gzip',
                                     :content => File.read('/path/to/filename.jpg')}

If you want to use a different encoding than Base64, you can pass an encoding in, but then it is up to you to pass in the content pre-encoded, and don‘t expect Mail to know how to decode this data:

 file_content = SpecialEncode(File.read('/path/to/filename.jpg'))
 mail.attachments['filename.jpg'] = {:mime_type => 'application/x-gzip',
                                     :encoding => 'SpecialEncoding',
                                     :content => file_content }

You can also search for specific attachments:

 # By Filename
 mail.attachments['filename.jpg']   #=> Mail::Part object or nil

 # or by index
 mail.attachments[0]                #=> Mail::Part (first attachment)

Returns the Bcc value of the mail object as an array of strings of address specs.

Example:

 mail.bcc = 'Mikel <mikel@test.lindsaar.net>'
 mail.bcc #=> ['mikel@test.lindsaar.net']
 mail.bcc = 'Mikel <mikel@test.lindsaar.net>, ada@test.lindsaar.net'
 mail.bcc #=> ['mikel@test.lindsaar.net', 'ada@test.lindsaar.net']

Also allows you to set the value by passing a value as a parameter

Example:

 mail.bcc 'Mikel <mikel@test.lindsaar.net>'
 mail.bcc #=> ['mikel@test.lindsaar.net']

Additionally, you can append new addresses to the returned Array like object.

Example:

 mail.bcc 'Mikel <mikel@test.lindsaar.net>'
 mail.bcc << 'ada@test.lindsaar.net'
 mail.bcc #=> ['mikel@test.lindsaar.net', 'ada@test.lindsaar.net']

Sets the Bcc value of the mail object, pass in a string of the field

Example:

 mail.bcc = 'Mikel <mikel@test.lindsaar.net>'
 mail.bcc #=> ['mikel@test.lindsaar.net']
 mail.bcc = 'Mikel <mikel@test.lindsaar.net>, ada@test.lindsaar.net'
 mail.bcc #=> ['mikel@test.lindsaar.net', 'ada@test.lindsaar.net']

Returns an array of addresses (the encoded value) in the Bcc field, if no Bcc field, returns an empty array

Returns the body of the message object. Or, if passed a parameter sets the value.

Example:

 mail = Mail::Message.new('To: mikel\r\n\r\nThis is the body')
 mail.body #=> #<Mail::Body:0x13919c @raw_source="This is the bo...

 mail.body 'This is another body'
 mail.body #=> #<Mail::Body:0x13919c @raw_source="This is anothe...

Sets the body object of the message object.

Example:

 mail.body = 'This is the body'
 mail.body #=> #<Mail::Body:0x13919c @raw_source="This is the bo...

You can also reset the body of an Message object by setting body to nil

Example:

 mail.body = 'this is the body'
 mail.body.encoded #=> 'this is the body'
 mail.body = nil
 mail.body.encoded #=> ''

If you try and set the body of an email that is a multipart email, then instead of deleting all the parts of your email, mail will add a text/plain part to your email:

 mail.add_file 'somefilename.png'
 mail.parts.length #=> 1
 mail.body = "This is a body"
 mail.parts.length #=> 2
 mail.parts.last.content_type.content_type #=> 'This is a body'

Returns the current boundary for this message part

Returns the Cc value of the mail object as an array of strings of address specs.

Example:

 mail.cc = 'Mikel <mikel@test.lindsaar.net>'
 mail.cc #=> ['mikel@test.lindsaar.net']
 mail.cc = 'Mikel <mikel@test.lindsaar.net>, ada@test.lindsaar.net'
 mail.cc #=> ['mikel@test.lindsaar.net', 'ada@test.lindsaar.net']

Also allows you to set the value by passing a value as a parameter

Example:

 mail.cc 'Mikel <mikel@test.lindsaar.net>'
 mail.cc #=> ['mikel@test.lindsaar.net']

Additionally, you can append new addresses to the returned Array like object.

Example:

 mail.cc 'Mikel <mikel@test.lindsaar.net>'
 mail.cc << 'ada@test.lindsaar.net'
 mail.cc #=> ['mikel@test.lindsaar.net', 'ada@test.lindsaar.net']

Sets the Cc value of the mail object, pass in a string of the field

Example:

 mail.cc = 'Mikel <mikel@test.lindsaar.net>'
 mail.cc #=> ['mikel@test.lindsaar.net']
 mail.cc = 'Mikel <mikel@test.lindsaar.net>, ada@test.lindsaar.net'
 mail.cc #=> ['mikel@test.lindsaar.net', 'ada@test.lindsaar.net']

Returns an array of addresses (the encoded value) in the Cc field, if no Cc field, returns an empty array

Returns the character set defined in the content type field

Sets the charset to the supplied value.

Returns the content type parameters

Returns the default value of the field requested as a symbol.

Each header field has a :default method which returns the most common use case for that field, for example, the date field types will return a DateTime object when sent :default, the subject, or unstructured fields will return a decoded string of their value, the address field types will return a single addr_spec or an array of addr_specs if there is more than one.

Delivers an mail object.

Examples:

 mail = Mail.read('file.eml')
 mail.deliver

This method bypasses checking perform_deliveries and raise_delivery_errors, so use with caution.

It still however fires off the intercepters and calls the observers callbacks if they are defined.

Returns self

returns the part in a multipart/report email that has the content-type delivery-status

Returns true if the message is a multipart/report; report-type=delivery-status;

Returns the list of addresses this message should be sent to by collecting the addresses off the to, cc and bcc fields.

Example:

 mail.to = 'mikel@test.lindsaar.net'
 mail.cc = 'sam@test.lindsaar.net'
 mail.bcc = 'bob@test.lindsaar.net'
 mail.destinations.length #=> 3
 mail.destinations.first #=> 'mikel@test.lindsaar.net'

Outputs an encoded string representation of the mail message including all headers, attachments, etc. This is an encoded email in US-ASCII, so it is able to be directly sent to an email server.

Returns a list of parser errors on the header, each field that had an error will be reparsed as an unstructured field to preserve the data inside, but will not be used for further processing.

It returns a nested array of [field_name, value, original_error_message] per error found.

Example:

 message = Mail.new("Content-Transfer-Encoding: weirdo\r\n")
 message.errors.size #=> 1
 message.errors.first[0] #=> "Content-Transfer-Encoding"
 message.errors.first[1] #=> "weirdo"
 message.errors.first[3] #=> <The original error message exception>

This is a good first defence on detecting spam by the way. Some spammers send invalid emails to try and get email parsers to give up parsing them.

Returns the filename of the attachment

Returns the From value of the mail object as an array of strings of address specs.

Example:

 mail.from = 'Mikel <mikel@test.lindsaar.net>'
 mail.from #=> ['mikel@test.lindsaar.net']
 mail.from = 'Mikel <mikel@test.lindsaar.net>, ada@test.lindsaar.net'
 mail.from #=> ['mikel@test.lindsaar.net', 'ada@test.lindsaar.net']

Also allows you to set the value by passing a value as a parameter

Example:

 mail.from 'Mikel <mikel@test.lindsaar.net>'
 mail.from #=> ['mikel@test.lindsaar.net']

Additionally, you can append new addresses to the returned Array like object.

Example:

 mail.from 'Mikel <mikel@test.lindsaar.net>'
 mail.from << 'ada@test.lindsaar.net'
 mail.from #=> ['mikel@test.lindsaar.net', 'ada@test.lindsaar.net']

Sets the From value of the mail object, pass in a string of the field

Example:

 mail.from = 'Mikel <mikel@test.lindsaar.net>'
 mail.from #=> ['mikel@test.lindsaar.net']
 mail.from = 'Mikel <mikel@test.lindsaar.net>, ada@test.lindsaar.net'
 mail.from #=> ['mikel@test.lindsaar.net', 'ada@test.lindsaar.net']

Returns an array of addresses (the encoded value) in the From field, if no From field, returns an empty array

Returns true if the message has a Date field, the field may or may not have a value, but the field exists or not.

Returns true if the message has a message ID field, the field may or may not have a value, but the field exists or not.

Returns true if the message has a Date field, the field may or may not have a value, but the field exists or not.

Returns the header object of the message object. Or, if passed a parameter sets the value.

Example:

 mail = Mail::Message.new('To: mikel\r\nFrom: you')
 mail.header #=> #<Mail::Header:0x13ce14 @raw_source="To: mikel\r\nFr...

 mail.header #=> nil
 mail.header 'To: mikel\r\nFrom: you'
 mail.header #=> #<Mail::Header:0x13ce14 @raw_source="To: mikel\r\nFr...

Sets the header of the message object.

Example:

 mail.header = 'To: mikel@test.lindsaar.net\r\nFrom: Bob@bob.com'
 mail.header #=> <#Mail::Header

Returns an FieldList of all the fields in the header in the order that they appear in the header

Provides a way to set custom headers, by passing in a hash

Helper to add a html part to a multipart/alternative email. If this and text_part are both defined in a message, then it will be a multipart/alternative message and set itself that way.

Returns whether message will be marked for deletion. If so, the message will be deleted at session close (i.e. after find exits), but only if also using the find_and_delete method, or by calling find with :delete_after_find set to true.

Side-note: Just to be clear, this method will return true even if the message hasn‘t yet been marked for delete on the mail server. However, if this method returns true, it *will be* marked on the server after each block yields back to find or find_and_delete.

Returns the main content type

Sets whether this message should be deleted at session close (i.e. after find). Message will only be deleted if messages are retrieved using the find_and_delete method, or by calling find with :delete_after_find set to true.

Returns the Message-ID of the mail object. Note, per RFC 2822 the Message ID consists of what is INSIDE the < > usually seen in the mail header, so this method will return only what is inside.

Example:

 mail.message_id = '<1234@message.id>'
 mail.message_id #=> '1234@message.id'

Also allows you to set the Message-ID by passing a string as a parameter

 mail.message_id '<1234@message.id>'
 mail.message_id #=> '1234@message.id'

Sets the Message-ID. Note, per RFC 2822 the Message ID consists of what is INSIDE the < > usually seen in the mail header, so this method will return only what is inside.

 mail.message_id = '<1234@message.id>'
 mail.message_id #=> '1234@message.id'

Method Missing in this implementation allows you to set any of the standard fields directly as you would the "to", "subject" etc.

Those fields used most often (to, subject et al) are given their own method for ease of documentation and also to avoid the hook call to method missing.

This will only catch the known fields listed in:

 Mail::Field::KNOWN_FIELDS

as per RFC 2822, any ruby string or method name could pretty much be a field name, so we don‘t want to just catch ANYTHING sent to a message object and interpret it as a header.

This method provides all three types of header call to set, read and explicitly set with the = operator

Examples:

 mail.comments = 'These are some comments'
 mail.comments #=> 'These are some comments'

 mail.comments 'These are other comments'
 mail.comments #=> 'These are other comments'

 mail.date = 'Tue, 1 Jul 2003 10:52:37 +0200'
 mail.date.to_s #=> 'Tue, 1 Jul 2003 10:52:37 +0200'

 mail.date 'Tue, 1 Jul 2003 10:52:37 +0200'
 mail.date.to_s #=> 'Tue, 1 Jul 2003 10:52:37 +0200'

 mail.resent_msg_id = '<1234@resent_msg_id.lindsaar.net>'
 mail.resent_msg_id #=> '<1234@resent_msg_id.lindsaar.net>'

 mail.resent_msg_id '<4567@resent_msg_id.lindsaar.net>'
 mail.resent_msg_id #=> '<4567@resent_msg_id.lindsaar.net>'

Returns the content type parameters

Returns the MIME media type of part we are on, this is taken from the content-type header

Returns the MIME version of the email as a string

Example:

 mail.mime_version = '1.0'
 mail.mime_version #=> '1.0'

Also allows you to set the MIME version by passing a string as a parameter.

Example:

 mail.mime_version '1.0'
 mail.mime_version #=> '1.0'

Sets the MIME version of the email by accepting a string

Example:

 mail.mime_version = '1.0'
 mail.mime_version #=> '1.0'

Returns true if the message is multipart

Returns true if the message is a multipart/report

Allows you to add a part in block form to an existing mail message object

Example:

 mail = Mail.new do
   part :content_type => "multipart/alternative", :content_disposition => "inline" do |p|
     p.part :content_type => "text/plain", :body => "test text\nline #2"
     p.part :content_type => "text/html", :body => "<b>test</b> HTML<br/>\nline #2"
   end
 end

Returns a parts list object of all the parts in the message

The raw_envelope is the From mikel@test.lindsaar.net Mon May 2 16:07:05 2009 type field that you can see at the top of any email that has come from a mailbox

Provides access to the raw source of the message as it was when it was instantiated. This is set at initialization and so is untouched by the parsers or decoder / encoders

Example:

 mail = Mail.new('This is an invalid email message')
 mail.raw_source #=> "This is an invalid email message"

Encodes the message, calls encode on all its parts, gets an email message ready to send

Returns the Reply-To value of the mail object as an array of strings of address specs.

Example:

 mail.reply_to = 'Mikel <mikel@test.lindsaar.net>'
 mail.reply_to #=> ['mikel@test.lindsaar.net']
 mail.reply_to = 'Mikel <mikel@test.lindsaar.net>, ada@test.lindsaar.net'
 mail.reply_to #=> ['mikel@test.lindsaar.net', 'ada@test.lindsaar.net']

Also allows you to set the value by passing a value as a parameter

Example:

 mail.reply_to 'Mikel <mikel@test.lindsaar.net>'
 mail.reply_to #=> ['mikel@test.lindsaar.net']

Additionally, you can append new addresses to the returned Array like object.

Example:

 mail.reply_to 'Mikel <mikel@test.lindsaar.net>'
 mail.reply_to << 'ada@test.lindsaar.net'
 mail.reply_to #=> ['mikel@test.lindsaar.net', 'ada@test.lindsaar.net']

Sets the Reply-To value of the mail object, pass in a string of the field

Example:

 mail.reply_to = 'Mikel <mikel@test.lindsaar.net>'
 mail.reply_to #=> ['mikel@test.lindsaar.net']
 mail.reply_to = 'Mikel <mikel@test.lindsaar.net>, ada@test.lindsaar.net'
 mail.reply_to #=> ['mikel@test.lindsaar.net', 'ada@test.lindsaar.net']

Returns the Resent-Bcc value of the mail object as an array of strings of address specs.

Example:

 mail.resent_bcc = 'Mikel <mikel@test.lindsaar.net>'
 mail.resent_bcc #=> ['mikel@test.lindsaar.net']
 mail.resent_bcc = 'Mikel <mikel@test.lindsaar.net>, ada@test.lindsaar.net'
 mail.resent_bcc #=> ['mikel@test.lindsaar.net', 'ada@test.lindsaar.net']

Also allows you to set the value by passing a value as a parameter

Example:

 mail.resent_bcc 'Mikel <mikel@test.lindsaar.net>'
 mail.resent_bcc #=> ['mikel@test.lindsaar.net']

Additionally, you can append new addresses to the returned Array like object.

Example:

 mail.resent_bcc 'Mikel <mikel@test.lindsaar.net>'
 mail.resent_bcc << 'ada@test.lindsaar.net'
 mail.resent_bcc #=> ['mikel@test.lindsaar.net', 'ada@test.lindsaar.net']

Sets the Resent-Bcc value of the mail object, pass in a string of the field

Example:

 mail.resent_bcc = 'Mikel <mikel@test.lindsaar.net>'
 mail.resent_bcc #=> ['mikel@test.lindsaar.net']
 mail.resent_bcc = 'Mikel <mikel@test.lindsaar.net>, ada@test.lindsaar.net'
 mail.resent_bcc #=> ['mikel@test.lindsaar.net', 'ada@test.lindsaar.net']

Returns the Resent-Cc value of the mail object as an array of strings of address specs.

Example:

 mail.resent_cc = 'Mikel <mikel@test.lindsaar.net>'
 mail.resent_cc #=> ['mikel@test.lindsaar.net']
 mail.resent_cc = 'Mikel <mikel@test.lindsaar.net>, ada@test.lindsaar.net'
 mail.resent_cc #=> ['mikel@test.lindsaar.net', 'ada@test.lindsaar.net']

Also allows you to set the value by passing a value as a parameter

Example:

 mail.resent_cc 'Mikel <mikel@test.lindsaar.net>'
 mail.resent_cc #=> ['mikel@test.lindsaar.net']

Additionally, you can append new addresses to the returned Array like object.

Example:

 mail.resent_cc 'Mikel <mikel@test.lindsaar.net>'
 mail.resent_cc << 'ada@test.lindsaar.net'
 mail.resent_cc #=> ['mikel@test.lindsaar.net', 'ada@test.lindsaar.net']

Sets the Resent-Cc value of the mail object, pass in a string of the field

Example:

 mail.resent_cc = 'Mikel <mikel@test.lindsaar.net>'
 mail.resent_cc #=> ['mikel@test.lindsaar.net']
 mail.resent_cc = 'Mikel <mikel@test.lindsaar.net>, ada@test.lindsaar.net'
 mail.resent_cc #=> ['mikel@test.lindsaar.net', 'ada@test.lindsaar.net']

Returns the Resent-From value of the mail object as an array of strings of address specs.

Example:

 mail.resent_from = 'Mikel <mikel@test.lindsaar.net>'
 mail.resent_from #=> ['mikel@test.lindsaar.net']
 mail.resent_from = 'Mikel <mikel@test.lindsaar.net>, ada@test.lindsaar.net'
 mail.resent_from #=> ['mikel@test.lindsaar.net', 'ada@test.lindsaar.net']

Also allows you to set the value by passing a value as a parameter

Example:

 mail.resent_from ['Mikel <mikel@test.lindsaar.net>']
 mail.resent_from #=> 'mikel@test.lindsaar.net'

Additionally, you can append new addresses to the returned Array like object.

Example:

 mail.resent_from 'Mikel <mikel@test.lindsaar.net>'
 mail.resent_from << 'ada@test.lindsaar.net'
 mail.resent_from #=> ['mikel@test.lindsaar.net', 'ada@test.lindsaar.net']

Sets the Resent-From value of the mail object, pass in a string of the field

Example:

 mail.resent_from = 'Mikel <mikel@test.lindsaar.net>'
 mail.resent_from #=> ['mikel@test.lindsaar.net']
 mail.resent_from = 'Mikel <mikel@test.lindsaar.net>, ada@test.lindsaar.net'
 mail.resent_from #=> ['mikel@test.lindsaar.net', 'ada@test.lindsaar.net']

Returns the Resent-Sender value of the mail object, as a single string of an address spec. A sender per RFC 2822 must be a single address, so you can not append to this address.

Example:

 mail.resent_sender = 'Mikel <mikel@test.lindsaar.net>'
 mail.resent_sender #=> 'mikel@test.lindsaar.net'

Also allows you to set the value by passing a value as a parameter

Example:

 mail.resent_sender 'Mikel <mikel@test.lindsaar.net>'
 mail.resent_sender #=> 'mikel@test.lindsaar.net'

Sets the Resent-Sender value of the mail object, pass in a string of the field

Example:

 mail.resent_sender = 'Mikel <mikel@test.lindsaar.net>'
 mail.resent_sender #=> 'mikel@test.lindsaar.net'

Returns the Resent-To value of the mail object as an array of strings of address specs.

Example:

 mail.resent_to = 'Mikel <mikel@test.lindsaar.net>'
 mail.resent_to #=> ['mikel@test.lindsaar.net']
 mail.resent_to = 'Mikel <mikel@test.lindsaar.net>, ada@test.lindsaar.net'
 mail.resent_to #=> ['mikel@test.lindsaar.net', 'ada@test.lindsaar.net']

Also allows you to set the value by passing a value as a parameter

Example:

 mail.resent_to 'Mikel <mikel@test.lindsaar.net>'
 mail.resent_to #=> ['mikel@test.lindsaar.net']

Additionally, you can append new addresses to the returned Array like object.

Example:

 mail.resent_to 'Mikel <mikel@test.lindsaar.net>'
 mail.resent_to << 'ada@test.lindsaar.net'
 mail.resent_to #=> ['mikel@test.lindsaar.net', 'ada@test.lindsaar.net']

Sets the Resent-To value of the mail object, pass in a string of the field

Example:

 mail.resent_to = 'Mikel <mikel@test.lindsaar.net>'
 mail.resent_to #=> ['mikel@test.lindsaar.net']
 mail.resent_to = 'Mikel <mikel@test.lindsaar.net>, ada@test.lindsaar.net'
 mail.resent_to #=> ['mikel@test.lindsaar.net', 'ada@test.lindsaar.net']

Returns the return path of the mail object, or sets it if you pass a string

Sets the return path of the object

Returns the Sender value of the mail object, as a single string of an address spec. A sender per RFC 2822 must be a single address.

Example:

 mail.sender = 'Mikel <mikel@test.lindsaar.net>'
 mail.sender #=> 'mikel@test.lindsaar.net'

Also allows you to set the value by passing a value as a parameter

Example:

 mail.sender 'Mikel <mikel@test.lindsaar.net>'
 mail.sender #=> 'mikel@test.lindsaar.net'

Sets the Sender value of the mail object, pass in a string of the field

Example:

 mail.sender = 'Mikel <mikel@test.lindsaar.net>'
 mail.sender #=> 'mikel@test.lindsaar.net'

Sets the envelope from for the email

Skips the deletion of this message. All other messages flagged for delete still will be deleted at session close (i.e. when find exits). Only has an effect if you‘re using find_and_delete or find with :delete_after_find set to true.

Returns the SMTP Envelope From value of the mail object, as a single string of an address spec.

Defaults to Return-Path, Sender, or the first From address.

Example:

 mail.smtp_envelope_from = 'Mikel <mikel@test.lindsaar.net>'
 mail.smtp_envelope_from #=> 'mikel@test.lindsaar.net'

Also allows you to set the value by passing a value as a parameter

Example:

 mail.smtp_envelope_from 'Mikel <mikel@test.lindsaar.net>'
 mail.smtp_envelope_from #=> 'mikel@test.lindsaar.net'

Sets the From address on the SMTP Envelope.

Example:

 mail.smtp_envelope_from = 'Mikel <mikel@test.lindsaar.net>'
 mail.smtp_envelope_from #=> 'mikel@test.lindsaar.net'

Returns the SMTP Envelope To value of the mail object.

Defaults to destinations: To, Cc, and Bcc addresses.

Example:

 mail.smtp_envelope_to = 'Mikel <mikel@test.lindsaar.net>'
 mail.smtp_envelope_to #=> 'mikel@test.lindsaar.net'

Also allows you to set the value by passing a value as a parameter

Example:

 mail.smtp_envelope_to ['Mikel <mikel@test.lindsaar.net>', 'Lindsaar <lindsaar@test.lindsaar.net>']
 mail.smtp_envelope_to #=> ['mikel@test.lindsaar.net', 'lindsaar@test.lindsaar.net']

Sets the To addresses on the SMTP Envelope.

Example:

 mail.smtp_envelope_to = 'Mikel <mikel@test.lindsaar.net>'
 mail.smtp_envelope_to #=> 'mikel@test.lindsaar.net'

 mail.smtp_envelope_to = ['Mikel <mikel@test.lindsaar.net>', 'Lindsaar <lindsaar@test.lindsaar.net>']
 mail.smtp_envelope_to #=> ['mikel@test.lindsaar.net', 'lindsaar@test.lindsaar.net']

Returns the sub content type

Returns the decoded value of the subject field, as a single string.

Example:

 mail.subject = "G'Day mate"
 mail.subject #=> "G'Day mate"
 mail.subject = '=?UTF-8?Q?This_is_=E3=81=82_string?='
 mail.subject #=> "This is あ string"

Also allows you to set the value by passing a value as a parameter

Example:

 mail.subject "G'Day mate"
 mail.subject #=> "G'Day mate"

Sets the Subject value of the mail object, pass in a string of the field

Example:

 mail.subject = '=?UTF-8?Q?This_is_=E3=81=82_string?='
 mail.subject #=> "This is あ string"

Helper to add a text part to a multipart/alternative email. If this and html_part are both defined in a message, then it will be a multipart/alternative message and set itself that way.

Returns the To value of the mail object as an array of strings of address specs.

Example:

 mail.to = 'Mikel <mikel@test.lindsaar.net>'
 mail.to #=> ['mikel@test.lindsaar.net']
 mail.to = 'Mikel <mikel@test.lindsaar.net>, ada@test.lindsaar.net'
 mail.to #=> ['mikel@test.lindsaar.net', 'ada@test.lindsaar.net']

Also allows you to set the value by passing a value as a parameter

Example:

 mail.to 'Mikel <mikel@test.lindsaar.net>'
 mail.to #=> ['mikel@test.lindsaar.net']

Additionally, you can append new addresses to the returned Array like object.

Example:

 mail.to 'Mikel <mikel@test.lindsaar.net>'
 mail.to << 'ada@test.lindsaar.net'
 mail.to #=> ['mikel@test.lindsaar.net', 'ada@test.lindsaar.net']

Sets the To value of the mail object, pass in a string of the field

Example:

 mail.to = 'Mikel <mikel@test.lindsaar.net>'
 mail.to #=> ['mikel@test.lindsaar.net']
 mail.to = 'Mikel <mikel@test.lindsaar.net>, ada@test.lindsaar.net'
 mail.to #=> ['mikel@test.lindsaar.net', 'ada@test.lindsaar.net']

Returns an array of addresses (the encoded value) in the To field, if no To field, returns an empty array

[Validate]