{
    "mode": "perldoc",
    "parameter": "Mail::Message::Head::ResentGroup",
    "section": "",
    "url": "https://www.chedong.com/phpMan.php/perldoc/Mail%3A%3AMessage%3A%3AHead%3A%3AResentGroup/json",
    "generated": "2026-10-07T18:27:36Z",
    "synopsis": "use Mail::Message::Head::ResentGroup;\nmy $rg = Mail::Message::Head::ResentGroup->new(head => $head,\nFrom => 'me@home.nl', To => 'You@tux.aq');\n$head->addResentGroup($rg);\nmy $rg = $head->addResentGroup(From => 'me');\nmy @from = $rg->From;\nmy @rgs = $head->resentGroups;\n$rg[2]->delete if @rgs > 2;",
    "sections": {
        "NAME": {
            "content": "Mail::Message::Head::ResentGroup - header fields tracking message delivery\n",
            "subsections": []
        },
        "INHERITANCE": {
            "content": "Mail::Message::Head::ResentGroup\nis a Mail::Message::Head::FieldGroup\nis a Mail::Reporter\n",
            "subsections": []
        },
        "SYNOPSIS": {
            "content": "use Mail::Message::Head::ResentGroup;\nmy $rg = Mail::Message::Head::ResentGroup->new(head => $head,\nFrom => 'me@home.nl', To => 'You@tux.aq');\n$head->addResentGroup($rg);\n\nmy $rg = $head->addResentGroup(From => 'me');\n\nmy @from = $rg->From;\n\nmy @rgs = $head->resentGroups;\n$rg[2]->delete if @rgs > 2;\n",
            "subsections": []
        },
        "DESCRIPTION": {
            "content": "A *resent group* is a set of header fields which describe one intermediate step in the message\ntransport. Resent groups have NOTHING to do with user activety; there is no relation to the\n\"user's\" sense of creating reply, forward, or bounce messages at all!\n\nExtends \"DESCRIPTION\" in Mail::Message::Head::FieldGroup.\n",
            "subsections": []
        },
        "METHODS": {
            "content": "Extends \"METHODS\" in Mail::Message::Head::FieldGroup.\n",
            "subsections": [
                {
                    "name": "Constructors",
                    "content": "Extends \"Constructors\" in Mail::Message::Head::FieldGroup.\n\n$obj->clone()\nInherited, see \"Constructors\" in Mail::Message::Head::FieldGroup\n\n$obj->from( [<$head|$message>, %options] )\nWARNING: this method has two very different purposes. For backward compatibility reasons,\nwithout arguments resentFrom() is called to return the \"From\" field of this resent group.\n\nWith any arguments, a list of \"Mail::Message::Head::ResentGroup\" objects is returned, taken\nfrom the specified $message or message $head.\n\n$obj->implementedTypes()\nMail::Message::Head::ResentGroup->implementedTypes()\nInherited, see \"Constructors\" in Mail::Message::Head::FieldGroup\n\nMail::Message::Head::ResentGroup->new( [$fields], %options )\nCreate an object which maintains one set of resent headers. The $fields are\nMail::Message::Field objects from the same header.\n\n%options which start with capitals will be used to construct additional fields. These option\nnames are prepended with \"Resent-*\", keeping the capitization of what is specified.\n\n-Option      --Defined in                     --Default\nBcc                                            undef\nCc                                             undef\nDate                                           <now>\nDelivered-To                                   undef\nFrom                                           <required>\nMessage-ID                                     <uniquely created>\nReceived                                       <created>\nReturn-Path                                    undef\nSender                                         undef\nTo                                             undef\nhead                                           <created automatically>\nlog           Mail::Reporter                   'WARNINGS'\nmessagehead                                   undef\nsoftware      Mail::Message::Head::FieldGroup  undef\ntrace         Mail::Reporter                   'WARNINGS'\ntype          Mail::Message::Head::FieldGroup  undef\nversion       Mail::Message::Head::FieldGroup  undef\n\nBcc => STRING|OBJECT|OBJECTS\nCc => STRING|OBJECT|OBJECTS\nDate => STRING\nWhen this resent-group is dispatched by the resender of the message. Like the \"Date\"\nfield, it is not the date and time that the message was actually transported.\n\nDelivered-To => STRING|FIELD\nFrom => STRING|OBJECT|OBJECTS\nMessage-ID => STRING|FIELD\nThe \"Resent-Message-ID\" which identifies this resent group. The FIELD must contain a\nmessage id.\n\nReceived => STRING\nThe \"Received\" field is the starting line for a resent group of header lines. If it is not\ndefined, one is created using createReceived().\n\nReturn-Path => STRING|FIELD\nSender => STRING|OBJECT\nOnly permitted when more than one from address is specified. In this case, it selects one\nof these addresses as the main originator of the message.\n\nTo => STRING|OBJECT|OBJECTS\nhead => OBJECT\nThe header where the data is stored in. By default a Mail::Message::Head::Partial is\ncreated for you.\n\nlog => LEVEL\nmessagehead => HEAD\nThe real header of the message where this resent group is part of. The \"head\" used in this\nclass is only a container for a subset of fields.\n\nsoftware => STRING\ntrace => LEVEL\ntype => STRING\nversion => STRING\n"
                },
                {
                    "name": "The header",
                    "content": "Extends \"The header\" in Mail::Message::Head::FieldGroup.\n\n$obj->add( <$field, $value> | $object )\nAll fields appear only once, so add() behaves as set().\n\n$obj->addFields( [$fieldnames] )\nNot applicable to resent-groups: the same name can appear in more than one group. Therefore,\na FIELDNAME is sufficiently distinctive.\n\n$obj->attach($head)\nInherited, see \"The header\" in Mail::Message::Head::FieldGroup\n\n$obj->delete()\nInherited, see \"The header\" in Mail::Message::Head::FieldGroup\n\n$obj->fieldNames()\nInherited, see \"The header\" in Mail::Message::Head::FieldGroup\n\n$obj->fields()\nInherited, see \"The header\" in Mail::Message::Head::FieldGroup\n\n$obj->head()\nInherited, see \"The header\" in Mail::Message::Head::FieldGroup\n\n$obj->messageHead( [$head] )\nReturns (optionally after setting) the real header where this resent group belongs to. This\nmay be undef at creation, and then later filled in when\nMail::Message::Head::Complete::addResentGroup() is called.\n\n$obj->orderedFields()\nReturns the fields in the order as should appear in header according to rfc2822. For the\n\"Resent-*\" fields of the group, the order is not that important, but the \"Return-Path\",\n\"Delivered-To\", and \"Received\" must come first. Only fields mentioned in the RFC are\nreturned.\n\n$obj->set( <$field, $value> | $object )\nSet a $field to a (new) $value. The $field names which do not start with 'Resent-*' but need\nit will have that added. It is also an option to specify a fully prepared message field\n$object. In any case, a field $object is returned.\n\nexample:\n\nmy $this = Mail::Message::Head::ResentGroup->new;\n$this->set(To => 'fish@tux.aq');\n$msg->addResentGroup($this);\n$msg->send;\n\n$msg->bounce(To => 'fish@tux.aq')->send;   # the same\n\nmy $this = Mail::Message::Head::ResentGroup\n->new(To => 'fish@tux.aq');\n"
                },
                {
                    "name": "Access to the header",
                    "content": "Extends \"Access to the header\" in Mail::Message::Head::FieldGroup.\n\n$obj->bcc()\nIn scalar context, the \"Resent-Bcc\" field is returned. In list context, the addresses as\nspecified within the bcc field are returned as Mail::Address objects. Bcc fields are not\ntransmitted (hidden for external parties).\n\n$obj->cc()\nIn scalar context, the \"Resent-Cc\" field is returned. In list context, the addresses as\nspecified within the cc field are returned as Mail::Address objects.\n\n$obj->date()\nReturns the \"Resent-Date\" field, or \"undef\" if it was not defined.\n\n$obj->dateTimestamp()\nThe timestamp as stored within the \"Resent-Date\" field converted to local system time.\n\n$obj->deliveredTo()\nThe field which describes the \"Delivered-To\" of this resent group.\n\n$obj->destinations()\nReturns a list of all addresses specified in the \"Resent-To\", \"-Cc\", and \"-Bcc\" fields of\nthis resent group.\n\n$obj->isResentGroupFieldName($name)\nMail::Message::Head::ResentGroup->isResentGroupFieldName($name)\n$obj->messageId()\nReturns the message-ID used for this group of resent lines.\n\n$obj->received()\nThe field which describes the \"Received\" data of this resent group.\n\n$obj->receivedTimestamp()\nThe timestamp as stored within the \"Received\" field converted to local system time.\n\n$obj->resentFrom()\nIn scalar context, the \"Resent-From\" field is returned. In list context, the addresses as\nspecified within the from field are returned as Mail::Address objects.\n\nFor reasons of backward compatibility and consistency, the from() method will return the\nsame as this method.\n\n$obj->returnPath()\nThe field which describes the \"Return-Path\" of this resent group.\n\n$obj->sender()\nIn scalar context, the \"Resent-Sender\" field is returned. In list context, the addresses as\nspecified within the from field are returned as Mail::Address objects.\n\n$obj->software()\nInherited, see \"Access to the header\" in Mail::Message::Head::FieldGroup\n\n$obj->to()\nIn scalar context, the \"Resent-To\" field is returned. In list context, the addresses as\nspecified within the to field are returned as Mail::Address objects.\n\n$obj->type()\nInherited, see \"Access to the header\" in Mail::Message::Head::FieldGroup\n\n$obj->version()\nInherited, see \"Access to the header\" in Mail::Message::Head::FieldGroup\n"
                },
                {
                    "name": "Internals",
                    "content": "Extends \"Internals\" in Mail::Message::Head::FieldGroup.\n\n$obj->collectFields( [$name] )\nInherited, see \"Internals\" in Mail::Message::Head::FieldGroup\n\n$obj->createReceived( [$domain] )\nCreate a received field for this resent group. This is automatically called if none was\nspecified during creation of this resent group object.\n\nThe content of this field is described in RFC2821 section 4.4. It could use some\nimprovement.\n\n$obj->detected($type, $software, $version)\nInherited, see \"Internals\" in Mail::Message::Head::FieldGroup\n"
                },
                {
                    "name": "Error handling",
                    "content": "Extends \"Error handling\" in Mail::Message::Head::FieldGroup.\n\n$obj->AUTOLOAD()\nInherited, see \"Error handling\" in Mail::Reporter\n\n$obj->addReport($object)\nInherited, see \"Error handling\" in Mail::Reporter\n\n$obj->defaultTrace( [$level]|[$loglevel, $tracelevel]|[$level, $callback] )\nMail::Message::Head::ResentGroup->defaultTrace( [$level]|[$loglevel, $tracelevel]|[$level,\n$callback] )\nInherited, see \"Error handling\" in Mail::Reporter\n\n$obj->details()\nInherited, see \"Error handling\" in Mail::Message::Head::FieldGroup\n\n$obj->errors()\nInherited, see \"Error handling\" in Mail::Reporter\n\n$obj->log( [$level, [$strings]] )\nMail::Message::Head::ResentGroup->log( [$level, [$strings]] )\nInherited, see \"Error handling\" in Mail::Reporter\n\n$obj->logPriority($level)\nMail::Message::Head::ResentGroup->logPriority($level)\nInherited, see \"Error handling\" in Mail::Reporter\n\n$obj->logSettings()\nInherited, see \"Error handling\" in Mail::Reporter\n\n$obj->notImplemented()\nInherited, see \"Error handling\" in Mail::Reporter\n\n$obj->print( [$fh] )\nInherited, see \"Error handling\" in Mail::Message::Head::FieldGroup\n\n$obj->report( [$level] )\nInherited, see \"Error handling\" in Mail::Reporter\n\n$obj->reportAll( [$level] )\nInherited, see \"Error handling\" in Mail::Reporter\n\n$obj->trace( [$level] )\nInherited, see \"Error handling\" in Mail::Reporter\n\n$obj->warnings()\nInherited, see \"Error handling\" in Mail::Reporter\n"
                },
                {
                    "name": "Cleanup",
                    "content": "Extends \"Cleanup\" in Mail::Message::Head::FieldGroup.\n\n$obj->DESTROY()\nInherited, see \"Cleanup\" in Mail::Reporter\n"
                }
            ]
        },
        "DIAGNOSTICS": {
            "content": "Error: Message header required for creation of ResentGroup.\nIt is required to know to which header the resent-group is created. Use the \"head\" option.\nMaybe you should use Mail::Message::Head::Complete::addResentGroup() with DATA, which will\norganize the correct initiations for you.\n\nError: Package $package does not implement $method.\nFatal error: the specific package (or one of its superclasses) does not implement this\nmethod where it should. This message means that some other related classes do implement this\nmethod however the class at hand does not. Probably you should investigate this and probably\ninform the author of the package.\n",
            "subsections": []
        },
        "SEE ALSO": {
            "content": "This module is part of Mail-Message distribution version 3.015, built on December 11, 2023.\nWebsite: http://perl.overmeer.net/CPAN/\n",
            "subsections": []
        },
        "LICENSE": {
            "content": "Copyrights 2001-2023 by [Mark Overmeer <markov@cpan.org>]. For other contributors see ChangeLog.\n\nThis program is free software; you can redistribute it and/or modify it under the same terms as\nPerl itself. See http://dev.perl.org/licenses/\n",
            "subsections": []
        }
    },
    "summary": "Mail::Message::Head::ResentGroup - header fields tracking message delivery",
    "flags": [],
    "examples": [],
    "see_also": []
}