perldoc > Mail::Message::Head::ResentGroup

man perldoc info pydoc3 ri search

🏷️ NAME

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

🚀 Quick Reference

Use Case	Command	Description
Create a new resent group	Mail::Message::Head::ResentGroup->new(From => 'me', To => 'you')	Instantiate a group of Resent-* fields
Add resent group to header	$head->addResentGroup($rg)	Attach the group to a message header
Convenient one‑step add	$head->addResentGroup(From => 'me')	Creates and adds in one call
Get the From address(es)	my @from = $rg->resentFrom;	Returns Mail::Address objects
Get all resent groups	my @rgs = $head->resentGroups;	List of groups in the header
Delete a resent group	$rg->delete;	Remove the group from the header
Set a field	$rg->set(To => 'fish@tux.aq');	Adds/updates a Resent-* field
Get message-id of the group	$rg->messageId;	Returns the Resent-Message-ID

🧬 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 AT home.nl', To => 'You AT 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 activity; 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. 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 starting with capitals will be used to construct additional fields, and are prepended with “Resent-*” (keeping original capitalisation).
  

  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. Like the “Date” field, it is not the date and time of actual transport.
  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. If not defined, one is created using createReceived().
  Return-Path => STRING|FIELD
  Sender => STRING|OBJECT — Only permitted when more than one from address is specified, selecting the main originator.
  To => STRING|OBJECT|OBJECTS
  head => OBJECT — The header where the data is stored. By default a Mail::Message::Head::Partial is created.
  log => LEVEL
  message_head => HEAD — The real header of the message where this resent group belongs. 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, so a FIELDNAME is sufficiently distinctive.
• $obj->attach($head) — Inherited, see “The header” in Mail::Message::Head::FieldGroup
• $obj->delete() — Inherited, see “The header” in Mail::Message::Head::FieldGroup
• $obj->fieldNames() — Inherited, see “The header” in Mail::Message::Head::FieldGroup
• $obj->fields() — Inherited, see “The header” in Mail::Message::Head::FieldGroup
• $obj->head() — Inherited, see “The header” in Mail::Message::Head::FieldGroup
• $obj->messageHead( [$head] ) — Returns (optionally after setting) the real header where this resent group belongs to. May be undef at creation, later filled in when Mail::Message::Head::Complete::addResentGroup() is called.
• $obj->orderedFields() — Returns the fields in the order as should appear in header according to RFC2822. “Return-Path”, “Delivered-To”, and “Received” must come first. Only fields mentioned in the RFC are returned.
• $obj->set( <$field, $value> | $object ) — Set a $field to a (new) $value. Field names not starting with ‘Resent-*’ but needing it will have that added. A fully prepared message field $object may also be supplied. Returns a field $object.
  Example:

  my $this = Mail::Message::Head::ResentGroup->new;
  $this->set(To => 'fish AT tux.aq');
  $msg->addResentGroup($this);
  $msg->send;

  $msg->bounce(To => 'fish AT tux.aq')->send;   # the same

  my $this = Mail::Message::Head::ResentGroup
      ->new(To => 'fish AT tux.aq');

🔍 Access to the header

Extends “Access to the header” in Mail::Message::Head::FieldGroup.

• $obj->bcc() — In scalar context returns the “Resent-Bcc” field; in list context returns addresses as Mail::Address objects. Bcc fields are hidden.
• $obj->cc() — In scalar context returns “Resent-Cc” field; in list context returns addresses as Mail::Address objects.
• $obj->date() — Returns the “Resent-Date” field, or undef.
• $obj->dateTimestamp() — The timestamp from “Resent-Date” converted to local system time.
• $obj->deliveredTo() — The “Delivered-To” field of this resent group.
• $obj->destinations() — Returns a list of all addresses from “Resent-To”, “-Cc”, and “-Bcc”.
• $obj->isResentGroupFieldName($name) / Mail::Message::Head::ResentGroup->isResentGroupFieldName($name) — Class method to test if a name is a known Resent-* field.
• $obj->messageId() — Returns the message-ID used for this group of resent lines.
• $obj->received() — The “Received” field of this resent group.
• $obj->receivedTimestamp() — The timestamp from “Received” converted to local system time.
• $obj->resentFrom() — In scalar context returns the “Resent-From” field; in list context returns addresses as Mail::Address objects. The from() method (without arguments) returns the same for backward compatibility.
• $obj->returnPath() — The “Return-Path” field of this resent group.
• $obj->sender() — In scalar context returns the “Resent-Sender” field; in list context returns addresses as Mail::Address objects.
• $obj->software() — Inherited.
• $obj->to() — In scalar context returns the “Resent-To” field; in list context returns addresses as Mail::Address objects.
• $obj->type() — Inherited.
• $obj->version() — Inherited.

⚙️ Internals

Extends “Internals” in Mail::Message::Head::FieldGroup.

• $obj->collectFields( [$name] ) — Inherited.
• $obj->createReceived( [$domain] ) — Create a received field for this resent group. Automatically called if none was specified during creation. The content follows RFC2821 section 4.4.
• $obj->detected($type, $software, $version) — Inherited.

🚨 Error handling

Extends “Error handling” in Mail::Message::Head::FieldGroup.

• $obj->AUTOLOAD() — Inherited.
• $obj->addReport($object) — Inherited.
• $obj->defaultTrace( [$level]|[$loglevel, $tracelevel]|[$level, $callback] ) / Mail::Message::Head::ResentGroup->defaultTrace(...) — Inherited.
• $obj->details() — Inherited.
• $obj->errors() — Inherited.
• $obj->log( [$level, [$strings]] ) / Mail::Message::Head::ResentGroup->log(...) — Inherited.
• $obj->logPriority($level) / Mail::Message::Head::ResentGroup->logPriority($level) — Inherited.
• $obj->logSettings() — Inherited.
• $obj->notImplemented() — Inherited.
• $obj->print( [$fh] ) — Inherited.
• $obj->report( [$level] ) — Inherited.
• $obj->reportAll( [$level] ) — Inherited.
• $obj->trace( [$level] ) — Inherited.
• $obj->warnings() — Inherited.

🧹 Cleanup

Extends “Cleanup” in Mail::Message::Head::FieldGroup.

• $obj->DESTROY() — Inherited.

🩺 DIAGNOSTICS

• Error: Message header required for creation of ResentGroup. — It is required to know to which header the resent-group is created. Use the “head” option. Maybe you should use Mail::Message::Head::Complete::addResentGroup() with DATA, which will organise the correct initiations for you.
• Error: Package $package does not implement $method. — Fatal error: the specific package (or one of its superclasses) does not implement this method where it should. This message means that some other related classes do implement this method however the class at hand does not. Probably you should investigate this and probably inform the author of the package.

📚 SEE ALSO

This module is part of Mail-Message distribution version 3.012, built on February 11, 2022. Website: http://perl.overmeer.net/CPAN/

⚖️ LICENSE

Copyrights 2001-2022 by [Mark Overmeer <markov AT cpan.org>]. For other contributors see ChangeLog.

This program is free software; you can redistribute it and/or modify it under the same terms as Perl itself. See http://dev.perl.org/licenses/

🏷️ NAME 🚀 Quick Reference 🧬 INHERITANCE 📖 SYNOPSIS 📝 DESCRIPTION 🔧 METHODS 🩺 DIAGNOSTICS 📚 SEE ALSO ⚖️ LICENSE