Class: Mail::Message

Inherits:
Object
  • 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 contians 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

Constants included from Patterns

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

Instance Attribute Summary collapse

Instance Method Summary collapse

Methods included from Utilities

#atom_safe?, #bracket, #capitalize_field, #constantize, #dasherize, #dquote, #escape_paren, #match_to_s, #paren, #quote_atom, #quote_phrase, #quote_token, #token_safe?, #unbracket, #underscoreize, #unparen, #unquote, #uri_escape, #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 '[email protected]'
       to '[email protected]'
  subject 'This is a test email'
     body File.read('body.txt')
end

mail.to_s #=> "From: [email protected]\r\nTo: you@...

Making an email via passing a string

mail = Mail.new("To: [email protected]\r\nSubject: Hello\r\n\r\nHi there!")
mail.body.to_s #=> 'Hi there!'
mail.subject   #=> 'Hello'
mail.to        #=> '[email protected]'

Making an email from a file

mail = Mail.read('path/to/file.eml')
mail.body.to_s #=> 'Hi there!'
mail.subject   #=> 'Hello'
mail.to        #=> '[email protected]'

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'] = '[email protected]'
mail[:to]    = '[email protected]'
mail.subject 'This is a test email'
mail.body    = 'This is a body'

mail.to_s #=> "From: [email protected]\r\nTo: you@...



98
99
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
 
# File 'lib/mail/message.rb', line 98

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

  @delivery_handler = nil
  
  @delivery_method = Mail.delivery_method.dup
 
  @transport_encoding = Mail::Encodings.get_encoding('7bit')

  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

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



1239
1240
1241
1242
1243
1244
1245
1246
1247
1248
1249
1250
1251
1252
1253
1254
 
# File 'lib/mail/message.rb', line 1239

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

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: [email protected]')
    @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.



168
169
170
 
# File 'lib/mail/message.rb', line 168

def delivery_handler
  @delivery_handler
end

#perform_deliveries ⇒ Object

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



192
193
194
 
# File 'lib/mail/message.rb', line 192

def perform_deliveries
  @perform_deliveries
end

#raise_delivery_errors ⇒ Object

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



199
200
201
 
# File 'lib/mail/message.rb', line 199

def raise_delivery_errors
  @raise_delivery_errors
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]



265
266
267
268
269
270
271
 
# File 'lib/mail/message.rb', line 265

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



304
305
306
307
308
309
310
311
312
313
314
315
316
317
 
# File 'lib/mail/message.rb', line 304

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 = "<#{self_message_id}>" if self_message_id
    other.message_id = "<#{other_message_id}>" if other_message_id
    result
  end
end

#[](name) ⇒ Object

Allows you to read an arbitrary header

Example:

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



1196
1197
1198
 
# File 'lib/mail/message.rb', line 1196

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'



1178
1179
1180
1181
1182
1183
1184
1185
1186
1187
1188
 
# File 'lib/mail/message.rb', line 1178

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

#action ⇒ Object 



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

def action
  delivery_status_part and delivery_status_part.action
end

#add_charset ⇒ Object

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

Otherwise raises a warning



1337
1338
1339
1340
1341
1342
1343
1344
1345
1346
1347
 
# File 'lib/mail/message.rb', line 1337

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

Adds a content transfer encoding

Otherwise raises a warning



1352
1353
1354
1355
1356
1357
1358
1359
1360
 
# File 'lib/mail/message.rb', line 1352

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

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

Otherwise raises a warning



1330
1331
1332
 
# File 'lib/mail/message.rb', line 1330

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.



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

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



1624
1625
1626
1627
1628
1629
1630
1631
1632
1633
1634
1635
 
# File 'lib/mail/message.rb', line 1624

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 = '') ⇒ 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.



1303
1304
1305
 
# File 'lib/mail/message.rb', line 1303

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.



1323
1324
1325
 
# File 'lib/mail/message.rb', line 1323

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



