Parent

Methods

Included Modules

Class/Module Index [+]

Quicksearch

Mail::Message

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).

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 it’s 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

new(*args, &block) click to toggle source

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#=(value)

  • Message#=(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@...
# File lib/mail/message.rb, line 97
def initialize(*args, &block)
  @body = nil
  @text_part = nil
  @html_part = nil

  @perform_deliveries = true
  @raise_delivery_errors = true

  @delivery_handler = nil
  
  @delivery_method = Mail.delivery_method.dup
  
  if args.flatten.first.respond_to?(:each_pair)
    init_with_hash(args.flatten.first)
  else
    init_with_string(args.flatten[0].to_s.strip)
  end

  if block_given?
    instance_eval(&block)
  end

  self
end

Public Instance Methods

<=>(other) click to toggle source

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]
# File lib/mail/message.rb, line 258
def <=>(other)
  if other.nil?
    1
  else
    self.date <=> other.date
  end
end
==(other) click to toggle source

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
# File lib/mail/message.rb, line 297
def ==(other)
  return false unless other.respond_to?(:encoded)
  
  if self.message_id && other.message_id
    result = (self.encoded == other.encoded)
  else
    self_message_id, other_message_id = self.message_id, other.message_id
    self.message_id, other.message_id = '<temp@test>', '<temp@test>'
    result = self.encoded == other.encoded
    self.message_id, other.message_id = "<#{self_message_id}>", "<#{other_message_id}>"
    result
  end
end
[](name) click to toggle source

Allows you to read an arbitrary header

Example:

mail['foo'] = '1234'
mail['foo'].to_s #=> '1234'
# File lib/mail/message.rb, line 1141
def [](name)
  header[underscoreize(name)]
end
[]=(name, value) click to toggle source

Allows you to add an arbitrary header

Example:

mail['foo'] = '1234'
mail['foo'].to_s #=> '1234'
# File lib/mail/message.rb, line 1125
def []=(name, value)
  if name.to_s == 'body'
    self.body = value
  elsif name.to_s =~ /content[-_]type/
    header[underscoreize(name)] = value
  else
    header[underscoreize(name)] = value
  end
end
action() click to toggle source
# File lib/mail/message.rb, line 1385
def action
  delivery_status_part and delivery_status_part.action
end
add_charset() click to toggle source

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

Otherwise raises a warning

# File lib/mail/message.rb, line 1282
def add_charset
  if body.only_us_ascii?
    header[:content_type].parameters['charset'] = 'US-ASCII'
  else
    warning = "Non US-ASCII detected and no charset defined.\nDefaulting to UTF-8, set your own if this is incorrect.\n"
    STDERR.puts(warning)
    header[:content_type].parameters['charset'] = 'UTF-8'
  end
end
add_content_transfer_encoding() click to toggle source

Adds a content transfer encoding

Otherwise raises a warning

# File lib/mail/message.rb, line 1295
def add_content_transfer_encoding
  if body.only_us_ascii?
    header[:content_transfer_encoding] = '7bit'
  else
    warning = "Non US-ASCII detected and no content-transfer-encoding defined.\nDefaulting to 8bit, set your own if this is incorrect.\n"
    STDERR.puts(warning)
    header[:content_transfer_encoding] = '8bit'
  end
end
add_content_type() click to toggle source

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

Otherwise raises a warning

# File lib/mail/message.rb, line 1275
def add_content_type
  header[:content_type] = 'text/plain'
end
add_date(date_val = '') click to toggle source

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.

# File lib/mail/message.rb, line 1258
def add_date(date_val = '')
  header['date'] = date_val
end
add_file(values) click to toggle source

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 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 it’s 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

# File lib/mail/message.rb, line 1566
def add_file(values)
  convert_to_multipart unless self.multipart? || self.body.decoded.blank?
  add_multipart_mixed_header
  if values.is_a?(String)
    basename = File.basename(values)
    filedata = File.read(values)
  else
    basename = values[:filename]
    filedata = values[:content] || File.read(values[:filename])
  end
  self.attachments[basename] = filedata
