Class: Mail::Message

Inherits:
Object show all
Includes:
Patterns, Utilities
Defined in:
lib/mail/message.rb

Overview

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:

  • A Header object which contains all information and settings of the header of the email

  • Body object which contains all parts of the email that are not part of the header, this includes any attachments, body text, MIME parts etc.

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

Direct Known Subclasses

Part

Constant Summary

Constant Summary

Constants included from Patterns

Patterns::ATOM_UNSAFE, Patterns::CONTROL_CHAR, Patterns::CRLF, Patterns::FIELD_BODY, Patterns::FIELD_LINE, Patterns::FIELD_NAME, Patterns::FIELD_PREFIX, Patterns::FIELD_SPLIT, Patterns::FWS, Patterns::HEADER_LINE, Patterns::HEADER_SPLIT, Patterns::PHRASE_UNSAFE, Patterns::QP_SAFE, Patterns::QP_UNSAFE, Patterns::TEXT, Patterns::TOKEN_UNSAFE, Patterns::WSP

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Methods included from Utilities

#atom_safe?, #bracket, #capitalize_field, #constantize, #dasherize, #dquote, #escape_paren, #map_lines, #map_with_index, #match_to_s, #paren, #quote_atom, #quote_phrase, #quote_token, #token_safe?, #unbracket, #underscoreize, #unparen, #unquote, #uri_escape, #uri_parser, #uri_unescape

Constructor Details

#initialize(*args, &block) ⇒ Message

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


100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
# File 'lib/mail/message.rb', line 100

def initialize(*args, &block)
  @body = nil
  @body_raw = nil
  @separate_parts = false
  @text_part = nil
  @html_part = nil
  @errors = nil
  @header = nil
  @charset = 'UTF-8'
  @defaulted_charset = true

  @smtp_envelope_from = nil
  @smtp_envelope_to = nil

  @perform_deliveries = true
  @raise_delivery_errors = true

  @delivery_handler = nil

  @delivery_method = Mail.delivery_method.dup

  @transport_encoding = Mail::Encodings.get_encoding('7bit')

  @mark_for_delete = false

  if args.flatten.first.respond_to?(:each_pair)
    init_with_hash(args.flatten.first)
  else
    init_with_string(args.flatten[0].to_s)
  end

  if block_given?
    instance_eval(&block)
  end

  self
end

Dynamic Method Handling

This class handles dynamic methods through the method_missing method

#method_missing(name, *args, &block) ⇒ Object

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>'


1357
1358
1359
1360
1361
1362
1363
1364
1365
1366
1367
1368
1369
1370
1371
1372
# File 'lib/mail/message.rb', line 1357

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

Instance Attribute Details

#delivery_handlerObject

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.



177
178
179
# File 'lib/mail/message.rb', line 177

def delivery_handler
  @delivery_handler
end

#perform_deliveriesObject

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



201
202
203
# File 'lib/mail/message.rb', line 201

def perform_deliveries
  @perform_deliveries
end

#raise_delivery_errorsObject

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



208
209
210
# File 'lib/mail/message.rb', line 208

def raise_delivery_errors
  @raise_delivery_errors
end

Class Method Details

.from_hash(hash) ⇒ Object



1865
1866
1867
# File 'lib/mail/message.rb', line 1865

def self.from_hash(hash)
  Mail::Message.new(hash)
end

.from_yaml(str) ⇒ Object



1843
1844
1845
1846
1847
1848
1849
1850
1851
1852
1853
1854
1855
1856
1857
1858
1859
1860
1861
1862
1863
# File 'lib/mail/message.rb', line 1843

def self.from_yaml(str)
  hash = YAML.load(str)
  m = self.new(:headers => hash['headers'])
  hash.delete('headers')
  hash.each do |k,v|
    case
    when k == 'delivery_handler'
      begin
        m.delivery_handler = Object.const_get(v) unless v.blank?
      rescue NameError
      end
    when k == 'transport_encoding'
      m.transport_encoding(v)
    when k == 'multipart_body'
      v.map {|part| m.add_part Mail::Part.from_yaml(part) }
    when k =~ /^@/
      m.instance_variable_set(k.to_sym, v)
    end
  end
  m
end

Instance Method Details

#<=>(other) ⇒ Object

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]


313
314
315
316
317
318
319
# File 'lib/mail/message.rb', line 313

def <=>(other)
  if other.nil?
    1
  else
    self.date <=> other.date
  end
end

#==(other) ⇒ Object

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


352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
# File 'lib/mail/message.rb', line 352

def ==(other)
  return false unless other.respond_to?(:encoded)

  if self.message_id && other.message_id
    self.encoded == other.encoded
  else
    self_message_id, other_message_id = self.message_id, other.message_id
    begin
      self.message_id, other.message_id = '<temp@test>', '<temp@test>'
      self.encoded == other.encoded
    ensure
      self.message_id, other.message_id = self_message_id, other_message_id
    end
  end
end

#[](name) ⇒ Object

Allows you to read an arbitrary header

Example:

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


