Gecko [ fernandoquevedodop.com ]

Name	Size	Permission
Dir	[ DIR ]	drwxr-xr-x
File	[ DIR ]	drwxr-xr-x
Locker	[ DIR ]	drwxr-xr-x
MH	[ DIR ]	drwxr-xr-x
Maildir	[ DIR ]	drwxr-xr-x
Manage	[ DIR ]	drwxr-xr-x
Mbox	[ DIR ]	drwxr-xr-x
Message	[ DIR ]	drwxr-xr-x
Net	[ DIR ]	drwxr-xr-x
Parser	[ DIR ]	drwxr-xr-x
Search	[ DIR ]	drwxr-xr-x
Thread	[ DIR ]	drwxr-xr-x
Tie	[ DIR ]	drwxr-xr-x
Collection.pm	1.81 KB	-rw-r--r--
Collection.pod	8.81 KB	-rw-r--r--
Dir.pm	3.03 KB	-rw-r--r--
Dir.pod	14.62 KB	-rw-r--r--
FastScalar.pm	4.13 KB	-rw-r--r--
FastScalar.pod	969 B	-rw-r--r--
File.pm	13.08 KB	-rw-r--r--
File.pod	21.55 KB	-rw-r--r--
Identity.pm	5.66 KB	-rw-r--r--
Identity.pod	12.12 KB	-rw-r--r--
Locker.pm	3.3 KB	-rw-r--r--
Locker.pod	8.57 KB	-rw-r--r--
MH.pm	11.23 KB	-rw-r--r--
MH.pod	19.9 KB	-rw-r--r--
Maildir.pm	10.3 KB	-rw-r--r--
Maildir.pod	17.54 KB	-rw-r--r--
Manager.pm	15.14 KB	-rw-r--r--
Manager.pod	21.18 KB	-rw-r--r--
Mbox.pm	5.72 KB	-rw-r--r--
Mbox.pod	19.23 KB	-rw-r--r--
Message.pm	2.6 KB	-rw-r--r--
Message.pod	17.92 KB	-rw-r--r--
Net.pm	2.55 KB	-rw-r--r--
Net.pod	13.55 KB	-rw-r--r--
Parser.pm	3.77 KB	-rw-r--r--
Parser.pod	10.76 KB	-rw-r--r--
Search.pm	5.06 KB	-rw-r--r--
Search.pod	9.12 KB	-rw-r--r--
Test.pm	8.36 KB	-rw-r--r--
Tie.pm	923 B	-rw-r--r--
Tie.pod	1.4 KB	-rw-r--r--

Code Editor : Message.pod

=encoding utf8

=head1 NAME

Mail::Box::Message - manage one message within a mail-folder

=head1 INHERITANCE

Mail::Box::Message
   is a Mail::Message
   is a Mail::Reporter

Mail::Box::Message is extended by
   Mail::Box::Dir::Message
   Mail::Box::File::Message
   Mail::Box::Message::Destructed
   Mail::Box::Net::Message

=head1 SYNOPSIS

# Usually these message objects are created indirectly
 use Mail::Box::Manager;
 my $manager = Mail::Box::Manager->new;
 my $folder  = $manager->open(folder => 'Mail/Drafts');
 my $msg     = $folder->message(1);
 $msg->delete;
 $msg->size;   # and much more

=head1 DESCRIPTION

These pages do only describe methods which relate to folders.  If you
access the knowledge of a message, then read L<Mail::Message|Mail::Message>.

During its life, a message will pass through certain stages.  These
stages were introduced to reduce the access-time to the folder.  Changing
from stage, the message's body and head objects may change.

Extends L<"DESCRIPTION" in Mail::Message|Mail::Message/"DESCRIPTION">.
 
=head1 METHODS

Extends L<"METHODS" in Mail::Message|Mail::Message/"METHODS">.
 
=head2 Constructors

Extends L<"Constructors" in Mail::Message|Mail::Message/"Constructors">.
 
=over 4

=item $obj-E<gt>B<clone>(%options)

Inherited, see L<Mail::Message/"Constructors">

=item Mail::Box::Message-E<gt>B<new>(%options)

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

=over 2

=item body => OBJECT

=item body_type => CODE|CLASS

If the body of a message is used delay-loaded, the message must what type
of message to become when it finally gets parsed.  The folder which is
delaying the load must specify the algorithm to determine that type.

=item deleted => BOOLEAN

=item field_type => CLASS

=item folder => FOLDER

The folder where this message appeared in.  The argument is
an instance of (a sub-class of) a L<Mail::Box|Mail::Box>.

=item head => OBJECT

=item head_type => CLASS

=item labels => ARRAY|HASH

=item log => LEVEL

=item messageId => STRING

=item modified => BOOLEAN

=item size => INTEGER

The size of the message, which includes head and body, but without the
message separators which may be used by the folder type.

=item trace => LEVEL

=item trusted => BOOLEAN

=back

=head2 Constructing a message

Extends L<"Constructing a message" in Mail::Message|Mail::Message/"Constructing a message">.
 
=over 4

=item $obj-E<gt>B<bounce>( [<$rg_object|%options>] )

Inherited, see L<Mail::Message::Construct::Bounce/"Constructing a message">

=item Mail::Box::Message-E<gt>B<build>( [$message|$part|$body], $content )

Inherited, see L<Mail::Message::Construct::Build/"Constructing a message">

=item Mail::Box::Message-E<gt>B<buildFromBody>($body, [$head], $headers)

Inherited, see L<Mail::Message::Construct::Build/"Constructing a message">

=item $obj-E<gt>B<forward>(%options)

