Mail::SpamAssassin::ArchiveIterator - find and process messages one at a time
my $iter = new Mail::SpamAssassin::ArchiveIterator( { 'opt_all' => 1, 'opt_cache' => 1, } );
$iter->set_functions( \&wanted, sub { } );
eval { $iter->run(@ARGV); };
sub wanted { my($class, $filename, $recv_date, $msg_array) = @_;
... }
The Mail::SpamAssassin::ArchiveIterator module will go through a set of mbox files, mbx files, and directories (with a single message per file) and generate a list of messages. It will then call the wanted and results functions appropriately per message.
Mail::SpamAssassin::ArchiveIterator
object. You may
pass the following attribute-value pairs to the constructor. The pairs are
optional unless otherwise noted.
This setting can be specified separately for each target.
This setting can be specified separately for each target.
This setting can be specified separately for each target.
wanted_sub
callback below. Set this to 0 to avoid this;
it's a good idea to set this to 0 if you can, as it imposes a performance
hit.
opt_cachedir
also be set.
opt_cache
, if you don't want to mix them with the input files (as is the
default). The directory must be both readable and writable.
Note that if opt_want_date
is set to 0, the received date scalar will be
undefined.
Note that if opt_want_date
is set to 0, the received date scalar will be
undefined.
.gz
or
.bz2
will be properly uncompressed via call to gzip -dc
and bzip2 -dc
respectively.
The target_paths array is expected to be either one element per path in the
following format: class:format:raw_location
, or a hash reference containing
key-value option pairs and a 'target' key with a value in that format.
The key-value option pairs that can be used are: opt_scanprob, opt_after, opt_before. See the constructor method's documentation for more information on their effects.
run()
returns 0 if there was an error (can't open a file, etc,) and 1 if there
were no errors.
dir
is a directory whose
files are individual messages, file
a file with a single message,
mbox
an mbox formatted file, or mbx
for an mbx formatted directory.
detect
can also be used. This assumes mbox
for any file whose path
contains the pattern /\.mbox/i
, file
anything that is not a
directory, or directory
otherwise.
perldoc -f glob
). ~
at the
front of the value will be replaced by the HOME
environment
variable. Escaped whitespace is protected as well.
NOTE: ~user
is not allowed.
NOTE 2: -
is not allowed as a raw location. To have
ArchiveIterator deal with STDIN, generate a temp file.
Mail::SpamAssassin
spamassassin
mass-check