1314
1315
1316
# File 'lib/mail/message.rb', line 1314

def [](name)
  header[underscoreize(name)]
end

#[]=(name, value) ⇒ Object

Allows you to add an arbitrary header

Example:

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


1296
1297
1298
1299
1300
1301
1302
1303
1304
1305
1306
# File 'lib/mail/message.rb', line 1296

def []=(name, value)
  if name.to_s == 'body'
    self.body = value
  elsif name.to_s =~ /content[-_]type/i
    header[name] = value
  elsif name.to_s == 'charset'
    self.charset = value
  else
    header[name] = value
  end
end

#actionObject



1563
1564
1565
# File 'lib/mail/message.rb', line 1563

def action
  delivery_status_part and delivery_status_part.action
end

#add_charsetObject

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

Otherwise raises a warning



1457
1458
1459
1460
1461
1462
1463
1464
1465
1466
1467
# File 'lib/mail/message.rb', line 1457

def add_charset
  if !body.empty?
    # Only give a warning if this isn't an attachment, has non US-ASCII and the user
    # has not specified an encoding explicitly.
    if @defaulted_charset && body.raw_source.not_ascii_only? && !self.attachment?
      warning = "Non US-ASCII detected and no charset defined.\nDefaulting to UTF-8, set your own if this is incorrect.\n"
      STDERR.puts(warning)
    end
    header[:content_type].parameters['charset'] = @charset
  end
end

#add_content_transfer_encodingObject

Adds a content transfer encoding

Otherwise raises a warning



1472
1473
1474
1475
1476
1477
1478
1479
1480
# File 'lib/mail/message.rb', line 1472

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_typeObject

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

Otherwise raises a warning



1450
1451
1452
# File 'lib/mail/message.rb', line 1450

def add_content_type
  header[:content_type] = 'text/plain'
end

#add_date(date_val = '') ⇒ Object

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.



1433
1434
1435
# File 'lib/mail/message.rb', line 1433

def add_date(date_val = '')
  header['date'] = date_val
end

#add_file(values) ⇒ Object

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



1758
1759
1760
1761
1762
1763
1764
1765
1766
1767
1768
1769
# File 'lib/mail/message.rb', line 1758

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.open(values, 'rb') { |f| f.read }
  else
    basename = values[:filename]
    filedata = values[:content] || File.open(values[:filename], 'rb') { |f| f.read }
  end
  self.attachments[basename] = filedata
end

#add_message_id(msg_id_val = '') ⇒ Object

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.



1423
1424
1425
# File 'lib/mail/message.rb', line 1423

def add_message_id(msg_id_val = '')
  header['message-id'] = msg_id_val
end

#add_mime_version(ver_val = '') ⇒ Object

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.



1443
1444
1445
# File 'lib/mail/message.rb', line 1443

def add_mime_version(ver_val = '')
  header['mime-version'] = ver_val
end

#add_part(part) ⇒ Object

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



1702
1703
1704
1705
1706
1707
1708
1709
1710
1711
# File 'lib/mail/message.rb', line 1702

def add_part(part)
  if !body.multipart? && !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

#add_transfer_encodingObject

:nodoc:



1482
1483
1484
1485
# File 'lib/mail/message.rb', line 1482

def add_transfer_encoding # :nodoc:
  STDERR.puts(":add_transfer_encoding is deprecated in Mail 1.4.3.  Please use add_content_transfer_encoding\n#{caller}")
  add_content_transfer_encoding
end

#all_partsObject



1918
1919
1920
# File 'lib/mail/message.rb', line 1918

def all_parts
  parts.map { |p| [p, p.all_parts] }.flatten
end

#attachmentObject

Returns the attachment data if there is any



1909
1910
1911
# File 'lib/mail/message.rb', line 1909

def attachment
  @attachment
end

#attachment?Boolean

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



1904
1905
1906
# File 'lib/mail/message.rb', line 1904

def attachment?
  !!find_attachment
end

#attachmentsObject

Returns an AttachmentsList object, which holds all of the attachments in the receiver object (either the entire 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)


1631
1632
1633
# File 'lib/mail/message.rb', line 1631

def attachments
  parts.attachments
end

#bcc(val = nil) ⇒ Object

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']


479
480
481
# File 'lib/mail/message.rb', line 479

def bcc( val = nil )
  default :bcc, val
end

#bcc=(val) ⇒ Object

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']


491
492
493
# File 'lib/mail/message.rb', line 491

def bcc=( val )
  header[:bcc] = val
end

#bcc_addrsObject

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



1286
1287
1288
# File 'lib/mail/message.rb', line 1286

def bcc_addrs
  bcc ? [bcc].flatten : []
end

#body(value = nil) ⇒ Object

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


1230
1231
1232
1233
1234
1235
1236
1237
1238
# File 'lib/mail/message.rb', line 1230

def body(value = nil)
  if value
    self.body = value
#        add_encoding_to_body
  else
    process_body_raw if @body_raw
    @body
  end
end

#body=(value) ⇒ Object

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'