Inherited, see L<Mail::Message::Construct::Forward/"Constructing a message">

=item $obj-E<gt>B<forwardAttach>(%options)

Inherited, see L<Mail::Message::Construct::Forward/"Constructing a message">

=item $obj-E<gt>B<forwardEncapsulate>(%options)

Inherited, see L<Mail::Message::Construct::Forward/"Constructing a message">

=item $obj-E<gt>B<forwardInline>(%options)

Inherited, see L<Mail::Message::Construct::Forward/"Constructing a message">

=item $obj-E<gt>B<forwardNo>(%options)

Inherited, see L<Mail::Message::Construct::Forward/"Constructing a message">

=item $obj-E<gt>B<forwardPostlude>()

Inherited, see L<Mail::Message::Construct::Forward/"Constructing a message">

=item $obj-E<gt>B<forwardPrelude>()

Inherited, see L<Mail::Message::Construct::Forward/"Constructing a message">

=item $obj-E<gt>B<forwardSubject>(STRING)

Inherited, see L<Mail::Message::Construct::Forward/"Constructing a message">

=item Mail::Box::Message-E<gt>B<read>($fh|STRING|SCALAR|ARRAY, %options)

Inherited, see L<Mail::Message::Construct::Read/"Constructing a message">

=item $obj-E<gt>B<rebuild>(%options)

Inherited, see L<Mail::Message::Construct::Rebuild/"Constructing a message">

=item $obj-E<gt>B<reply>(%options)

Inherited, see L<Mail::Message::Construct::Reply/"Constructing a message">

=item $obj-E<gt>B<replyPrelude>( [STRING|$field|$address|ARRAY-$of-$things] )

Inherited, see L<Mail::Message::Construct::Reply/"Constructing a message">

=item $obj-E<gt>B<replySubject>(STRING)

=item Mail::Box::Message-E<gt>B<replySubject>(STRING)

Inherited, see L<Mail::Message::Construct::Reply/"Constructing a message">

=back

=head2 The message

Extends L<"The message" in Mail::Message|Mail::Message/"The message">.
 
=over 4

=item $obj-E<gt>B<container>()

Inherited, see L<Mail::Message/"The message">

=item $obj-E<gt>B<copyTo>($folder, %options)

Copy the message to the indicated opened $folder, without deleting the
original.  The coerced message (the clone in the destination folder)
is returned.

-Option      --Default
  shallow       <false>
  shallow_body  <false>
  shallow_head  <false>
  share         <false>

=over 2

=item shallow => BOOLEAN

Used for L<clone(shallow)|Mail::Message/"Constructors">.

=item shallow_body => BOOLEAN

Used for L<clone(shallow_body)|Mail::Message/"Constructors">.

=item shallow_head => BOOLEAN

Used for L<clone(shallow_head)|Mail::Message/"Constructors">.

=item share => BOOLEAN

Try to share the physical storage of the message between the two folders.
Sometimes, they even may be of different types.  When not possible, this
options will be silently ignored.

=back

example:

my $draft = $mgr->open(folder => 'Draft');
 $message->copyTo($draft, share => 1);

=item $obj-E<gt>B<folder>( [$folder] )

In with folder did we detect this message/dummy?  This is a reference
to the folder-object.

=item $obj-E<gt>B<isDummy>()

Inherited, see L<Mail::Message/"The message">

=item $obj-E<gt>B<isPart>()

Inherited, see L<Mail::Message/"The message">

=item $obj-E<gt>B<messageId>()

Inherited, see L<Mail::Message/"The message">

=item $obj-E<gt>B<moveTo>($folder, %options)

Move the message from this folder to the $folder specified.  This will
create a copy using L<clone()|Mail::Message/"Constructors"> first.  Then, this original message is
flagged to get deleted.  So until the source folder is closed, two copies
of the message may stay in memory.

The newly created message clone (part of the destination folder)
is returned.  All %options are passed to L<copyTo()|Mail::Box::Message/"The message">

-Option      --Default
  shallow_body  <undef>
  share         <true unless shallow_body exists>

=over 2

=item shallow_body => BOOLEAN

Only create a shallow body, which means that the header can not be
reused.  A message can therefore not be shared in storage unless
explicitly stated.

=item share => BOOLEAN

When there is a chance that the original message can be undeleted, then
this must be set to false.  Otherwise a shallow clone will be made, which
will share the header which can be modified in the undeleted message.

=back

example: of moving a message

my $trash = Mail::Box::Mbox->new(folder => 'trash');
 my $t = $msg->moveTo($trash);

is equivalent to

my $t = $msg->copyTo($trash, share => 1);
 $msg->delete;

=item $obj-E<gt>B<partNumber>()

Inherited, see L<Mail::Message/"The message">

=item $obj-E<gt>B<print>( [$fh] )

Inherited, see L<Mail::Message/"The message">

=item $obj-E<gt>B<send>( [$mailer], %options )

Inherited, see L<Mail::Message/"The message">

=item $obj-E<gt>B<seqnr>( [$integer] )

Get the number of this message is the current folder.  It starts counting
from zero.  Do not change the number.

=item $obj-E<gt>B<size>()

Inherited, see L<Mail::Message/"The message">

=item $obj-E<gt>B<toplevel>()

Inherited, see L<Mail::Message/"The message">

=item $obj-E<gt>B<write>( [$fh] )

Inherited, see L<Mail::Message/"The message">

=back

=head2 The header

Extends L<"The header" in Mail::Message|Mail::Message/"The header">.
 
=over 4

=item $obj-E<gt>B<bcc>()