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

1Mail::Box::Net::MessageU(s3e)r Contributed Perl DocumentaMtaiioln::Box::Net::Message(3)
2
3
4

NAME

6       Mail::Box::Net::Message - one message from a distant folder
7

INHERITANCE

9        Mail::Box::Net::Message
10          is a Mail::Box::Message
11          is a Mail::Message
12          is a Mail::Reporter
13
14        Mail::Box::Net::Message is extended by
15          Mail::Box::IMAP4::Message
16          Mail::Box::POP3::Message
17

SYNOPSIS

19        my $folder = new Mail::Box::POP3 ...
20        my $message = $folder->message(10);
21

DESCRIPTION

23       A Mail::Box::Net::Message represents one message in a folder which can
24       only be accessed via some kind of protocol.  On this moment, only a
25       POP3 client is available.  IMAP, DBI, and NNTP are other candidates.
26

METHODS

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

DETAILS

DIAGNOSTICS

483       Error: Cannot include forward source as $include.
484
485       Unknown alternative for the forward(include).  Valid choices are "NO",
486       "INLINE", "ATTACH", and "ENCAPSULATE".
487
488       Error: Cannot include reply source as $include.
489
490       Unknown alternative for the "include" option of reply().  Valid choices
491       are "NO", "INLINE", and "ATTACH".
492
493       Error: Method bounce requires To, Cc, or Bcc
494
495       The message bounce() method forwards a received message off to someone
496       else without modification; you must specified it's new destination.  If
497       you have the urge not to specify any destination, you probably are
498       looking for reply(). When you wish to modify the content, use for‐
499       ward().
500
501       Error: Method forwardAttach requires a preamble
502
503       Error: Method forwardEncapsulate requires a preamble
504
505       Error: No address to create forwarded to.
506
507       If a forward message is created, a destination address must be speci‐
508       fied.
509
510       Error: No default mailer found to send message.
511
512       The message send() mechanism had not enough information to automati‐
513       cally find a mail transfer agent to sent this message.  Specify a
514       mailer explicitly using the "via" options.
515
516       Error: No rebuild rule $name defined.
517
518       Error: Only build() Mail::Message's; they are not in a folder yet
519
520       You may wish to construct a message to be stored in a some kind of
521       folder, but you need to do that in two steps.  First, create a normal
522       Mail::Message, and then add it to the folder.  During this
523       Mail::Box::addMessage() process, the message will get coerce()-d into
524       the right message type, adding storage information and the like.
525
526       Error: Package $package does not implement $method.
527
528       Fatal error: the specific package (or one of its superclasses) does not
529       implement this method where it should. This message means that some
530       other related classes do implement this method however the class at
531       hand does not.  Probably you should investigate this and probably
532       inform the author of the package.
533
534       Error: Unable to read delayed body.
535
536       Error: Unable to read delayed head.
537

LICENSE

543       Copyrights 2001-2007 by Mark Overmeer.For other contributors see
544       ChangeLog.
545
546       This program is free software; you can redistribute it and/or modify it
547       under the same terms as Perl itself.  See
548       http://www.perl.com/perl/misc/Artistic.html
549
550
551
552perl v5.8.8                       2007-03-25        Mail::Box::Net::Message(3)