Contents

# encoding: utf-8
# 
# = 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 it's 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 <[e-mail]>, [e-mail]'
#  mail.to    #=> ['Mikel Lindsaar <[e-mail]>', '[e-mail]']
#  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 <[e-mail]>, [e-mail]\r\n'
#  mail[:to].decoded   #=> 'Mikel Lindsaar <[e-mail]>, [e-mail]'
#  mail[:to].addresses #=> ['[e-mail]', '[e-mail]']
#  mail[:to].formatted #=> ['Mikel Lindsaar <[e-mail]>', '[e-mail]']
# 
module Mail
  class ToField < StructuredField
    
    include Mail::CommonAddress
    
    FIELD_NAME = 'to'
    CAPITALIZED_FIELD = 'To'
    
    def initialize(*args)
      super(CAPITALIZED_FIELD, strip_field(FIELD_NAME, args.last))
    end
    
    def encoded
      do_encode(CAPITALIZED_FIELD)
    end
    
    def decoded
      do_decode
    end
    
  end
end

Version data entries

3 entries across 3 versions & 1 rubygems

Version	Path
mail-1.5.2	lib/mail/fields/to_field.rb
mail-1.5.1	lib/mail/fields/to_field.rb
mail-1.5.0	lib/mail/fields/to_field.rb