1568
1569
1570
1571
1572
1573
1574
1575
1576
1577
 
# File 'lib/mail/message.rb', line 1568

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

:nodoc:



1362
1363
1364
1365
 
# File 'lib/mail/message.rb', line 1362

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



1718
1719
1720
 
# File 'lib/mail/message.rb', line 1718

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

#attachment ⇒ Object

Returns the attachment data if there is any



1709
1710
1711
 
# File 'lib/mail/message.rb', line 1709

def attachment
  @attachment
end

#attachment? ⇒ Boolean

Returns true if this part is an attachment

Returns:

  • (Boolean) 


1704
1705
1706
 
# File 'lib/mail/message.rb', line 1704

def attachment?
  find_attachment
end

#attachments ⇒ Object

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



1511
1512
1513
 
# File 'lib/mail/message.rb', line 1511

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 <[email protected]>'
mail.bcc #=> ['[email protected]']
mail.bcc = 'Mikel <[email protected]>, [email protected]'
mail.bcc #=> ['[email protected]', '[email protected]']

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

Example:

mail.bcc 'Mikel <[email protected]>'
mail.bcc #=> ['[email protected]']

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

Example:

mail.bcc 'Mikel <[email protected]>'
mail.bcc << '[email protected]'
mail.bcc #=> ['[email protected]', '[email protected]']



430
431
432
 
# File 'lib/mail/message.rb', line 430

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 <[email protected]>'
mail.bcc #=> ['[email protected]']
mail.bcc = 'Mikel <[email protected]>, [email protected]'
mail.bcc #=> ['[email protected]', '[email protected]']



442
443
444
 
# File 'lib/mail/message.rb', line 442

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

#bcc_addrs ⇒ Object

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



1168
1169
1170
 
# File 'lib/mail/message.rb', line 1168

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



1113
1114
1115
1116
1117
1118
1119
1120
 
# File 'lib/mail/message.rb', line 1113

def body(value = nil)
  if value
    self.body = value
    add_encoding_to_body
  else
    @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'



1091
1092
1093
1094
1095
1096
1097
1098
1099
1100
1101
 
# File 'lib/mail/message.rb', line 1091

def body=(value)
  case
  when value == nil
    @body = Mail::Body.new('')
  when @body && @body.multipart?
    @body << Mail::Part.new(value)
  else
    @body = Mail::Body.new(value)
  end
  add_encoding_to_body
end

#body_encoding(value) ⇒ Object 



1122
1123
1124
1125
1126
1127
1128
 
# File 'lib/mail/message.rb', line 1122

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

#body_encoding=(value) ⇒ Object 



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

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

#bounced? ⇒ Boolean

Returns:

  • (Boolean) 


1439
1440
1441
 
# File 'lib/mail/message.rb', line 1439

def bounced?
  delivery_status_part and delivery_status_part.bounced?
end

#boundary ⇒ Object

Returns the current boundary for this message part



1468
1469
1470
 
# File 'lib/mail/message.rb', line 1468

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 <[email protected]>'
mail.cc #=> ['[email protected]']
mail.cc = 'Mikel <[email protected]>, [email protected]'
mail.cc #=> ['[email protected]', '[email protected]']

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

Example:

mail.cc 'Mikel <[email protected]>'
mail.cc #=> ['[email protected]']

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

Example:

mail.cc 'Mikel <[email protected]>'
mail.cc << '[email protected]'
mail.cc #=> ['[email protected]', '[email protected]']



471
472
473
 
# File 'lib/mail/message.rb', line 471

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 <[email protected]>'
mail.cc #=> ['[email protected]']
mail.cc = 'Mikel <[email protected]>, [email protected]'
mail.cc #=> ['[email protected]', '[email protected]']



483
484
485
 
# File 'lib/mail/message.rb', line 483

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

#cc_addrs ⇒ Object

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



1162
1163
1164
 
# File 'lib/mail/message.rb', line 1162

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

