Class: Mail::ToField

Inherits:
CommonAddressField show all
Defined in:
lib/mail/fields/to_field.rb

Overview

To Field

The To field inherits to StructuredField and handles the To: header field in the email.

Sending to to a mail message will instantiate a Mail::Field object that has a ToField as its field type. This includes all Mail::CommonAddress module instance metods.

Only one To field can appear in a header, though it can have multiple addresses and groups of addresses.

Examples:

mail = Mail.new
mail.to = 'Mikel Lindsaar <[email protected]>, [email protected]'
mail.to    #=> ['[email protected]', '[email protected]']
mail[:to]  #=> '#<Mail::Field:0x180e5e8 @field=#<Mail::ToField:0x180e1c4
mail['to'] #=> '#<Mail::Field:0x180e5e8 @field=#<Mail::ToField:0x180e1c4
mail['To'] #=> '#<Mail::Field:0x180e5e8 @field=#<Mail::ToField:0x180e1c4

mail[:to].encoded   #=> 'To: Mikel Lindsaar <[email protected]>, [email protected]\r\n'
mail[:to].decoded   #=> 'Mikel Lindsaar <[email protected]>, [email protected]'
mail[:to].addresses #=> ['[email protected]', '[email protected]']
mail[:to].formatted #=> ['Mikel Lindsaar <[email protected]>', '[email protected]']

Constant Summary collapse

NAME =

:nodoc:

'To'

Instance Attribute Summary

Attributes inherited from CommonField

#charset, #errors, #name, #value

Method Summary

Methods inherited from CommonAddressField

#<<, #address, #addresses, #addrs, #decoded_group_addresses, #default, #display_names, #each, #element, #encode_if_needed, #encoded_group_addresses, #formatted, #group_addresses, #group_names, #groups, #initialize, singular?

Methods inherited from NamedStructuredField

#initialize

Methods inherited from CommonField

#decoded, #default, #element, #encoded, #initialize, #parse, parse, #responsible_for?, singular?, #singular?, #to_s

Constructor Details

This class inherits a constructor from Mail::CommonAddressField