1216
1217
1218
# File 'lib/mail/message.rb', line 1216

def body=(value)
  body_lazy(value)
end

#body_encoding(value) ⇒ Object



1240
1241
1242
1243
1244
1245
1246
# File 'lib/mail/message.rb', line 1240

def body_encoding(value)
  if value.nil?
    body.encoding
  else
    body.encoding = value
  end
end

#body_encoding=(value) ⇒ Object



1248
1249
1250
# File 'lib/mail/message.rb', line 1248

def body_encoding=(value)
    body.encoding = value
end

#bounced?Boolean



1559
1560
1561
# File 'lib/mail/message.rb', line 1559

def bounced?
  delivery_status_part and delivery_status_part.bounced?
end

#boundaryObject

Returns the current boundary for this message part



1588
1589
1590
# File 'lib/mail/message.rb', line 1588

def boundary
  content_type_parameters ? content_type_parameters['boundary'] : nil
end

#cc(val = nil) ⇒ Object

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']


520
521
522
# File 'lib/mail/message.rb', line 520

def cc( val = nil )
  default :cc, val
end

#cc=(val) ⇒ Object

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']


532
533
534
# File 'lib/mail/message.rb', line 532

def cc=( val )
  header[:cc] = val
end

#cc_addrsObject

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



1280
1281
1282
# File 'lib/mail/message.rb', line 1280

def cc_addrs
  cc ? [cc].flatten : []
end

#charsetObject

Returns the character set defined in the content type field



1503
1504
1505
1506
1507
1508
1509
# File 'lib/mail/message.rb', line 1503

def charset
  if @header
    has_content_type? ? content_type_parameters['charset'] : @charset
  else
    @charset
  end
end

#charset=(value) ⇒ Object

Sets the charset to the supplied value.



1512
1513
1514
1515
1516
# File 'lib/mail/message.rb', line 1512

def charset=(value)
  @defaulted_charset = false
  @charset = value
  @header.charset = value
end

#comments(val = nil) ⇒ Object



536
537
538
# File 'lib/mail/message.rb', line 536

def comments( val = nil )
  default :comments, val
end

#comments=(val) ⇒ Object



540
541
542
# File 'lib/mail/message.rb', line 540

def comments=( val )
  header[:comments] = val
end

#content_description(val = nil) ⇒ Object



544
545
546
# File 'lib/mail/message.rb', line 544

def content_description( val = nil )
  default :content_description, val
end

#content_description=(val) ⇒ Object



548
549
550
# File 'lib/mail/message.rb', line 548

def content_description=( val )
  header[:content_description] = val
end

#content_disposition(val = nil) ⇒ Object



552
553
554
# File 'lib/mail/message.rb', line 552

def content_disposition( val = nil )
  default :content_disposition, val
end

#content_disposition=(val) ⇒ Object



556
557
558
# File 'lib/mail/message.rb', line 556

def content_disposition=( val )
  header[:content_disposition] = val
end

#content_id(val = nil) ⇒ Object



560
561
562
# File 'lib/mail/message.rb', line 560

def content_id( val = nil )
  default :content_id, val
end

#content_id=(val) ⇒ Object



564
565
566
# File 'lib/mail/message.rb', line 564

def content_id=( val )
  header[:content_id] = val
end

#content_location(val = nil) ⇒ Object



568
569
570
# File 'lib/mail/message.rb', line 568

def content_location( val = nil )
  default :content_location, val
end

#content_location=(val) ⇒ Object



572
573
574
# File 'lib/mail/message.rb', line 572

def content_location=( val )
  header[:content_location] = val
end

#content_transfer_encoding(val = nil) ⇒ Object



576
577
578
# File 'lib/mail/message.rb', line 576

def content_transfer_encoding( val = nil )
  default :content_transfer_encoding, val
end

#content_transfer_encoding=(val) ⇒ Object



580
581
582
# File 'lib/mail/message.rb', line 580

def content_transfer_encoding=( val )
  header[:content_transfer_encoding] = val
end

#content_type(val = nil) ⇒ Object



584
585
586
# File 'lib/mail/message.rb', line 584

def content_type( val = nil )
  default :content_type, val
end

#content_type=(val) ⇒ Object



588
589
590
# File 'lib/mail/message.rb', line 588

def content_type=( val )
  header[:content_type] = val
end

#content_type_parametersObject

Returns the content type parameters



1535
1536
1537
# File 'lib/mail/message.rb', line 1535

def content_type_parameters
  has_content_type? ? header[:content_type].parameters : nil rescue nil
end

#convert_to_multipartObject



1771
1772
1773
1774
1775
1776
1777
1778
# File 'lib/mail/message.rb', line 1771

def convert_to_multipart
  text = body.decoded
  self.body = ''
  text_part = Mail::Part.new({:content_type => 'text/plain;',
                              :body => text})
  text_part.charset = charset unless @defaulted_charset
  self.body << text_part
end

#date(val = nil) ⇒ Object



592
593
594
# File 'lib/mail/message.rb', line 592

