Mail::Box::Mbox::Message(3pm)

1Mail::Box::Mbox::MessagUes(e3r)Contributed Perl DocumentMaatiilo:n:Box::Mbox::Message(3)
2
3
4

NAME

6       Mail::Box::Mbox::Message - one message in a Mbox folder
7

INHERITANCE

9        Mail::Box::Mbox::Message
10          is a Mail::Box::File::Message
11          is a Mail::Box::Message
12          is a Mail::Message
13          is a Mail::Reporter
14

SYNOPSIS

16        my $folder  = new Mail::Box::Mbox folder => $ENV{MAIL}, ...;
17        my $message = $folder->message(0);
18

DESCRIPTION

20       Maintain one message in an Mail::Box::Mbox folder.
21

METHODS

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

DETAILS

DIAGNOSTICS

441       Error: Cannot include forward source as $include.
442
443       Unknown alternative for the forward(include).  Valid choices are "NO",
444       "INLINE", "ATTACH", and "ENCAPSULATE".
445
446       Error: Cannot include reply source as $include.
447
448       Unknown alternative for the "include" option of reply().  Valid choices
449       are "NO", "INLINE", and "ATTACH".
450
451       Error: Method bounce requires To, Cc, or Bcc
452
453       The message bounce() method forwards a received message off to someone
454       else without modification; you must specified it's new destination.  If
455       you have the urge not to specify any destination, you probably are
456       looking for reply(). When you wish to modify the content, use for‐
457       ward().
458
459       Error: Method forwardAttach requires a preamble
460
461       Error: Method forwardEncapsulate requires a preamble
462
463       Error: No address to create forwarded to.
464
465       If a forward message is created, a destination address must be speci‐
466       fied.
467
468       Error: No default mailer found to send message.
469
470       The message send() mechanism had not enough information to automati‐
471       cally find a mail transfer agent to sent this message.  Specify a
472       mailer explicitly using the "via" options.
473
474       Error: No rebuild rule $name defined.
475
476       Error: Only build() Mail::Message's; they are not in a folder yet
477
478       You may wish to construct a message to be stored in a some kind of
479       folder, but you need to do that in two steps.  First, create a normal
480       Mail::Message, and then add it to the folder.  During this
481       Mail::Box::addMessage() process, the message will get coerce()-d into
482       the right message type, adding storage information and the like.
483
484       Error: Package $package does not implement $method.
485
486       Fatal error: the specific package (or one of its superclasses) does not
487       implement this method where it should. This message means that some
488       other related classes do implement this method however the class at
489       hand does not.  Probably you should investigate this and probably
490       inform the author of the package.
491
492       Error: Unable to read delayed body.
493

LICENSE

499       Copyrights 2001-2007 by Mark Overmeer.For other contributors see
500       ChangeLog.
501
502       This program is free software; you can redistribute it and/or modify it
503       under the same terms as Perl itself.  See
504       http://www.perl.com/perl/misc/Artistic.html
505
506
507
508perl v5.8.8                       2007-03-25       Mail::Box::Mbox::Message(3)