Sha256: 771010b9c2956eb1f6f871d64579a721b00d2f2814f74f1fb0612bcf26247b87
Contents?: true
Size: 1.15 KB
Versions: 16
Compression:
Stored size: 1.15 KB
Contents
# encoding: utf-8
# frozen_string_literal: true
require 'mail/fields/named_unstructured_field'
module Mail
# = 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 its 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"]
class CommentsField < NamedUnstructuredField #:nodoc:
NAME = 'Comments'
end
end
Version data entries
16 entries across 15 versions & 6 rubygems