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

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

NAME

6       Mail::Box::POP3::Message - one message on a POP3 server
7

INHERITANCE

9        Mail::Box::POP3::Message
10          is a Mail::Box::Net::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::POP3 ...
17        my $message = $folder->message(10);
18

DESCRIPTION

20       A "Mail::Box::POP3::Message" represents one message on a POP3 server,
21       maintained by a Mail::Box::POP3 folder. Each message is stored as sepa‐
22       rate entity on the server, and maybe temporarily in your program as
23       well.
24

METHODS

26       Constructors
27
28       $obj->clone(OPTIONS)
29
30           See "Constructors" in Mail::Message
31
32       Mail::Box::POP3::Message->new(OPTIONS)
33
34        Option    --Defined in     --Default
35        body        Mail::Message    undef
36        body_type   Mail::Box::Message  Mail::Message::Body::Lines
37        deleted     Mail::Message    <false>
38        field_type  Mail::Message    undef
39        folder      Mail::Box::Message  <required>
40        head        Mail::Message    undef
41        head_type   Mail::Message    Mail::Message::Head::Complete
42        labels      Mail::Message    {}
43        log         Mail::Reporter   'WARNINGS'
44        messageId   Mail::Message    undef
45        modified    Mail::Message    <false>
46        size        Mail::Box::Message  undef
47        trace       Mail::Reporter   'WARNINGS'
48        trusted     Mail::Message    <false>
49        unique      Mail::Box::Net::Message  <unique string>
50
51           . body OBJECT
52
53           . body_type CODE⎪CLASS
54
55           . deleted BOOLEAN
56
57           . field_type CLASS
58
59           . folder FOLDER
60
61           . head OBJECT
62
63           . head_type CLASS
64
65           . labels ARRAY⎪HASH
66
67           . log LEVEL
68
69           . messageId STRING
70
71           . modified BOOLEAN
72
73           . size INTEGER
74
75           . trace LEVEL
76
77           . trusted BOOLEAN
78
79           . unique STRING
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::Box::POP3::Message->build([MESSAGE⎪PART⎪BODY], CONTENT)
88
89           See "Constructing a message" in Mail::Message::Construct::Build
90
91       Mail::Box::POP3::Message->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::Box::POP3::Message->read(FILEHAN‐
128       DLE⎪SCALAR⎪REF-SCALAR⎪ARRAY-OF-LINES, 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::Box::POP3::Message->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->copyTo(FOLDER, OPTIONS)
157
158           See "The message" in Mail::Box::Message
159
160       $obj->folder([FOLDER])
161
162           See "The message" in Mail::Box::Message
163
164       $obj->isDummy
165
166           See "The message" in Mail::Message
167
168       $obj->isPart
169
170           See "The message" in Mail::Message
171
172       $obj->messageId
173
174           See "The message" in Mail::Message
175
176       $obj->moveTo(FOLDER, OPTIONS)
177
178           See "The message" in Mail::Box::Message
179
180       $obj->print([FILEHANDLE])
181
182           See "The message" in Mail::Message
183
184       $obj->send([MAILER], OPTIONS)
185
186           See "The message" in Mail::Message
187
188       $obj->seqnr([INTEGER])
189
190           See "The message" in Mail::Box::Message
191
192       $obj->size
193
194           Returns the size of this message.  If the message is still on the
195           remote server, POP is used to ask for the size.  When the message
196           is already loaded onto the local system, the size of the parsed
197           message is taken.  These sizes can differ because the difference in
198           line-ending representation.
199
200       $obj->toplevel
201
202           See "The message" in Mail::Message
203
204       $obj->unique([STRING⎪undef])
205
206           See "The message" in Mail::Box::Net::Message
207
208       $obj->write([FILEHANDLE])
209
210           See "The message" in Mail::Message
211
212       The header
213
214       $obj->bcc
215
216           See "The header" in Mail::Message
217
218       $obj->cc
219
220           See "The header" in Mail::Message
221
222       $obj->date
223
224           See "The header" in Mail::Message
225
226       $obj->destinations
227
228           See "The header" in Mail::Message
229
230       $obj->from
231
232           See "The header" in Mail::Message
233
234       $obj->get(FIELDNAME)
235
236           See "The header" in Mail::Message
237
238       $obj->guessTimestamp
239
240           See "The header" in Mail::Message
241
242       $obj->head([HEAD])
243
244           See "The header" in Mail::Message
245
246       $obj->nrLines
247
248           See "The header" in Mail::Message
249
250       $obj->sender
251
252           See "The header" in Mail::Message
253
254       $obj->study(FIELDNAME)
255
256           See "The header" in Mail::Message
257
258       $obj->subject
259
260           See "The header" in Mail::Message
261
262       $obj->timestamp
263
264           See "The header" in Mail::Message
265
266       $obj->to
267
268           See "The header" in Mail::Message
269
270       The body
271
272       $obj->body([BODY])
273
274           See "The body" in Mail::Message
275
276       $obj->decoded(OPTIONS)
277
278           See "The body" in Mail::Message
279
280       $obj->encode(OPTIONS)
281
282           See "The body" in Mail::Message
283
284       $obj->isMultipart
285
286           See "The body" in Mail::Message
287
288       $obj->isNested
289
290           See "The body" in Mail::Message
291
292       $obj->parts(['ALL'⎪'ACTIVE'⎪'DELETED'⎪'RECURSE'⎪FILTER])
293
294           See "The body" in Mail::Message
295
296       Flags
297
298       $obj->delete
299
300           See "Flags" in Mail::Message
301
302       $obj->deleted([BOOLEAN])
303
304           See "Flags" in Mail::Message
305
306       $obj->isDeleted
307
308           See "Flags" in Mail::Message
309
310       $obj->isModified
311
312           See "Flags" in Mail::Message
313
314       $obj->label(LABEL⎪PAIRS)
315
316           See "Flags" in Mail::Message
317
318       $obj->labels
319
320           See "Flags" in Mail::Message
321
322       $obj->labelsToStatus
323
324           See "Flags" in Mail::Message
325
326       $obj->modified([BOOLEAN])
327
328           See "Flags" in Mail::Message
329
330       $obj->statusToLabels
331
332           See "Flags" in Mail::Message
333
334       The whole message as text
335
336       $obj->file
337
338           See "The whole message as text" in Mail::Message::Construct::Text
339
340       $obj->lines
341
342           See "The whole message as text" in Mail::Message::Construct::Text
343
344       $obj->printStructure([FILEHANDLE⎪undef],[INDENT])
345
346           See "The whole message as text" in Mail::Message::Construct::Text
347
348       $obj->string
349
350           See "The whole message as text" in Mail::Message::Construct::Text
351
352       Internals
353
354       $obj->clonedFrom
355
356           See "Internals" in Mail::Message
357
358       Mail::Box::POP3::Message->coerce(MESSAGE, OPTIONS)
359
360           See "Internals" in Mail::Message
361
362       $obj->diskDelete
363
364           See "Internals" in Mail::Box::Message
365
366       $obj->isDelayed
367
368           See "Internals" in Mail::Message
369
370       $obj->loadBody
371
372           See "Internals" in Mail::Box::Net::Message
373
374       $obj->readBody(PARSER, HEAD [, BODYTYPE])
375
376           See "Internals" in Mail::Box::Message
377
378       $obj->readFromParser(PARSER, [BODYTYPE])
379
380           See "Internals" in Mail::Message
381
382       $obj->readHead(PARSER [,CLASS])
383
384           See "Internals" in Mail::Message
385
386       $obj->recursiveRebuildPart(PART, OPTIONS)
387
388           See "Internals" in Mail::Message::Construct::Rebuild
389
390       $obj->storeBody(BODY)
391
392           See "Internals" in Mail::Message
393
394       $obj->takeMessageId([STRING])
395
396           See "Internals" in Mail::Message
397
398       Error handling
399
400       $obj->AUTOLOAD
401
402           See "METHODS" in Mail::Message::Construct
403
404       $obj->addReport(OBJECT)
405
406           See "Error handling" in Mail::Reporter
407
408       $obj->defaultTrace([LEVEL]⎪[LOGLEVEL, TRACELEVEL]⎪[LEVEL, CALLBACK])
409
410       Mail::Box::POP3::Message->defaultTrace([LEVEL]⎪[LOGLEVEL,
411       TRACELEVEL]⎪[LEVEL, CALLBACK])
412
413           See "Error handling" in Mail::Reporter
414
415       $obj->errors
416
417           See "Error handling" in Mail::Reporter
418
419       $obj->log([LEVEL [,STRINGS]])
420
421       Mail::Box::POP3::Message->log([LEVEL [,STRINGS]])
422
423           See "Error handling" in Mail::Reporter
424
425       $obj->logPriority(LEVEL)
426
427       Mail::Box::POP3::Message->logPriority(LEVEL)
428
429           See "Error handling" in Mail::Reporter
430
431       $obj->logSettings
432
433           See "Error handling" in Mail::Reporter
434
435       $obj->notImplemented
436
437           See "Error handling" in Mail::Reporter
438
439       $obj->report([LEVEL])
440
441           See "Error handling" in Mail::Reporter
442
443       $obj->reportAll([LEVEL])
444
445           See "Error handling" in Mail::Reporter
446
447       $obj->shortSize([VALUE])
448
449       Mail::Box::POP3::Message->shortSize([VALUE])
450
451           See "Error handling" in Mail::Message
452
453       $obj->shortString
454
455           See "Error handling" in Mail::Message
456
457       $obj->trace([LEVEL])
458
459           See "Error handling" in Mail::Reporter
460
461       $obj->warnings
462
463           See "Error handling" in Mail::Reporter
464
465       Cleanup
466
467       $obj->DESTROY
468
469           See "Cleanup" in Mail::Message
470
471       $obj->destruct
472
473           See "Cleanup" in Mail::Box::Message
474
475       $obj->inGlobalDestruction
476
477           See "Cleanup" in Mail::Reporter
478

DETAILS

DIAGNOSTICS

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

LICENSE

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