Contents

# encoding: utf-8
# 
# = Comments Field
# 
# The Comments field inherits from UnstructuredField and handles the Comments:
# header field in the email.
# 
# Sending comments to a mail message will instantiate a Mail::Field object that
# has a CommentsField as it's field type.
#  
# An email header can have as many comments fields as it wants.  There is no upper
# limit, the comments field is also optional (that is, no comment is needed)
# 
# == Examples:
# 
#  mail = Mail.new
#  mail.comments = 'This is a comment'
#  mail.comments    #=> 'This is a comment'
#  mail[:comments]  #=> '#<Mail::Field:0x180e5e8 @field=#<Mail::CommentsField:0x180e1c4
#  mail['comments'] #=> '#<Mail::Field:0x180e5e8 @field=#<Mail::CommentsField:0x180e1c4
#  mail['comments'] #=> '#<Mail::Field:0x180e5e8 @field=#<Mail::CommentsField:0x180e1c4
# 
#  mail.comments = "This is another comment"
#  mail[:comments].map { |c| c.to_s } 
#  #=> ['This is a comment', "This is another comment"]
#
module Mail
  class CommentsField < UnstructuredField
    
    FIELD_NAME = 'comments'
    CAPITALIZED_FIELD = 'Comments'
    
    def initialize(*args)
      super(CAPITALIZED_FIELD, strip_field(FIELD_NAME, args.last))
    end
    
  end
end

Version data entries

3 entries across 3 versions & 1 rubygems

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