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
27       Extends "DESCRIPTION" in Mail::Box::Message.
28

METHODS

30       Extends "METHODS" in Mail::Box::Message.
31
32   Constructors
33       Extends "Constructors" in Mail::Box::Message.
34
35       $obj->clone(%options)
36           Inherited, see "Constructors" in Mail::Message
37
38       Mail::Box::Net::Message->new(%options)
39            -Option    --Defined in        --Default
40             body        Mail::Message       undef
41             body_type   Mail::Box::Message  <from folder>
42             deleted     Mail::Message       <false>
43             field_type  Mail::Message       undef
44             folder      Mail::Box::Message  <required>
45             head        Mail::Message       undef
46             head_type   Mail::Message       Mail::Message::Head::Complete
47             labels      Mail::Message       {}
48             log         Mail::Reporter      'WARNINGS'
49             messageId   Mail::Message       undef
50             modified    Mail::Message       <false>
51             size        Mail::Box::Message  undef
52             trace       Mail::Reporter      'WARNINGS'
53             trusted     Mail::Message       <false>
54             unique                          <unique string>
55
56           body => OBJECT
57           body_type => CODE|CLASS
58           deleted => BOOLEAN
59           field_type => CLASS
60           folder => FOLDER
61           head => OBJECT
62           head_type => CLASS
63           labels => ARRAY|HASH
64           log => LEVEL
65           messageId => STRING
66           modified => BOOLEAN
67           size => INTEGER
68           trace => LEVEL
69           trusted => BOOLEAN
70           unique => STRING
71             The unique keys which identifies this message on the remote
72             server.
73
74   Constructing a message
75       Extends "Constructing a message" in Mail::Box::Message.
76
77       $obj->bounce( [<$rg_object|%options>] )
78           Inherited, see "Constructing a message" in
79           Mail::Message::Construct::Bounce
80
81       Mail::Box::Net::Message->build( [$message|$part|$body], $content )
82           Inherited, see "Constructing a message" in
83           Mail::Message::Construct::Build
84
85       Mail::Box::Net::Message->buildFromBody($body, [$head], $headers)
86           Inherited, see "Constructing a message" in
87           Mail::Message::Construct::Build
88
89       $obj->forward(%options)
90           Inherited, see "Constructing a message" in
91           Mail::Message::Construct::Forward
92
93       $obj->forwardAttach(%options)
94           Inherited, see "Constructing a message" in
95           Mail::Message::Construct::Forward
96
97       $obj->forwardEncapsulate(%options)
98           Inherited, see "Constructing a message" in
99           Mail::Message::Construct::Forward
100
101       $obj->forwardInline(%options)
102           Inherited, see "Constructing a message" in
103           Mail::Message::Construct::Forward
104
105       $obj->forwardNo(%options)
106           Inherited, see "Constructing a message" in
107           Mail::Message::Construct::Forward
108
109       $obj->forwardPostlude()
110           Inherited, see "Constructing a message" in
111           Mail::Message::Construct::Forward
112
113       $obj->forwardPrelude()
114           Inherited, see "Constructing a message" in
115           Mail::Message::Construct::Forward
116
117       $obj->forwardSubject(STRING)
118           Inherited, see "Constructing a message" in
119           Mail::Message::Construct::Forward
120
121       Mail::Box::Net::Message->read($fh|STRING|SCALAR|ARRAY, %options)
122           Inherited, see "Constructing a message" in
123           Mail::Message::Construct::Read
124
125       $obj->rebuild(%options)
126           Inherited, see "Constructing a message" in
127           Mail::Message::Construct::Rebuild
128
129       $obj->reply(%options)
130           Inherited, see "Constructing a message" in
131           Mail::Message::Construct::Reply
132
133       $obj->replyPrelude( [STRING|$field|$address|ARRAY-$of-$things] )
134           Inherited, see "Constructing a message" in
135           Mail::Message::Construct::Reply
136
137       $obj->replySubject(STRING)
138       Mail::Box::Net::Message->replySubject(STRING)
139           Inherited, see "Constructing a message" in
140           Mail::Message::Construct::Reply
141
142   The message
143       Extends "The message" in Mail::Box::Message.
144
145       $obj->container()
146           Inherited, see "The message" in Mail::Message
147
148       $obj->copyTo($folder, %options)
149           Inherited, see "The message" in Mail::Box::Message
150
151       $obj->folder( [$folder] )
152           Inherited, see "The message" in Mail::Box::Message
153
154       $obj->isDummy()
155           Inherited, see "The message" in Mail::Message
156
157       $obj->isPart()
158           Inherited, see "The message" in Mail::Message
159
160       $obj->messageId()
161           Inherited, see "The message" in Mail::Message
162
163       $obj->moveTo($folder, %options)
164           Inherited, see "The message" in Mail::Box::Message
165
166       $obj->partNumber()
167           Inherited, see "The message" in Mail::Message
168
169       $obj->print( [$fh] )
170           Inherited, see "The message" in Mail::Message
171
172       $obj->send( [$mailer], %options )
173           Inherited, see "The message" in Mail::Message
174
175       $obj->seqnr( [$integer] )
176           Inherited, see "The message" in Mail::Box::Message
177
178       $obj->size()
179           Inherited, see "The message" in Mail::Message
180
181       $obj->toplevel()
182           Inherited, see "The message" in Mail::Message
183
184       $obj->unique( [STRING|undef] )
185           Returns the name of the file in which this message is actually
186           stored.  This will return "undef" when the message is not stored in
187           a file.  When a STRING is specified, a new identifier is stored
188           first.
189
190       $obj->write( [$fh] )
191           Inherited, see "The message" in Mail::Message
192
193   The header
194       Extends "The header" in Mail::Box::Message.
195
196       $obj->bcc()
197           Inherited, see "The header" in Mail::Message
198
199       $obj->cc()
200           Inherited, see "The header" in Mail::Message
201
202       $obj->date()
203           Inherited, see "The header" in Mail::Message
204
205       $obj->destinations()
206           Inherited, see "The header" in Mail::Message
207
208       $obj->from()
209           Inherited, see "The header" in Mail::Message
210
211       $obj->get($fieldname)
212           Inherited, see "The header" in Mail::Message
213
214       $obj->guessTimestamp()
215           Inherited, see "The header" in Mail::Message
216
217       $obj->head( [$head] )
218           Inherited, see "The header" in Mail::Message
219
220       $obj->nrLines()
221           Inherited, see "The header" in Mail::Message
222
223       $obj->sender()
224           Inherited, see "The header" in Mail::Message
225
226       $obj->study($fieldname)
227           Inherited, see "The header" in Mail::Message
228
229       $obj->subject()
230           Inherited, see "The header" in Mail::Message
231
232       $obj->timestamp()
233           Inherited, see "The header" in Mail::Message
234
235       $obj->to()
236           Inherited, see "The header" in Mail::Message
237
238   The body
239       Extends "The body" in Mail::Box::Message.
240
241       $obj->body( [$body] )
242           Inherited, see "The body" in Mail::Message
243
244       $obj->contentType()
245           Inherited, see "The body" in Mail::Message
246
247       $obj->decoded(%options)
248           Inherited, see "The body" in Mail::Message
249
250       $obj->encode(%options)
251           Inherited, see "The body" in Mail::Message
252
253       $obj->isMultipart()
254           Inherited, see "The body" in Mail::Message
255
256       $obj->isNested()
257           Inherited, see "The body" in Mail::Message
258
259       $obj->parts( [<'ALL'|'ACTIVE'|'DELETED'|'RECURSE'|$filter>] )
260           Inherited, see "The body" in Mail::Message
261
262   Flags
263       Extends "Flags" in Mail::Box::Message.
264
265       $obj->delete()
266           Inherited, see "Flags" in Mail::Message
267
268       $obj->deleted( [BOOLEAN] )
269           Inherited, see "Flags" in Mail::Message
270
271       $obj->isDeleted()
272           Inherited, see "Flags" in Mail::Message
273
274       $obj->isModified()
275           Inherited, see "Flags" in Mail::Message
276
277       $obj->label($label|PAIRS)
278           Inherited, see "Flags" in Mail::Message
279
280       $obj->labels()
281           Inherited, see "Flags" in Mail::Message
282
283       $obj->labelsToStatus()
284           Inherited, see "Flags" in Mail::Message
285
286       $obj->modified( [BOOLEAN] )
287           Inherited, see "Flags" in Mail::Message
288
289       $obj->statusToLabels()
290           Inherited, see "Flags" in Mail::Message
291
292   The whole message as text
293       Extends "The whole message as text" in Mail::Box::Message.
294
295       $obj->file()
296           Inherited, see "The whole message as text" in
297           Mail::Message::Construct::Text
298
299       $obj->lines()
300           Inherited, see "The whole message as text" in
301           Mail::Message::Construct::Text
302
303       $obj->printStructure( [$fh|undef],[$indent] )
304           Inherited, see "The whole message as text" in
305           Mail::Message::Construct::Text
306
307       $obj->string()
308           Inherited, see "The whole message as text" in
309           Mail::Message::Construct::Text
310
311   Internals
312       Extends "Internals" in Mail::Box::Message.
313
314       $obj->clonedFrom()
315           Inherited, see "Internals" in Mail::Message
316
317       Mail::Box::Net::Message->coerce($message, %options)
318           Inherited, see "Internals" in Mail::Message
319
320       $obj->diskDelete()
321           Inherited, see "Internals" in Mail::Box::Message
322
323       $obj->isDelayed()
324           Inherited, see "Internals" in Mail::Message
325
326       $obj->loadBody()
327       $obj->readBody( $parser, $head, [$bodytype] )
328           Inherited, see "Internals" in Mail::Box::Message
329
330       $obj->readFromParser( $parser, [$bodytype] )
331           Inherited, see "Internals" in Mail::Message
332
333       $obj->readHead( $parser, [$class] )
334           Inherited, see "Internals" in Mail::Message
335
336       $obj->recursiveRebuildPart($part, %options)
337           Inherited, see "Internals" in Mail::Message::Construct::Rebuild
338
339       $obj->storeBody($body)
340           Inherited, see "Internals" in Mail::Message
341
342       $obj->takeMessageId( [STRING] )
343           Inherited, see "Internals" in Mail::Message
344
345   Error handling
346       Extends "Error handling" in Mail::Box::Message.
347
348       $obj->AUTOLOAD()
349           Inherited, see "METHODS" in Mail::Message::Construct
350
351       $obj->addReport($object)
352           Inherited, see "Error handling" in Mail::Reporter
353
354       $obj->defaultTrace( [$level]|[$loglevel, $tracelevel]|[$level,
355       $callback] )
356       Mail::Box::Net::Message->defaultTrace( [$level]|[$loglevel,
357       $tracelevel]|[$level, $callback] )
358           Inherited, see "Error handling" in Mail::Reporter
359
360       $obj->errors()
361           Inherited, see "Error handling" in Mail::Reporter
362
363       $obj->log( [$level, [$strings]] )
364       Mail::Box::Net::Message->log( [$level, [$strings]] )
365           Inherited, see "Error handling" in Mail::Reporter
366
367       $obj->logPriority($level)
368       Mail::Box::Net::Message->logPriority($level)
369           Inherited, see "Error handling" in Mail::Reporter
370
371       $obj->logSettings()
372           Inherited, see "Error handling" in Mail::Reporter
373
374       $obj->notImplemented()
375           Inherited, see "Error handling" in Mail::Reporter
376
377       $obj->report( [$level] )
378           Inherited, see "Error handling" in Mail::Reporter
379
380       $obj->reportAll( [$level] )
381           Inherited, see "Error handling" in Mail::Reporter
382
383       $obj->shortSize( [$value] )
384       Mail::Box::Net::Message->shortSize( [$value] )
385           Inherited, see "Error handling" in Mail::Message
386
387       $obj->shortString()
388           Inherited, see "Error handling" in Mail::Message
389
390       $obj->trace( [$level] )
391           Inherited, see "Error handling" in Mail::Reporter
392
393       $obj->warnings()
394           Inherited, see "Error handling" in Mail::Reporter
395
396   Cleanup
397       Extends "Cleanup" in Mail::Box::Message.
398
399       $obj->DESTROY()
400           Inherited, see "Cleanup" in Mail::Reporter
401
402       $obj->destruct()
403           Inherited, see "Cleanup" in Mail::Box::Message
404

