/ 
Mail-Box-1.310
River stage one • 8 direct dependents • 8 total dependents
/ Mail::Box::Tie::ARRAY

NAME

Mail::Box::Tie::ARRAY - Acces an existing message-folder as array

SYNOPSIS

use Mail::Box::Manager;
my $mgr    = Mail::Box::Manager->new;
my $folder = $mgr->open(folder => 'inbox');

use Mail::Box::Tie::ARRAY;
tie my(@inbox), 'Mail::Box::Tie::ARRAY', $folder;

# deprecated, but works too
use Mail::Box::Tie;
tie my(@inbox), 'Mail::Box::Tie', $folder;

foreach (@inbox) {print $_->short}
print $_->print foreach @inbox;
my $emails = @inbox;

print $inbox[3];
print scalar @inbox;
push @inbox, Mail::Box::Message->new(...);
delete $inbox[6];
print $inbox[0]->head->get('status');

my $folder = tied @inbox;
untie @inbox;

DESCRIPTION

Read Mail::Box::Manager first.

Folders certainly look like an array of messages, so why not just access them as one?

Not all operations on arrays are supported. Actually, most functions which would reduce the size of the array are modified to signal messages as ready for removal.

Examples what you cannot do:

shift/unshift/pop/splice @inbox;

METHODS for tied array

tie ARRAY, 'Mail::Box::Tie::ARRAY', FOLDER
tie ARRAY, 'Mail::Box::Tie', FOLDER

Create the tie on an existing folder. The second version is deprecated, but will work because Mail::Box::Tie::TIEARRAY will trigger this class.

Example:

my $mgr   = Mail::Box::Manager->new;
my $inbox = $mgr->new(folder => $ENV{MAIL});
tie my(@inbox), ref $inbox, $inbox;
FETCH INDEX

Get the message which is on the indicated location in the list of messages contained in this folder. Deleted message will count.

Example:

print $inbox[3];
STORE INDEX, MESSAGE

It is not permitted to randomly replace messages: it would disturb threads etc. The only thing what is allowed is to store a message on the first free index behind the folder (which is also achievable with PUSH -see below).

If you want to replace one message is a folder, then do the following:

$inbox[3]->delete;
push @inbox, $replacement;
FETCHSIZE

Return the total number of messages in a folder. This is called when the folder-array is used in scalar context, for instance

if(@inbox > 10)    # contains more than 10 messages
my $nrmsgs = @inbox;
PUSH [MESSAGES]

Add messages to the (end of the) folder.

push @inbox, $newmsg;
DELETE

Flag a message to be removed. Be warned that the message stays in the folder, and is not removed before the folder is written.

Examples:

delete $inbox[5];
$inbox[5]->delete;   #same

LIMITATIONS for arrays

This module implements TIEARRAY, FETCH, STORE, FETCHSIZE, DELETE, PUSH, and DESTROY.

This module does not implement all other methods as described in the Tie::Array manual-page.

AUTHOR

Mark Overmeer (Mark@Overmeer.net). All rights reserved. This program is free software; you can redistribute it and/or modify it under the same terms as Perl itself.

VERSION

This code is beta, version 1.310