Mail::Message::Part • man page

Mail::Message::Part (3)

Leading comments

Automatically generated by Pod::Man 4.07 (Pod::Simple 3.32)

Standard preamble:
========================================================================

(The comments found at the beginning of the groff file "man3/Mail::Message::Part.3pm".)

NAME

Mail::Message::Part - a part of a message, but a message by itself

INHERITANCE

 Mail::Message::Part
   is a Mail::Message
   is a Mail::Reporter

SYNOPSIS

 my Mail::Message $message = ...;
 if($message->isMultipart) {
    my Mail::Message::Part $part;

    foreach $part ($message->body->parts) {
       $part->print(\*OUT);
       my $attached_head = $part->head;
       my $attached_body = $part->body;      # encoded as read
       my $attached_body = $part->decoded;   # transfer-encoding removed
    }
 }

DESCRIPTION

A "Mail::Message::Part" object contains a message which is included in the body of an other message. For instance attachments are parts.

READ

Mail::Message

FIRST. A

part is a special message: it has a reference to its parent message, and will usually not be sub-classed into mail folder specific variants.

Extends ``

DESCRIPTION''

in Mail::Message.

METHODS

Extends ``

METHODS''

in Mail::Message.

Constructors

Extends ``Constructors'' in Mail::Message.

$obj->clone(%options)

Inherited, see ``Constructors'' in Mail::Message

Mail::Message::Part->new(%options)

Create a message part.

 -Option    --Defined in     --Default
  body        Mail::Message    undef
  body_type   Mail::Message    Mail::Message::Body::Lines
  container                    <required>
  deleted     Mail::Message    <false>
  field_type  Mail::Message    undef
  head        Mail::Message    <empty header>
  head_type   Mail::Message    Mail::Message::Head::Complete
  labels      Mail::Message    {}
  log         Mail::Reporter   'WARNINGS'
  messageId   Mail::Message    undef
  modified    Mail::Message    <false>
  trace       Mail::Reporter   'WARNINGS'
  trusted     Mail::Message    <false>

body => OBJECT
body_type => CLASS
container => BODY: Reference to the parental Mail::Message::Body object where this part is a member of. That object may be a Mail::Message::Body::Multipart or a Mail::Message::Body::Nested.
deleted => BOOLEAN
field_type => CLASS
head => OBJECT
head_type => CLASS
labels => ARRAY|HASH
log => LEVEL
messageId => STRING
modified => BOOLEAN
trace => LEVEL
trusted => BOOLEAN

Constructing a message

Extends ``Constructing a message'' in Mail::Message.

$obj->bounce( [<$rg_object|%options>] )

Inherited, see ``Constructing a message'' in Mail::Message::Construct::Bounce

Mail::Message::Part->build( [$message|$part|$body], $content )

Inherited, see ``Constructing a message'' in Mail::Message::Construct::Build

Mail::Message::Part->buildFromBody($body, $container, $headers)

Shape a message part around a $body. Bodies have information about their content in them, which is used to construct a header for the message. Next to that, more $headers can be specified. No headers are obligatory. No extra headers are fabricated automatically.

example:

 my $multi = Mail::Message::Body::Multipart->new;
 my $part  = Mail::Message::Part->buildFromBody($body, $multi);

$obj->forward(%options)