end
add_message_id(msg_id_val = '') click to toggle source

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.

# File lib/mail/message.rb, line 1248
def add_message_id(msg_id_val = '')
  header['message-id'] = msg_id_val
end
add_mime_version(ver_val = '') click to toggle source

Creates a new empty Mime Version field and inserts it in the correct order into the Header. The MimeVersion 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.

# File lib/mail/message.rb, line 1268
def add_mime_version(ver_val = '')
  header['mime-version'] = ver_val
end
add_part(part) click to toggle source

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

# File lib/mail/message.rb, line 1510
def add_part(part)
  if body.parts.empty? && !self.body.decoded.blank?
     @text_part = Mail::Part.new('Content-Type: text/plain;')
     @text_part.body = body.decoded
     self.body << @text_part
     add_multipart_alternate_header
  end
  add_boundary
  self.body << part
end
all_parts() click to toggle source
# File lib/mail/message.rb, line 1657
def all_parts
  parts.map { |p| [p, p.all_parts] }.flatten
end
attachment() click to toggle source

Returns the attachment data if there is any

# File lib/mail/message.rb, line 1648
def attachment
  @attachment
end
attachment?() click to toggle source

Returns true if this part is an attachment

# File lib/mail/message.rb, line 1643
def attachment?
  find_attachment
end
attachments() click to toggle source

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 it’s 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 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)
# File lib/mail/message.rb, line 1453
def attachments
  parts.attachments
end
bcc( val = nil ) click to toggle source

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']
# File lib/mail/message.rb, line 401
def bcc( val = nil )
  default :bcc, val
end
bcc=( val ) click to toggle source

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']
# File lib/mail/message.rb, line 413
def bcc=( val )
  header[:bcc] = val
end
bcc_addrs() click to toggle source

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

# File lib/mail/message.rb, line 1115
def bcc_addrs
  bcc ? [bcc].flatten : []
end
body(value = nil) click to toggle source

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...
# File lib/mail/message.rb, line 1072
def body(value = nil)
  if value
    self.body = value
    add_encoding_to_body
  else
    @body
  end
end
body=(value) click to toggle source

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'
# File lib/mail/message.rb, line 1050
def body=(value)
  case
  when value == nil
    @body = Mail::Body.new('')
  when @body && !@body.parts.empty?
    @body << Mail::Part.new(value)
  else
    @body = Mail::Body.new(value)
  end
  add_encoding_to_body
end
bounced?() click to toggle source
# File lib/mail/message.rb, line 1381
def bounced?
  delivery_status_part and delivery_status_part.bounced?
end
boundary() click to toggle source

Returns the current boundary for this message part

# File lib/mail/message.rb, line 1410
def boundary
  content_type_parameters ? content_type_parameters['boundary'] : nil
end
cc( val = nil ) click to toggle source

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']
# File lib/mail/message.rb, line 442
def cc( val = nil )
  default :cc, val
end
cc=( val ) click to toggle source

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']
# File lib/mail/message.rb, line 454
def cc=( val )
  header[:cc] = val
end
cc_addrs() click to toggle source

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

# File lib/mail/message.rb, line 1109
def cc_addrs
  cc ? [cc].flatten : []
end
charset() click to toggle source

Returns the character set defined in the content type field

# File lib/mail/message.rb, line 1326
def charset
  content_type ? content_type_parameters['charset'] : nil
end
charset=(value) click to toggle source

Sets the charset to the supplied value. Will set the content type to text/plain if it does not already exist

# File lib/mail/message.rb, line 1332
def charset=(value)
  if content_type
    content_type_parameters['charset'] = value
  else
    self.content_type ['text', 'plain', {'charset' => value}]
  end
end
comments( val = nil ) click to toggle source
# File lib/mail/message.rb, line 458
def comments( val = nil )
  default :comments, val
end
comments=( val ) click to toggle source
# File lib/mail/message.rb, line 462
def comments=( val )
  header[:comments] = val
