1Mail::Message::Part(3)User Contributed Perl DocumentationMail::Message::Part(3)
2
6 Mail::Message::Part - a part of a message, but a message by itself
7
9 Mail::Message::Part
10 is a Mail::Message
11 is a Mail::Reporter
12
14 my Mail::Message $message = ...;
15 if($message->isMultipart) {
16 my Mail::Message::Part $part;
17 foreach $part ($message->body->parts) {
19 $part->print(\*OUT);
20 my $attached_head = $part->head;
21 my $attached_body = $part->body; # encoded as read
22 my $attached_body = $part->decoded; # transfer-encoding removed
23 }
24 }
25
27 A "Mail::Message::Part" object contains a message which is included in
28 the body of an other message. For instance attachments are parts.
29 READ Mail::Message FIRST. A part is a special message: it has a
31 reference to its parent message, and will usually not be sub-classed
32 into mail folder specific variants.
33
35 Constructors
36 $obj->clone(OPTIONS)
37 See "Constructors" in Mail::Message
38 Mail::Message::Part->new(OPTIONS)
40 Create a message part.
41 -Option --Defined in --Default
43 body Mail::Message undef
44 body_type Mail::Message Mail::Message::Body::Lines
45 container <required>
46 deleted Mail::Message <false>
47 field_type Mail::Message undef
48 head Mail::Message <empty header>
49 head_type Mail::Message Mail::Message::Head::Complete
50 labels Mail::Message {}
51 log Mail::Reporter 'WARNINGS'
52 messageId Mail::Message undef
53 modified Mail::Message <false>
54 trace Mail::Reporter 'WARNINGS'
55 trusted Mail::Message <false>
56 body => OBJECT
58 body_type => CLASS
59 container => BODY
60 Reference to the parental Mail::Message::Body object where this
61 part is a member of. That object may be a
62 Mail::Message::Body::Multipart or a Mail::Message::Body::Nested.
63 deleted => BOOLEAN
65 field_type => CLASS
66 head => OBJECT
67 head_type => CLASS
68 labels => ARRAY|HASH
69 log => LEVEL
70 messageId => STRING
71 modified => BOOLEAN
72 trace => LEVEL
73 trusted => BOOLEAN
74 Constructing a message
76 $obj->bounce([RG-OBJECT|OPTIONS])
77 See "Constructing a message" in Mail::Message::Construct::Bounce
78 Mail::Message::Part->build([MESSAGE|PART|BODY], CONTENT)
80 See "Constructing a message" in Mail::Message::Construct::Build
81 Mail::Message::Part->buildFromBody(BODY, CONTAINER, HEADERS)
83 Shape a message part around a BODY. Bodies have information about
84 their content in them, which is used to construct a header for the
85 message. Next to that, more HEADERS can be specified. No headers
86 are obligatory. No extra headers are fabricated automatically.
87 example:
89 my $multi = Mail::Message::Body::Multipart->new;
91 my $part = Mail::Message::Part->buildFromBody($body, $multi);
92 $obj->forward(OPTIONS)
94 See "Constructing a message" in Mail::Message::Construct::Forward
95 $obj->forwardAttach(OPTIONS)
97 See "Constructing a message" in Mail::Message::Construct::Forward
98 $obj->forwardEncapsulate(OPTIONS)
100 See "Constructing a message" in Mail::Message::Construct::Forward
101 $obj->forwardInline(OPTIONS)
103 See "Constructing a message" in Mail::Message::Construct::Forward
104 $obj->forwardNo(OPTIONS)
106 See "Constructing a message" in Mail::Message::Construct::Forward
107 $obj->forwardPostlude
109 See "Constructing a message" in Mail::Message::Construct::Forward
110 $obj->forwardPrelude
112 See "Constructing a message" in Mail::Message::Construct::Forward
113 $obj->forwardSubject(STRING)
115 See "Constructing a message" in Mail::Message::Construct::Forward
116 Mail::Message::Part->read(FILEHANDLE|SCALAR|REF-SCALAR|ARRAY-OF-LINES,
118 OPTIONS)
119 See "Constructing a message" in Mail::Message::Construct::Read
120 $obj->rebuild(OPTIONS)
122 See "Constructing a message" in Mail::Message::Construct::Rebuild
123 $obj->reply(OPTIONS)
125 See "Constructing a message" in Mail::Message::Construct::Reply
126 $obj->replyPrelude([STRING|FIELD|ADDRESS|ARRAY-OF-THINGS])
128 See "Constructing a message" in Mail::Message::Construct::Reply
129 $obj->replySubject(STRING)
131 Mail::Message::Part->replySubject(STRING)
132 See "Constructing a message" in Mail::Message::Construct::Reply
134 The message
136 $obj->container
137 See "The message" in Mail::Message
138 $obj->isDummy
140 See "The message" in Mail::Message
141 $obj->isPart
143 See "The message" in Mail::Message
144 $obj->messageId
146 See "The message" in Mail::Message
147 $obj->print([FILEHANDLE])
149 See "The message" in Mail::Message
150 $obj->printEscapedFrom(FILEHANDLE)
152 Prints the message part, but all lines which start with 'From '
153 will get a leading >. See Mail::Message::Body::printEscapedFrom().
154 $obj->send([MAILER], OPTIONS)
156 See "The message" in Mail::Message
157 $obj->size
159 See "The message" in Mail::Message
160 $obj->toplevel
162 See "The message" in Mail::Message
163 $obj->write([FILEHANDLE])
165 See "The message" in Mail::Message
166 The header
168 $obj->bcc
169 See "The header" in Mail::Message
170 $obj->cc
172 See "The header" in Mail::Message
173 $obj->date
175 See "The header" in Mail::Message
176 $obj->destinations
178 See "The header" in Mail::Message
179 $obj->from
181 See "The header" in Mail::Message
182 $obj->get(FIELDNAME)
184 See "The header" in Mail::Message
185 $obj->guessTimestamp
187 See "The header" in Mail::Message
188 $obj->head([HEAD])
190 See "The header" in Mail::Message
191 $obj->nrLines
193 See "The header" in Mail::Message
194 $obj->sender
196 See "The header" in Mail::Message
197 $obj->study(FIELDNAME)
199 See "The header" in Mail::Message
200 $obj->subject
202 See "The header" in Mail::Message
203 $obj->timestamp
205 See "The header" in Mail::Message
206 $obj->to
208 See "The header" in Mail::Message
209 The body
211 $obj->body([BODY])
212 See "The body" in Mail::Message
213 $obj->contentType
215 See "The body" in Mail::Message
216 $obj->decoded(OPTIONS)
218 See "The body" in Mail::Message
219 $obj->encode(OPTIONS)
221 See "The body" in Mail::Message
222 $obj->isMultipart
224 See "The body" in Mail::Message
225 $obj->isNested
227 See "The body" in Mail::Message
228 $obj->parts(['ALL'|'ACTIVE'|'DELETED'|'RECURSE'|FILTER])
230 See "The body" in Mail::Message
231 Flags
233 $obj->delete
234 See "Flags" in Mail::Message
235 $obj->deleted([BOOLEAN])
237 See "Flags" in Mail::Message
238 $obj->isDeleted
240 See "Flags" in Mail::Message
241 $obj->isModified
243 See "Flags" in Mail::Message
244 $obj->label(LABEL|PAIRS)
246 See "Flags" in Mail::Message
247 $obj->labels
249 See "Flags" in Mail::Message
250 $obj->labelsToStatus
252 See "Flags" in Mail::Message
253 $obj->modified([BOOLEAN])
255 See "Flags" in Mail::Message
256 $obj->statusToLabels
258 See "Flags" in Mail::Message
259 The whole message as text
261 $obj->file
262 See "The whole message as text" in Mail::Message::Construct::Text
263 $obj->lines
265 See "The whole message as text" in Mail::Message::Construct::Text
266 $obj->printStructure([FILEHANDLE|undef],[INDENT])
268 See "The whole message as text" in Mail::Message::Construct::Text
269 $obj->string
271 See "The whole message as text" in Mail::Message::Construct::Text
272 Internals
274 $obj->clonedFrom
275 See "Internals" in Mail::Message
276 Mail::Message::Part->coerce(BODY|MESSAGE, MULTIPART, HEADERS)
278 Transforms a BODY or MESSAGE to a real message part. The MULTIPART
279 refers to the parental body.
280 When ta BODY is specified, extra HEADERS can be supplied as well.
282 Bodies are coerced into message parts by calling buildFromBody().
283 If you specify a MESSAGE residing in a folder, this message will
284 automatically be cloned.
285 $obj->isDelayed
287 See "Internals" in Mail::Message
288 $obj->readBody(PARSER, HEAD [, BODYTYPE])
290 See "Internals" in Mail::Message
291 $obj->readFromParser(PARSER, [BODYTYPE])
293 See "Internals" in Mail::Message
294 $obj->readHead(PARSER [,CLASS])
296 See "Internals" in Mail::Message
297 $obj->recursiveRebuildPart(PART, OPTIONS)
299 See "Internals" in Mail::Message::Construct::Rebuild
300 $obj->storeBody(BODY)
302 See "Internals" in Mail::Message
303 $obj->takeMessageId([STRING])
305 See "Internals" in Mail::Message
306 Error handling
308 $obj->AUTOLOAD
309 See "METHODS" in Mail::Message::Construct
310 $obj->addReport(OBJECT)
312 See "Error handling" in Mail::Reporter
313 $obj->defaultTrace([LEVEL]|[LOGLEVEL, TRACELEVEL]|[LEVEL, CALLBACK])
315 Mail::Message::Part->defaultTrace([LEVEL]|[LOGLEVEL,
316 TRACELEVEL]|[LEVEL, CALLBACK])
317 See "Error handling" in Mail::Reporter
319 $obj->errors
321 See "Error handling" in Mail::Reporter
322 $obj->log([LEVEL [,STRINGS]])
324 Mail::Message::Part->log([LEVEL [,STRINGS]])
325 See "Error handling" in Mail::Reporter
327 $obj->logPriority(LEVEL)
329 Mail::Message::Part->logPriority(LEVEL)
330 See "Error handling" in Mail::Reporter
332 $obj->logSettings
334 See "Error handling" in Mail::Reporter
335 $obj->notImplemented
337 See "Error handling" in Mail::Reporter
338 $obj->report([LEVEL])
340 See "Error handling" in Mail::Reporter
341 $obj->reportAll([LEVEL])
343 See "Error handling" in Mail::Reporter
344 $obj->shortSize([VALUE])
346 Mail::Message::Part->shortSize([VALUE])
347 See "Error handling" in Mail::Message
349 $obj->shortString
351 See "Error handling" in Mail::Message
352 $obj->trace([LEVEL])
354 See "Error handling" in Mail::Reporter
355 $obj->warnings
357 See "Error handling" in Mail::Reporter
358 Cleanup
360 $obj->DESTROY
361 See "Cleanup" in Mail::Message
362 $obj->destruct
364 Message parts can not be destructed per part: only whole messages
365 can be forcefully freed from memory. Of course, you can delete()
366 separate parts, which only sets a flag not to write a part again.
367 Furthermore, you may cosider rebuild() to get rit of deleted parts.
368 $obj->inGlobalDestruction
370 See "Cleanup" in Mail::Reporter
371
373 Error: Cannot include forward source as $include.
374 Unknown alternative for the forward(include). Valid choices are
375 "NO", "INLINE", "ATTACH", and "ENCAPSULATE".
376 Error: Cannot include reply source as $include.
378 Unknown alternative for the "include" option of reply(). Valid
379 choices are "NO", "INLINE", and "ATTACH".
380 Error: Method bounce requires To, Cc, or Bcc
382 The message bounce() method forwards a received message off to
383 someone else without modification; you must specified it's new
384 destination. If you have the urge not to specify any destination,
385 you probably are looking for reply(). When you wish to modify the
386 content, use forward().
387 Error: Method forwardAttach requires a preamble
389 Error: Method forwardEncapsulate requires a preamble
390 Error: No address to create forwarded to.
391 If a forward message is created, a destination address must be
392 specified.
393 Error: No default mailer found to send message.
395 The message send() mechanism had not enough information to
396 automatically find a mail transfer agent to sent this message.
397 Specify a mailer explicitly using the "via" options.
398 Error: No rebuild rule $name defined.
400 Error: Only build() Mail::Message's; they are not in a folder yet
401 You may wish to construct a message to be stored in a some kind of
402 folder, but you need to do that in two steps. First, create a
403 normal Mail::Message, and then add it to the folder. During this
404 Mail::Box::addMessage() process, the message will get coerce()-d
405 into the right message type, adding storage information and the
406 like.
407 Error: Package $package does not implement $method.
409 Fatal error: the specific package (or one of its superclasses) does
410 not implement this method where it should. This message means that
411 some other related classes do implement this method however the
412 class at hand does not. Probably you should investigate this and
413 probably inform the author of the package.
414 Error: You cannot destruct message parts, only whole messages
416 Message parts can not be destructed per part: only whole messages
417 can be forcefully freed from memory. Consider delete() or
418 rebuild().
419
421 This module is part of Mail-Box distribution version 2.097, built on
422 January 26, 2011. Website: http://perl.overmeer.net/mailbox/
423
425 Copyrights 2001-2011 by Mark Overmeer. For other contributors see
426 ChangeLog.
427 This program is free software; you can redistribute it and/or modify it
429 under the same terms as Perl itself. See
430 http://www.perl.com/perl/misc/Artistic.html
431perl v5.12.3 2011-01-26 Mail::Message::Part(3)