1Mail::Box::POP3::MessagUes(e3r)Contributed Perl DocumentMaatiilo:n:Box::POP3::Message(3)
2
3
4
6 Mail::Box::POP3::Message - one message on a POP3 server
7
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
16 my $folder = new Mail::Box::POP3 ...
17 my $message = $folder->message(10);
18
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
25 Extends "DESCRIPTION" in Mail::Box::Net::Message.
26
28 Extends "METHODS" in Mail::Box::Net::Message.
29
30 Constructors
31 Extends "Constructors" in Mail::Box::Net::Message.
32
33 $obj->clone(%options)
34 Inherited, see "Constructors" in Mail::Message
35
36 Mail::Box::POP3::Message->new(%options)
37 -Option --Defined in --Default
38 body Mail::Message undef
39 body_type Mail::Box::Message Mail::Message::Body::Lines
40 deleted Mail::Message <false>
41 field_type Mail::Message undef
42 folder Mail::Box::Message <required>
43 head Mail::Message undef
44 head_type Mail::Message Mail::Message::Head::Complete
45 labels Mail::Message {}
46 log Mail::Reporter 'WARNINGS'
47 messageId Mail::Message undef
48 modified Mail::Message <false>
49 size Mail::Box::Message undef
50 trace Mail::Reporter 'WARNINGS'
51 trusted Mail::Message <false>
52 unique Mail::Box::Net::Message <unique string>
53
54 body => OBJECT
55 body_type => CODE|CLASS
56 deleted => BOOLEAN
57 field_type => CLASS
58 folder => FOLDER
59 head => OBJECT
60 head_type => CLASS
61 labels => ARRAY|HASH
62 log => LEVEL
63 messageId => STRING
64 modified => BOOLEAN
65 size => INTEGER
66 trace => LEVEL
67 trusted => BOOLEAN
68 unique => STRING
69
70 Constructing a message
71 Extends "Constructing a message" in Mail::Box::Net::Message.
72
73 $obj->bounce( [<$rg_object|%options>] )
74 Inherited, see "Constructing a message" in
75 Mail::Message::Construct::Bounce
76
77 Mail::Box::POP3::Message->build( [$message|$part|$body], $content )
78 Inherited, see "Constructing a message" in
79 Mail::Message::Construct::Build
80
81 Mail::Box::POP3::Message->buildFromBody($body, [$head], $headers)
82 Inherited, see "Constructing a message" in
83 Mail::Message::Construct::Build
84
85 $obj->forward(%options)
86 Inherited, see "Constructing a message" in
87 Mail::Message::Construct::Forward
88
89 $obj->forwardAttach(%options)
90 Inherited, see "Constructing a message" in
91 Mail::Message::Construct::Forward
92
93 $obj->forwardEncapsulate(%options)
94 Inherited, see "Constructing a message" in
95 Mail::Message::Construct::Forward
96
97 $obj->forwardInline(%options)
98 Inherited, see "Constructing a message" in
99 Mail::Message::Construct::Forward
100
101 $obj->forwardNo(%options)
102 Inherited, see "Constructing a message" in
103 Mail::Message::Construct::Forward
104
105 $obj->forwardPostlude()
106 Inherited, see "Constructing a message" in
107 Mail::Message::Construct::Forward
108
109 $obj->forwardPrelude()
110 Inherited, see "Constructing a message" in
111 Mail::Message::Construct::Forward
112
113 $obj->forwardSubject(STRING)
114 Inherited, see "Constructing a message" in
115 Mail::Message::Construct::Forward
116
117 Mail::Box::POP3::Message->read($fh|STRING|SCALAR|ARRAY, %options)
118 Inherited, see "Constructing a message" in
119 Mail::Message::Construct::Read
120
121 $obj->rebuild(%options)
122 Inherited, see "Constructing a message" in
123 Mail::Message::Construct::Rebuild
124
125 $obj->reply(%options)
126 Inherited, see "Constructing a message" in
127 Mail::Message::Construct::Reply
128
129 $obj->replyPrelude( [STRING|$field|$address|ARRAY-$of-$things] )
130 Inherited, see "Constructing a message" in
131 Mail::Message::Construct::Reply
132
133 $obj->replySubject(STRING)
134 Mail::Box::POP3::Message->replySubject(STRING)
135 Inherited, see "Constructing a message" in
136 Mail::Message::Construct::Reply
137
138 The message
139 Extends "The message" in Mail::Box::Net::Message.
140
141 $obj->container()
142 Inherited, see "The message" in Mail::Message
143
144 $obj->copyTo($folder, %options)
145 Inherited, see "The message" in Mail::Box::Message
146
147 $obj->folder( [$folder] )
148 Inherited, see "The message" in Mail::Box::Message
149
150 $obj->isDummy()
151 Inherited, see "The message" in Mail::Message
152
153 $obj->isPart()
154 Inherited, see "The message" in Mail::Message
155
156 $obj->messageId()
157 Inherited, see "The message" in Mail::Message
158
159 $obj->moveTo($folder, %options)
160 Inherited, see "The message" in Mail::Box::Message
161
162 $obj->partNumber()
163 Inherited, see "The message" in Mail::Message
164
165 $obj->print( [$fh] )
166 Inherited, see "The message" in Mail::Message
167
168 $obj->send( [$mailer], %options )
169 Inherited, see "The message" in Mail::Message
170
171 $obj->seqnr( [$integer] )
172 Inherited, see "The message" in Mail::Box::Message
173
174 $obj->size()
175 Returns the size of this message. If the message is still on the
176 remote server, POP is used to ask for the size. When the message
177 is already loaded onto the local system, the size of the parsed
178 message is taken. These sizes can differ because the difference in
179 line-ending representation.
180
181 $obj->toplevel()
182 Inherited, see "The message" in Mail::Message
183
184 $obj->unique( [STRING|undef] )
185 Inherited, see "The message" in Mail::Box::Net::Message
186
187 $obj->write( [$fh] )
188 Inherited, see "The message" in Mail::Message
189
190 The header
191 Extends "The header" in Mail::Box::Net::Message.
192
193 $obj->bcc()
194 Inherited, see "The header" in Mail::Message
195
196 $obj->cc()
197 Inherited, see "The header" in Mail::Message
198
199 $obj->date()
200 Inherited, see "The header" in Mail::Message
201
202 $obj->destinations()
203 Inherited, see "The header" in Mail::Message
204
205 $obj->from()
206 Inherited, see "The header" in Mail::Message
207
208 $obj->get($fieldname)
209 Inherited, see "The header" in Mail::Message
210
211 $obj->guessTimestamp()
212 Inherited, see "The header" in Mail::Message
213
214 $obj->head( [$head] )
215 Inherited, see "The header" in Mail::Message
216
217 $obj->nrLines()
218 Inherited, see "The header" in Mail::Message
219
220 $obj->sender()
221 Inherited, see "The header" in Mail::Message
222
223 $obj->study($fieldname)
224 Inherited, see "The header" in Mail::Message
225
226 $obj->subject()
227 Inherited, see "The header" in Mail::Message
228
229 $obj->timestamp()
230 Inherited, see "The header" in Mail::Message
231
232 $obj->to()
233 Inherited, see "The header" in Mail::Message
234
235 The body
236 Extends "The body" in Mail::Box::Net::Message.
237
238 $obj->body( [$body] )
239 Inherited, see "The body" in Mail::Message
240
241 $obj->contentType()
242 Inherited, see "The body" in Mail::Message
243
244 $obj->decoded(%options)
245 Inherited, see "The body" in Mail::Message
246
247 $obj->encode(%options)
248 Inherited, see "The body" in Mail::Message
249
250 $obj->isMultipart()
251 Inherited, see "The body" in Mail::Message
252
253 $obj->isNested()
254 Inherited, see "The body" in Mail::Message
255
256 $obj->parts( [<'ALL'|'ACTIVE'|'DELETED'|'RECURSE'|$filter>] )
257 Inherited, see "The body" in Mail::Message
258
259 Flags
260 Extends "Flags" in Mail::Box::Net::Message.
261
262 $obj->delete()
263 Inherited, see "Flags" in Mail::Message
264
265 $obj->deleted( [BOOLEAN] )
266 Inherited, see "Flags" in Mail::Message
267
268 $obj->isDeleted()
269 Inherited, see "Flags" in Mail::Message
270
271 $obj->isModified()
272 Inherited, see "Flags" in Mail::Message
273
274 $obj->label($label|PAIRS)
275 Inherited, see "Flags" in Mail::Message
276
277 $obj->labels()
278 Inherited, see "Flags" in Mail::Message
279
280 $obj->labelsToStatus()
281 Inherited, see "Flags" in Mail::Message
282
283 $obj->modified( [BOOLEAN] )
284 Inherited, see "Flags" in Mail::Message
285
286 $obj->statusToLabels()
287 Inherited, see "Flags" in Mail::Message
288
289 The whole message as text
290 Extends "The whole message as text" in Mail::Box::Net::Message.
291
292 $obj->file()
293 Inherited, see "The whole message as text" in
294 Mail::Message::Construct::Text
295
296 $obj->lines()
297 Inherited, see "The whole message as text" in
298 Mail::Message::Construct::Text
299
300 $obj->printStructure( [$fh|undef],[$indent] )
301 Inherited, see "The whole message as text" in
302 Mail::Message::Construct::Text
303
304 $obj->string()
305 Inherited, see "The whole message as text" in
306 Mail::Message::Construct::Text
307
308 Internals
309 Extends "Internals" in Mail::Box::Net::Message.
310
311 $obj->clonedFrom()
312 Inherited, see "Internals" in Mail::Message
313
314 Mail::Box::POP3::Message->coerce($message, %options)
315 Inherited, see "Internals" in Mail::Message
316
317 $obj->diskDelete()
318 Inherited, see "Internals" in Mail::Box::Message
319
320 $obj->isDelayed()
321 Inherited, see "Internals" in Mail::Message
322
323 $obj->loadBody()
324 Inherited, see "Internals" in Mail::Box::Net::Message
325
326 $obj->readBody( $parser, $head, [$bodytype] )
327 Inherited, see "Internals" in Mail::Box::Message
328
329 $obj->readFromParser( $parser, [$bodytype] )
330 Inherited, see "Internals" in Mail::Message
331
332 $obj->readHead( $parser, [$class] )
333 Inherited, see "Internals" in Mail::Message
334
335 $obj->recursiveRebuildPart($part, %options)
336 Inherited, see "Internals" in Mail::Message::Construct::Rebuild
337
338 $obj->storeBody($body)
339 Inherited, see "Internals" in Mail::Message
340
341 $obj->takeMessageId( [STRING] )
342 Inherited, see "Internals" in Mail::Message
343
344 Error handling
345 Extends "Error handling" in Mail::Box::Net::Message.
346
347 $obj->AUTOLOAD()
348 Inherited, see "METHODS" in Mail::Message::Construct
349
350 $obj->addReport($object)
351 Inherited, see "Error handling" in Mail::Reporter
352
353 $obj->defaultTrace( [$level]|[$loglevel, $tracelevel]|[$level,
354 $callback] )
355 Mail::Box::POP3::Message->defaultTrace( [$level]|[$loglevel,
356 $tracelevel]|[$level, $callback] )
357 Inherited, see "Error handling" in Mail::Reporter
358
359 $obj->errors()
360 Inherited, see "Error handling" in Mail::Reporter
361
362 $obj->log( [$level, [$strings]] )
363 Mail::Box::POP3::Message->log( [$level, [$strings]] )
364 Inherited, see "Error handling" in Mail::Reporter
365
366 $obj->logPriority($level)
367 Mail::Box::POP3::Message->logPriority($level)
368 Inherited, see "Error handling" in Mail::Reporter
369
370 $obj->logSettings()
371 Inherited, see "Error handling" in Mail::Reporter
372
373 $obj->notImplemented()
374 Inherited, see "Error handling" in Mail::Reporter
375
376 $obj->report( [$level] )
377 Inherited, see "Error handling" in Mail::Reporter
378
379 $obj->reportAll( [$level] )
380 Inherited, see "Error handling" in Mail::Reporter
381
382 $obj->shortSize( [$value] )
383 Mail::Box::POP3::Message->shortSize( [$value] )
384 Inherited, see "Error handling" in Mail::Message
385
386 $obj->shortString()
387 Inherited, see "Error handling" in Mail::Message
388
389 $obj->trace( [$level] )
390 Inherited, see "Error handling" in Mail::Reporter
391
392 $obj->warnings()
393 Inherited, see "Error handling" in Mail::Reporter
394
395 Cleanup
396 Extends "Cleanup" in Mail::Box::Net::Message.
397
398 $obj->DESTROY()
399 Inherited, see "Cleanup" in Mail::Reporter
400
401 $obj->destruct()
402 Inherited, see "Cleanup" in Mail::Box::Message
403
405 Extends "DETAILS" in Mail::Box::Net::Message.
406
408 Error: Cannot coerce a $class object into a $class object
409 Error: Cannot include forward source as $include.
410 Unknown alternative for the forward(include). Valid choices are
411 "NO", "INLINE", "ATTACH", and "ENCAPSULATE".
412
413 Error: Cannot include reply source as $include.
414 Unknown alternative for the "include" option of reply(). Valid
415 choices are "NO", "INLINE", and "ATTACH".
416
417 Error: Method bounce requires To, Cc, or Bcc
418 The message bounce() method forwards a received message off to
419 someone else without modification; you must specified it's new
420 destination. If you have the urge not to specify any destination,
421 you probably are looking for reply(). When you wish to modify the
422 content, use forward().
423
424 Error: Method forwardAttach requires a preamble
425 Error: Method forwardEncapsulate requires a preamble
426 Error: No address to create forwarded to.
427 If a forward message is created, a destination address must be
428 specified.
429
430 Error: No default mailer found to send message.
431 The message send() mechanism had not enough information to
432 automatically find a mail transfer agent to sent this message.
433 Specify a mailer explicitly using the "via" options.
434
435 Error: No rebuild rule $name defined.
436 Error: Only build() Mail::Message's; they are not in a folder yet
437 You may wish to construct a message to be stored in a some kind of
438 folder, but you need to do that in two steps. First, create a
439 normal Mail::Message, and then add it to the folder. During this
440 Mail::Box::addMessage() process, the message will get coerce()-d
441 into the right message type, adding storage information and the
442 like.
443
444 Error: Package $package does not implement $method.
445 Fatal error: the specific package (or one of its superclasses) does
446 not implement this method where it should. This message means that
447 some other related classes do implement this method however the
448 class at hand does not. Probably you should investigate this and
449 probably inform the author of the package.
450
451 Error: Unable to read delayed body.
452 Error: Unable to read delayed head.
453 Error: coercion starts with some object
454
456 This module is part of Mail-Box-POP3 distribution version 3.005, built
457 on May 03, 2019. Website: http://perl.overmeer.net/CPAN/
458
460 Copyrights 2001-2019 by [Mark Overmeer]. For other contributors see
461 ChangeLog.
462
463 This program is free software; you can redistribute it and/or modify it
464 under the same terms as Perl itself. See http://dev.perl.org/licenses/
465
466
467
468perl v5.36.0 2022-07-22 Mail::Box::POP3::Message(3)