def date( val = nil )
  default :date, val
end

#date=(val) ⇒ Object



596
597
598
# File 'lib/mail/message.rb', line 596

def date=( val )
  header[:date] = val
end

#decode_bodyObject



1898
1899
1900
# File 'lib/mail/message.rb', line 1898

def decode_body
  body.decoded
end

#decodedObject



1877
1878
1879
1880
1881
1882
1883
1884
1885
1886
1887
1888
# File 'lib/mail/message.rb', line 1877

def decoded
  case
  when self.text?
    decode_body_as_text
  when self.attachment?
    decode_body
  when !self.multipart?
    body.decoded
  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) ⇒ Object

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.



1183
1184
1185
1186
1187
1188
1189
# File 'lib/mail/message.rb', line 1183

def default( sym, val = nil )
  if val
    header[sym] = val
  else
    header[sym].default if header[sym]
  end
end

#deliverObject

Delivers an mail object.

Examples:

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


229
230
231
232
233
234
235
236
237
238
# File 'lib/mail/message.rb', line 229

def deliver
  inform_interceptors
  if delivery_handler
    delivery_handler.deliver_mail(self) { do_delivery }
  else
    do_delivery
  end
  inform_observers
  self
end

#deliver!Object

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

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

Returns self



246
247
248
249
250
251
# File 'lib/mail/message.rb', line 246

def deliver!
  inform_interceptors
  response = delivery_method.deliver!(self)
  inform_observers
  delivery_method.settings[:return_response] ? response : self
end

#delivery_method(method = nil, settings = {}) ⇒ Object



253
254
255
256
257
258
259
# File 'lib/mail/message.rb', line 253

def delivery_method(method = nil, settings = {})
  unless method
    @delivery_method
  else
    @delivery_method = Configuration.instance.lookup_delivery_method(method).new(settings)
  end
end

#delivery_status_partObject

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



1555
1556
1557
# File 'lib/mail/message.rb', line 1555

def delivery_status_part
  @delivery_stats_part ||= parts.select { |p| p.delivery_status_report_part? }.first
end

#delivery_status_report?Boolean

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



1550
1551
1552
# File 'lib/mail/message.rb', line 1550

def delivery_status_report?
  multipart_report? && content_type_parameters['report-type'] =~ /^delivery-status$/i
end

#destinationsObject

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'


1262
1263
1264
# File 'lib/mail/message.rb', line 1262

def destinations
  [to_addrs, cc_addrs, bcc_addrs].compact.flatten
end

#diagnostic_codeObject



1575
1576
1577
# File 'lib/mail/message.rb', line 1575

def diagnostic_code
  delivery_status_part and delivery_status_part.diagnostic_code
end

#encode!Object



1792
1793
1794
1795
# File 'lib/mail/message.rb', line 1792

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

#encodedObject

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.



1800
1801
1802
1803
1804
1805
1806
# File 'lib/mail/message.rb', line 1800

def encoded
  ready_to_send!
  buffer = header.encoded
  buffer << "\r\n"
  buffer << body.encoded(content_transfer_encoding)
  buffer
end

#envelope_dateObject



397
398
399
# File 'lib/mail/message.rb', line 397

def envelope_date
  @envelope ? @envelope.date : nil
end

#envelope_fromObject



393
394
395
# File 'lib/mail/message.rb', line 393

def envelope_from
  @envelope ? @envelope.from : nil
end

#error_statusObject



1571
1572
1573
# File 'lib/mail/message.rb', line 1571

def error_status
  delivery_status_part and delivery_status_part.error_status
end

#errorsObject

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.



450
451
452
# File 'lib/mail/message.rb', line 450

def errors
  header.errors
end

#filenameObject

Returns the filename of the attachment



1914
1915
1916
# File 'lib/mail/message.rb', line 1914

def filename
  find_attachment
end

#final_recipientObject



1567
1568
1569
# File 'lib/mail/message.rb', line 1567

def final_recipient
  delivery_status_part and delivery_status_part.final_recipient
end

#find_first_mime_type(mt) ⇒ Object



1922
1923
1924
# File 'lib/mail/message.rb', line 1922

def find_first_mime_type(mt)
  all_parts.detect { |p| p.mime_type == mt && !p.attachment? }
end

#from(val = nil) ⇒ Object

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']


637
638
639
# File 'lib/mail/message.rb', line 637

def from( val = nil )
  default :from, val
end

#from=(val) ⇒ Object

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']


649
650
651
# File 'lib/mail/message.rb', line 649

def from=( val )
  header[:from] = val
end

#from_addrsObject

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



1268
1269
1270
# File 'lib/mail/message.rb', line 1268

def from_addrs
  from ? [from].flatten : []
end

#has_attachments?Boolean



1635
1636
1637
# File 'lib/mail/message.rb', line 1635

def has_attachments?
  !attachments.empty?
end

#has_charset?Boolean



1403
1404
1405
1406
# File 'lib/mail/message.rb', line 1403

def has_charset?
  tmp = header[:content_type].parameters rescue nil
  !!(has_content_type? && tmp && tmp['charset'])
