Mail::Abuse::Report 1.025

SYNOPSIS

use Mail::Abuse::Report;

my $r = new Mail::Abuse::Report
(
-text => $report_text,
-reader => $reader,
-filters => [ $f1, $f2, ... ],
-parsers => [ $i1, $i2, ... ],
-processors => [ $p1, $p2, ... ],
-debug => 1,
-config => $config_file,
);

This class encapsulates an abuse report and provides methods to automate tasks such as extracting individual incidents from it, filtering the incidents, etc.

Each of the methods are described in detail, below:

->new(%args)

Creates a new Mail::Abuse::Report object. It accepts the following arguments:

-text
Specifies the text that will be used to fill the report with. This is incompatible with -reader, so choose one and stick to it. Defaults to undef.

-reader
Specifies the object (tipically a member of Mail::Abuse::Reader) that will be used to fetch the text of the next report. This is incompatible with -text, so pick one and stick to it. Defaults to undef.

-filters
A reference to a list of objects that can filter incidents. Normally, objects based on Mail::Abuse::Filter. Defaults to no filters.

-parsers
A reference to a list of objects that can parse incidents out of the report text. Normally, objects based on Mail::Abuse::Incident. Defaults to no parsers.

-processors
A reference to a list of objects that can process the incidents on the report, normally objects based on the Mail::Abuse::Processor class. Defaults to no processors.

-debug
A true value causes diagnostic messages to be sent via warn().

-config
Specifies the name of the config file to fetch configuration items from. Can be left unspecified.