#charset ⇒ Object

Returns the character set defined in the content type field



1383
1384
1385
1386
1387
1388
1389
 
# File 'lib/mail/message.rb', line 1383

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

#charset=(value) ⇒ Object

Sets the charset to the supplied value.



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

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

#comments(val = nil) ⇒ Object 



487
488
489
 
# File 'lib/mail/message.rb', line 487

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

#comments=(val) ⇒ Object 



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

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

#content_description(val = nil) ⇒ Object 



495
496
497
 
# File 'lib/mail/message.rb', line 495

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

#content_description=(val) ⇒ Object 



499
500
501
 
# File 'lib/mail/message.rb', line 499

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

#content_disposition(val = nil) ⇒ Object 



503
504
505
 
# File 'lib/mail/message.rb', line 503

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

#content_disposition=(val) ⇒ Object 



507
508
509
 
# File 'lib/mail/message.rb', line 507

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

#content_id(val = nil) ⇒ Object 



511
512
513
 
# File 'lib/mail/message.rb', line 511

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

#content_id=(val) ⇒ Object 



515
516
517
 
# File 'lib/mail/message.rb', line 515

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

#content_location(val = nil) ⇒ Object 



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

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

#content_location=(val) ⇒ Object 



523
524
525
 
# File 'lib/mail/message.rb', line 523

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

#content_transfer_encoding(val = nil) ⇒ Object 



527
528
529
 
# File 'lib/mail/message.rb', line 527

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

#content_transfer_encoding=(val) ⇒ Object 



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

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

#content_type(val = nil) ⇒ Object 



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

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

#content_type=(val) ⇒ Object 



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

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

#content_type_parameters ⇒ Object

Returns the content type parameters



1415
1416
1417
 
# File 'lib/mail/message.rb', line 1415

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

#convert_to_multipart ⇒ Object 



1637
1638
1639
1640
1641
1642
1643
 
# File 'lib/mail/message.rb', line 1637

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



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

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

#date=(val) ⇒ Object 



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

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

#decode_body ⇒ Object 



1699
1700
1701
 
# File 'lib/mail/message.rb', line 1699

def decode_body
    body.decoded
end

#decoded ⇒ Object 



1680
1681
1682
1683
1684
1685
1686
1687
1688
1689
 
# File 'lib/mail/message.rb', line 1680

def decoded
  case
  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.



1058
1059
1060
1061
1062
1063
1064
 
# File 'lib/mail/message.rb', line 1058

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

#deliver ⇒ Object

Delivers an mail object.

Examples:

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



220
221
222
223
224
225
226
227
228
229
 
# File 'lib/mail/message.rb', line 220

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 callbacks to the observers if they are defined.

Returns self



237
238
239
240
241
 
# File 'lib/mail/message.rb', line 237

def deliver!
  delivery_method.deliver!(self)
  inform_observers
  self
end

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



243
244
245
246
247
248
249
 
# File 'lib/mail/message.rb', line 243

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

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



1435
1436
1437
 
# File 'lib/mail/message.rb', line 1435

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;

Returns:

  • (Boolean) 


1430
1431
1432
 
# File 'lib/mail/message.rb', line 1430

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

#destinations ⇒ Object

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 = '[email protected]'
mail.cc = '[email protected]'
mail.bcc = '[email protected]'
mail.destinations.length #=> 3
mail.destinations.first #=> '[email protected]'



1144
1145
1146
 
# File 'lib/mail/message.rb', line 1144

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

#diagnostic_code ⇒ Object 



1455
1456
1457
 
# File 'lib/mail/message.rb', line 1455

def diagnostic_code
  delivery_status_part and delivery_status_part.diagnostic_code
end

#encode! ⇒ Object 



1656
1657
1658
1659
 
# File 'lib/mail/message.rb', line 1656

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

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.



1664
1665
1666
1667
1668
1669
1670
 