end
content_description( val = nil ) click to toggle source
# File lib/mail/message.rb, line 466
def content_description( val = nil )
  default :content_description, val
end
content_description=( val ) click to toggle source
# File lib/mail/message.rb, line 470
def content_description=( val )
  header[:content_description] = val
end
content_disposition( val = nil ) click to toggle source
# File lib/mail/message.rb, line 474
def content_disposition( val = nil )
  default :content_disposition, val
end
content_disposition=( val ) click to toggle source
# File lib/mail/message.rb, line 478
def content_disposition=( val )
  header[:content_disposition] = val
end
content_id( val = nil ) click to toggle source
# File lib/mail/message.rb, line 482
def content_id( val = nil )
  default :content_id, val
end
content_id=( val ) click to toggle source
# File lib/mail/message.rb, line 486
def content_id=( val )
  header[:content_id] = val
end
content_location( val = nil ) click to toggle source
# File lib/mail/message.rb, line 490
def content_location( val = nil )
  default :content_location, val
end
content_location=( val ) click to toggle source
# File lib/mail/message.rb, line 494
def content_location=( val )
  header[:content_location] = val
end
content_transfer_encoding( val = nil ) click to toggle source
# File lib/mail/message.rb, line 498
def content_transfer_encoding( val = nil )
  default :content_transfer_encoding, val
end
content_transfer_encoding=( val ) click to toggle source
# File lib/mail/message.rb, line 502
def content_transfer_encoding=( val )
  header[:content_transfer_encoding] = val
end
content_type( val = nil ) click to toggle source
# File lib/mail/message.rb, line 506
def content_type( val = nil )
  default :content_type, val
end
content_type=( val ) click to toggle source
# File lib/mail/message.rb, line 510
def content_type=( val )
  header[:content_type] = val
end
content_type_parameters() click to toggle source

Returns the content type parameters

# File lib/mail/message.rb, line 1357
def content_type_parameters
  has_content_type? ? header[:content_type].parameters : nil
end
convert_to_multipart() click to toggle source
# File lib/mail/message.rb, line 1579
def convert_to_multipart
  text = @body.decoded
  self.body = ''
  text_part = Mail::Part.new({:content_type => 'text/plain;',
                              :body => text})
  self.body << text_part
end
date( val = nil ) click to toggle source
# File lib/mail/message.rb, line 514
def date( val = nil )
  default :date, val
end
date=( val ) click to toggle source
# File lib/mail/message.rb, line 518
def date=( val )
  header[:date] = val
end
decode_body() click to toggle source
# File lib/mail/message.rb, line 1634
def decode_body
  if Mail::Encodings.defined?(content_transfer_encoding)
    Mail::Encodings.get_encoding(content_transfer_encoding).decode(body.encoded)
  else
    raise UnknownEncodingType, "Don't know how to decode #{content_transfer_encoding}, please call #encoded and decode it yourself."
  end
end
decoded() click to toggle source
# File lib/mail/message.rb, line 1618
def decoded
  if self.attachment?
    decode_body
  else
    raise NoMethodError, 'Can not decode an entire message, try calling #decoded on the various fields and body or parts if it is a multipart message.'
  end
end
default( sym, val = nil ) click to toggle source

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.

# File lib/mail/message.rb, line 1017
def default( sym, val = nil )
  if val
    header[sym] = val
  else
    header[sym].default if header[sym]
  end
end
deliver() click to toggle source

Delivers an mail object.

Examples:

mail = Mail.read('file.eml')
mail.deliver
# File lib/mail/message.rb, line 213
def deliver
  inform_interceptors
  if delivery_handler
    delivery_handler.deliver_mail(self) { do_delivery }
  else
    do_delivery
  end
  inform_observers
  self
end
deliver!() click to toggle source

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

It still however fires callbacks to the observers if they are defined.

Returns self

# File lib/mail/message.rb, line 230
def deliver!
  delivery_method.deliver!(self)
  inform_observers
  self