end

#has_content_transfer_encoding?Boolean



1408
1409
1410
# File 'lib/mail/message.rb', line 1408

def has_content_transfer_encoding?
  header[:content_transfer_encoding] && header[:content_transfer_encoding].errors.blank?
end

#has_content_type?Boolean



1398
1399
1400
1401
# File 'lib/mail/message.rb', line 1398

def has_content_type?
  tmp = header[:content_type].main_type rescue nil
  !!tmp
end

#has_date?Boolean

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



1388
1389
1390
# File 'lib/mail/message.rb', line 1388

def has_date?
  header.has_date?
end

#has_message_id?Boolean

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.



1382
1383
1384
# File 'lib/mail/message.rb', line 1382

def has_message_id?
  header.has_message_id?
end

#has_mime_version?Boolean

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



1394
1395
1396
# File 'lib/mail/message.rb', line 1394

def has_mime_version?
  header.has_mime_version?
end

#has_transfer_encoding?Boolean

:nodoc:



1412
1413
1414
1415
# File 'lib/mail/message.rb', line 1412

def has_transfer_encoding? # :nodoc:
  STDERR.puts(":has_transfer_encoding? is deprecated in Mail 1.4.3.  Please use has_content_transfer_encoding?\n#{caller}")
  has_content_transfer_encoding?
end

#header(value = nil) ⇒ Object

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


422
423
424
# File 'lib/mail/message.rb', line 422

def header(value = nil)
  value ? self.header = value : @header
end

#header=(value) ⇒ Object

Sets the header of the message object.

Example:

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


407
408
409
# File 'lib/mail/message.rb', line 407

def header=(value)
  @header = Mail::Header.new(value, charset)
end

#header_fieldsObject

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



1376
1377
1378
# File 'lib/mail/message.rb', line 1376

def header_fields
  header.fields
end

#headers(hash = {}) ⇒ Object

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



427
428
429
430
431
# File 'lib/mail/message.rb', line 427

def headers(hash = {})
  hash.each_pair do |k,v|
    header[k] = v
  end
end

#html_part(&block) ⇒ Object

Accessor for html_part



1640
1641
1642
1643
1644
1645
1646
# File 'lib/mail/message.rb', line 1640

def html_part(&block)
  if block_given?
    self.html_part = Mail::Part.new(:content_type => 'text/html', &block)
  else
    @html_part || find_first_mime_type('text/html')
  end
end

#html_part=(msg) ⇒ Object

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.



1660
1661
1662
1663
1664
1665
1666
1667
1668
1669
1670
1671
1672
1673
1674
1675
1676
1677
# File 'lib/mail/message.rb', line 1660

def html_part=(msg)
  # Assign the html part and set multipart/alternative if there's a text part.
  if msg
    @html_part = msg
    @html_part.content_type = 'text/html' unless @html_part.has_content_type?
    add_multipart_alternate_header if text_part
    add_part @html_part

  # If nil, delete the html part and back out of multipart/alternative.
  elsif @html_part
    parts.delete_if { |p| p.object_id == @html_part.object_id }
    @html_part = nil
    if text_part
      self.content_type = nil
      body.boundary = nil
    end
  end
end

#in_reply_to(val = nil) ⇒ Object



653
654
655
# File 'lib/mail/message.rb', line 653

def in_reply_to( val = nil )
  default :in_reply_to, val
end

#in_reply_to=(val) ⇒ Object



657
658
659
# File 'lib/mail/message.rb', line 657

def in_reply_to=( val )
  header[:in_reply_to] = val
end

#inform_interceptorsObject



219
220
221
# File 'lib/mail/message.rb', line 219

def inform_interceptors
  Mail.inform_interceptors(self)
end

#inform_observersObject



215
216
217
# File 'lib/mail/message.rb', line 215

def inform_observers
  Mail.inform_observers(self)
end

#inspectObject



1873
1874
1875
# File 'lib/mail/message.rb', line 1873

def inspect
  "#<#{self.class}:#{self.object_id}, Multipart: #{multipart?}, Headers: #{header.field_summary}>"
end

#is_marked_for_delete?Boolean

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.



1951
1952
1953
# File 'lib/mail/message.rb', line 1951

def is_marked_for_delete?
  return @mark_for_delete
end

#keywords(val = nil) ⇒ Object



661
662
663
# File 'lib/mail/message.rb', line 661

def keywords( val = nil )
  default :keywords, val
end

#keywords=(val) ⇒ Object



665
666
667
# File 'lib/mail/message.rb', line 665

def keywords=( val )
  header[:keywords] = val
end

#main_typeObject

Returns the main content type



1519
1520
1521
# File 'lib/mail/message.rb', line 1519

def main_type
  has_content_type? ? header[:content_type].main_type : nil rescue nil
end

#mark_for_delete=(value = true) ⇒ Object

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.



1938
1939
1940
# File 'lib/mail/message.rb', line 1938

def mark_for_delete=(value = true)
  @mark_for_delete = value
