Mail::Message::Head::ResentGroup

Section: User Contributed Perl Documentation (3)
Updated: 2021-01-27
Page Index

NAME

Mail::Message::Head::ResentGroup - header fields tracking message delivery

INHERITANCE

 Mail::Message::Head::ResentGroup
   is a Mail::Message::Head::FieldGroup
   is a Mail::Reporter

SYNOPSIS

 use Mail::Message::Head::ResentGroup;
 my $rg = Mail::Message::Head::ResentGroup->new(head => $head,
              From => 'me@home.nl', To => 'You@tux.aq');
 $head->addResentGroup($rg);

 my $rg = $head->addResentGroup(From => 'me');

 my @from = $rg->From;

 my @rgs = $head->resentGroups;
 $rg[2]->delete if @rgs > 2;

DESCRIPTION

A resent group is a set of header fields which describe one intermediate step in the message transport. Resent groups have NOTHING to do with user activety; there is no relation to the "user's" sense of creating reply, forward, or bounce messages at all!

Extends ``DESCRIPTION'' in Mail::Message::Head::FieldGroup.

METHODS

Extends ``METHODS'' in Mail::Message::Head::FieldGroup.

Constructors

Extends ``Constructors'' in Mail::Message::Head::FieldGroup.

$obj->clone()

Inherited, see ``Constructors'' in Mail::Message::Head::FieldGroup

$obj->from( [<$head|$message>, %options] )

WARNING: this method has two very different purposes. For backward compatibility reasons, without arguments resentFrom() is called to return the "From" field of this resent group.

With any arguments, a list of "Mail::Message::Head::ResentGroup" objects is returned, taken from the specified $message or message $head.

$obj->implementedTypes()

Mail::Message::Head::ResentGroup->implementedTypes()

Inherited, see ``Constructors'' in Mail::Message::Head::FieldGroup

Mail::Message::Head::ResentGroup->new( [$fields], %options )

Create an object which maintains one set of resent headers. The $fields are Mail::Message::Field objects from the same header.

%options which start with capitals will be used to construct additional fields. These option names are prepended with "Resent-*", keeping the capitization of what is specified.

 -Option      --Defined in                     --Default
  Bcc                                            undef
  Cc                                             undef
  Date                                           <now>
  Delivered-To                                   undef
  From                                           <required>
  Message-ID                                     <uniquely created>
  Received                                       <created>
  Return-Path                                    undef
  Sender                                         undef
  To                                             undef
  head                                           <created automatically>
  log           Mail::Reporter                   'WARNINGS'
  message_head                                   undef
  software      Mail::Message::Head::FieldGroup  undef
  trace         Mail::Reporter                   'WARNINGS'
  type          Mail::Message::Head::FieldGroup  undef
  version       Mail::Message::Head::FieldGroup  undef

Bcc => STRING|OBJECT|OBJECTS
Cc => STRING|OBJECT|OBJECTS
Date => STRING: When this resent-group is dispatched by the resender of the message. Like the "Date" field, it is not the date and time that the message was actually transported.
Delivered-To => STRING|FIELD
From => STRING|OBJECT|OBJECTS
Message-ID => STRING|FIELD: The "Resent-Message-ID" which identifies this resent group. The FIELD must contain a message id.
Received => STRING: The "Received" field is the starting line for a resent group of header lines. If it is not defined, one is created using createReceived().
Return-Path => STRING|FIELD
Sender => STRING|OBJECT: Only permitted when more than one from address is specified. In this case, it selects one of these addresses as the main originator of the message.
To => STRING|OBJECT|OBJECTS
head => OBJECT: The header where the data is stored in. By default a Mail::Message::Head::Partial is created for you.
log => LEVEL
message_head => HEAD: The real header of the message where this resent group is part of. The "head" used in this class is only a container for a subset of fields.
software => STRING
trace => LEVEL
type => STRING
version => STRING

The header

Extends ``The header'' in Mail::Message::Head::FieldGroup.

$obj->add( <$field, $value> | $object )

All fields appear only once, so "add()" behaves as set().

$obj->addFields( [$fieldnames] )

Not applicable to resent-groups: the same name can appear in more than one group. Therefore, a FIELDNAME is sufficiently distinctive.

$obj->attach($head)