Mail::Message::Dummy(3pm)

1Mail::Message::Dummy(3)User Contributed Perl DocumentatioMnail::Message::Dummy(3)
2
3
4

NAME

6       Mail::Message::Dummy - a placeholder for a missing messages
7

INHERITANCE

9        Mail::Message::Dummy
10          is a Mail::Message
11          is a Mail::Reporter
12

SYNOPSIS

DESCRIPTION

15       Dummy messages are used by modules which maintain ordered lists of mes‐
16       sages, usually based on message-id.  A good example is
17       Mail::Box::Thread::Manager, which detects related messages by scanning
18       the known message headers for references to other messages.  As long as
19       the referenced messages are not found inside the mailbox, their place
20       is occupied by a dummy.
21
22       Be careful when using modules which may create dummies.  Before trying
23       to access the header or body use isDummy() to check if the message is a
24       dummy message.
25

METHODS

27       Constructors
28
29       $obj->clone(OPTIONS)
30
31           See "Constructors" in Mail::Message
32
33       Mail::Message::Dummy->new(MESSAGE-ID, OPTIONS)
34
35           Create a new dummy message to occupy the space for a real message
36           with the specified MESSAGE-ID.
37
38            Option    --Defined in     --Default
39            body        Mail::Message    <not used>
40            body_type   Mail::Message    Mail::Message::Body::Lines
41            deleted     Mail::Message    <false>
42            field_type  Mail::Message    <not used>
43            head        Mail::Message    <not used>
44            head_type   Mail::Message    <not used>
45            labels      Mail::Message    {}
46            log         Mail::Reporter   'WARNINGS'
47            messageId   Mail::Message    <required>
48            modified    Mail::Message    <always false>
49            trace       Mail::Reporter   'WARNINGS'
50            trusted     Mail::Message    <always true>
51
52           . body OBJECT
53
54           . body_type CLASS
55
56           . deleted BOOLEAN
57
58           . field_type CLASS
59
60           . head OBJECT
61
62           . head_type CLASS
63
64           . labels ARRAY⎪HASH
65
66           . log LEVEL
67
68           . messageId STRING
69
70           . modified BOOLEAN
71
72           . trace LEVEL
73
74           . trusted BOOLEAN
75
76           Example:
77
78            my $message = Mail::Message::Dummy->new($msgid);
79            if($message->isDummy) {...}
80
81       Constructing a message
82
83       $obj->bounce([RG-OBJECT⎪OPTIONS])
84
85           See "Constructing a message" in Mail::Message::Construct::Bounce
86
87       Mail::Message::Dummy->build([MESSAGE⎪PART⎪BODY], CONTENT)
88
89           See "Constructing a message" in Mail::Message::Construct::Build
90
91       Mail::Message::Dummy->buildFromBody(BODY, [HEAD], HEADERS)
92
93           See "Constructing a message" in Mail::Message::Construct::Build
94
95       $obj->forward(OPTIONS)
96
97           See "Constructing a message" in Mail::Message::Construct::Forward
98
99       $obj->forwardAttach(OPTIONS)
100
101           See "Constructing a message" in Mail::Message::Construct::Forward
102
103       $obj->forwardEncapsulate(OPTIONS)
104
105           See "Constructing a message" in Mail::Message::Construct::Forward
106
107       $obj->forwardInline(OPTIONS)
108
109           See "Constructing a message" in Mail::Message::Construct::Forward
110
111       $obj->forwardNo(OPTIONS)
112
113           See "Constructing a message" in Mail::Message::Construct::Forward
114
115       $obj->forwardPostlude
116
117           See "Constructing a message" in Mail::Message::Construct::Forward
118
119       $obj->forwardPrelude
120
121           See "Constructing a message" in Mail::Message::Construct::Forward
122
123       $obj->forwardSubject(STRING)
124
125           See "Constructing a message" in Mail::Message::Construct::Forward
126
127       Mail::Message::Dummy->read(FILEHANDLE⎪SCALAR⎪REF-SCALAR⎪ARRAY-OF-LINES,
128       OPTIONS)
129
130           See "Constructing a message" in Mail::Message::Construct::Read
131
132       $obj->rebuild(OPTIONS)
133
134           See "Constructing a message" in Mail::Message::Construct::Rebuild
135
136       $obj->reply(OPTIONS)
137
138           See "Constructing a message" in Mail::Message::Construct::Reply
139
140       $obj->replyPrelude([STRING⎪FIELD⎪ADDRESS⎪ARRAY-OF-THINGS])
141
142           See "Constructing a message" in Mail::Message::Construct::Reply
143
144       $obj->replySubject(STRING)
145
146       Mail::Message::Dummy->replySubject(STRING)
147
148           See "Constructing a message" in Mail::Message::Construct::Reply
149
150       The message
151
152       $obj->container
153
154           See "The message" in Mail::Message
155
156       $obj->isDummy
157
158           See "The message" in Mail::Message
159
160       $obj->isPart
161
162           See "The message" in Mail::Message
163
164       $obj->messageId
165
166           See "The message" in Mail::Message
167
168       $obj->print([FILEHANDLE])
169
170           See "The message" in Mail::Message
171
172       $obj->send([MAILER], OPTIONS)
173
174           See "The message" in Mail::Message
175
176       $obj->size
177
178           See "The message" in Mail::Message
179
180       $obj->toplevel
181
182           See "The message" in Mail::Message
183
184       $obj->write([FILEHANDLE])
185
186           See "The message" in Mail::Message
187
188       The header
189
190       $obj->bcc
191
192           See "The header" in Mail::Message
193
194       $obj->cc
195
196           See "The header" in Mail::Message
197
198       $obj->date
199
200           See "The header" in Mail::Message
201
202       $obj->destinations
203
204           See "The header" in Mail::Message
205
206       $obj->from
207
208           See "The header" in Mail::Message
209
210       $obj->get(FIELDNAME)
211
212           See "The header" in Mail::Message
213
214       $obj->guessTimestamp
215
216           See "The header" in Mail::Message
217
218       $obj->head(...)
219
220       $obj->nrLines
221
222           See "The header" in Mail::Message
223
224       $obj->sender
225
226           See "The header" in Mail::Message
227
228       $obj->study(FIELDNAME)
229
230           See "The header" in Mail::Message
231
232       $obj->subject
233
234           See "The header" in Mail::Message
235
236       $obj->timestamp
237
238           See "The header" in Mail::Message
239
240       $obj->to
241
242           See "The header" in Mail::Message
243
244       The body
245
246       $obj->body([BODY])
247
248           See "The body" in Mail::Message
249
250       $obj->decoded(OPTIONS)
251
252           See "The body" in Mail::Message
253
254       $obj->encode(OPTIONS)
255
256           See "The body" in Mail::Message
257
258       $obj->isMultipart
259
260           See "The body" in Mail::Message
261
262       $obj->isNested
263
264           See "The body" in Mail::Message
265
266       $obj->parts(['ALL'⎪'ACTIVE'⎪'DELETED'⎪'RECURSE'⎪FILTER])
267
268           See "The body" in Mail::Message
269
270       Flags
271
272       $obj->delete
273
274           See "Flags" in Mail::Message
275
276       $obj->deleted([BOOLEAN])
277
278           See "Flags" in Mail::Message
279
280       $obj->isDeleted
281
282           See "Flags" in Mail::Message
283
284       $obj->isModified
285
286           See "Flags" in Mail::Message
287
288       $obj->label(LABEL⎪PAIRS)
289
290           See "Flags" in Mail::Message
291
292       $obj->labels
293
294           See "Flags" in Mail::Message
295
296       $obj->labelsToStatus
297
298           See "Flags" in Mail::Message
299
300       $obj->modified([BOOLEAN])
301
302           See "Flags" in Mail::Message
303
304       $obj->statusToLabels
305
306           See "Flags" in Mail::Message
307
308       The whole message as text
309
310       $obj->file
311
312           See "The whole message as text" in Mail::Message::Construct::Text
313
314       $obj->lines
315
316           See "The whole message as text" in Mail::Message::Construct::Text
317
318       $obj->printStructure([FILEHANDLE⎪undef],[INDENT])
319
320           See "The whole message as text" in Mail::Message::Construct::Text
321
322       $obj->string
323
324           See "The whole message as text" in Mail::Message::Construct::Text
325
326       Internals
327
328       $obj->clonedFrom
329
330           See "Internals" in Mail::Message
331
332       Mail::Message::Dummy->coerce(MESSAGE, OPTIONS)
333
334           See "Internals" in Mail::Message
335
336       $obj->isDelayed
337
338           See "Internals" in Mail::Message
339
340       $obj->readBody(PARSER, HEAD [, BODYTYPE])
341
342           See "Internals" in Mail::Message
343
344       $obj->readFromParser(PARSER, [BODYTYPE])
345
346           See "Internals" in Mail::Message
347
348       $obj->readHead(PARSER [,CLASS])
349
350           See "Internals" in Mail::Message
351
352       $obj->recursiveRebuildPart(PART, OPTIONS)
353
354           See "Internals" in Mail::Message::Construct::Rebuild
355
356       $obj->storeBody(BODY)
357
358           See "Internals" in Mail::Message
359
360       $obj->takeMessageId([STRING])
361
362           See "Internals" in Mail::Message
363
364       Error handling
365
366       $obj->AUTOLOAD
367
368           See "METHODS" in Mail::Message::Construct
369
370       $obj->addReport(OBJECT)
371
372           See "Error handling" in Mail::Reporter
373
374       $obj->defaultTrace([LEVEL]⎪[LOGLEVEL, TRACELEVEL]⎪[LEVEL, CALLBACK])
375
376       Mail::Message::Dummy->defaultTrace([LEVEL]⎪[LOGLEVEL,
377       TRACELEVEL]⎪[LEVEL, CALLBACK])
378
379           See "Error handling" in Mail::Reporter
380
381       $obj->errors
382
383           See "Error handling" in Mail::Reporter
384
385       $obj->log([LEVEL [,STRINGS]])
386
387       Mail::Message::Dummy->log([LEVEL [,STRINGS]])
388
389           See "Error handling" in Mail::Reporter
390
391       $obj->logPriority(LEVEL)
392
393       Mail::Message::Dummy->logPriority(LEVEL)
394
395           See "Error handling" in Mail::Reporter
396
397       $obj->logSettings
398
399           See "Error handling" in Mail::Reporter
400
401       $obj->notImplemented
402
403           See "Error handling" in Mail::Reporter
404
405       $obj->report([LEVEL])
406
407           See "Error handling" in Mail::Reporter
408
409       $obj->reportAll([LEVEL])
410
411           See "Error handling" in Mail::Reporter
412
413       $obj->shortSize([VALUE])
414
415       Mail::Message::Dummy->shortSize([VALUE])
416
417           See "Error handling" in Mail::Message
418
419       $obj->shortString
420
421           See "Error handling" in Mail::Message
422
423       $obj->trace([LEVEL])
424
425           See "Error handling" in Mail::Reporter
426
427       $obj->warnings
428
429           See "Error handling" in Mail::Reporter
430
431       Cleanup
432
433       $obj->DESTROY
434
435           See "Cleanup" in Mail::Message
436
437       $obj->destruct
438
439           See "Cleanup" in Mail::Message
440
441       $obj->inGlobalDestruction
442
443           See "Cleanup" in Mail::Reporter
444

DETAILS

DIAGNOSTICS

447       Error: Cannot include forward source as $include.
448
449       Unknown alternative for the forward(include).  Valid choices are "NO",
450       "INLINE", "ATTACH", and "ENCAPSULATE".
451
452       Error: Cannot include reply source as $include.
453
454       Unknown alternative for the "include" option of reply().  Valid choices
455       are "NO", "INLINE", and "ATTACH".
456
457       Error: Message-Id is required for a dummy.
458
459       A dummy message occupies the place for a real message.  When a dummy is
460       created, the id of the message which place it is holding must be known.
461
462       Error: Method bounce requires To, Cc, or Bcc
463
464       The message bounce() method forwards a received message off to someone
465       else without modification; you must specified it's new destination.  If
466       you have the urge not to specify any destination, you probably are
467       looking for reply(). When you wish to modify the content, use for‐
468       ward().
469
470       Error: Method forwardAttach requires a preamble
471
472       Error: Method forwardEncapsulate requires a preamble
473
474       Error: No address to create forwarded to.
475
476       If a forward message is created, a destination address must be speci‐
477       fied.
478
479       Error: No default mailer found to send message.
480
481       The message send() mechanism had not enough information to automati‐
482       cally find a mail transfer agent to sent this message.  Specify a
483       mailer explicitly using the "via" options.
484
485       Error: No rebuild rule $name defined.
486
487       Error: Only build() Mail::Message's; they are not in a folder yet
488
489       You may wish to construct a message to be stored in a some kind of
490       folder, but you need to do that in two steps.  First, create a normal
491       Mail::Message, and then add it to the folder.  During this
492       Mail::Box::addMessage() process, the message will get coerce()-d into
493       the right message type, adding storage information and the like.
494
495       Error: Package $package does not implement $method.
496
497       Fatal error: the specific package (or one of its superclasses) does not
498       implement this method where it should. This message means that some
499       other related classes do implement this method however the class at
500       hand does not.  Probably you should investigate this and probably
501       inform the author of the package.
502
503       Error: You cannot take the head/body of a dummy message
504
505       Dummy messages are place-holders in message threads: the thread
506       detected the existence of the message, because it found the message-id
507       in a Reply-To or References field, however it did not find the header
508       and body of the message yet.  Use isDummy() to check whether the thread
509       node returned a dummy or not.
510

LICENSE

516       Copyrights 2001-2007 by Mark Overmeer.For other contributors see
517       ChangeLog.
518
519       This program is free software; you can redistribute it and/or modify it
520       under the same terms as Perl itself.  See
521       http://www.perl.com/perl/misc/Artistic.html
522
523
524
525perl v5.8.8                       2007-03-25           Mail::Message::Dummy(3)