end
delivery_method(method = nil, settings = {}) click to toggle source
# File lib/mail/message.rb, line 236
def delivery_method(method = nil, settings = {})
  unless method
    @delivery_method
  else
    @delivery_method = Mail::Configuration.instance.lookup_delivery_method(method).new(settings)
  end
end
delivery_status_part() click to toggle source

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

# File lib/mail/message.rb, line 1377
def delivery_status_part
  @delivery_stats_part ||= parts.select { |p| p.delivery_status_report_part? }.first
end
delivery_status_report?() click to toggle source

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

# File lib/mail/message.rb, line 1372
def delivery_status_report?
  multipart_report? && content_type_parameters['report-type'] =~ /^delivery-status$/
end
destinations() click to toggle source

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'
# File lib/mail/message.rb, line 1091
def destinations
  [to_addrs, cc_addrs, bcc_addrs].compact.flatten
end
diagnostic_code() click to toggle source
# File lib/mail/message.rb, line 1397
def diagnostic_code
  delivery_status_part and delivery_status_part.diagnostic_code
end
encode!() click to toggle source
# File lib/mail/message.rb, line 1594
def encode!
  STDERR.puts("Deprecated in 1.1.0 in favour of :ready_to_send! as it is less confusing with encoding and decoding.")
  ready_to_send!
end
encoded() click to toggle source

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.

# File lib/mail/message.rb, line 1602
def encoded
  ready_to_send!
  buffer = header.encoded
  buffer << "\r\n"
  buffer << body.encoded
  buffer
end
envelope_date() click to toggle source
# File lib/mail/message.rb, line 340
def envelope_date
  @envelope ? @envelope.date : nil
end
envelope_from() click to toggle source
# File lib/mail/message.rb, line 336
def envelope_from
  @envelope ? @envelope.from : nil
end
error_status() click to toggle source
# File lib/mail/message.rb, line 1393
def error_status
  delivery_status_part and delivery_status_part.error_status
end
filename() click to toggle source

Returns the filename of the attachment

# File lib/mail/message.rb, line 1653
def filename
  find_attachment
end
final_recipient() click to toggle source
# File lib/mail/message.rb, line 1389
def final_recipient
  delivery_status_part and delivery_status_part.final_recipient
end
find_first_mime_type(mt) click to toggle source
# File lib/mail/message.rb, line 1661
def find_first_mime_type(mt)
  all_parts.detect { |p| p.mime_type == mt }
end
from( val = nil ) click to toggle source

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']
# File lib/mail/message.rb, line 547
def from( val = nil )
  default :from, val
end
from=( val ) click to toggle source

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']
# File lib/mail/message.rb, line 559
def from=( val )
  header[:from] = val
end
from_addrs() click to toggle source

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

# File lib/mail/message.rb, line 1097
def from_addrs
  from ? [from].flatten : []
end
has_attachments?() click to toggle source
# File lib/mail/message.rb, line 1457
def has_attachments?
  !attachments.empty?
end
has_charset?() click to toggle source
# File lib/mail/message.rb, line 1229
def has_charset?
  !!charset
end
has_content_transfer_encoding?() click to toggle source
# File lib/mail/message.rb, line 1233
def has_content_transfer_encoding?
  !!content_transfer_encoding
end
has_content_type?() click to toggle source
# File lib/mail/message.rb, line 1225
def has_content_type?
  !!header[:content_type]
end
has_date?() click to toggle source

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

# File lib/mail/message.rb, line 1215
def has_date?
  header.has_date?
end
has_message_id?() click to toggle source

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.

# File lib/mail/message.rb, line 1209
def has_message_id?
  header.has_message_id?
end
has_mime_version?() click to toggle source

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

# File lib/mail/message.rb, line 1221
def has_mime_version?
  header.has_mime_version?
end
header(value = nil) click to toggle source

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...
# File lib/mail/message.rb, line 365
def header(value = nil)
  value ? self.header = value : @header
end
header=(value) click to toggle source

Sets the header of the message object.

Example:

mail.header = 'To: mikel@test.lindsaar.net\r\nFrom: Bob@bob.com'
mail.header #=> <#Mail::Header
# File lib/mail/message.rb, line 350
def header=(value)
  @header = Mail::Header.new(value)
end
header_fields() click to toggle source

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

# File lib/mail/message.rb, line 1203
def header_fields
  header.fields
end
headers(hash = {}) click to toggle source

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

# File lib/mail/message.rb, line 370
def headers(hash = {})
  hash.each_pair do |k,v|
    header[k] = v
  end
end
html_part(&block) click to toggle source

Accessor for html_part

# File lib/mail/message.rb, line 1462
def html_part(&block)
  if block_given?
    @html_part = Mail::Part.new(&block)
    add_multipart_alternate_header unless html_part.blank?
    add_part(@html_part)
  else
    @html_part || find_first_mime_type('text/html')
  end
end
html_part=(msg = nil) click to toggle source

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.

# File lib/mail/message.rb, line 1486
def html_part=(msg = nil)
  if msg
    @html_part = msg
  else
    @html_part = Mail::Part.new('Content-Type: text/html;')
  end
  add_multipart_alternate_header unless text_part.blank?
  add_part(@html_part)
end
in_reply_to( val = nil ) click to toggle source
# File lib/mail/message.rb, line 563
def in_reply_to( val = nil )
  default :in_reply_to, val
end
in_reply_to=( val ) click to toggle source
# File lib/mail/message.rb, line 567
def in_reply_to=( val )
  header[:in_reply_to] = val
end
inform_interceptors() click to toggle source
# File lib/mail/message.rb, line 203
def inform_interceptors
  Mail.inform_interceptors(self)
end
inform_observers() click to toggle source
# File lib/mail/message.rb, line 199
def inform_observers
  Mail.inform_observers(self)
end
inspect() click to toggle source
# File lib/mail/message.rb, line 1614
def inspect
  "#<#{self.class}:#{self.object_id}, Multipart: #{multipart?}, Headers: #{header.field_summary}>"
end
keywords( val = nil ) click to toggle source
# File lib/mail/message.rb, line 571
def keywords( val = nil )
  default :keywords, val
end
keywords=( val ) click to toggle source
# File lib/mail/message.rb, line 575
def keywords=( val )
  header[:keywords] = val
end
main_type() click to toggle source

Returns the main content type

# File lib/mail/message.rb, line 1341
def main_type
  has_content_type? ? header[:content_type].main_type : nil
end
message_content_type() click to toggle source
# File lib/mail/message.rb, line 1320
def message_content_type
  STDERR.puts(":message_content_type is deprecated in Mail 1.4.3.  Please use mime_type\n#{caller}")
  mime_type
end
message_id( val = nil ) click to toggle source

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'
# File lib/mail/message.rb, line 592
def message_id( val = nil )
  default :message_id, val
end
message_id=( val ) click to toggle source

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'
# File lib/mail/message.rb, line 601
def message_id=( val )
  header[:message_id] = val
end
method_missing(name, *args, &block) click to toggle source

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>'
# File lib/mail/message.rb, line 1184
def method_missing(name, *args, &block)
  #:nodoc:
  # Only take the structured fields, as we could take _anything_ really
  # as it could become an optional field... "but therin lies the dark side"
  field_name = underscoreize(name).chomp("=")
  if Mail::Field::KNOWN_FIELDS.include?(field_name)
    if args.empty?
      header[field_name]
    else
      header[field_name] = args.first
    end
  else
    super # otherwise pass it on 
  end 
  #:startdoc:
end
mime_parameters() click to toggle source

Returns the content type parameters

# File lib/mail/message.rb, line 1351
def mime_parameters
  STDERR.puts(':mime_parameters is deprecated in Mail 1.4.3, please use :content_type_parameters instead')
  content_type_parameters
end
mime_type() click to toggle source

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

# File lib/mail/message.rb, line 1316
def mime_type
  content_type ? header[:content_type].string : nil
