/ 
SWISH-Prog-0.75
River stage one • 7 direct dependents • 8 total dependents
/ SWISH::Prog::Aggregator::Mail

NAME

SWISH::Prog::Aggregator::Mail - crawl a mail box

SYNOPSIS

use SWISH::Prog::Aggregator::Mail;

my $aggregator = 
    SWISH::Prog::Aggregator::Mail->new( 
        indexer => SWISH::Prog::Indexer::Native->new()
    );

$aggregator->indexer->start;
$aggregator->crawl('path/to/my/maildir');
$aggregator->indexer->finish;

DESCRIPTION

SWISH::Prog::Aggregator::Mail is a SWISH::Prog::Aggregator subclass designed for providing full-text search for your email.

SWISH::Prog::Aggregator::Mail uses Mail::Box, available from CPAN.

METHODS

Since SWISH::Prog::Aggregator::Mail inherits from SWISH::Prog::Aggregator, read the SWISH::Prog::Aggregator docs first. Any overridden methods are documented here.

init

Adds the special mail MetaName to the Config object before opening indexer.

crawl( path_to_maildir )

Create index.

Returns number of emails indexed.

get_doc( folder, Mail::Message )

Extract data and content from Mail::Message in folder and return doc_class() object.

AUTHOR

Peter Karman, <perl@peknet.com>

BUGS

Please report any bugs or feature requests to bug-swish-prog at rt.cpan.org, or through the web interface at http://rt.cpan.org/NoAuth/ReportBug.html?Queue=SWISH-Prog. I will be notified, and then you'll automatically be notified of progress on your bug as I make changes.

SUPPORT

You can find documentation for this module with the perldoc command.

perldoc SWISH::Prog

You can also look for information at:

COPYRIGHT AND LICENSE

Copyright 2008-2009 by Peter Karman

This library is free software; you can redistribute it and/or modify it under the same terms as Perl itself.

SEE ALSO

http://swish-e.org/