Mail::Message::Head::ResentGroup(3pm)

1Mail::Message::Head::ReUsseenrtGCroonutpr(i3b)uted PerlMDaoiclu:m:eMnetsastaigoen::Head::ResentGroup(3)
2
3
4

NAME

6       Mail::Message::Head::ResentGroup - header fields tracking message
7       delivery
8

INHERITANCE

10        Mail::Message::Head::ResentGroup
11          is a Mail::Message::Head::FieldGroup
12          is a Mail::Reporter
13

SYNOPSIS

15        my $rg = Mail::Message::Head::ResentGroup->new(head => $head,
16                     From => 'me@home.nl', To => 'You@tux.aq');
17        $head->addResentGroup($rg);
18
19        my $rg = $head->addResentGroup(From => 'me');
20
21        my @from = $rg->From;
22
23        my @rgs = $head->resentGroups;
24        $rg[2]->delete if @rgs > 2;
25

DESCRIPTION

27       A resent group is a set of header fields which describe one intermedi‐
28       ate step in the message transport.  Resent groups have NOTHING to do
29       with user activety; there is no relation to the "user's" sense of cre‐
30       ating reply, forward, or bounce messages at all!
31

METHODS

33       Constructors
34
35       $obj->clone
36
37           See "Constructors" in Mail::Message::Head::FieldGroup
38
39       $obj->from([HEAD⎪MESSAGE, OPTIONS])
40
41           WARNING: this method has two very different purposes.  For backward
42           compatibility reasons, without arguments resentFrom() is called to
43           return the "From" field of this resent group.
44
45           With any arguments, a list of "Mail::Message::Head::ResentGroup"
46           objects is returned, taken from the specified MESSAGE or message
47           HEAD.
48
49       $obj->implementedTypes
50
51       Mail::Message::Head::ResentGroup->implementedTypes
52
53           See "Constructors" in Mail::Message::Head::FieldGroup
54
55       Mail::Message::Head::ResentGroup->new([FIELDS], OPTIONS)
56
57           Create an object which maintains one set of resent headers.  The
58           FIELDS are Mail::Message::Field objects from the same header.
59
60           OPTIONS which start with capitals will be used to construct addi‐
61           tional fields.  These option names are prepended with "Resent-",
62           keeping the capitization of what is specified.
63
64            Option      --Defined in     --Default
65            Bcc                            undef
66            Cc                             undef
67            Date                           <now>
68            Delivered-To                   undef
69            From                           <required>
70            Message-ID                     <uniquely created>
71            Received                       <created>
72            Return-Path                    undef
73            Sender                         undef
74            To                             undef
75            head                           <created automatically>
76            log           Mail::Reporter   'WARNINGS'
77            message_head                   undef
78            software      Mail::Message::Head::FieldGroup  undef
79            trace         Mail::Reporter   'WARNINGS'
80            type          Mail::Message::Head::FieldGroup  undef
81            version       Mail::Message::Head::FieldGroup  undef
82
83           . Bcc STRING⎪OBJECT⎪OBJECTS
84
85           . Cc STRING⎪OBJECT⎪OBJECTS
86
87           . Date STRING
88
89               When this resent-group is dispatched by the resender of the
90               message. Like the "Date" field, it is not the date and time
91               that the message was actually transported.
92
93           . Delivered-To STRING⎪FIELD
94
95           . From STRING⎪OBJECT⎪OBJECTS
96
97           . Message-ID STRING⎪FIELD
98
99               The "Resent-Message-ID" which identifies this resent group.
100               The FIELD must contain a message id.
101
102           . Received STRING
103
104               The "Received" field is the starting line for a resent group of
105               header lines. If it is not defined, one is created using cre‐
106               ateReceived().
107
108           . Return-Path STRING⎪FIELD
109
110           . Sender STRING⎪OBJECT
111
112               Only permitted when more than one from address is specified.
113               In this case, it selects one of these addresses as the main
114               originator of the message.
115
116           . To STRING⎪OBJECT⎪OBJECTS
117
118           . head OBJECT
119
120               The header where the data is stored in.  Be dafault a
121               Mail::Message::Head::Partial is created for you.
122
123           . log LEVEL
124
125           . message_head HEAD
126
127               The real header of the message where this resent group is part
128               of.  The "head" used in this class is only a container for a
129               subset of fields.
130
131           . software STRING
132
133           . trace LEVEL
134
135           . type STRING
136
137           . version STRING
138
139       The header
140
141       $obj->add((FIELD => VALUE) ⎪ OBJECT)
142
143           All fields appear only once, so "add()" behaves as set().
144
145       $obj->addFields([FIELDNAMES])
146
147           Not applicable to resent-groups: the same name can appear in more
148           than one group.  Therefore, a FIELDNAME is sufficiently distinc‐
149           tive.
150
151       $obj->attach(HEAD)
152
153           See "The header" in Mail::Message::Head::FieldGroup
154
155       $obj->delete
156
157           See "The header" in Mail::Message::Head::FieldGroup
158
159       $obj->fieldNames
160
161           See "The header" in Mail::Message::Head::FieldGroup
162
163       $obj->fields
164
165           See "The header" in Mail::Message::Head::FieldGroup
166
167       $obj->head
168
169           See "The header" in Mail::Message::Head::FieldGroup
170
171       $obj->messageHead([HEAD])
172
173           Returns (optionally after setting) the real header where this
174           resent group belongs to.  This may be undef at creation, and then
175           later filled in when Mail::Message::Head::Complete::addResent‐
176           Group() is called.
177
178       $obj->orderedFields
179
180           Returns the fields in the order as should appear in header accord‐
181           ing to rfc2822.  For the "Resent-" fields of the group, the order
182           is not that important, but the "Return-Path", "Delivered-To", and
183           "Received" must come first.  Only fields mentioned in the RFC are
184           returned.
185
186       $obj->set((FIELD => VALUE) ⎪ OBJECT)
187
188           Set a FIELD to a (new) VALUE.  The FIELD names which do not start
189           with 'Resent-*' but need it will have that added.  It is also an
190           option to specify a fully prepared message field OBJECT.  In any
191           case, a field OBJECT is returned.
192
193           Example:
194
195            my $this = Mail::Message::Head::ResentGroup->new;
196            $this->set(To => 'fish@tux.aq');
197            $msg->addResentGroup($this);
198            $msg->send;
199
200            $msg->bounce(To => 'fish@tux.aq')->send;   # the same
201
202            my $this = Mail::Message::Head::ResentGroup
203                ->new(To => 'fish@tux.aq');
204
205       Access to the header
206
207       $obj->bcc
208
209           In scalar context, the "Resent-Bcc" field is returned.  In list
210           context, the addresses as specified within the bcc field are
211           returned as Mail::Address objects.  Bcc fields are not transmitted
212           (hidden for external parties).
213
214       $obj->cc
215
216           In scalar context, the "Resent-Cc" field is returned.  In list con‐
217           text, the addresses as specified within the cc field are returned
218           as Mail::Address objects.
219
220       $obj->date
221
222           Returns the "Resent-Date" field, or "undef" if it was not defined.
223
224       $obj->dateTimestamp
225
226           The timestamp as stored within the "Resent-Date" field converted to
227           local system time.
228
229       $obj->deliveredTo
230
231           The field which describes the "Delivered-To" of this resent group.
232
233       $obj->destinations
234
235           Returns a list of all addresses specified in the "Resent-To",
236           "-Cc", and "-Bcc" fields of this resent group.
237
238       $obj->isResentGroupFieldName(NAME)
239
240       Mail::Message::Head::ResentGroup->isResentGroupFieldName(NAME)
241
242       $obj->messageId
243
244           Returns the message-ID used for this group of resent lines.
245
246       $obj->received
247
248           The field which describes the "Received" data of this resent group.
249
250       $obj->receivedTimestamp
251
252           The timestamp as stored within the "Received" field converted to
253           local system time.
254
255       $obj->resentFrom
256
257           In scalar context, the "Resent-From" field is returned.  In list
258           context, the addresses as specified within the from field are
259           returned as Mail::Address objects.
260
261           For reasons of backward compatibility and consistency, the from()
262           method will return the same as this method.
263
264       $obj->returnPath
265
266           The field which describes the "Return-Path" of this resent group.
267
268       $obj->sender
269
270           In scalar context, the "Resent-Sender" field is returned.  In list
271           context, the addresses as specified within the from field are
272           returned as Mail::Address objects.
273
274       $obj->software
275
276           See "Access to the header" in Mail::Message::Head::FieldGroup
277
278       $obj->to
279
280           In scalar context, the "Resent-To" field is returned.  In list con‐
281           text, the addresses as specified within the to field are returned
282           as Mail::Address objects.
283
284       $obj->type
285
286           See "Access to the header" in Mail::Message::Head::FieldGroup
287
288       $obj->version
289
290           See "Access to the header" in Mail::Message::Head::FieldGroup
291
292       Internals
293
294       $obj->collectFields([NAME])
295
296           See "Internals" in Mail::Message::Head::FieldGroup
297
298       $obj->createReceived([DOMAIN])
299
300           Create a recieved field for this resent group.  This is automati‐
301           cally called if none was specified during creation of this resent
302           group object.
303
304           The content of this field is described in RFC2821 section 4.4.  It
305           could use some improvement.
306
307       $obj->detected(TYPE, SOFTWARE, VERSION)
308
309           See "Internals" in Mail::Message::Head::FieldGroup
310
311       Error handling
312
313       $obj->AUTOLOAD
314
315           See "Error handling" in Mail::Reporter
316
317       $obj->addReport(OBJECT)
318
319           See "Error handling" in Mail::Reporter
320
321       $obj->defaultTrace([LEVEL]⎪[LOGLEVEL, TRACELEVEL]⎪[LEVEL, CALLBACK])
322
323       Mail::Message::Head::ResentGroup->defaultTrace([LEVEL]⎪[LOGLEVEL,
324       TRACELEVEL]⎪[LEVEL, CALLBACK])
325
326           See "Error handling" in Mail::Reporter
327
328       $obj->details
329
330           See "Error handling" in Mail::Message::Head::FieldGroup
331
332       $obj->errors
333
334           See "Error handling" in Mail::Reporter
335
336       $obj->log([LEVEL [,STRINGS]])
337
338       Mail::Message::Head::ResentGroup->log([LEVEL [,STRINGS]])
339
340           See "Error handling" in Mail::Reporter
341
342       $obj->logPriority(LEVEL)
343
344       Mail::Message::Head::ResentGroup->logPriority(LEVEL)
345
346           See "Error handling" in Mail::Reporter
347
348       $obj->logSettings
349
350           See "Error handling" in Mail::Reporter
351
352       $obj->notImplemented
353
354           See "Error handling" in Mail::Reporter
355
356       $obj->print([FILEHANDLE])
357
358           See "Error handling" in Mail::Message::Head::FieldGroup
359
360       $obj->report([LEVEL])
361
362           See "Error handling" in Mail::Reporter
363
364       $obj->reportAll([LEVEL])
365
366           See "Error handling" in Mail::Reporter
367
368       $obj->trace([LEVEL])
369
370           See "Error handling" in Mail::Reporter
371
372       $obj->warnings
373
374           See "Error handling" in Mail::Reporter
375
376       Cleanup
377
378       $obj->DESTROY
379
380           See "Cleanup" in Mail::Reporter
381
382       $obj->inGlobalDestruction
383
384           See "Cleanup" in Mail::Reporter
385

DIAGNOSTICS

387       Error: Message header required for creation of ResentGroup.
388
389       It is required to know to which header the resent-group is created.
390       Use the "head" option.  Maybe you should use Mail::Message::Head::Com‐
391       plete::addResentGroup() with DATA, which will organize the correct ini‐
392       tiations for you.
393
394       Error: Package $package does not implement $method.
395
396       Fatal error: the specific package (or one of its superclasses) does not
397       implement this method where it should. This message means that some
398       other related classes do implement this method however the class at
399       hand does not.  Probably you should investigate this and probably
400       inform the author of the package.
401

LICENSE

407       Copyrights 2001-2007 by Mark Overmeer.For other contributors see
408       ChangeLog.
409
410       This program is free software; you can redistribute it and/or modify it
411       under the same terms as Perl itself.  See
412       http://www.perl.com/perl/misc/Artistic.html
413
414
415
416perl v5.8.8                       2007-03-25Mail::Message::Head::ResentGroup(3)