1Mail::Message::Head::ReUsseenrtGCroonutpr(i3b)uted PerlMDaoiclu:m:eMnetsastaigoen::Head::ResentGroup(3)
2
6 Mail::Message::Head::ResentGroup - header fields tracking message
7 delivery
8
10 Mail::Message::Head::ResentGroup
11 is a Mail::Message::Head::FieldGroup
12 is a Mail::Reporter
13
15 use Mail::Message::Head::ResentGroup;
16 my $rg = Mail::Message::Head::ResentGroup->new(head => $head,
17 From => 'me@home.nl', To => 'You@tux.aq');
18 $head->addResentGroup($rg);
19 my $rg = $head->addResentGroup(From => 'me');
21 my @from = $rg->From;
23 my @rgs = $head->resentGroups;
25 $rg[2]->delete if @rgs > 2;
26
28 A resent group is a set of header fields which describe one
29 intermediate step in the message transport. Resent groups have NOTHING
30 to do with user activety; there is no relation to the "user's" sense of
31 creating reply, forward, or bounce messages at all!
32 Extends "DESCRIPTION" in Mail::Message::Head::FieldGroup.
34
36 Extends "METHODS" in Mail::Message::Head::FieldGroup.
37 Constructors
39 Extends "Constructors" in Mail::Message::Head::FieldGroup.
40 $obj->clone()
42 Inherited, see "Constructors" in Mail::Message::Head::FieldGroup
43 $obj->from( [<$head|$message>, %options] )
45 WARNING: this method has two very different purposes. For backward
46 compatibility reasons, without arguments resentFrom() is called to
47 return the "From" field of this resent group.
48 With any arguments, a list of "Mail::Message::Head::ResentGroup"
50 objects is returned, taken from the specified $message or message
51 $head.
52 $obj->implementedTypes()
54 Mail::Message::Head::ResentGroup->implementedTypes()
55 Inherited, see "Constructors" in Mail::Message::Head::FieldGroup
56 Mail::Message::Head::ResentGroup->new( [$fields], %options )
58 Create an object which maintains one set of resent headers. The
59 $fields are Mail::Message::Field objects from the same header.
60 %options which start with capitals will be used to construct
62 additional fields. These option names are prepended with
63 "Resent-*", keeping the capitization of what is specified.
64 -Option --Defined in --Default
66 Bcc undef
67 Cc undef
68 Date <now>
69 Delivered-To undef
70 From <required>
71 Message-ID <uniquely created>
72 Received <created>
73 Return-Path undef
74 Sender undef
75 To undef
76 head <created automatically>
77 log Mail::Reporter 'WARNINGS'
78 message_head undef
79 software Mail::Message::Head::FieldGroup undef
80 trace Mail::Reporter 'WARNINGS'
81 type Mail::Message::Head::FieldGroup undef
82 version Mail::Message::Head::FieldGroup undef
83 Bcc => STRING|OBJECT|OBJECTS
85 Cc => STRING|OBJECT|OBJECTS
86 Date => STRING
87 When this resent-group is dispatched by the resender of the
88 message. Like the "Date" field, it is not the date and time that
89 the message was actually transported.
90 Delivered-To => STRING|FIELD
92 From => STRING|OBJECT|OBJECTS
93 Message-ID => STRING|FIELD
94 The "Resent-Message-ID" which identifies this resent group. The
95 FIELD must contain a message id.
96 Received => STRING
98 The "Received" field is the starting line for a resent group of
99 header lines. If it is not defined, one is created using
100 createReceived().
101 Return-Path => STRING|FIELD
103 Sender => STRING|OBJECT
104 Only permitted when more than one from address is specified. In
105 this case, it selects one of these addresses as the main
106 originator of the message.
107 To => STRING|OBJECT|OBJECTS
109 head => OBJECT
110 The header where the data is stored in. By default a
111 Mail::Message::Head::Partial is created for you.
112 log => LEVEL
114 message_head => HEAD
115 The real header of the message where this resent group is part
116 of. The "head" used in this class is only a container for a
117 subset of fields.
118 software => STRING
120 trace => LEVEL
121 type => STRING
122 version => STRING
123 The header
125 Extends "The header" in Mail::Message::Head::FieldGroup.
126 $obj->add( <$field, $value> | $object )
128 All fields appear only once, so "add()" behaves as set().
129 $obj->addFields( [$fieldnames] )
131 Not applicable to resent-groups: the same name can appear in more
132 than one group. Therefore, a FIELDNAME is sufficiently
133 distinctive.
134 $obj->attach($head)
136 Inherited, see "The header" in Mail::Message::Head::FieldGroup
137 $obj->delete()
139 Inherited, see "The header" in Mail::Message::Head::FieldGroup
140 $obj->fieldNames()
142 Inherited, see "The header" in Mail::Message::Head::FieldGroup
143 $obj->fields()
145 Inherited, see "The header" in Mail::Message::Head::FieldGroup
146 $obj->head()
148 Inherited, see "The header" in Mail::Message::Head::FieldGroup
149 $obj->messageHead( [$head] )
151 Returns (optionally after setting) the real header where this
152 resent group belongs to. This may be undef at creation, and then
153 later filled in when
154 Mail::Message::Head::Complete::addResentGroup() is called.
155 $obj->orderedFields()
157 Returns the fields in the order as should appear in header
158 according to rfc2822. For the "Resent-*" fields of the group, the
159 order is not that important, but the "Return-Path", "Delivered-To",
160 and "Received" must come first. Only fields mentioned in the RFC
161 are returned.
162 $obj->set( <$field, $value> | $object )
164 Set a $field to a (new) $value. The $field names which do not
165 start with 'Resent-*' but need it will have that added. It is also
166 an option to specify a fully prepared message field $object. In
167 any case, a field $object is returned.
168 example:
170 my $this = Mail::Message::Head::ResentGroup->new;
172 $this->set(To => 'fish@tux.aq');
173 $msg->addResentGroup($this);
174 $msg->send;
175 $msg->bounce(To => 'fish@tux.aq')->send; # the same
177 my $this = Mail::Message::Head::ResentGroup
179 ->new(To => 'fish@tux.aq');
180 Access to the header
182 Extends "Access to the header" in Mail::Message::Head::FieldGroup.
183 $obj->bcc()
185 In scalar context, the "Resent-Bcc" field is returned. In list
186 context, the addresses as specified within the bcc field are
187 returned as Mail::Address objects. Bcc fields are not transmitted
188 (hidden for external parties).
189 $obj->cc()
191 In scalar context, the "Resent-Cc" field is returned. In list
192 context, the addresses as specified within the cc field are
193 returned as Mail::Address objects.
194 $obj->date()
196 Returns the "Resent-Date" field, or "undef" if it was not defined.
197 $obj->dateTimestamp()
199 The timestamp as stored within the "Resent-Date" field converted to
200 local system time.
201 $obj->deliveredTo()
203 The field which describes the "Delivered-To" of this resent group.
204 $obj->destinations()
206 Returns a list of all addresses specified in the "Resent-To",
207 "-Cc", and "-Bcc" fields of this resent group.
208 $obj->isResentGroupFieldName($name)
210 Mail::Message::Head::ResentGroup->isResentGroupFieldName($name)
211 $obj->messageId()
212 Returns the message-ID used for this group of resent lines.
213 $obj->received()
215 The field which describes the "Received" data of this resent group.
216 $obj->receivedTimestamp()
218 The timestamp as stored within the "Received" field converted to
219 local system time.
220 $obj->resentFrom()
222 In scalar context, the "Resent-From" field is returned. In list
223 context, the addresses as specified within the from field are
224 returned as Mail::Address objects.
225 For reasons of backward compatibility and consistency, the from()
227 method will return the same as this method.
228 $obj->returnPath()
230 The field which describes the "Return-Path" of this resent group.
231 $obj->sender()
233 In scalar context, the "Resent-Sender" field is returned. In list
234 context, the addresses as specified within the from field are
235 returned as Mail::Address objects.
236 $obj->software()
238 Inherited, see "Access to the header" in
239 Mail::Message::Head::FieldGroup
240 $obj->to()
242 In scalar context, the "Resent-To" field is returned. In list
243 context, the addresses as specified within the to field are
244 returned as Mail::Address objects.
245 $obj->type()
247 Inherited, see "Access to the header" in
248 Mail::Message::Head::FieldGroup
249 $obj->version()
251 Inherited, see "Access to the header" in
252 Mail::Message::Head::FieldGroup
253 Internals
255 Extends "Internals" in Mail::Message::Head::FieldGroup.
256 $obj->collectFields( [$name] )
258 Inherited, see "Internals" in Mail::Message::Head::FieldGroup
259 $obj->createReceived( [$domain] )
261 Create a received field for this resent group. This is
262 automatically called if none was specified during creation of this
263 resent group object.
264 The content of this field is described in RFC2821 section 4.4. It
266 could use some improvement.
267 $obj->detected($type, $software, $version)
269 Inherited, see "Internals" in Mail::Message::Head::FieldGroup
270 Error handling
272 Extends "Error handling" in Mail::Message::Head::FieldGroup.
273 $obj->AUTOLOAD()
275 Inherited, see "Error handling" in Mail::Reporter
276 $obj->addReport($object)
278 Inherited, see "Error handling" in Mail::Reporter
279 $obj->defaultTrace( [$level]|[$loglevel, $tracelevel]|[$level,
281 $callback] )
282 Mail::Message::Head::ResentGroup->defaultTrace( [$level]|[$loglevel,
283 $tracelevel]|[$level, $callback] )
284 Inherited, see "Error handling" in Mail::Reporter
285 $obj->details()
287 Inherited, see "Error handling" in Mail::Message::Head::FieldGroup
288 $obj->errors()
290 Inherited, see "Error handling" in Mail::Reporter
291 $obj->log( [$level, [$strings]] )
293 Mail::Message::Head::ResentGroup->log( [$level, [$strings]] )
294 Inherited, see "Error handling" in Mail::Reporter
295 $obj->logPriority($level)
297 Mail::Message::Head::ResentGroup->logPriority($level)
298 Inherited, see "Error handling" in Mail::Reporter
299 $obj->logSettings()
301 Inherited, see "Error handling" in Mail::Reporter
302 $obj->notImplemented()
304 Inherited, see "Error handling" in Mail::Reporter
305 $obj->print( [$fh] )
307 Inherited, see "Error handling" in Mail::Message::Head::FieldGroup
308 $obj->report( [$level] )
310 Inherited, see "Error handling" in Mail::Reporter
311 $obj->reportAll( [$level] )
313 Inherited, see "Error handling" in Mail::Reporter
314 $obj->trace( [$level] )
316 Inherited, see "Error handling" in Mail::Reporter
317 $obj->warnings()
319 Inherited, see "Error handling" in Mail::Reporter
320 Cleanup
322 Extends "Cleanup" in Mail::Message::Head::FieldGroup.
323 $obj->DESTROY()
325 Inherited, see "Cleanup" in Mail::Reporter
326
328 Error: Message header required for creation of ResentGroup.
329 It is required to know to which header the resent-group is created.
330 Use the "head" option. Maybe you should use
331 Mail::Message::Head::Complete::addResentGroup() with DATA, which
332 will organize the correct initiations for you.
333 Error: Package $package does not implement $method.
335 Fatal error: the specific package (or one of its superclasses) does
336 not implement this method where it should. This message means that
337 some other related classes do implement this method however the
338 class at hand does not. Probably you should investigate this and
339 probably inform the author of the package.
340
342 This module is part of Mail-Message distribution version 3.009, built
343 on February 07, 2020. Website: http://perl.overmeer.net/CPAN/
344
346 Copyrights 2001-2020 by [Mark Overmeer <markov@cpan.org>]. For other
347 contributors see ChangeLog.
348 This program is free software; you can redistribute it and/or modify it
350 under the same terms as Perl itself. See http://dev.perl.org/licenses/
351perl v5.32.0 2020-07-28Mail::Message::Head::ResentGroup(3)