SWISH::Prog::Aggregator::MailFS - crawl a filesystem of email messages


SWISH-Prog documentation  | view source Contained in the SWISH-Prog distribution.

Index


NAME

Top

SWISH::Prog::Aggregator::MailFS - crawl a filesystem of email messages

SYNOPSIS

Top

 use SWISH::Prog::Aggregator::MailFS;
 my $fs = SWISH::Prog::Aggregator::MailFS->new(
        indexer => SWISH::Prog::Indexer->new
    );

 $fs->indexer->start;
 $fs->crawl( $path_to_mail );
 $fs->indexer->finish;

DESCRIPTION

Top

SWISH::Prog::Aggregator::MailFS is a subclass of SWISH::Prog::Aggregator::FS that expects every file in a filesystem to be an email message. This class is useful for crawling a file tree like those managed by ezmlm.

NOTE: This class will not work with personal email boxes in the Mbox format. It might work with maildir format, but that is coincidental. Use SWISH::Prog::Aggregator::Mail to handle your personal email box. Use this class to handle mail archives as with a mailing list.

METHODS

Top

See SWISH::Prog::Aggregator::FS. Only new or overridden methods are documented here.

init

Constructor.

file_ok( full_path )

Like the parent class method, but ignores file extension, assuming that all files are email messages.

Returns the full_path value if the file is ok for indexing; returns 0 if not ok.

get_doc( url )

Overrides parent class to delegate the creation of the SWISH::Prog::Doc object to SWISH::Prog::Aggregator::Mail->get_doc().

Returns a SWISH::Prog::Doc object.

AUTHOR

Top

Peter Karman, <perl@peknet.com>

BUGS

Top

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

Top

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

    perldoc SWISH::Prog




You can also look for information at:

* Mailing list

http://lists.swish-e.org/listinfo/users

* RT: CPAN's request tracker

http://rt.cpan.org/NoAuth/Bugs.html?Dist=SWISH-Prog

* AnnoCPAN: Annotated CPAN documentation

http://annocpan.org/dist/SWISH-Prog

* CPAN Ratings

http://cpanratings.perl.org/d/SWISH-Prog

* Search CPAN

http://search.cpan.org/dist/SWISH-Prog/

COPYRIGHT AND LICENSE

Top

SEE ALSO

Top

http://swish-e.org/


SWISH-Prog documentation  | view source Contained in the SWISH-Prog distribution.