end

#message_content_typeObject



1497
1498
1499
1500
# File 'lib/mail/message.rb', line 1497

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) ⇒ Object

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'


682
683
684
# File 'lib/mail/message.rb', line 682

def message_id( val = nil )
  default :message_id, val
end

#message_id=(val) ⇒ Object

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'


691
692
693
# File 'lib/mail/message.rb', line 691

def message_id=( val )
  header[:message_id] = val
end

#mime_parametersObject

Returns the content type parameters



1529
1530
1531
1532
# File 'lib/mail/message.rb', line 1529

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_typeObject

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



1493
1494
1495
# File 'lib/mail/message.rb', line 1493

def mime_type
  has_content_type? ? header[:content_type].string : nil rescue nil
end

#mime_version(val = nil) ⇒ Object

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'


708
709
710
# File 'lib/mail/message.rb', line 708

def mime_version( val = nil )
  default :mime_version, val
end

#mime_version=(val) ⇒ Object

Sets the MIME version of the email by accepting a string

Example:

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


718
719
720
# File 'lib/mail/message.rb', line 718

def mime_version=( val )
  header[:mime_version] = val
end

#multipart?Boolean

Returns true if the message is multipart



1540
1541
1542
# File 'lib/mail/message.rb', line 1540

def multipart?
  has_content_type? ? !!(main_type =~ /^multipart$/i) : false
end

#multipart_report?Boolean

Returns true if the message is a multipart/report



1545
1546
1547
# File 'lib/mail/message.rb', line 1545

def multipart_report?
  multipart? && sub_type =~ /^report$/i
end

#part(params = {}) {|new_part| ... } ⇒ Object

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

Yields:

  • (new_part)


1723
1724
1725
1726
1727
# File 'lib/mail/message.rb', line 1723

def part(params = {})
  new_part = Part.new(params)
  yield new_part if block_given?
  add_part(new_part)
end

#partsObject

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



1593
1594
1595
# File 'lib/mail/message.rb', line 1593

def parts
  body.parts
end

#raw_envelopeObject

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



389
390
391
# File 'lib/mail/message.rb', line 389

def raw_envelope
  @raw_envelope
end

#raw_sourceObject

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"


376
377
378
# File 'lib/mail/message.rb', line 376

def raw_source
  @raw_source
end

#readObject



1890
1891
1892
1893
1894
1895
1896
# File 'lib/mail/message.rb', line 1890

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!Object

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



1782
1783
1784
1785
1786
1787
1788
1789
1790
# File 'lib/mail/message.rb', line 1782

def ready_to_send!
  identify_and_set_transfer_encoding
  parts.sort!([ "text/plain", "text/enriched", "text/html", "multipart/alternative" ])
  parts.each do |part|
    part.transport_encoding = transport_encoding
    part.ready_to_send!
  end
  add_required_fields
end

#received(val = nil) ⇒ Object



722
723
724
725
726
727
728
# File 'lib/mail/message.rb', line 722

def received( val = nil )
  if val
    header[:received] = val
  else
    header[:received]
  end
end

#received=(val) ⇒ Object



730
731
732
# File 'lib/mail/message.rb', line 730

def received=( val )
  header[:received] = val
end

#references(val = nil) ⇒ Object



734
735
736
# File 'lib/mail/message.rb', line 734

def references( val = nil )
  default :references, val
end

#references=(val) ⇒ Object



738
739
740
# File 'lib/mail/message.rb', line 738

def references=( val )
  header[:references] = val
end

#register_for_delivery_notification(observer) ⇒ Object



210
211
212
213
# File 'lib/mail/message.rb', line 210

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_mtaObject



1579
1580
1581
# File 'lib/mail/message.rb', line 1579

def remote_mta
  delivery_status_part and delivery_status_part.remote_mta
end

#reply(*args, &block) ⇒ Object



261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
# File 'lib/mail/message.rb', line 261

def reply(*args, &block)
  self.class.new.tap do |reply|
    if message_id
      bracketed_message_id = "<#{message_id}>"
      reply.in_reply_to = bracketed_message_id
      if !references.nil?
        refs = [references].flatten.map { |r| "<#{r}>" }
        refs << bracketed_message_id
        reply.references = refs.join(' ')
      elsif !in_reply_to.nil? && !in_reply_to.kind_of?(Array)
        reply.references = "<#{in_reply_to}> #{bracketed_message_id}"
      end
      reply.references ||= bracketed_message_id
    end
    if subject
      reply.subject = subject =~ /^Re:/i ? subject : "RE: #{subject}"
    end
    if reply_to || from
      reply.to = self[reply_to ? :reply_to : :from].to_s
    end
    if to
      reply.from = self[:to].formatted.first.to_s
    end

    unless args.empty?
      if args.flatten.first.respond_to?(:each_pair)
        reply.send(:init_with_hash, args.flatten.first)
      else
        reply.send(:init_with_string, args.flatten[0].to_s.strip)
      end
    end

    if block_given?
      reply.instance_eval(&block)
    end
  end
