Mail::Ezmlm::Archive - Object Methods for Ezmlm-Idx Archives
use Mail::Ezmlm::Archive; $archive = Mail::Ezmlm::Archive->new('/path/to/list/folder'); $message_count = $archive->getcount; @available_months = $archive->getmonths; $threads = $archive->getthreads('200304');
Mail::Ezmlm::Archive is designed to provide an object interface to the message archives maintained by the ezmlm-idx software. See the ezmlm web page for a complete description of that software: <http://www.ezmlm.org>.
This version is designed to work with ezmlm 0.53 and ezmlm-idx 0.40.
use Mail::Ezmlm::Archive; $archive = Mail::Ezmlm::Archive->new('/path/to/list/folder');
$archive->setlist('/full/path/to/other/list');
$message_count = $archive->getcount;
Actually the getcount methods reads message count from DIR/num file, so we'd better consider the result as count of distributed messages instead of archived.
@available_months = $archive->getmonths;
This returns an array of strings in the 'YYYYMM' format, such as '200304', which represent months for which we have archived messages.
$threads = $archive->getthreads('200304');
This method returns a reference to an array, whose elements are hashes with these keys:
The subject of the thread, as archived in DIR/archived/threads/$month
Count of messages in the thread
Id of first message in the thread
Thread Id.
The date of last message in the thread, as archived in DIR/archived/threads/$month
$messages = $archive->getthread('nknmgklhcgijmbonmbkk');
This method returns a reference to a hash, which has two keys: 'subject' and 'messages'. The former contains the subject of the first message in the thread. The latter is a reference to an array, whose elements are hashes with these keys:
Message Id for retrieving.
Month of the message, in 'YYYYMM' format
Author Id
Full value of the 'From:' line
$message = $archive->getmessage('52');
This method returns a reference to a hash with two keys: text and month. The first contains the full raw message, and the message contains the month in YYYYMM format. It returns undef if the message doesn't exist.
All opened files are cached by default, so that we do not need to overload the filesystem for doing normal listing and browsing operations. However, caching can be disabled to reduce memory usage:
$archive->nocache;
Then, to enable it again:
$archive->cache;
No methods for author-based browsing.
Not enough object oriented, maybe? :-)
You can download the latest version from CPAN ( http://search.cpan.org ). You are very welcome to write mail to the author (aar@cpan.org) with your comments, suggestions, bug reports and complaints.
Mail::Ezmlm: object methods to manage Ezmlm lists by Guy Antony Halse
Copyright (C) Alessandro Ranellucci. All rights reserved.
This library is free software; you can redistribute it and/or modify it under the same terms as Perl itself.
Alessandro Ranellucci <aar@cpan.org>
5 POD Errors
The following errors were encountered while parsing the POD:
'=item' outside of any '=over'
You forgot a '=back' before '=head2'
You forgot a '=back' before '=head1'
To install Mail::Ezmlm::Archive, copy and paste the appropriate command in to your terminal.
cpanm
cpanm Mail::Ezmlm::Archive
CPAN shell
perl -MCPAN -e shell install Mail::Ezmlm::Archive
For more information on module installation, please visit the detailed CPAN module installation guide.