end
mime_version( val = nil ) click to toggle source

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'
# File lib/mail/message.rb, line 618
def mime_version( val = nil )
  default :mime_version, val
end
mime_version=( val ) click to toggle source

Sets the mime version of the email by accepting a string

Example:

mail.mime_version = '1.0'
mail.mime_version #=> '1.0'
# File lib/mail/message.rb, line 628
def mime_version=( val )
  header[:mime_version] = val
end
multipart?() click to toggle source

Returns true if the message is multipart

# File lib/mail/message.rb, line 1362
def multipart?
  has_content_type? ? !!(main_type =~ /^multipart$/) : false
end
multipart_report?() click to toggle source

Returns true if the message is a multipart/report

# File lib/mail/message.rb, line 1367
def multipart_report?
  multipart? && sub_type =~ /^report$/
end
part(params = {}) click to toggle source

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
# File lib/mail/message.rb, line 1531
def part(params = {})
  new_part = Part.new(params)
  yield new_part if block_given?
  add_part(new_part)
end
parts() click to toggle source

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

# File lib/mail/message.rb, line 1415
def parts
  body.parts
end
raw_envelope() click to toggle source

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

# File lib/mail/message.rb, line 332
def raw_envelope
  @raw_envelope
end
raw_source() click to toggle source

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"
# File lib/mail/message.rb, line 319
def raw_source
  @raw_source
end
read() click to toggle source
# File lib/mail/message.rb, line 1626
def read
  if self.attachment?
    decode_body
  else
    raise NoMethodError, 'Can not call read on a part unless it is an attachment.'
  end
end
ready_to_send!() click to toggle source

Encodes the message, calls encode on all it’s parts, gets an email message ready to send

# File lib/mail/message.rb, line 1589
def ready_to_send!
  parts.each { |part| part.ready_to_send! }
  add_required_fields
end
received( val = nil ) click to toggle source
# File lib/mail/message.rb, line 632
def received( val = nil )
  if val
    header[:received] = val
  else
    header[:received]
  end
end
received=( val ) click to toggle source
# File lib/mail/message.rb, line 640
def received=( val )
  header[:received] = val
end
references( val = nil ) click to toggle source
# File lib/mail/message.rb, line 644
def references( val = nil )
  default :references, val
end
references=( val ) click to toggle source
# File lib/mail/message.rb, line 648
def references=( val )
  header[:references] = val
end
register_for_delivery_notification(observer) click to toggle source
# File lib/mail/message.rb, line 194
def register_for_delivery_notification(observer)
  STDERR.puts("Message#register_for_delivery_notification is deprecated, please call Mail.register_observer instead")
  Mail.register_observer(observer)
end
remote_mta() click to toggle source
# File lib/mail/message.rb, line 1401
def remote_mta
  delivery_status_part and delivery_status_part.remote_mta
end
reply_to( val = nil ) click to toggle source

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']
# File lib/mail/message.rb, line 677
def reply_to( val = nil )
  default :reply_to, val
end
reply_to=( val ) click to toggle source

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']
# File lib/mail/message.rb, line 689
def reply_to=( val )
  header[:reply_to] = val
end
resent_bcc( val = nil ) click to toggle source

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']
# File lib/mail/message.rb, line 718
def resent_bcc( val = nil )
  default :resent_bcc, val
end
resent_bcc=( val ) click to toggle source

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']
# File lib/mail/message.rb, line 730
def resent_bcc=( val )
  header[:resent_bcc] = val
end
resent_cc( val = nil ) click to toggle source

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']
# File lib/mail/message.rb, line 759
def resent_cc( val = nil )
  default :resent_cc, val
end
resent_cc=( val ) click to toggle source

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']
# File lib/mail/message.rb, line 771
def resent_cc=( val )
  header[:resent_cc] = val
end
resent_date( val = nil ) click to toggle source
# File lib/mail/message.rb, line 775
def resent_date( val = nil )
  default :resent_date, val
end
resent_date=( val ) click to toggle source
# File lib/mail/message.rb, line 779
def resent_date=( val )
  header[:resent_date] = val
