
=head1 NAME

Mail::Message::Body::Construct - adds functionality to Mail::Message::Body


=head1 INHERITANCE


=head1 SYNOPSIS



=head1 DESCRIPTION

This package adds complex functionality to the L<Mail::Message::Body|Mail::Message::Body>
class.  This functions less often used, so many programs will not
compile this package.



=head1 METHODS


=head2 Constructing a body


$obj-E<gt>B<attach>(MESSAGES, OPTIONS)

=over 4

Make a multipart containing this body and the specified MESSAGES. The
options are passed to the constructor of the multi-part body.  If you
need more control, create the multi-part body yourself.  At least
take a look at L<Mail::Message::Body::Multipart|Mail::Message::Body::Multipart>.

The message-parts will be coerced into a L<Mail::Message::Part|Mail::Message::Part>, so you
may attach Mail::Internet or MIME::Entity objects if you want --see
L<Mail::Message::coerce()|"Constructors">.  A new body with attached messages is
returned.

I<Example:> 

 my $pgpkey = L<Mail::Message::Body::File|Mail::Message::Body::File>->new(file => '.pgp');
 my $msg    = L<Mail::Message|Mail::Message>->buildFromBody(
    $message->decoded->attach($pgpkey));

 # The last message of the $multi multiparted body becomes a coerced $entity.
 my $entity  = MIME::Entity->new;
 my $multi   = $msg->body->attach($entity);

 # Now create a new message
 my $msg     = Mail::Message->new(head => ..., body => $multi);

=back

$obj-E<gt>B<concatenate>(COMPONENTS)

=over 4

Concatenate a list of elements into one new body.  The encoding is defined by
the body where this method is called upon (and which does not need to be
included in the result).

Specify a list of COMPONENTS.  Each component can be
a message (L<Mail::Message|Mail::Message>, the body of the message is used),
a plain body (L<Mail::Message::Body|Mail::Message::Body>), 
C<undef> (which will be skipped),
a scalar (which is split into lines), or
an array of scalars (each providing one line).

I<Example:> 

 # all arguments are L<Mail::Message::Body|Mail::Message::Body>'s.
 my $sum = $body->concatenate($preamble, $body, $epilogue, "--\n" , $sig);

=back

$obj-E<gt>B<foreachLine>(CODE)

=over 4

Create a new body by performing an action on each of its lines.  If none
of the lines change, the current body will be returned, otherwise a new
body is created of the same type as the current.

The CODE refers to a subroutine which is called, where C<$_> contains
body's original line.  DO NOT CHANGE C<$_>!!!  The result of the routine
is taken as new line.  When the routine returns C<undef>, the line will be
skipped.

I<Example:> 

 my $content  = $msg->decoded;
 my $reply    = $content->foreachLine( sub { '> '.$_ } );
 my $rev      = $content->foreachLine( sub {reverse} );

 sub filled() { length $_ > 1 ? $_ : undef }
 my $nonempty = $content->foreachLine( \&filled );

 my $wrong    = $content->foreachLine( sub {s/a/A/} );  # WRONG!!!
 my $right    = $content->foreachLine( sub {(my $x=$_) =~ s/a/A/} );

=back

$obj-E<gt>B<stripSignature>(OPTIONS)

=over 4

Strip the signature from the body.  The body must already be decoded
otherwise the wrong lines may get stripped.

The signature is added by the sender to tell about him-
or herself.  It is superfluous in some situations, for instance if you
want to create a reply to the person's message you do not need to include
that signature.

C<stripSignature> returns the stripped version body, and in list context
also the signature, encapsulated in its own body object.  If the body had
no signature, the original body object is returned, and C<undef> for
the signature body.  The signature separator is the first line of the
returned signature body.

 Option       Defined in       Default          
 max_lines                     C<10>            
 pattern                       C<qr/^--\s?$/>   
 result_type                   <same as current>

. max_lines INTEGER|undef

=over 4

The maximum number of lines which can be the length of a signature.
Specify C<undef> to remove the limit.

=back

. pattern REGEX|STRING|CODE

=over 4

Which pattern defines the line which indicates the separator between
the message and the signature.  In case of a STRING, this is matched
to the beginning of the line, and REGEX is a full regular expression.

In case of CODE, each line (from last to front) is passed to the
specified subroutine as first argument.  The subroutine must return
TRUE when the separator is found.

=back

. result_type CLASS

=over 4

The type of body to be created for the stripped body (and maybe also to
contain the stripped signature)

=back

I<Example:> 

 my $stripped = $message->decoded;
 my $stripped = $body->decoded;
 my ($stripped, $signature) = $message->decoded
    ->stripSignature(max_lines => 5, pattern => '-*-*-');

=back








=head1 REFERENCES

See the Mail::Box website at L<http://perl.overmeer.net/mailbox/> for more details.

=head1 COPYRIGHTS

Module version 2.042.
Written by Mark Overmeer (mark@overmeer.net).  See the ChangeLog for
other contributors.

Copyright (c) 2001-2003 by the author(s). All rights reserved.
This program is free software; you can redistribute it and/or modify it
under the same terms as Perl itself.


