Sha256: 03e7ba0f829d7a7b8f869b5a2e663d828b9f73707ffb0bc0ccf973b71494f411

Contents?: true

Size: 1.48 KB

Versions: 15

Compression:

Stored size: 1.48 KB

Contents

# encoding: utf-8
# 
# = From Field
# 
# The From field inherits from StructuredField and handles the From: header
# field in the email.
# 
# Sending from to a mail message will instantiate a Mail::Field object that
# has a FromField as it's field type.  This includes all Mail::CommonAddress
# module instance metods.
# 
# Only one From field can appear in a header, though it can have multiple
# addresses and groups of addresses.
# 
# == Examples:
# 
#  mail = Mail.new
#  mail.from = 'Mikel Lindsaar <mikel@test.lindsaar.net>, ada@test.lindsaar.net'
#  mail.from    #=> '#<Mail::Field:0x180e5e8 @field=#<Mail::FromField:0x180e1c4
#  mail[:from]  #=> '#<Mail::Field:0x180e5e8 @field=#<Mail::FromField:0x180e1c4
#  mail['from'] #=> '#<Mail::Field:0x180e5e8 @field=#<Mail::FromField:0x180e1c4
#  mail['From'] #=> '#<Mail::Field:0x180e5e8 @field=#<Mail::FromField:0x180e1c4
# 
#  mail.from.to_s  #=> 'Mikel Lindsaar <mikel@test.lindsaar.net>, ada@test.lindsaar.net'
#  mail.from.addresses #=> ['mikel@test.lindsaar.net', 'ada@test.lindsaar.net']
#  mail.from.formatted #=> ['Mikel Lindsaar <mikel@test.lindsaar.net>', 'ada@test.lindsaar.net']
# 
module Mail
  class FromField < StructuredField
    
    include Mail::CommonAddress
    
    FIELD_NAME = 'from'
    CAPITALIZED_FIELD = 'From'
    
    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

15 entries across 15 versions & 1 rubygems

Version Path
mail-1.4.3 lib/mail/fields/from_field.rb
mail-1.4.2 lib/mail/fields/from_field.rb
mail-1.4.1 lib/mail/fields/from_field.rb
mail-1.4.0 lib/mail/fields/from_field.rb
mail-1.3.5 lib/mail/fields/from_field.rb
mail-1.3.4 lib/mail/fields/from_field.rb
mail-1.3.3 lib/mail/fields/from_field.rb
mail-1.3.2 lib/mail/fields/from_field.rb
mail-1.3.1 lib/mail/fields/from_field.rb
mail-1.3.0 lib/mail/fields/from_field.rb
mail-1.2.9 lib/mail/fields/from_field.rb
mail-1.2.8 lib/mail/fields/from_field.rb
mail-1.2.6 lib/mail/fields/from_field.rb
mail-1.2.5 ./lib/mail/fields/from_field.rb
mail-1.2.1 ./lib/mail/fields/from_field.rb