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
22       separate entity on the server, and maybe temporarily in your program as
23       well.
24

METHODS

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

DIAGNOSTICS

366       Error: Cannot coerce a $class object into a $class object
367       Error: Cannot include forward source as $include.
368           Unknown alternative for the forward(include).  Valid choices are
369           "NO", "INLINE", "ATTACH", and "ENCAPSULATE".
370
371       Error: Cannot include reply source as $include.
372           Unknown alternative for the "include" option of reply().  Valid
373           choices are "NO", "INLINE", and "ATTACH".
374
375       Error: Method bounce requires To, Cc, or Bcc
376           The message bounce() method forwards a received message off to
377           someone else without modification; you must specified it's new
378           destination.  If you have the urge not to specify any destination,
379           you probably are looking for reply(). When you wish to modify the
380           content, use forward().
381
382       Error: Method forwardAttach requires a preamble
383       Error: Method forwardEncapsulate requires a preamble
384       Error: No address to create forwarded to.
385           If a forward message is created, a destination address must be
386           specified.
387
388       Error: No default mailer found to send message.
389           The message send() mechanism had not enough information to
390           automatically find a mail transfer agent to sent this message.
391           Specify a mailer explicitly using the "via" options.
392
393       Error: No rebuild rule $name defined.
394       Error: Only build() Mail::Message's; they are not in a folder yet
395           You may wish to construct a message to be stored in a some kind of
396           folder, but you need to do that in two steps.  First, create a
397           normal Mail::Message, and then add it to the folder.  During this
398           Mail::Box::addMessage() process, the message will get coerce()-d
399           into the right message type, adding storage information and the
400           like.
401
402       Error: Package $package does not implement $method.
403           Fatal error: the specific package (or one of its superclasses) does
404           not implement this method where it should. This message means that
405           some other related classes do implement this method however the
406           class at hand does not.  Probably you should investigate this and
407           probably inform the author of the package.
408
409       Error: Unable to read delayed body.
410       Error: Unable to read delayed head.
411       Error: coercion starts with some object
412

SEE ALSO

414       This module is part of Mail-Box distribution version 2.097, built on
415       January 26, 2011. Website: http://perl.overmeer.net/mailbox/
416

LICENSE

418       Copyrights 2001-2011 by Mark Overmeer. For other contributors see
419       ChangeLog.
420
421       This program is free software; you can redistribute it and/or modify it
422       under the same terms as Perl itself.  See
423       http://www.perl.com/perl/misc/Artistic.html
424
425
426
427perl v5.12.3                      2011-01-26       Mail::Box::POP3::Message(3)