Sha256: d38ca521484ad381e4962c587cc87f394fae8a9286cd7311ef8083317eeb4f7a

Contents?: true

Size: 1.64 KB

Versions: 15

Compression:

Stored size: 1.64 KB

Contents

# encoding: utf-8
# 
# = References Field
# 
# The References field inherits references StructuredField and handles the References: header
# field in the email.
# 
# Sending references to a mail message will instantiate a Mail::Field object that
# has a ReferencesField as it's field type.  This includes all Mail::CommonAddress
# module instance metods.
# 
# Note that, the #message_ids method will return an array of message IDs without the
# enclosing angle brackets which per RFC are not syntactically part of the message id.
# 
# Only one References field can appear in a header, though it can have multiple
# Message IDs.
# 
# == Examples:
# 
#  mail = Mail.new
#  mail.references = '<F6E2D0B4-CC35-4A91-BA4C-C7C712B10C13@test.me.dom>'
#  mail.references    #=> '#<Mail::Field:0x180e5e8 @field=#<Mail::ReferencesField:0x180e1c4
#  mail[:references]  #=> '#<Mail::Field:0x180e5e8 @field=#<Mail::ReferencesField:0x180e1c4
#  mail['references'] #=> '#<Mail::Field:0x180e5e8 @field=#<Mail::ReferencesField:0x180e1c4
#  mail['References'] #=> '#<Mail::Field:0x180e5e8 @field=#<Mail::ReferencesField:0x180e1c4
# 
#  mail.references.to_s  #=> '<F6E2D0B4-CC35-4A91-BA4C-C7C712B10C13@test.me.dom>'
#  mail.references.message_ids #=> ['F6E2D0B4-CC35-4A91-BA4C-C7C712B10C13@test.me.dom']
# 
module Mail
  class ReferencesField < StructuredField
    
    include CommonMessageId
    
    FIELD_NAME = 'references'
    CAPITALIZED_FIELD = 'References'
    
    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/references_field.rb
mail-1.4.2 lib/mail/fields/references_field.rb
mail-1.4.1 lib/mail/fields/references_field.rb
mail-1.4.0 lib/mail/fields/references_field.rb
mail-1.3.5 lib/mail/fields/references_field.rb
mail-1.3.4 lib/mail/fields/references_field.rb
mail-1.3.3 lib/mail/fields/references_field.rb
mail-1.3.2 lib/mail/fields/references_field.rb
mail-1.3.1 lib/mail/fields/references_field.rb
mail-1.3.0 lib/mail/fields/references_field.rb
mail-1.2.9 lib/mail/fields/references_field.rb
mail-1.2.8 lib/mail/fields/references_field.rb
mail-1.2.6 lib/mail/fields/references_field.rb
mail-1.2.5 ./lib/mail/fields/references_field.rb
mail-1.2.1 ./lib/mail/fields/references_field.rb