end

#reply_to(val = nil) ⇒ Object

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']


767
768
769
# File 'lib/mail/message.rb', line 767

def reply_to( val = nil )
  default :reply_to, val
end

#reply_to=(val) ⇒ Object

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']


779
780
781
# File 'lib/mail/message.rb', line 779

def reply_to=( val )
  header[:reply_to] = val
end

#resent_bcc(val = nil) ⇒ Object

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']


808
809
810
# File 'lib/mail/message.rb', line 808

def resent_bcc( val = nil )
  default :resent_bcc, val
end

#resent_bcc=(val) ⇒ Object

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']


820
821
822
# File 'lib/mail/message.rb', line 820

def resent_bcc=( val )
  header[:resent_bcc] = val
end

#resent_cc(val = nil) ⇒ Object

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']


849
850
851
# File 'lib/mail/message.rb', line 849

def resent_cc( val = nil )
  default :resent_cc, val
end

#resent_cc=(val) ⇒ Object

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']


861
862
863
# File 'lib/mail/message.rb', line 861

def resent_cc=( val )
  header[:resent_cc] = val
end

#resent_date(val = nil) ⇒ Object



865
866
867
# File 'lib/mail/message.rb', line 865

def resent_date( val = nil )
  default :resent_date, val
end

#resent_date=(val) ⇒ Object



869
870
871
# File 'lib/mail/message.rb', line 869

def resent_date=( val )
  header[:resent_date] = val
end

#resent_from(val = nil) ⇒ Object

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']


898
899
900
# File 'lib/mail/message.rb', line 898

def resent_from( val = nil )
  default :resent_from, val
end

#resent_from=(val) ⇒ Object

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']


910
911
912
# File 'lib/mail/message.rb', line 910

def resent_from=( val )
  header[:resent_from] = val
end

#resent_message_id(val = nil) ⇒ Object



914
915
916
# File 'lib/mail/message.rb', line 914

def resent_message_id( val = nil )
  default :resent_message_id, val
end

#resent_message_id=(val) ⇒ Object



918
919
920
# File 'lib/mail/message.rb', line 918

def resent_message_id=( val )
  header[:resent_message_id] = val
end

#resent_sender(val = nil) ⇒ Object

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'


937
938
939
# File 'lib/mail/message.rb', line 937

def resent_sender( val = nil )
  default :resent_sender, val
end

#resent_sender=(val) ⇒ Object

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'


947
948
949
# File 'lib/mail/message.rb', line 947

def resent_sender=( val )
  header[:resent_sender] = val
end

#resent_to(val = nil) ⇒ Object

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']


976
977
978
# File 'lib/mail/message.rb', line 976

def resent_to( val = nil )
  default :resent_to, val
end

#resent_to=(val) ⇒ Object

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']


988
989
990
# File 'lib/mail/message.rb', line 988

def resent_to=( val )
  header[:resent_to] = val
end

#retryable?Boolean



1583
1584
1585
# File 'lib/mail/message.rb', line 1583

def retryable?
  delivery_status_part and delivery_status_part.retryable?
end

#return_path(val = nil) ⇒ Object

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



993
994
995
# File 'lib/mail/message.rb', line 993

def return_path( val = nil )
  default :return_path, val
end

#return_path=(val) ⇒ Object

Sets the return path of the object



998
999
1000
# File 'lib/mail/message.rb', line 998

def return_path=( val )
  header[:return_path] = val
end

#sender(val = nil) ⇒ 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'


1016
1017
1018
# File 'lib/mail/message.rb', line 1016

def sender( val = nil )
  default :sender, val
end

#sender=(val) ⇒ Object

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'


1026
1027
1028
# File 'lib/mail/message.rb', line 1026

def sender=( val )
  header[:sender] = val
end

#set_envelope(val) ⇒ Object

Sets the envelope from for the email



381
382
383
384
# File 'lib/mail/message.rb', line 381

def set_envelope( val )
  @raw_envelope = val
  @envelope = Mail::Envelope.new( val )
end

#skip_deletionObject

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.



1930
1931
1932
# File 'lib/mail/message.rb', line 1930

def skip_deletion
  @mark_for_delete = false
end

#smtp_envelope_from(val = nil) ⇒ Object

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'


1046
1047
1048
1049
1050
1051
1052
# File 'lib/mail/message.rb', line 1046

def smtp_envelope_from( val = nil )
  if val
    self.smtp_envelope_from = val
  else
    @smtp_envelope_from || return_path || sender || from_addrs.first
  end
end

#smtp_envelope_from=(val) ⇒ Object

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'


1060
1061
1062
# File 'lib/mail/message.rb', line 1060

def smtp_envelope_from=( val )
  @smtp_envelope_from = val
end

#smtp_envelope_to(val = nil) ⇒ Object

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']


1079
1080
1081
1082
1083
1084
1085
# File 'lib/mail/message.rb', line 1079

def smtp_envelope_to( val = nil )
  if val
    self.smtp_envelope_to = val
  else
    @smtp_envelope_to || destinations
  end