# File 'lib/mail/message.rb', line 1664

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

#envelope_date ⇒ Object 



348
349
350
 
# File 'lib/mail/message.rb', line 348

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

#envelope_from ⇒ Object 



344
345
346
 
# File 'lib/mail/message.rb', line 344

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

#error_status ⇒ Object 



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

def error_status
  delivery_status_part and delivery_status_part.error_status
end

#errors ⇒ Object

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.



401
402
403
 
# File 'lib/mail/message.rb', line 401

def errors
  header.errors
end

#filename ⇒ Object

Returns the filename of the attachment



1714
1715
1716
 
# File 'lib/mail/message.rb', line 1714

def filename
  find_attachment
end

#final_recipient ⇒ Object 



1447
1448
1449
 
# File 'lib/mail/message.rb', line 1447

def final_recipient
  delivery_status_part and delivery_status_part.final_recipient
end

#find_first_mime_type(mt) ⇒ Object 



1722
1723
1724
 
# File 'lib/mail/message.rb', line 1722

def find_first_mime_type(mt)
  all_parts.detect { |p| p.mime_type == mt }
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 <[email protected]>'
mail.from #=> ['[email protected]']
mail.from = 'Mikel <[email protected]>, [email protected]'
mail.from #=> ['[email protected]', '[email protected]']

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

Example:

mail.from 'Mikel <[email protected]>'
mail.from #=> ['[email protected]']

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

Example:

mail.from 'Mikel <[email protected]>'
mail.from << '[email protected]'
mail.from #=> ['[email protected]', '[email protected]']



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

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 <[email protected]>'
mail.from #=> ['[email protected]']
mail.from = 'Mikel <[email protected]>, [email protected]'
mail.from #=> ['[email protected]', '[email protected]']



600
601
602
 
# File 'lib/mail/message.rb', line 600

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

#from_addrs ⇒ Object

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



1150
1151
1152
 
# File 'lib/mail/message.rb', line 1150

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

#has_attachments? ⇒ Boolean

Returns:

  • (Boolean) 


1515
1516
1517
 
# File 'lib/mail/message.rb', line 1515

def has_attachments?
  !attachments.empty?
end

#has_charset? ⇒ Boolean

Returns:

  • (Boolean) 


1284
1285
1286
 
# File 'lib/mail/message.rb', line 1284

def has_charset?
  !!(header[:content_type] && header[:content_type].parameters['charset'])
end

#has_content_transfer_encoding? ⇒ Boolean

Returns:

  • (Boolean) 


1288
1289
1290
 
# File 'lib/mail/message.rb', line 1288

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

#has_content_type? ⇒ Boolean

Returns:

  • (Boolean) 


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

def has_content_type?
  !!header[:content_type]
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.

Returns:

  • (Boolean) 


1270
1271
1272
 
# File 'lib/mail/message.rb', line 1270

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.

Returns:

  • (Boolean) 


1264
1265
1266
 
# File 'lib/mail/message.rb', line 1264

def has_message_id?
  header.has_message_id?
end

#has_mime_version? ⇒ 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.

Returns:

  • (Boolean) 


1276
1277
1278
 
# File 'lib/mail/message.rb', line 1276

def has_mime_version?
  header.has_mime_version?
end

#has_transfer_encoding? ⇒ Boolean

:nodoc:

Returns:

  • (Boolean) 


1292
1293
1294
1295
 
# File 'lib/mail/message.rb', line 1292

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



373
374
375
 
# File 'lib/mail/message.rb', line 373

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

#header=(value) ⇒ Object

Sets the header of the message object.

Example:

mail.header = 'To: [email protected]\r\nFrom: [email protected]'
mail.header #=> <#Mail::Header



358
359
360
 
# File 'lib/mail/message.rb', line 358

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

#header_fields ⇒ Object

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



1258
1259
1260
 
# File 'lib/mail/message.rb', line 1258

def header_fields
  header.fields
end

