Luis Muñoz > Mail-Abuse > Mail::Abuse::Processor::Store

Download:
Mail-Abuse-1.026.tar.gz

Dependencies

Annotate this POD

CPAN RT

New  1
Open  0
View/Report Bugs
Module Version: 1.012   Source  

NAME ^

Mail::Abuse::Processor::Store - Process a Mail::Abuse::Report

SYNOPSIS ^

  use Mail::Abuse::Processor::Store;

  use Mail::Abuse::Report;
  my $p = new Mail::Abuse::Processor::Store;
  my $report = new Mail::Abuse::Report (processors => [ $p ]);

  # ... other pieces of code that configure the report ...

DESCRIPTION ^

This class stores a processed report in a file hierarchy that is composed using the smallest acceptable timestamp from the list of incidents in a report.

If no incidents are found within a report, a special name is built based on the report text.

The place where the files are created can be controlled with entries in the configuration file. Currently, the following directives are understood.

store root path

Points to the root of the tree where reports are to be stored. Defaults to the current directory.

store empty path

The name of the leaf where reports with no incidents are stored. This is a subdir of store root path. It defaults to the very creative name, "empty".

store mode

The mode in which to store abuse reports. The following modes are supported.

serialized

This is the default, and uses Storable to serialize the in-memory Mail::Abuse::Report object and store it in a flat file.

serialized-gz

Just like serialized, but the resulting file is compressed with the equivalent of gzip, using PerlIO::gzip.

plain

Store only the report text, as a flat file.

plain-gz

Just like plain but the resulting file is compressed on the fly using PerlIO::gzip.

debug store

If set to a true value, causes this module to emit debugging information using warn().

The following functions are implemented.

process($report)

Takes a Mail::Abuse::Report object as an argument and performs the processing action required.

The processed $report will have the filename where the report was stored, added in store_file.

EXPORT

None by default.

HISTORY ^

0.01

Original version; created by h2xs 1.2 with options

  -ACOXcfkn
        Mail::Abuse
        -v
        0.01

LICENSE AND WARRANTY ^

This code and all accompanying software comes with NO WARRANTY. You use it at your own risk.

This code and all accompanying software can be used freely under the same terms as Perl itself.

AUTHOR ^

Luis E. Muñoz <luismunoz@cpan.org>

SEE ALSO ^

perl(1).

syntax highlighting: