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

DIAGNOSTICS

337       Error: Cannot coerce a $class object into a $class object
338       Error: Cannot include forward source as $include.
339           Unknown alternative for the forward(include).  Valid choices are
340           "NO", "INLINE", "ATTACH", and "ENCAPSULATE".
341
342       Error: Cannot include reply source as $include.
343           Unknown alternative for the "include" option of reply().  Valid
344           choices are "NO", "INLINE", and "ATTACH".
345
346       Error: Method bounce requires To, Cc, or Bcc
347           The message bounce() method forwards a received message off to
348           someone else without modification; you must specified it's new
349           destination.  If you have the urge not to specify any destination,
350           you probably are looking for reply(). When you wish to modify the
351           content, use forward().
352
353       Error: Method forwardAttach requires a preamble
354       Error: Method forwardEncapsulate requires a preamble
355       Error: No address to create forwarded to.
356           If a forward message is created, a destination address must be
357           specified.
358
359       Error: No default mailer found to send message.
360           The message send() mechanism had not enough information to
361           automatically find a mail transfer agent to sent this message.
362           Specify a mailer explicitly using the "via" options.
363
364       Error: No rebuild rule $name defined.
365       Error: Only build() Mail::Message's; they are not in a folder yet
366           You may wish to construct a message to be stored in a some kind of
367           folder, but you need to do that in two steps.  First, create a
368           normal Mail::Message, and then add it to the folder.  During this
369           Mail::Box::addMessage() process, the message will get coerce()-d
370           into the right message type, adding storage information and the
371           like.
372
373       Error: Package $package does not implement $method.
374           Fatal error: the specific package (or one of its superclasses) does
375           not implement this method where it should. This message means that
376           some other related classes do implement this method however the
377           class at hand does not.  Probably you should investigate this and
378           probably inform the author of the package.
379
380       Error: Unable to read delayed body.
381       Error: coercion starts with some object
382

LICENSE

388       Copyrights 2001-2011 by Mark Overmeer. For other contributors see
389       ChangeLog.
390
391       This program is free software; you can redistribute it and/or modify it
392       under the same terms as Perl itself.  See
393       http://www.perl.com/perl/misc/Artistic.html
394
395
396
397perl v5.12.3                      2011-01-26       Mail::Box::Mbox::Message(3)