#headers(hash = {}) ⇒ Object

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



378
379
380
381
382
 
# File 'lib/mail/message.rb', line 378

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

#html_part(&block) ⇒ Object

Accessor for html_part



1520
1521
1522
1523
1524
1525
1526
1527
1528
 
# File 'lib/mail/message.rb', line 1520

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



1544
1545
1546
1547
1548
1549
1550
1551
1552
 
# File 'lib/mail/message.rb', line 1544

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



604
605
606
 
# File 'lib/mail/message.rb', line 604

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

#in_reply_to=(val) ⇒ Object 



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

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

#inform_interceptors ⇒ Object 



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

def inform_interceptors
  Mail.inform_interceptors(self)
end

#inform_observers ⇒ Object 



206
207
208
 
# File 'lib/mail/message.rb', line 206

def inform_observers
  Mail.inform_observers(self)
end

#inspect ⇒ Object 



1676
1677
1678
 
# File 'lib/mail/message.rb', line 1676

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

#keywords(val = nil) ⇒ Object 



612
613
614
 
# File 'lib/mail/message.rb', line 612

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

#keywords=(val) ⇒ Object 



616
617
618
 
# File 'lib/mail/message.rb', line 616

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

#main_type ⇒ Object

Returns the main content type



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

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

#message_content_type ⇒ Object 



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

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 = '<[email protected]>'
mail.message_id #=> '[email protected]'

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

mail.message_id '<[email protected]>'
mail.message_id #=> '[email protected]'



633
634
635
 
# File 'lib/mail/message.rb', line 633

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 = '<[email protected]>'
mail.message_id #=> '[email protected]'



642
643
644
 
# File 'lib/mail/message.rb', line 642

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

#mime_parameters ⇒ Object

Returns the content type parameters



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

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

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



1373
1374
1375
 
# File 'lib/mail/message.rb', line 1373

def mime_type
  content_type ? header[:content_type].string : 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'



659
660
661
 
# File 'lib/mail/message.rb', line 659

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'



669
670
671
 
# File 'lib/mail/message.rb', line 669

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

#multipart? ⇒ Boolean

Returns true if the message is multipart

Returns:

  • (Boolean) 


1420
1421
1422
 
# File 'lib/mail/message.rb', line 1420

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

#multipart_report? ⇒ Boolean

Returns true if the message is a multipart/report

Returns:

  • (Boolean) 


1425
1426
1427
 
# File 'lib/mail/message.rb', line 1425

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) 


1589
1590
1591
1592
1593
 
# File 'lib/mail/message.rb', line 1589

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

#parts ⇒ Object

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



1473
1474
1475
 
# File 'lib/mail/message.rb', line 1473

def parts
  body.parts
end

#raw_envelope ⇒ Object

The raw_envelope is the From [email protected] 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



340
341
342
 
# File 'lib/mail/message.rb', line 340

def raw_envelope
  @raw_envelope
end

#raw_source ⇒ Object

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"



327
328
329
 
# File 'lib/mail/message.rb', line 327

def raw_source
  @raw_source
end

#read ⇒ Object 



1691
1692
1693
1694
1695
1696
1697
 
# File 'lib/mail/message.rb', line 1691

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 it’s parts, gets an email message ready to send



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

def ready_to_send!
  identify_and_set_transfer_encoding
  parts.each do |part| 
    part.transport_encoding = transport_encoding
    part.ready_to_send!
  end
  add_required_fields
end

#received(val = nil) ⇒ Object 



673
674
675
676
677
678
679
 
# File 'lib/mail/message.rb', line 673

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

#received=(val) ⇒ Object 



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

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

#references(val = nil) ⇒ Object 



685
686
687
 
# File 'lib/mail/message.rb', line 685

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

#references=(val) ⇒ Object 



689
690
691
 
# File 'lib/mail/message.rb', line 689

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

#register_for_delivery_notification(observer) ⇒ Object 



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

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



