Class: Mail::CommentsField

Inherits:
NamedUnstructuredField show all
Defined in:
lib/mail/fields/comments_field.rb

Overview

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"]

Constant Summary collapse

NAME =

:nodoc:

'Comments'

Instance Attribute Summary

Attributes inherited from CommonField

#charset, #errors, #name, #value

Method Summary

Methods inherited from NamedUnstructuredField

#initialize

Methods inherited from UnstructuredField

#initialize, #parse

Methods inherited from CommonField

#decoded, #default, #element, #encoded, #initialize, #parse, parse, #responsible_for?, singular?, #singular?, #to_s

Constructor Details

This class inherits a constructor from Mail::NamedUnstructuredField