end
resent_from( val = nil ) click to toggle source

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']
# File lib/mail/message.rb, line 808
def resent_from( val = nil )
  default :resent_from, val
end
resent_from=( val ) click to toggle source

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']
# File lib/mail/message.rb, line 820
def resent_from=( val )
  header[:resent_from] = val
end
resent_message_id( val = nil ) click to toggle source
# File lib/mail/message.rb, line 824
def resent_message_id( val = nil )
  default :resent_message_id, val
end
resent_message_id=( val ) click to toggle source
# File lib/mail/message.rb, line 828
def resent_message_id=( val )
  header[:resent_message_id] = val
end
resent_sender( val = nil ) click to toggle source

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'
# File lib/mail/message.rb, line 847
def resent_sender( val = nil )
  default :resent_sender, val
end
resent_sender=( val ) click to toggle source

Sets the Resent-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'
# File lib/mail/message.rb, line 857
def resent_sender=( val )
  header[:resent_sender] = val
end
resent_to( val = nil ) click to toggle source

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']
# File lib/mail/message.rb, line 886
def resent_to( val = nil )
  default :resent_to, val
end
resent_to=( val ) click to toggle source

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']
# File lib/mail/message.rb, line 898
def resent_to=( val )
  header[:resent_to] = val
end
retryable?() click to toggle source
# File lib/mail/message.rb, line 1405
def retryable?
  delivery_status_part and delivery_status_part.retryable?
end
return_path( val = nil ) click to toggle source

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

# File lib/mail/message.rb, line 903
def return_path( val = nil )
  default :return_path, val
end
return_path=( val ) click to toggle source

Sets the return path of the object

# File lib/mail/message.rb, line 908
def return_path=( val )
  header[:return_path] = val
end
sender( val = nil ) click to toggle source

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'
# File lib/mail/message.rb, line 926
def sender( val = nil )
  default :sender, val
end
sender=( val ) click to toggle source

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'
# File lib/mail/message.rb, line 936
def sender=( val )
  header[:sender] = val
end
set_envelope( val ) click to toggle source

Sets the envelope from for the email

# File lib/mail/message.rb, line 324
def set_envelope( val )
  @raw_envelope = val
  @envelope = Mail::Envelope.new( val )
end
sub_type() click to toggle source

Returns the sub content type

# File lib/mail/message.rb, line 1346
def sub_type
  has_content_type? ? header[:content_type].sub_type : nil
end
subject( val = nil ) click to toggle source

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"
# File lib/mail/message.rb, line 955
def subject( val = nil )
  default :subject, val
end
subject=( val ) click to toggle source

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"
# File lib/mail/message.rb, line 965
def subject=( val )
  header[:subject] = val
end
text_part(&block) click to toggle source

Accessor for text_part

# File lib/mail/message.rb, line 1473
def text_part(&block)
  if block_given?
    @text_part = Mail::Part.new(&block)
    add_multipart_alternate_header unless html_part.blank?
    add_part(@text_part)
  else
    @text_part || find_first_mime_type('text/plain')
  end
end
text_part=(msg = nil) click to toggle source

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.

# File lib/mail/message.rb, line 1499
def text_part=(msg = nil)
  if msg
    @text_part = msg
  else
    @text_part = Mail::Part.new('Content-Type: text/plain;')
  end
  add_multipart_alternate_header unless html_part.blank?
  add_part(@text_part)
end
to( val = nil ) click to toggle source

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']
# File lib/mail/message.rb, line 994
def to( val = nil )
  default :to, val
end
to=( val ) click to toggle source

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']
# File lib/mail/message.rb, line 1006
def to=( val )
  header[:to] = val
end
to_addrs() click to toggle source

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

# File lib/mail/message.rb, line 1103
def to_addrs
  to ? [to].flatten : []
end
to_s() click to toggle source
# File lib/mail/message.rb, line 1610
def to_s
  encoded
end

[Validate]

Generated with the Darkfish Rdoc Generator 2.