DETAILS

406       Extends "DETAILS" in Mail::Box::Message.
407

DIAGNOSTICS

409       Error: Cannot coerce a $class object into a $class object
410       Error: Cannot include forward source as $include.
411           Unknown alternative for the forward(include).  Valid choices are
412           "NO", "INLINE", "ATTACH", and "ENCAPSULATE".
413
414       Error: Cannot include reply source as $include.
415           Unknown alternative for the "include" option of reply().  Valid
416           choices are "NO", "INLINE", and "ATTACH".
417
418       Error: Method bounce requires To, Cc, or Bcc
419           The message bounce() method forwards a received message off to
420           someone else without modification; you must specified it's new
421           destination.  If you have the urge not to specify any destination,
422           you probably are looking for reply(). When you wish to modify the
423           content, use forward().
424
425       Error: Method forwardAttach requires a preamble
426       Error: Method forwardEncapsulate requires a preamble
427       Error: No address to create forwarded to.
428           If a forward message is created, a destination address must be
429           specified.
430
431       Error: No default mailer found to send message.
432           The message send() mechanism had not enough information to
433           automatically find a mail transfer agent to sent this message.
434           Specify a mailer explicitly using the "via" options.
435
436       Error: No rebuild rule $name defined.
437       Error: Only build() Mail::Message's; they are not in a folder yet
438           You may wish to construct a message to be stored in a some kind of
439           folder, but you need to do that in two steps.  First, create a
440           normal Mail::Message, and then add it to the folder.  During this
441           Mail::Box::addMessage() process, the message will get coerce()-d
442           into the right message type, adding storage information and the
443           like.
444
445       Error: Package $package does not implement $method.
446           Fatal error: the specific package (or one of its superclasses) does
447           not implement this method where it should. This message means that
448           some other related classes do implement this method however the
449           class at hand does not.  Probably you should investigate this and
450           probably inform the author of the package.
451
452       Error: Unable to read delayed body.
453       Error: Unable to read delayed head.
454       Error: coercion starts with some object
455

LICENSE

461       Copyrights 2001-2020 by [Mark Overmeer]. For other contributors see
462       ChangeLog.
463
464       This program is free software; you can redistribute it and/or modify it
465       under the same terms as Perl itself.  See http://dev.perl.org/licenses/
466
467
468
469perl v5.34.0                      2022-01-21        Mail::Box::Net::Message(3)