1459
1460
1461
 
# File 'lib/mail/message.rb', line 1459

def remote_mta
  delivery_status_part and delivery_status_part.remote_mta
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 <[email protected]>'
mail.reply_to #=> ['[email protected]']
mail.reply_to = 'Mikel <[email protected]>, [email protected]'
mail.reply_to #=> ['[email protected]', '[email protected]']

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

Example:

mail.reply_to 'Mikel <[email protected]>'
mail.reply_to #=> ['[email protected]']

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

Example:

mail.reply_to 'Mikel <[email protected]>'
mail.reply_to << '[email protected]'
mail.reply_to #=> ['[email protected]', '[email protected]']



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

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 <[email protected]>'
mail.reply_to #=> ['[email protected]']
mail.reply_to = 'Mikel <[email protected]>, [email protected]'
mail.reply_to #=> ['[email protected]', '[email protected]']



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

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 <[email protected]>'
mail.resent_bcc #=> ['[email protected]']
mail.resent_bcc = 'Mikel <[email protected]>, [email protected]'
mail.resent_bcc #=> ['[email protected]', '[email protected]']

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

Example:

mail.resent_bcc 'Mikel <[email protected]>'
mail.resent_bcc #=> ['[email protected]']

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

Example:

mail.resent_bcc 'Mikel <[email protected]>'
mail.resent_bcc << '[email protected]'
mail.resent_bcc #=> ['[email protected]', '[email protected]']



759
760
761
 
# File 'lib/mail/message.rb', line 759

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 <[email protected]>'
mail.resent_bcc #=> ['[email protected]']
mail.resent_bcc = 'Mikel <[email protected]>, [email protected]'
mail.resent_bcc #=> ['[email protected]', '[email protected]']



771
772
773
 
# File 'lib/mail/message.rb', line 771

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 <[email protected]>'
mail.resent_cc #=> ['[email protected]']
mail.resent_cc = 'Mikel <[email protected]>, [email protected]'
mail.resent_cc #=> ['[email protected]', '[email protected]']

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

Example:

mail.resent_cc 'Mikel <[email protected]>'
mail.resent_cc #=> ['[email protected]']

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

Example:

mail.resent_cc 'Mikel <[email protected]>'
mail.resent_cc << '[email protected]'
mail.resent_cc #=> ['[email protected]', '[email protected]']



800
801
802
 
# File 'lib/mail/message.rb', line 800

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 <[email protected]>'
mail.resent_cc #=> ['[email protected]']
mail.resent_cc = 'Mikel <[email protected]>, [email protected]'
mail.resent_cc #=> ['[email protected]', '[email protected]']



812
813
814
 
# File 'lib/mail/message.rb', line 812

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

#resent_date(val = nil) ⇒ Object 



816
817
818
 
# File 'lib/mail/message.rb', line 816

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

#resent_date=(val) ⇒ Object 



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

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 <[email protected]>'
mail.resent_from #=> ['[email protected]']
mail.resent_from = 'Mikel <[email protected]>, [email protected]'
mail.resent_from #=> ['[email protected]', '[email protected]']

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

Example:

mail.resent_from ['Mikel <[email protected]>']
mail.resent_from #=> '[email protected]'

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

Example:

mail.resent_from 'Mikel <[email protected]>'
mail.resent_from << '[email protected]'
mail.resent_from #=> ['[email protected]', '[email protected]']



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

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 <[email protected]>'
mail.resent_from #=> ['[email protected]']
mail.resent_from = 'Mikel <[email protected]>, [email protected]'
mail.resent_from #=> ['[email protected]', '[email protected]']



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

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

#resent_message_id(val = nil) ⇒ Object 



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

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

#resent_message_id=(val) ⇒ Object 



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

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 <[email protected]>'
mail.resent_sender #=> '[email protected]'

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

Example:

mail.resent_sender 'Mikel <[email protected]>'
mail.resent_sender #=> '[email protected]'



