Sha256: 80f9da3d4284903243bc9b10c2e765dc9e3e6191ad9307037e4a49b7f40ac330
Contents?: true
Size: 1.4 KB
Versions: 15
Compression:
Stored size: 1.4 KB
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 #=> '#<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'] #=> '#<Mail::Field:0x180e5e8 @field=#<Mail::CommentsField:0x180e1c4
#
# mail.comments.to_s #=> 'This is a comment'
#
# mail.comments = "This is another comment"
# mail.comments.map { |c| c.to_s }
# #=> ['This is a comment', "This is another comment"]
# mail.comments.to_s # Probably not what you want to do in this case
# #=> "This is a commentThis 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
15 entries across 15 versions & 1 rubygems