Class: Mail::Message
- 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
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
-
#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.
-
#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.
-
#raise_delivery_errors ⇒ Object
If set to false, mail will silently catch and ignore any exceptions raised through attempting to deliver an email.
Class Method Summary collapse
Instance Method Summary collapse
-
#<=>(other) ⇒ Object
Provides the operator needed for sort et al.
-
#==(other) ⇒ Object
Two emails are the same if they have the same fields and body contents.
-
#[](name) ⇒ Object
Allows you to read an arbitrary header.
-
#[]=(name, value) ⇒ Object
Allows you to add an arbitrary header.
- #action ⇒ Object
-
#add_charset ⇒ Object
Adds a content type and charset if the body is US-ASCII.
-
#add_content_transfer_encoding ⇒ Object
Adds a content transfer encoding.
-
#add_content_type ⇒ Object
Adds a content type and charset if the body is US-ASCII.
-
#add_date(date_val = '') ⇒ Object
Creates a new empty Date field and inserts it in the correct order into the Header.
-
#add_file(values) ⇒ Object
Adds a file to the message.
-
#add_message_id(msg_id_val = '') ⇒ Object
Creates a new empty Message-ID field and inserts it in the correct order into the Header.
-
#add_mime_version(ver_val = '') ⇒ Object
Creates a new empty Mime Version field and inserts it in the correct order into the Header.
-
#add_part(part) ⇒ Object
Adds a part to the parts list or creates the part list.
-
#add_transfer_encoding ⇒ Object
:nodoc:.
- #all_parts ⇒ Object
-
#attachment ⇒ Object
Returns the attachment data if there is any.
-
#attachment? ⇒ Boolean
Returns true if this part is an attachment, false otherwise.
-
#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.
-
#bcc(val = nil) ⇒ Object
Returns the Bcc value of the mail object as an array of strings of address specs.
-
#bcc=(val) ⇒ Object
Sets the Bcc value of the mail object, pass in a string of the field.
-
#bcc_addrs ⇒ Object
Returns an array of addresses (the encoded value) in the Bcc field, if no Bcc field, returns an empty array.
-
#body(value = nil) ⇒ Object
Returns the body of the message object.
-
#body=(value) ⇒ Object
Sets the body object of the message object.
- #body_encoding(value) ⇒ Object
- #body_encoding=(value) ⇒ Object
- #bounced? ⇒ Boolean
-
#boundary ⇒ Object
Returns the current boundary for this message part.
-
#cc(val = nil) ⇒ Object
Returns the Cc value of the mail object as an array of strings of address specs.
-
#cc=(val) ⇒ Object
Sets the Cc value of the mail object, pass in a string of the field.
-
#cc_addrs ⇒ Object
Returns an array of addresses (the encoded value) in the Cc field, if no Cc field, returns an empty array.
-
#charset ⇒ Object
Returns the character set defined in the content type field.
-
#charset=(value) ⇒ Object
Sets the charset to the supplied value.
- #comments(val = nil) ⇒ Object
- #comments=(val) ⇒ Object
- #content_description(val = nil) ⇒ Object
- #content_description=(val) ⇒ Object
- #content_disposition(val = nil) ⇒ Object
- #content_disposition=(val) ⇒ Object
- #content_id(val = nil) ⇒ Object
- #content_id=(val) ⇒ Object
- #content_location(val = nil) ⇒ Object
- #content_location=(val) ⇒ Object
- #content_transfer_encoding(val = nil) ⇒ Object
- #content_transfer_encoding=(val) ⇒ Object
- #content_type(val = nil) ⇒ Object
- #content_type=(val) ⇒ Object
-
#content_type_parameters ⇒ Object
Returns the content type parameters.
- #convert_to_multipart ⇒ Object
- #date(val = nil) ⇒ Object
- #date=(val) ⇒ Object
- #decode_body ⇒ Object
- #decoded ⇒ Object
-
#default(sym, val = nil) ⇒ Object
Returns the default value of the field requested as a symbol.
-
#deliver ⇒ Object
Delivers an mail object.
-
#deliver! ⇒ Object
This method bypasses checking perform_deliveries and raise_delivery_errors, so use with caution.
- #delivery_method(method = nil, settings = {}) ⇒ Object
-
#delivery_status_part ⇒ Object
returns the part in a multipart/report email that has the content-type delivery-status.
-
#delivery_status_report? ⇒ Boolean
Returns true if the message is a multipart/report; report-type=delivery-status;.
-
#destinations ⇒ Object
Returns the list of addresses this message should be sent to by collecting the addresses off the to, cc and bcc fields.
- #diagnostic_code ⇒ Object
- #encode! ⇒ Object
-
#encoded ⇒ Object
Outputs an encoded string representation of the mail message including all headers, attachments, etc.
- #envelope_date ⇒ Object
- #envelope_from ⇒ Object
- #error_status ⇒ Object
-
#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.
-
#filename ⇒ Object
Returns the filename of the attachment.
- #final_recipient ⇒ Object
- #find_first_mime_type(mt) ⇒ Object
-
#from(val = nil) ⇒ Object
Returns the From value of the mail object as an array of strings of address specs.
-
#from=(val) ⇒ Object
Sets the From value of the mail object, pass in a string of the field.
-
#from_addrs ⇒ Object
Returns an array of addresses (the encoded value) in the From field, if no From field, returns an empty array.
- #has_attachments? ⇒ Boolean
- #has_charset? ⇒ Boolean
- #has_content_transfer_encoding? ⇒ Boolean
- #has_content_type? ⇒ Boolean
-
#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.
-
#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.
-
#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.
-
#has_transfer_encoding? ⇒ Boolean
:nodoc:.
-
#header(value = nil) ⇒ Object
Returns the header object of the message object.
-
#header=(value) ⇒ Object
Sets the header of the message object.
-
#header_fields ⇒ Object
Returns an FieldList of all the fields in the header in the order that they appear in the header.
-
#headers(hash = {}) ⇒ Object
Provides a way to set custom headers, by passing in a hash.
-
#html_part(&block) ⇒ Object
Accessor for html_part.
-
#html_part=(msg = nil) ⇒ Object
Helper to add a html part to a multipart/alternative email.
- #in_reply_to(val = nil) ⇒ Object
- #in_reply_to=(val) ⇒ Object
- #inform_interceptors ⇒ Object
- #inform_observers ⇒ Object
-
#initialize(*args, &block) ⇒ Message
constructor
Making an email.
- #inspect ⇒ Object
-
#is_marked_for_delete? ⇒ Boolean
Returns whether message will be marked for deletion.
- #keywords(val = nil) ⇒ Object
- #keywords=(val) ⇒ Object
-
#main_type ⇒ Object
Returns the main content type.
-
#mark_for_delete=(value = true) ⇒ Object
Sets whether this message should be deleted at session close (i.e. after #find).
- #message_content_type ⇒ Object
-
#message_id(val = nil) ⇒ Object
Returns the Message-ID of the mail object.
-
#message_id=(val) ⇒ Object
Sets the Message-ID.
-
#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.
-
#mime_parameters ⇒ Object
Returns the content type parameters.
-
#mime_type ⇒ Object
Returns the MIME media type of part we are on, this is taken from the content-type header.
-
#mime_version(val = nil) ⇒ Object
Returns the MIME version of the email as a string.
-
#mime_version=(val) ⇒ Object
Sets the MIME version of the email by accepting a string.
-
#multipart? ⇒ Boolean
Returns true if the message is multipart.
-
#multipart_report? ⇒ Boolean
Returns true if the message is a multipart/report.
-
#part(params = {}) {|new_part| ... } ⇒ Object
Allows you to add a part in block form to an existing mail message object.
-
#parts ⇒ Object
Returns a parts list object of all the parts in the message.
-
#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.
-
#raw_source ⇒ Object
Provides access to the raw source of the message as it was when it was instantiated.
- #read ⇒ Object
-
#ready_to_send! ⇒ Object
Encodes the message, calls encode on all it’s parts, gets an email message ready to send.
- #received(val = nil) ⇒ Object
- #received=(val) ⇒ Object
- #references(val = nil) ⇒ Object
- #references=(val) ⇒ Object
- #register_for_delivery_notification(observer) ⇒ Object
- #remote_mta ⇒ Object
- #reply(*args, &block) ⇒ Object
-
#reply_to(val = nil) ⇒ Object
Returns the Reply-To value of the mail object as an array of strings of address specs.
-
#reply_to=(val) ⇒ Object
Sets the Reply-To value of the mail object, pass in a string of the field.
-
#resent_bcc(val = nil) ⇒ Object
Returns the Resent-Bcc value of the mail object as an array of strings of address specs.
-
#resent_bcc=(val) ⇒ Object
Sets the Resent-Bcc value of the mail object, pass in a string of the field.
-
#resent_cc(val = nil) ⇒ Object
Returns the Resent-Cc value of the mail object as an array of strings of address specs.
-
#resent_cc=(val) ⇒ Object
Sets the Resent-Cc value of the mail object, pass in a string of the field.
- #resent_date(val = nil) ⇒ Object
- #resent_date=(val) ⇒ Object
-
#resent_from(val = nil) ⇒ Object
Returns the Resent-From value of the mail object as an array of strings of address specs.
-
#resent_from=(val) ⇒ Object
Sets the Resent-From value of the mail object, pass in a string of the field.
- #resent_message_id(val = nil) ⇒ Object
- #resent_message_id=(val) ⇒ Object
-
#resent_sender(val = nil) ⇒ Object
Returns the Resent-Sender value of the mail object, as a single string of an address spec.
-
#resent_sender=(val) ⇒ Object
Sets the Resent-Sender value of the mail object, pass in a string of the field.
-
#resent_to(val = nil) ⇒ Object
Returns the Resent-To value of the mail object as an array of strings of address specs.
-
#resent_to=(val) ⇒ Object
Sets the Resent-To value of the mail object, pass in a string of the field.
- #retryable? ⇒ Boolean
-
#return_path(val = nil) ⇒ Object
Returns the return path of the mail object, or sets it if you pass a string.
-
#return_path=(val) ⇒ Object
Sets the return path of the object.
-
#sender(val = nil) ⇒ Object
Returns the Sender value of the mail object, as a single string of an address spec.
-
#sender=(val) ⇒ Object
Sets the Sender value of the mail object, pass in a string of the field.
-
#set_envelope(val) ⇒ Object
Sets the envelope from for the email.
-
#skip_deletion ⇒ Object
Skips the deletion of this message.
-
#sub_type ⇒ Object
Returns the sub content type.
-
#subject(val = nil) ⇒ Object
Returns the decoded value of the subject field, as a single string.
-
#subject=(val) ⇒ Object
Sets the Subject value of the mail object, pass in a string of the field.
- #text? ⇒ Boolean
-
#text_part(&block) ⇒ Object
Accessor for text_part.
-
#text_part=(msg = nil) ⇒ Object
Helper to add a text part to a multipart/alternative email.
-
#to(val = nil) ⇒ Object
Returns the To value of the mail object as an array of strings of address specs.
-
#to=(val) ⇒ Object
Sets the To value of the mail object, pass in a string of the field.
-
#to_addrs ⇒ Object
Returns an array of addresses (the encoded value) in the To field, if no To field, returns an empty array.
- #to_s ⇒ Object
- #to_yaml(opts = {}) ⇒ Object
-
#transfer_encoding ⇒ Object
:nodoc:.
- #transport_encoding(val = nil) ⇒ Object
- #transport_encoding=(val) ⇒ Object
- #without_attachments! ⇒ Object
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 '[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:
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@...
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 |
# 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 @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.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>'
1277 1278 1279 1280 1281 1282 1283 1284 1285 1286 1287 1288 1289 1290 1291 1292 |
# File 'lib/mail/message.rb', line 1277 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.
174 175 176 |
# File 'lib/mail/message.rb', line 174 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
198 199 200 |
# File 'lib/mail/message.rb', line 198 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
205 206 207 |
# File 'lib/mail/message.rb', line 205 def raise_delivery_errors @raise_delivery_errors end |
Class Method Details
.from_hash(hash) ⇒ Object
1771 1772 1773 |
# File 'lib/mail/message.rb', line 1771 def self.from_hash(hash) Mail::Message.new(hash) end |
.from_yaml(str) ⇒ Object
1749 1750 1751 1752 1753 1754 1755 1756 1757 1758 1759 1760 1761 1762 1763 1764 1765 1766 1767 1768 1769 |
# File 'lib/mail/message.rb', line 1749 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]
310 311 312 313 314 315 316 |
# File 'lib/mail/message.rb', line 310 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
349 350 351 352 353 354 355 356 357 358 359 360 361 362 |
# File 'lib/mail/message.rb', line 349 def ==(other) return false unless other.respond_to?(:encoded) if self. && other. result = (self.encoded == other.encoded) else , = self., other. self., other. = '<temp@test>', '<temp@test>' result = self.encoded == other.encoded self. = "<#{}>" if other. = "<#{}>" if result end end |
#[](name) ⇒ Object
Allows you to read an arbitrary header
Example:
mail['foo'] = '1234'
mail['foo'].to_s #=> '1234'
1234 1235 1236 |
# File 'lib/mail/message.rb', line 1234 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'
1216 1217 1218 1219 1220 1221 1222 1223 1224 1225 1226 |
# File 'lib/mail/message.rb', line 1216 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
1483 1484 1485 |
# File 'lib/mail/message.rb', line 1483 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
1377 1378 1379 1380 1381 1382 1383 1384 1385 1386 1387 |
# File 'lib/mail/message.rb', line 1377 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. 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
1392 1393 1394 1395 1396 1397 1398 1399 1400 |
# File 'lib/mail/message.rb', line 1392 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
1370 1371 1372 |
# File 'lib/mail/message.rb', line 1370 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.
1353 1354 1355 |
# File 'lib/mail/message.rb', line 1353 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
1664 1665 1666 1667 1668 1669 1670 1671 1672 1673 1674 1675 |
# File 'lib/mail/message.rb', line 1664 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.[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.
1343 1344 1345 |
# File 'lib/mail/message.rb', line 1343 def (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.
1363 1364 1365 |
# File 'lib/mail/message.rb', line 1363 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
1608 1609 1610 1611 1612 1613 1614 1615 1616 1617 |
# File 'lib/mail/message.rb', line 1608 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:
1402 1403 1404 1405 |
# File 'lib/mail/message.rb', line 1402 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
1824 1825 1826 |
# File 'lib/mail/message.rb', line 1824 def all_parts parts.map { |p| [p, p.all_parts] }.flatten end |
#attachment ⇒ Object
Returns the attachment data if there is any
1815 1816 1817 |
# File 'lib/mail/message.rb', line 1815 def @attachment end |
#attachment? ⇒ Boolean
Returns true if this part is an attachment, false otherwise.
1810 1811 1812 |
# File 'lib/mail/message.rb', line 1810 def !! 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.['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.['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.['filename.jpg'] = {:mime_type => 'application/x-gzip',
:encoding => 'SpecialEncoding',
:content => file_content }
You can also search for specific attachments:
# By Filename
mail.['filename.jpg'] #=> Mail::Part object or nil
# or by index
mail.[0] #=> Mail::Part (first attachment)
1551 1552 1553 |
# File 'lib/mail/message.rb', line 1551 def parts. 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]']
475 476 477 |
# File 'lib/mail/message.rb', line 475 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]']
487 488 489 |
# File 'lib/mail/message.rb', line 487 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
1206 1207 1208 |
# File 'lib/mail/message.rb', line 1206 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...
1150 1151 1152 1153 1154 1155 1156 1157 1158 |
# File 'lib/mail/message.rb', line 1150 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'
1136 1137 1138 |
# File 'lib/mail/message.rb', line 1136 def body=(value) body_lazy(value) end |
#body_encoding(value) ⇒ Object
1160 1161 1162 1163 1164 1165 1166 |
# File 'lib/mail/message.rb', line 1160 def body_encoding(value) if value.nil? body.encoding else body.encoding = value end end |
#body_encoding=(value) ⇒ Object
1168 1169 1170 |
# File 'lib/mail/message.rb', line 1168 def body_encoding=(value) body.encoding = value end |
#bounced? ⇒ Boolean
1479 1480 1481 |
# File 'lib/mail/message.rb', line 1479 def bounced? delivery_status_part and delivery_status_part.bounced? end |
#boundary ⇒ Object
Returns the current boundary for this message part
1508 1509 1510 |
# File 'lib/mail/message.rb', line 1508 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]']
516 517 518 |
# File 'lib/mail/message.rb', line 516 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]']
528 529 530 |
# File 'lib/mail/message.rb', line 528 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
1200 1201 1202 |
# File 'lib/mail/message.rb', line 1200 def cc_addrs cc ? [cc].flatten : [] end |
#charset ⇒ Object
Returns the character set defined in the content type field
1423 1424 1425 1426 1427 1428 1429 |
# File 'lib/mail/message.rb', line 1423 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.
1432 1433 1434 1435 1436 |
# File 'lib/mail/message.rb', line 1432 def charset=(value) @defaulted_charset = false @charset = value @header.charset = value end |
#comments(val = nil) ⇒ Object
532 533 534 |
# File 'lib/mail/message.rb', line 532 def comments( val = nil ) default :comments, val end |
#comments=(val) ⇒ Object
536 537 538 |
# File 'lib/mail/message.rb', line 536 def comments=( val ) header[:comments] = val end |
#content_description(val = nil) ⇒ Object
540 541 542 |
# File 'lib/mail/message.rb', line 540 def content_description( val = nil ) default :content_description, val end |
#content_description=(val) ⇒ Object
544 545 546 |
# File 'lib/mail/message.rb', line 544 def content_description=( val ) header[:content_description] = val end |
#content_disposition(val = nil) ⇒ Object
548 549 550 |
# File 'lib/mail/message.rb', line 548 def content_disposition( val = nil ) default :content_disposition, val end |
#content_disposition=(val) ⇒ Object
552 553 554 |
# File 'lib/mail/message.rb', line 552 def content_disposition=( val ) header[:content_disposition] = val end |
#content_id(val = nil) ⇒ Object
556 557 558 |
# File 'lib/mail/message.rb', line 556 def content_id( val = nil ) default :content_id, val end |
#content_id=(val) ⇒ Object
560 561 562 |
# File 'lib/mail/message.rb', line 560 def content_id=( val ) header[:content_id] = val end |
#content_location(val = nil) ⇒ Object
564 565 566 |
# File 'lib/mail/message.rb', line 564 def content_location( val = nil ) default :content_location, val end |
#content_location=(val) ⇒ Object
568 569 570 |
# File 'lib/mail/message.rb', line 568 def content_location=( val ) header[:content_location] = val end |
#content_transfer_encoding(val = nil) ⇒ Object
572 573 574 |
# File 'lib/mail/message.rb', line 572 def content_transfer_encoding( val = nil ) default :content_transfer_encoding, val end |
#content_transfer_encoding=(val) ⇒ Object
576 577 578 |
# File 'lib/mail/message.rb', line 576 def content_transfer_encoding=( val ) header[:content_transfer_encoding] = val end |
#content_type(val = nil) ⇒ Object
580 581 582 |
# File 'lib/mail/message.rb', line 580 def content_type( val = nil ) default :content_type, val end |
#content_type=(val) ⇒ Object
584 585 586 |
# File 'lib/mail/message.rb', line 584 def content_type=( val ) header[:content_type] = val end |
#content_type_parameters ⇒ Object
Returns the content type parameters
1455 1456 1457 |
# File 'lib/mail/message.rb', line 1455 def content_type_parameters has_content_type? ? header[:content_type].parameters : nil rescue nil end |
#convert_to_multipart ⇒ Object
1677 1678 1679 1680 1681 1682 1683 1684 |
# File 'lib/mail/message.rb', line 1677 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
588 589 590 |
# File 'lib/mail/message.rb', line 588 def date( val = nil ) default :date, val end |
#date=(val) ⇒ Object
592 593 594 |
# File 'lib/mail/message.rb', line 592 def date=( val ) header[:date] = val end |
#decode_body ⇒ Object
1804 1805 1806 |
# File 'lib/mail/message.rb', line 1804 def decode_body body.decoded end |
#decoded ⇒ Object
1783 1784 1785 1786 1787 1788 1789 1790 1791 1792 1793 1794 |
# File 'lib/mail/message.rb', line 1783 def decoded case when self.text? decode_body_as_text when self. 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.
1103 1104 1105 1106 1107 1108 1109 |
# File 'lib/mail/message.rb', line 1103 def default( sym, val = nil ) if val header[sym] = val else header[sym].default if header[sym] end end |
#deliver ⇒ Object
226 227 228 229 230 231 232 233 234 235 |
# File 'lib/mail/message.rb', line 226 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 intercepters and calls the observers callbacks if they are defined.
Returns self
243 244 245 246 247 248 |
# File 'lib/mail/message.rb', line 243 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
250 251 252 253 254 255 256 |
# File 'lib/mail/message.rb', line 250 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_part ⇒ Object
returns the part in a multipart/report email that has the content-type delivery-status
1475 1476 1477 |
# File 'lib/mail/message.rb', line 1475 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;
1470 1471 1472 |
# File 'lib/mail/message.rb', line 1470 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]'
1182 1183 1184 |
# File 'lib/mail/message.rb', line 1182 def destinations [to_addrs, cc_addrs, bcc_addrs].compact.flatten end |
#diagnostic_code ⇒ Object
1495 1496 1497 |
# File 'lib/mail/message.rb', line 1495 def diagnostic_code delivery_status_part and delivery_status_part.diagnostic_code end |
#encode! ⇒ Object
1698 1699 1700 1701 |
# File 'lib/mail/message.rb', line 1698 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.
1706 1707 1708 1709 1710 1711 1712 |
# File 'lib/mail/message.rb', line 1706 def encoded ready_to_send! buffer = header.encoded buffer << "\r\n" buffer << body.encoded(content_transfer_encoding) buffer end |
#envelope_date ⇒ Object
393 394 395 |
# File 'lib/mail/message.rb', line 393 def envelope_date @envelope ? @envelope.date : nil end |
#envelope_from ⇒ Object
389 390 391 |
# File 'lib/mail/message.rb', line 389 def envelope_from @envelope ? @envelope.from : nil end |
#error_status ⇒ Object
1491 1492 1493 |
# File 'lib/mail/message.rb', line 1491 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:
= Mail.new("Content-Transfer-Encoding: weirdo\r\n")
.errors.size #=> 1
.errors.first[0] #=> "Content-Transfer-Encoding"
.errors.first[1] #=> "weirdo"
.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.
446 447 448 |
# File 'lib/mail/message.rb', line 446 def errors header.errors end |
#filename ⇒ Object
Returns the filename of the attachment
1820 1821 1822 |
# File 'lib/mail/message.rb', line 1820 def filename end |
#final_recipient ⇒ Object
1487 1488 1489 |
# File 'lib/mail/message.rb', line 1487 def final_recipient delivery_status_part and delivery_status_part.final_recipient end |
#find_first_mime_type(mt) ⇒ Object
1828 1829 1830 |
# File 'lib/mail/message.rb', line 1828 def find_first_mime_type(mt) all_parts.detect { |p| p.mime_type == mt && !p. } 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]']
633 634 635 |
# File 'lib/mail/message.rb', line 633 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]']
645 646 647 |
# File 'lib/mail/message.rb', line 645 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
1188 1189 1190 |
# File 'lib/mail/message.rb', line 1188 def from_addrs from ? [from].flatten : [] end |
#has_attachments? ⇒ Boolean
1555 1556 1557 |
# File 'lib/mail/message.rb', line 1555 def !.empty? end |
#has_charset? ⇒ Boolean
1323 1324 1325 1326 |
# File 'lib/mail/message.rb', line 1323 def has_charset? tmp = header[:content_type].parameters rescue nil !!(has_content_type? && tmp && tmp['charset']) end |
#has_content_transfer_encoding? ⇒ Boolean
1328 1329 1330 |
# File 'lib/mail/message.rb', line 1328 def has_content_transfer_encoding? header[:content_transfer_encoding] && header[:content_transfer_encoding].errors.blank? end |
#has_content_type? ⇒ Boolean
1318 1319 1320 1321 |
# File 'lib/mail/message.rb', line 1318 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.
1308 1309 1310 |
# File 'lib/mail/message.rb', line 1308 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.
1302 1303 1304 |
# File 'lib/mail/message.rb', line 1302 def header. 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.
1314 1315 1316 |
# File 'lib/mail/message.rb', line 1314 def has_mime_version? header.has_mime_version? end |
#has_transfer_encoding? ⇒ Boolean
:nodoc:
1332 1333 1334 1335 |
# File 'lib/mail/message.rb', line 1332 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...
418 419 420 |
# File 'lib/mail/message.rb', line 418 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
403 404 405 |
# File 'lib/mail/message.rb', line 403 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
1296 1297 1298 |
# File 'lib/mail/message.rb', line 1296 def header_fields header.fields end |
#headers(hash = {}) ⇒ Object
Provides a way to set custom headers, by passing in a hash
423 424 425 426 427 |
# File 'lib/mail/message.rb', line 423 def headers(hash = {}) hash.each_pair do |k,v| header[k] = v end end |
#html_part(&block) ⇒ Object
Accessor for html_part
1560 1561 1562 1563 1564 1565 1566 1567 1568 |
# File 'lib/mail/message.rb', line 1560 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.
1584 1585 1586 1587 1588 1589 1590 1591 1592 |
# File 'lib/mail/message.rb', line 1584 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
649 650 651 |
# File 'lib/mail/message.rb', line 649 def in_reply_to( val = nil ) default :in_reply_to, val end |
#in_reply_to=(val) ⇒ Object
653 654 655 |
# File 'lib/mail/message.rb', line 653 def in_reply_to=( val ) header[:in_reply_to] = val end |
#inform_interceptors ⇒ Object
216 217 218 |
# File 'lib/mail/message.rb', line 216 def inform_interceptors Mail.inform_interceptors(self) end |
#inform_observers ⇒ Object
212 213 214 |
# File 'lib/mail/message.rb', line 212 def inform_observers Mail.inform_observers(self) end |
#inspect ⇒ Object
1779 1780 1781 |
# File 'lib/mail/message.rb', line 1779 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.
1857 1858 1859 |
# File 'lib/mail/message.rb', line 1857 def is_marked_for_delete? return @mark_for_delete end |
#keywords(val = nil) ⇒ Object
657 658 659 |
# File 'lib/mail/message.rb', line 657 def keywords( val = nil ) default :keywords, val end |
#keywords=(val) ⇒ Object
661 662 663 |
# File 'lib/mail/message.rb', line 661 def keywords=( val ) header[:keywords] = val end |
#main_type ⇒ Object
Returns the main content type
1439 1440 1441 |
# File 'lib/mail/message.rb', line 1439 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.
1844 1845 1846 |
# File 'lib/mail/message.rb', line 1844 def mark_for_delete=(value = true) @mark_for_delete = value end |
#message_content_type ⇒ Object
1417 1418 1419 1420 |
# File 'lib/mail/message.rb', line 1417 def 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. = '<[email protected]>'
mail. #=> '[email protected]'
Also allows you to set the Message-ID by passing a string as a parameter
mail. '<[email protected]>'
mail. #=> '[email protected]'
678 679 680 |
# File 'lib/mail/message.rb', line 678 def ( 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. = '<[email protected]>'
mail. #=> '[email protected]'
687 688 689 |
# File 'lib/mail/message.rb', line 687 def ( val ) header[:message_id] = val end |
#mime_parameters ⇒ Object
Returns the content type parameters
1449 1450 1451 1452 |
# File 'lib/mail/message.rb', line 1449 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
1413 1414 1415 |
# File 'lib/mail/message.rb', line 1413 def mime_type 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'
704 705 706 |
# File 'lib/mail/message.rb', line 704 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'
714 715 716 |
# File 'lib/mail/message.rb', line 714 def mime_version=( val ) header[:mime_version] = val end |
#multipart? ⇒ Boolean
Returns true if the message is multipart
1460 1461 1462 |
# File 'lib/mail/message.rb', line 1460 def multipart? has_content_type? ? !!(main_type =~ /^multipart$/i) : false end |
#multipart_report? ⇒ Boolean
Returns true if the message is a multipart/report
1465 1466 1467 |
# File 'lib/mail/message.rb', line 1465 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
1629 1630 1631 1632 1633 |
# File 'lib/mail/message.rb', line 1629 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
1513 1514 1515 |
# File 'lib/mail/message.rb', line 1513 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
385 386 387 |
# File 'lib/mail/message.rb', line 385 def raw_envelope @raw_envelope end |
#raw_source ⇒ Object
372 373 374 |
# File 'lib/mail/message.rb', line 372 def raw_source @raw_source end |
#read ⇒ Object
1796 1797 1798 1799 1800 1801 1802 |
# File 'lib/mail/message.rb', line 1796 def read if self. 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
1688 1689 1690 1691 1692 1693 1694 1695 1696 |
# File 'lib/mail/message.rb', line 1688 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
718 719 720 721 722 723 724 |
# File 'lib/mail/message.rb', line 718 def received( val = nil ) if val header[:received] = val else header[:received] end end |
#received=(val) ⇒ Object
726 727 728 |
# File 'lib/mail/message.rb', line 726 def received=( val ) header[:received] = val end |
#references(val = nil) ⇒ Object
730 731 732 |
# File 'lib/mail/message.rb', line 730 def references( val = nil ) default :references, val end |
#references=(val) ⇒ Object
734 735 736 |
# File 'lib/mail/message.rb', line 734 def references=( val ) header[:references] = val end |
#register_for_delivery_notification(observer) ⇒ Object
207 208 209 210 |
# File 'lib/mail/message.rb', line 207 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
1499 1500 1501 |
# File 'lib/mail/message.rb', line 1499 def remote_mta delivery_status_part and delivery_status_part.remote_mta end |
#reply(*args, &block) ⇒ Object
258 259 260 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 |
# File 'lib/mail/message.rb', line 258 def reply(*args, &block) self.class.new.tap do |reply| if = "<#{}>" reply.in_reply_to = if !references.nil? refs = [references].flatten.map { |r| "<#{r}>" } refs << reply.references = refs.join(' ') elsif !in_reply_to.nil? && !in_reply_to.kind_of?(Array) reply.references = "<#{in_reply_to}> #{}" end reply.references ||= 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 <[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]']
763 764 765 |
# File 'lib/mail/message.rb', line 763 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]']
775 776 777 |
# File 'lib/mail/message.rb', line 775 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]']
804 805 806 |
# File 'lib/mail/message.rb', line 804 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]']
816 817 818 |
# File 'lib/mail/message.rb', line 816 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]']
845 846 847 |
# File 'lib/mail/message.rb', line 845 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]']
857 858 859 |
# File 'lib/mail/message.rb', line 857 def resent_cc=( val ) header[:resent_cc] = val end |
#resent_date(val = nil) ⇒ Object
861 862 863 |
# File 'lib/mail/message.rb', line 861 def resent_date( val = nil ) default :resent_date, val end |
#resent_date=(val) ⇒ Object
865 866 867 |
# File 'lib/mail/message.rb', line 865 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]']
894 895 896 |
# File 'lib/mail/message.rb', line 894 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]']
906 907 908 |
# File 'lib/mail/message.rb', line 906 def resent_from=( val ) header[:resent_from] = val end |
#resent_message_id(val = nil) ⇒ Object
910 911 912 |
# File 'lib/mail/message.rb', line 910 def ( val = nil ) default :resent_message_id, val end |
#resent_message_id=(val) ⇒ Object
914 915 916 |
# File 'lib/mail/message.rb', line 914 def ( 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]'
933 934 935 |
# File 'lib/mail/message.rb', line 933 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]'
943 944 945 |
# File 'lib/mail/message.rb', line 943 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]']
972 973 974 |
# File 'lib/mail/message.rb', line 972 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]']
984 985 986 |
# File 'lib/mail/message.rb', line 984 def resent_to=( val ) header[:resent_to] = val end |
#retryable? ⇒ Boolean
1503 1504 1505 |
# File 'lib/mail/message.rb', line 1503 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
989 990 991 |
# File 'lib/mail/message.rb', line 989 def return_path( val = nil ) default :return_path, val end |
#return_path=(val) ⇒ Object
Sets the return path of the object
994 995 996 |
# File 'lib/mail/message.rb', line 994 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]'
1012 1013 1014 |
# File 'lib/mail/message.rb', line 1012 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]'
1022 1023 1024 |
# File 'lib/mail/message.rb', line 1022 def sender=( val ) header[:sender] = val end |
#set_envelope(val) ⇒ Object
Sets the envelope from for the email
377 378 379 380 |
# File 'lib/mail/message.rb', line 377 def set_envelope( val ) @raw_envelope = val @envelope = Mail::Envelope.new( val ) end |
#skip_deletion ⇒ Object
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.
1836 1837 1838 |
# File 'lib/mail/message.rb', line 1836 def skip_deletion @mark_for_delete = false end |
#sub_type ⇒ Object
Returns the sub content type
1444 1445 1446 |
# File 'lib/mail/message.rb', line 1444 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"
1041 1042 1043 |
# File 'lib/mail/message.rb', line 1041 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"
1051 1052 1053 |
# File 'lib/mail/message.rb', line 1051 def subject=( val ) header[:subject] = val end |
#text? ⇒ Boolean
1861 1862 1863 |
# File 'lib/mail/message.rb', line 1861 def text? has_content_type? ? !!(main_type =~ /^text$/i) : false end |
#text_part(&block) ⇒ Object
Accessor for text_part
1571 1572 1573 1574 1575 1576 1577 1578 1579 |
# File 'lib/mail/message.rb', line 1571 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.
1597 1598 1599 1600 1601 1602 1603 1604 1605 |
# File 'lib/mail/message.rb', line 1597 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]']
1080 1081 1082 |
# File 'lib/mail/message.rb', line 1080 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]']
1092 1093 1094 |
# File 'lib/mail/message.rb', line 1092 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
1194 1195 1196 |
# File 'lib/mail/message.rb', line 1194 def to_addrs to ? [to].flatten : [] end |
#to_s ⇒ Object
1775 1776 1777 |
# File 'lib/mail/message.rb', line 1775 def to_s encoded end |
#to_yaml(opts = {}) ⇒ Object
1729 1730 1731 1732 1733 1734 1735 1736 1737 1738 1739 1740 1741 1742 1743 1744 1745 1746 1747 |
# File 'lib/mail/message.rb', line 1729 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_encoding ⇒ Object
:nodoc:
1407 1408 1409 1410 |
# File 'lib/mail/message.rb', line 1407 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
596 597 598 599 600 601 602 |
# File 'lib/mail/message.rb', line 596 def transport_encoding( val = nil) if val self.transport_encoding = val else @transport_encoding end end |
#transport_encoding=(val) ⇒ Object
604 605 606 |
# File 'lib/mail/message.rb', line 604 def transport_encoding=( val ) @transport_encoding = Mail::Encodings.get_encoding(val) end |