GSP
Quick Navigator

Search Site

Unix VPS
A - Starter
B - Basic
C - Preferred
D - Commercial
MPS - Dedicated
Previous VPSs
* Sign Up! *

Support
Contact Us
Online Help
Handbooks
Domain Status
Man Pages

FAQ
Virtual Servers
Pricing
Billing
Technical

Network
Facilities
Connectivity
Topology Map

Miscellaneous
Server Agreement
Year 2038
Credits
 

USA Flag

 

 

Man Pages


Manual Reference Pages  -  MAIL::BOX::SEARCH::SPAMASSASSIN (3)

.ds Aq ’

NAME

Mail::Box::Search::SpamAssassin - select spam messages with Mail::SpamAssassin

CONTENTS

INHERITANCE



 Mail::Box::Search::SpamAssassin
   is a Mail::Box::Search
   is a Mail::Reporter



SYNOPSIS



 use Mail::Box::Manager;
 my $mgr    = Mail::Box::Manager->new;
 my $folder = $mgr->open(Inbox);

 my $spam = Mail::Box::Search::SpamAssassin->new;
 if($spam->search($message)) {...}

 my @msgs   = $filter->search($folder);
 foreach my $msg ($folder->messages)
 {   $msg->delete if $msg->label(spam);
 }

 my $spam2 = Mail::Box::Search::SpamAssassin
               ->new(deliver => DELETE);
 $spam2->search($folder);
 $mgr->moveMessages($spamfolder, $folder->messages(spam));



DESCRIPTION

Spam means unsollicited e-mail, and is as name derived from a Monty Python scatch. Although Monty Python is fun, spam is a pain: it needlessly spoils minutes of time from most people: telephone bills, overful mailboxes which block honest e-mail, and accidentally removal of honest e-mail which looks like spam. Spam is the pest of Internet.

Happily, Mail::Box can be used as spam filter, in combination with the useful Mail::SpamAssassin module (which must be installed separately). Each message which is searched is wrapped in a Mail::Message::Wrapper::SpamAssassin object.

The spam-assassin module version 2 is not really well adapted for Mail::Message objects, which will make this search even slower than spam-detection already is.

See documentation in the base class.

METHODS

See documentation in the base class.

    Constructors

See documentation in the base class.
Mail::Box::Search::SpamAssassin-><B>newB>(OPTIONS) Create a spam filter. Internally, a Mail::SpamAssassin object is maintained.

Only the whole message can be searched; this is a limitation of the Mail::SpamAssassin module.



 -Option       --Defined in       --Default
  binaries       Mail::Box::Search  <false>
  decode         Mail::Box::Search  <true>
  delayed        Mail::Box::Search  <true>
  deleted        Mail::Box::Search  <false>
  deliver        Mail::Box::Search  undef
  in             Mail::Box::Search  MESSAGE
  label                             c<spam>
  limit          Mail::Box::Search  0
  log            Mail::Reporter     WARNINGS
  logical        Mail::Box::Search  REPLACE
  multiparts     Mail::Box::Search  <true>
  rewrite_mail                      <true>
  sa_options                        { }
  spam_assassin                     undef
  trace          Mail::Reporter     WARNINGS



binaries => BOOLEAN
decode => BOOLEAN
delayed => BOOLEAN
deleted => BOOLEAN
deliver => undef|CODE|’DELETE
in => ’HEAD’|’BODY’|’MESSAGE
label => STRING|undef Mark all selected message with the specified STRING. If this option is explicitly set to undef, the label will not be set.
limit => NUMBER
log => LEVEL
logical => ’REPLACE’|’AND’|’OR’|’NOT’|’AND NOT’|’OR NOT
multiparts => BOOLEAN
rewrite_mail => BOOLEAN Add lines to the message header describing the results of the spam scan. See Mail::SpamAssassin::PerMsgStatus subroutine rewrite_mail.
sa_options => HASH Options to create the internal Mail::SpamAssassin object; see its manual page for the available options. Other setting may be provided via SpamAssassins configuration file mechanism, which is explained in Mail::SpamAssassin::Conf.
spam_assassin => OBJECT Provide a Mail::SpamAssassin object to be used for searching spam. If none is specified, one is created internally. The object can be retrieved with assassinator().
trace => LEVEL

example:



 my $filter = Mail::Box::Search::SpamAssassin
               ->new( found => DELETE );



    Searching

See documentation in the base class.
$obj-><B>assassinatorB>() Returns the internally maintained assassinator object. You may want to reach this object for complex configuration.
$obj-><B>inBodyB>(PART, BODY) See Searching in Mail::Box::Search
$obj-><B>inHeadB>(PART, HEAD) See Searching in Mail::Box::Search
$obj-><B>searchB>(FOLDER|THREAD|MESSAGE|ARRAY-OF-MESSAGES) See Searching in Mail::Box::Search
$obj-><B>searchPartB>(PART) See Searching in Mail::Box::Search

    The Results

See documentation in the base class.
$obj-><B>printMatchB>([FILEHANDLE], HASH) See The Results in Mail::Box::Search

    Error handling

See documentation in the base class.
$obj-><B>AUTOLOADB>() See Error handling in Mail::Reporter
$obj-><B>addReportB>(OBJECT) See Error handling in Mail::Reporter
$obj-><B>defaultTraceB>([LEVEL]|[LOGLEVEL, TRACELEVEL]|[LEVEL, CALLBACK])
Mail::Box::Search::SpamAssassin-><B>defaultTraceB>([LEVEL]|[LOGLEVEL, TRACELEVEL]|[LEVEL, CALLBACK]) See Error handling in Mail::Reporter
$obj-><B>errorsB>() See Error handling in Mail::Reporter
$obj-><B>logB>([LEVEL [,STRINGS]])
Mail::Box::Search::SpamAssassin-><B>logB>([LEVEL [,STRINGS]]) See Error handling in Mail::Reporter
$obj-><B>logPriorityB>(LEVEL)
Mail::Box::Search::SpamAssassin-><B>logPriorityB>(LEVEL) See Error handling in Mail::Reporter
$obj-><B>logSettingsB>() See Error handling in Mail::Reporter
$obj-><B>notImplementedB>() See Error handling in Mail::Reporter
$obj-><B>reportB>([LEVEL]) See Error handling in Mail::Reporter
$obj-><B>reportAllB>([LEVEL]) See Error handling in Mail::Reporter
$obj-><B>traceB>([LEVEL]) See Error handling in Mail::Reporter
$obj-><B>warningsB>() See Error handling in Mail::Reporter

    Cleanup

See documentation in the base class.
$obj-><B>DESTROYB>() See Cleanup in Mail::Reporter

DIAGNOSTICS

Error: Package $package does not implement $method. Fatal error: the specific package (or one of its superclasses) does not implement this method where it should. This message means that some other related classes do implement this method however the class at hand does not. Probably you should investigate this and probably inform the author of the package.

SEE ALSO

This module is part of Mail-Box distribution version 2.109, built on August 19, 2013. Website: http://perl.overmeer.net/mailbox/

LICENSE

Copyrights 2001-2013 by [Mark Overmeer]. For other contributors see ChangeLog.

This program is free software; you can redistribute it and/or modify it under the same terms as Perl itself. See http://www.perl.com/perl/misc/Artistic.html

Search for    or go to Top of page |  Section 3 |  Main Index


perl v5.20.3 MAIL::BOX::SEARCH::SPAMASSASSIN (3) 2013-08-19

Powered by GSP Visit the GSP FreeBSD Man Page Interface.
Output converted with manServer 1.07.