See METHODS in Mail::Reporter
Make a copy of this object. The collected fieldnames are copied and the list type information. No deep copy is made for the header: this is only copied as reference.
Create a group of fields based on the specified MESSAGE or message HEAD. This may return one or more of the objects, which depends on the type of group. Mailing list fields are all stored in one object, where resent and spam groups can appear more than once.
Returns a list of strings containing all possible return values for type().
Construct an object which maintains one set of header FIELDS. The
FIELDS may be specified as Mail::Message::Field
objects or as key-value
pairs. The OPTIONS and FIELDS (as key-value pair) can be mixed: they are
distinguished by their name, where the fields always start with a capital.
The field objects must aways lead the OPTIONS.
Option | Defined in | Default |
---|---|---|
head |
| |
log | Mail::Reporter |
|
software |
| |
trace | Mail::Reporter |
|
type |
| |
version |
|
Add a field to the header, using the field group. When the field group is already attached to a real message header, it will appear in that one as well as being registed in this set. If no header is defined, the field only appears internally.
my $this = Mail::Message::Head::ListGroup->new(...); $this->add('List-Id' => 'mailbox'); $msg->addListGroup($this); $msg->send;
my $lg = Mail::Message::Head::ListGroup->from($msg); $lg->add('List-Id' => 'mailbox');
Add some FIELDNAMES to the set.
Add a group of fields to a message HEAD. The fields will be cloned(!) into the header, so that the field group object can be used again.
my $lg = Mail::Message::Head::ListGroup->new(...); $lg->attach($msg->head); $msg->head->addListGroup($lg); # same $msg->head->addSpamGroup($sg); # also implemented with attach
Remove all the header lines which are combined in this fields group, from the header.
Return the names of the fields which are used in this group.
Return the fields which are defined for this group.
Returns the header object, which includes these fields.
Returns an abstract name for the field group; which software is
controling it. undef
is returned in case the type is not known.
Valid names are group type dependent: see the applicable manual
pages. A list of all types can be retrieved with implementedTypes().
Returns the version number of the software used to produce the fields.
Some kinds of software do leave such a trace, other cases will return
undef
Scan the header for fields which are usually contained in field group with the specified NAME. For mailinglist groups, you can not specify a NAME: only one set of headers will be found (all headers are considered to be produced by exactly one package of mailinglist software).
This method is automatically called when a field group is constructed via from() on an existing header or message.
Returned are the names of the list header fields found, in scalar context the amount of fields. An empty list/zero indicates that there was no group to be found.
Please warn the author of MailBox if you see that to few or too many fields are included.
Sets the values for the field group type, software, and version,
prossibly to undef
.
Produce information about the detected/created field group, which may be helpful during debugging. A nicely formatted string is returned.
Print the group to the specified FILEHANDLE or GLOB. This is probably only useful for debugging purposed. The output defaults to the selected file handle.