888
889
890
 
# File 'lib/mail/message.rb', line 888

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.sender = 'Mikel <[email protected]>'
mail.sender #=> '[email protected]'



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

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 <[email protected]>'
mail.resent_to #=> ['[email protected]']
mail.resent_to = 'Mikel <[email protected]>, [email protected]'
mail.resent_to #=> ['[email protected]', '[email protected]']

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

Example:

mail.resent_to 'Mikel <[email protected]>'
mail.resent_to #=> ['[email protected]']

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

Example:

mail.resent_to 'Mikel <[email protected]>'
mail.resent_to << '[email protected]'
mail.resent_to #=> ['[email protected]', '[email protected]']



927
928
929
 
# File 'lib/mail/message.rb', line 927

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 <[email protected]>'
mail.resent_to #=> ['[email protected]']
mail.resent_to = 'Mikel <[email protected]>, [email protected]'
mail.resent_to #=> ['[email protected]', '[email protected]']



939
940
941
 
# File 'lib/mail/message.rb', line 939

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

#retryable? ⇒ Boolean

Returns:

  • (Boolean) 


1463
1464
1465
 
# File 'lib/mail/message.rb', line 1463

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



944
945
946
 
# File 'lib/mail/message.rb', line 944

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

#return_path=(val) ⇒ Object

Sets the return path of the object



949
950
951
 
# File 'lib/mail/message.rb', line 949

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 <[email protected]>'
mail.sender #=> '[email protected]'

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

Example:

mail.sender 'Mikel <[email protected]>'
mail.sender #=> '[email protected]'



967
968
969
 
# File 'lib/mail/message.rb', line 967

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 <[email protected]>'
mail.sender #=> '[email protected]'



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

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

#set_envelope(val) ⇒ Object

Sets the envelope from for the email



332
333
334
335
 
# File 'lib/mail/message.rb', line 332

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

#sub_type ⇒ Object

Returns the sub content type



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

def sub_type
  has_content_type? ? header[:content_type].sub_type : 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"



996
997
998
 
# File 'lib/mail/message.rb', line 996

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"



1006
1007
1008
 
# File 'lib/mail/message.rb', line 1006

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

#text_part(&block) ⇒ Object

Accessor for text_part



1531
1532
1533
1534
1535
1536
1537
1538
1539
 
# File 'lib/mail/message.rb', line 1531

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



1557
1558
1559
1560
1561
1562
1563
1564
1565
 
# File 'lib/mail/message.rb', line 1557

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

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

Example:

mail.to = 'Mikel <[email protected]>'
mail.to #=> ['[email protected]']
mail.to = 'Mikel <[email protected]>, [email protected]'
mail.to #=> ['[email protected]', '[email protected]']

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

Example:

mail.to 'Mikel <[email protected]>'
mail.to #=> ['[email protected]']

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

Example:

mail.to 'Mikel <[email protected]>'
mail.to << '[email protected]'
mail.to #=> ['[email protected]', '[email protected]']



1035
1036
1037
 
# File 'lib/mail/message.rb', line 1035

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 <[email protected]>'
mail.to #=> ['[email protected]']
mail.to = 'Mikel <[email protected]>, [email protected]'
mail.to #=> ['[email protected]', '[email protected]']



1047
1048
1049
 
# File 'lib/mail/message.rb', line 1047

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

#to_addrs ⇒ Object

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



1156
1157
1158
 
# File 'lib/mail/message.rb', line 1156

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

#to_s ⇒ Object 



1672
1673
1674
 
# File 'lib/mail/message.rb', line 1672

def to_s
  encoded
end

#transfer_encoding ⇒ Object

:nodoc:



1367
1368
1369
1370
 
# File 'lib/mail/message.rb', line 1367

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 



551
552
553
554
555
556
557
 
# File 'lib/mail/message.rb', line 551

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

#transport_encoding=(val) ⇒ Object 



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

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