GSP
Quick Navigator

Search Site

Unix VPS
A - Starter
B - Basic
C - Preferred
D - Commercial
MPS - Dedicated
Previous VPSs
* Sign Up! *

Support
Contact Us
Online Help
Handbooks
Domain Status
Man Pages

FAQ
Virtual Servers
Pricing
Billing
Technical

Network
Facilities
Connectivity
Topology Map

Miscellaneous
Server Agreement
Year 2038
Credits
 

USA Flag

 

 

Man Pages


Manual Reference Pages  -  MAIL::MESSAGE::HEAD::RESENTGROUP (3)

.ds Aq ’

NAME

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

CONTENTS

INHERITANCE



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



SYNOPSIS



 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 <B>have NOTHING to doB> with user activety; there is no relation to the users sense of creating reply, forward, or bounce messages at all!

See documentation in the base class.

METHODS

See documentation in the base class.

    Constructors

See documentation in the base class.
$obj-><B>cloneB>() See Constructors in Mail::Message::Head::FieldGroup
$obj-><B>fromB>([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-><B>implementedTypesB>()
Mail::Message::Head::ResentGroup-><B>implementedTypesB>() See Constructors in Mail::Message::Head::FieldGroup
Mail::Message::Head::ResentGroup-><B>newB>([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

See documentation in the base class.
$obj-><B>addB>((FIELD => VALUE) | OBJECT) All fields appear only once, so add() behaves as set().
$obj-><B>addFieldsB>([FIELDNAMES]) Not applicable to resent-groups: the same name can appear in more than one group. Therefore, a FIELDNAME is sufficiently distinctive.
$obj-><B>attachB>(HEAD) See The header in Mail::Message::Head::FieldGroup
$obj-><B>deleteB>() See The header in Mail::Message::Head::FieldGroup
$obj-><B>fieldNamesB>() See The header in Mail::Message::Head::FieldGroup
$obj-><B>fieldsB>() See The header in Mail::Message::Head::FieldGroup
$obj-><B>headB>() See The header in Mail::Message::Head::FieldGroup
$obj-><B>messageHeadB>([HEAD]) Returns (optionally after setting) the real header where this resent group belongs to. This may be undef at creation, and then later filled in when Mail::Message::Head::Complete::addResentGroup() is called.
$obj-><B>orderedFieldsB>() Returns the fields in the order as should appear in header according to rfc2822. For the Resent-* fields of the group, the order is not that important, but the Return-Path, Delivered-To, and Received must come first. Only fields mentioned in the RFC are returned.
$obj-><B>setB>((FIELD => VALUE) | OBJECT) Set a FIELD to a (new) VALUE. The FIELD names which do not start with ’Resent-*’ but need it will have that added. It is also an option to specify a fully prepared message field OBJECT. In any case, a field OBJECT is returned.

example:



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

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

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



    Access to the header

See documentation in the base class.
$obj-><B>bccB>() In scalar context, the Resent-Bcc field is returned. In list context, the addresses as specified within the bcc field are returned as Mail::Address objects. Bcc fields are not transmitted (hidden for external parties).
$obj-><B>ccB>() In scalar context, the Resent-Cc field is returned. In list context, the addresses as specified within the cc field are returned as Mail::Address objects.
$obj-><B>dateB>() Returns the Resent-Date field, or undef if it was not defined.
$obj-><B>dateTimestampB>() The timestamp as stored within the Resent-Date field converted to local system time.
$obj-><B>deliveredToB>() The field which describes the Delivered-To of this resent group.
$obj-><B>destinationsB>() Returns a list of all addresses specified in the Resent-To, -Cc, and -Bcc fields of this resent group.
$obj-><B>isResentGroupFieldNameB>(NAME)
Mail::Message::Head::ResentGroup-><B>isResentGroupFieldNameB>(NAME)
$obj-><B>messageIdB>() Returns the message-ID used for this group of resent lines.
$obj-><B>receivedB>() The field which describes the Received data of this resent group.
$obj-><B>receivedTimestampB>() The timestamp as stored within the Received field converted to local system time.
$obj-><B>resentFromB>() In scalar context, the Resent-From field is returned. In list context, the addresses as specified within the from field are returned as Mail::Address objects.

For reasons of backward compatibility and consistency, the from() method will return the same as this method.

$obj-><B>returnPathB>() The field which describes the Return-Path of this resent group.
$obj-><B>senderB>() In scalar context, the Resent-Sender field is returned. In list context, the addresses as specified within the from field are returned as Mail::Address objects.
$obj-><B>softwareB>() See Access to the header in Mail::Message::Head::FieldGroup
$obj-><B>toB>() In scalar context, the Resent-To field is returned. In list context, the addresses as specified within the to field are returned as Mail::Address objects.
$obj-><B>typeB>() See Access to the header in Mail::Message::Head::FieldGroup
$obj-><B>versionB>() See Access to the header in Mail::Message::Head::FieldGroup

    Internals

See documentation in the base class.
$obj-><B>collectFieldsB>([NAME]) See Internals in Mail::Message::Head::FieldGroup
$obj-><B>createReceivedB>([DOMAIN]) Create a received field for this resent group. This is automatically called if none was specified during creation of this resent group object.

The content of this field is described in RFC2821 section 4.4. It could use some improvement.

$obj-><B>detectedB>(TYPE, SOFTWARE, VERSION) See Internals in Mail::Message::Head::FieldGroup

    Error handling

See documentation in the base class.
$obj-><B>AUTOLOADB>() See Error handling in Mail::Reporter
$obj-><B>addReportB>(OBJECT) See Error handling in Mail::Reporter
$obj-><B>defaultTraceB>([LEVEL]|[LOGLEVEL, TRACELEVEL]|[LEVEL, CALLBACK])
Mail::Message::Head::ResentGroup-><B>defaultTraceB>([LEVEL]|[LOGLEVEL, TRACELEVEL]|[LEVEL, CALLBACK]) See Error handling in Mail::Reporter
$obj-><B>detailsB>() See Error handling in Mail::Message::Head::FieldGroup
$obj-><B>errorsB>() See Error handling in Mail::Reporter
$obj-><B>logB>([LEVEL [,STRINGS]])
Mail::Message::Head::ResentGroup-><B>logB>([LEVEL [,STRINGS]]) See Error handling in Mail::Reporter
$obj-><B>logPriorityB>(LEVEL)
Mail::Message::Head::ResentGroup-><B>logPriorityB>(LEVEL) See Error handling in Mail::Reporter
$obj-><B>logSettingsB>() See Error handling in Mail::Reporter
$obj-><B>notImplementedB>() See Error handling in Mail::Reporter
$obj-><B>printB>([FILEHANDLE]) See Error handling in Mail::Message::Head::FieldGroup
$obj-><B>reportB>([LEVEL]) See Error handling in Mail::Reporter
$obj-><B>reportAllB>([LEVEL]) See Error handling in Mail::Reporter
$obj-><B>traceB>([LEVEL]) See Error handling in Mail::Reporter
$obj-><B>warningsB>() See Error handling in Mail::Reporter

    Cleanup

See documentation in the base class.
$obj-><B>DESTROYB>() See Cleanup in Mail::Reporter

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 organize 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-Box distribution version 2.109, built on August 19, 2013. Website: http://perl.overmeer.net/mailbox/

LICENSE

Copyrights 2001-2013 by [Mark Overmeer]. 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://www.perl.com/perl/misc/Artistic.html

Search for    or go to Top of page |  Section 3 |  Main Index


perl v5.20.3 MAIL::MESSAGE::HEAD::RESENTGROUP (3) 2013-08-19

Powered by GSP Visit the GSP FreeBSD Man Page Interface.
Output converted with manServer 1.07.