Sha256: c1c87951310e560ba0294923872ed62ce0289e296d9d1a97caade0d175aab28b

Contents?: true

Size: 1.69 KB

Versions: 217

Compression:

Stored size: 1.69 KB

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 <mikel@test.lindsaar.net>, ada@test.lindsaar.net'
#  mail.to    #=> ['Mikel Lindsaar <mikel@test.lindsaar.net>', 'ada@test.lindsaar.net']
#  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 <mikel@test.lindsaar.net>, ada@test.lindsaar.net\r\n'
#  mail[:to].decoded   #=> 'Mikel Lindsaar <mikel@test.lindsaar.net>, ada@test.lindsaar.net'
#  mail[:to].addresses #=> ['mikel@test.lindsaar.net', 'ada@test.lindsaar.net']
#  mail[:to].formatted #=> ['Mikel Lindsaar <mikel@test.lindsaar.net>', 'ada@test.lindsaar.net']
# 
require 'mail/fields/common/common_address'

module Mail
  class ToField < StructuredField
    
    include Mail::CommonAddress
    
    FIELD_NAME = 'to'
    CAPITALIZED_FIELD = 'To'
    
    def initialize(value = nil, charset = 'utf-8')
      self.charset = charset
      super(CAPITALIZED_FIELD, strip_field(FIELD_NAME, value), charset)
      self.parse
      self
    end
    
    def encoded
      do_encode(CAPITALIZED_FIELD)
    end
    
    def decoded
      do_decode
    end
    
  end
end

Version data entries

217 entries across 175 versions & 16 rubygems

Version Path
depengine-0.0.14 etc/isolate/jruby-1.8/gems/mail-2.2.5/lib/mail/fields/to_field.rb
depengine-0.0.13 etc/isolate/ruby-1.8/gems/mail-2.2.5/lib/mail/fields/to_field.rb
depengine-0.0.13 etc/isolate/jruby-1.8/gems/mail-2.2.5/lib/mail/fields/to_field.rb
classiccms-0.7.2 vendor/bundle/gems/mail-2.4.4/lib/mail/fields/to_field.rb
classiccms-0.7.1 vendor/bundle/gems/mail-2.4.4/lib/mail/fields/to_field.rb
active_mailer-0.0.9 test/fixtures/dummyapp_rails_3.2/vendor/bundle/ruby/1.9.1/gems/mail-2.4.4/lib/mail/fields/to_field.rb
active_mailer-0.0.8 test/fixtures/dummyapp_rails_3.2/vendor/bundle/ruby/1.9.1/gems/mail-2.4.4/lib/mail/fields/to_field.rb
active_mailer-0.0.7 test/fixtures/dummyapp_rails_3.2/vendor/bundle/ruby/1.9.1/gems/mail-2.4.4/lib/mail/fields/to_field.rb
active_mailer-0.0.6 test/fixtures/dummyapp_rails_3.2/vendor/bundle/ruby/1.9.1/gems/mail-2.4.4/lib/mail/fields/to_field.rb
classiccms-0.7.0 vendor/bundle/gems/mail-2.4.4/lib/mail/fields/to_field.rb
mail-2.2.20 lib/mail/fields/to_field.rb
challah-1.0.0.beta3 vendor/bundle/gems/mail-2.5.3/lib/mail/fields/to_field.rb
fc-webicons-0.0.4 vendor/bundle/ruby/1.9.1/gems/mail-2.5.3/lib/mail/fields/to_field.rb
challah-1.0.0.beta2 vendor/bundle/gems/mail-2.5.3/lib/mail/fields/to_field.rb
challah-1.0.0.beta vendor/bundle/gems/mail-2.4.4/lib/mail/fields/to_field.rb
challah-1.0.0.beta vendor/bundle/gems/mail-2.5.3/lib/mail/fields/to_field.rb
depengine-0.0.12 etc/isolate/ruby-1.8/gems/mail-2.2.5/lib/mail/fields/to_field.rb
depengine-0.0.12 etc/isolate/jruby-1.8/gems/mail-2.2.5/lib/mail/fields/to_field.rb
depengine-0.0.11 etc/isolate/jruby-1.8/gems/mail-2.2.5/lib/mail/fields/to_field.rb
depengine-0.0.11 etc/isolate/ruby-1.8/gems/mail-2.2.5/lib/mail/fields/to_field.rb