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

DIAGNOSTICS

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

SEE ALSO

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

LICENSE

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