end

#smtp_envelope_to=(val) ⇒ Object

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']


1096
1097
1098
1099
1100
1101
1102
1103
1104
# File 'lib/mail/message.rb', line 1096

def smtp_envelope_to=( val )
  @smtp_envelope_to =
    case val
    when Array, NilClass
      val
    else
      [val]
    end
end

#sub_typeObject

Returns the sub content type



1524
1525
1526
# File 'lib/mail/message.rb', line 1524

def sub_type
  has_content_type? ? header[:content_type].sub_type : nil rescue nil
end

#subject(val = nil) ⇒ Object

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"


1121
1122
1123
# File 'lib/mail/message.rb', line 1121

def subject( val = nil )
  default :subject, val
end

#subject=(val) ⇒ Object

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"


1131
1132
1133
# File 'lib/mail/message.rb', line 1131

def subject=( val )
  header[:subject] = val
end

#text?Boolean



1955
1956
1957
# File 'lib/mail/message.rb', line 1955

def text?
  has_content_type? ? !!(main_type =~ /^text$/i) : false
end

#text_part(&block) ⇒ Object

Accessor for text_part



1649
1650
1651
1652
1653
1654
1655
# File 'lib/mail/message.rb', line 1649

def text_part(&block)
  if block_given?
    self.text_part = Mail::Part.new(:content_type => 'text/plain', &block)
  else
    @text_part || find_first_mime_type('text/plain')
  end
end

#text_part=(msg) ⇒ Object

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.



1682
1683
1684
1685
1686
1687
1688
1689
1690
1691
1692
1693
1694
1695
1696
1697
1698
1699
# File 'lib/mail/message.rb', line 1682

def text_part=(msg)
  # Assign the text part and set multipart/alternative if there's an html part.
  if msg
    @text_part = msg
    @text_part.content_type = 'text/plain' unless @text_part.has_content_type?
    add_multipart_alternate_header if html_part
    add_part @text_part

  # If nil, delete the text part and back out of multipart/alternative.
  elsif @text_part
    parts.delete_if { |p| p.object_id == @text_part.object_id }
    @text_part = nil
    if html_part
      self.content_type = nil
      body.boundary = nil
    end
  end
end

#to(val = nil) ⇒ Object

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']


1160
1161
1162
# File 'lib/mail/message.rb', line 1160

def to( val = nil )
  default :to, val
end

#to=(val) ⇒ Object

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']


1172
1173
1174
# File 'lib/mail/message.rb', line 1172

def to=( val )
  header[:to] = val
end

#to_addrsObject

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



1274
1275
1276
# File 'lib/mail/message.rb', line 1274

def to_addrs
  to ? [to].flatten : []
end

#to_sObject



1869
1870
1871
# File 'lib/mail/message.rb', line 1869

def to_s
  encoded
end

#to_yaml(opts = {}) ⇒ Object



1823
1824
1825
1826
1827
1828
1829
1830
1831
1832
1833
1834
1835
1836
1837
1838
1839
1840
1841
# File 'lib/mail/message.rb', line 1823

def to_yaml(opts = {})
  hash = {}
  hash['headers'] = {}
  header.fields.each do |field|
    hash['headers'][field.name] = field.value
  end
  hash['delivery_handler'] = delivery_handler.to_s if delivery_handler
  hash['transport_encoding'] = transport_encoding.to_s
  special_variables = [:@header, :@delivery_handler, :@transport_encoding]
  if multipart?
    hash['multipart_body'] = []
    body.parts.map { |part| hash['multipart_body'] << part.to_yaml }
    special_variables.push(:@body, :@text_part, :@html_part)
  end
  (instance_variables.map(&:to_sym) - special_variables).each do |var|
    hash[var.to_s] = instance_variable_get(var)
  end
  hash.to_yaml(opts)
end

#transfer_encodingObject

:nodoc:



1487
1488
1489
1490
# File 'lib/mail/message.rb', line 1487

def transfer_encoding # :nodoc:
  STDERR.puts(":transfer_encoding is deprecated in Mail 1.4.3.  Please use content_transfer_encoding\n#{caller}")
  content_transfer_encoding
end

#transport_encoding(val = nil) ⇒ Object



600
601
602
603
604
605
606
# File 'lib/mail/message.rb', line 600

def transport_encoding( val = nil)
  if val
    self.transport_encoding = val
  else
    @transport_encoding
  end
end

#transport_encoding=(val) ⇒ Object



608
609
610
# File 'lib/mail/message.rb', line 608

def transport_encoding=( val )
  @transport_encoding = Mail::Encodings.get_encoding(val)
end

#without_attachments!Object



1808
1809
1810
1811
1812
1813
1814
1815
1816
1817
1818
1819
1820
1821
# File 'lib/mail/message.rb', line 1808

def without_attachments!
  return self unless has_attachments?

  parts.delete_if { |p| p.attachment? }
  body_raw = if parts.empty?
               ''
             else
               body.encoded
             end

  @body = Mail::Body.new(body_raw)

  self
end