# info > Mail::Box::Search::SpamAssassin ## [Mail::Box::Search::SpaUseraContributed](https://www.chedong.com/phpMan.php/perldoc/Mail%3A%3ABox%3A%3ASearch%3A%3ASpaUseraContributed/markdown) [PerMail::Box::Search](https://www.chedong.com/phpMan.php/perldoc/PerMail%3A%3ABox%3A%3ASearch/markdown)::[SpamAssassin(3pm)](https://www.chedong.com/phpMan.php/man/SpamAssassin/3pm/markdown) ## NAME [Mail::Box::Search::SpamAssassin](https://www.chedong.com/phpMan.php/perldoc/Mail%3A%3ABox%3A%3ASearch%3A%3ASpamAssassin/markdown) - select spam messages with [Mail::SpamAssassin](https://www.chedong.com/phpMan.php/perldoc/Mail%3A%3ASpamAssassin/markdown) ## INHERITANCE [Mail::Box::Search::SpamAssassin](https://www.chedong.com/phpMan.php/perldoc/Mail%3A%3ABox%3A%3ASearch%3A%3ASpamAssassin/markdown) is a [Mail::Box::Search](https://www.chedong.com/phpMan.php/perldoc/Mail%3A%3ABox%3A%3ASearch/markdown) is a [Mail::Reporter](https://www.chedong.com/phpMan.php/perldoc/Mail%3A%3AReporter/markdown) ## SYNOPSIS use [Mail::Box::Manager](https://www.chedong.com/phpMan.php/perldoc/Mail%3A%3ABox%3A%3AManager/markdown); my $mgr = [Mail::Box::Manager](https://www.chedong.com/phpMan.php/perldoc/Mail%3A%3ABox%3A%3AManager/markdown)->new; my $folder = $mgr->open('Inbox'); my $spam = [Mail::Box::Search::SpamAssassin](https://www.chedong.com/phpMan.php/perldoc/Mail%3A%3ABox%3A%3ASearch%3A%3ASpamAssassin/markdown)->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](https://www.chedong.com/phpMan.php/perldoc/Mail%3A%3ABox%3A%3ASearch%3A%3ASpamAssassin/markdown) ->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](https://www.chedong.com/phpMan.php/perldoc/Mail%3A%3ABox/markdown) can be used as spam filter, in combination with the useful [Mail::SpamAssassin](https://www.chedong.com/phpMan.php/perldoc/Mail%3A%3ASpamAssassin/markdown) module (which must be installed separately). Each message which is searched is wrapped in a [Mail::Message::Wrapper::SpamAssassin](https://www.chedong.com/phpMan.php/perldoc/Mail%3A%3AMessage%3A%3AWrapper%3A%3ASpamAssassin/markdown) object. The spam-assassin module version 2 is not really well adapted for [Mail::Message](https://www.chedong.com/phpMan.php/perldoc/Mail%3A%3AMessage/markdown) objects, which will make this search even slower than spam-detection already is. Extends "DESCRIPTION" in [Mail::Box::Search](https://www.chedong.com/phpMan.php/perldoc/Mail%3A%3ABox%3A%3ASearch/markdown). ## METHODS Extends "METHODS" in [Mail::Box::Search](https://www.chedong.com/phpMan.php/perldoc/Mail%3A%3ABox%3A%3ASearch/markdown). Constructors Extends "Constructors" in [Mail::Box::Search](https://www.chedong.com/phpMan.php/perldoc/Mail%3A%3ABox%3A%3ASearch/markdown). [Mail::Box::Search::SpamAssassin](https://www.chedong.com/phpMan.php/perldoc/Mail%3A%3ABox%3A%3ASearch%3A%3ASpamAssassin/markdown)->new(%options) Create a spam filter. Internally, a [Mail::SpamAssassin](https://www.chedong.com/phpMan.php/perldoc/Mail%3A%3ASpamAssassin/markdown) object is maintained. Only the whole message can be searched; this is a limitation of the [Mail::SpamAssassin](https://www.chedong.com/phpMan.php/perldoc/Mail%3A%3ASpamAssassin/markdown) module. -Option --Defined in --Default binaries [Mail::Box::Search](https://www.chedong.com/phpMan.php/perldoc/Mail%3A%3ABox%3A%3ASearch/markdown) decode [Mail::Box::Search](https://www.chedong.com/phpMan.php/perldoc/Mail%3A%3ABox%3A%3ASearch/markdown) delayed [Mail::Box::Search](https://www.chedong.com/phpMan.php/perldoc/Mail%3A%3ABox%3A%3ASearch/markdown) deleted [Mail::Box::Search](https://www.chedong.com/phpMan.php/perldoc/Mail%3A%3ABox%3A%3ASearch/markdown) deliver [Mail::Box::Search](https://www.chedong.com/phpMan.php/perldoc/Mail%3A%3ABox%3A%3ASearch/markdown) undef in [Mail::Box::Search](https://www.chedong.com/phpMan.php/perldoc/Mail%3A%3ABox%3A%3ASearch/markdown) 'MESSAGE' label c<'spam'> limit [Mail::Box::Search](https://www.chedong.com/phpMan.php/perldoc/Mail%3A%3ABox%3A%3ASearch/markdown) 0 log [Mail::Reporter](https://www.chedong.com/phpMan.php/perldoc/Mail%3A%3AReporter/markdown) 'WARNINGS' logical [Mail::Box::Search](https://www.chedong.com/phpMan.php/perldoc/Mail%3A%3ABox%3A%3ASearch/markdown) 'REPLACE' multiparts [Mail::Box::Search](https://www.chedong.com/phpMan.php/perldoc/Mail%3A%3ABox%3A%3ASearch/markdown) rewrite_mail sa_options { } spam_assassin undef trace [Mail::Reporter](https://www.chedong.com/phpMan.php/perldoc/Mail%3A%3AReporter/markdown) '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](https://www.chedong.com/phpMan.php/perldoc/Mail%3A%3ASpamAssassin%3A%3APerMsgStatus/markdown) subroutine rewrite_mail. sa_options => HASH Options to create the internal [Mail::SpamAssassin](https://www.chedong.com/phpMan.php/perldoc/Mail%3A%3ASpamAssassin/markdown) 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](https://www.chedong.com/phpMan.php/perldoc/Mail%3A%3ASpamAssassin%3A%3AConf/markdown). spam_assassin => OBJECT Provide a [Mail::SpamAssassin](https://www.chedong.com/phpMan.php/perldoc/Mail%3A%3ASpamAssassin/markdown) 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](https://www.chedong.com/phpMan.php/perldoc/Mail%3A%3ABox%3A%3ASearch%3A%3ASpamAssassin/markdown) ->new( found => 'DELETE' ); Searching Extends "Searching" in [Mail::Box::Search](https://www.chedong.com/phpMan.php/perldoc/Mail%3A%3ABox%3A%3ASearch/markdown). $obj->assassinator() Returns the internally maintained assassinator object. You may want to reach this object for complex configuration. $obj->inBody($part, $body) Inherited, see "Searching" in [Mail::Box::Search](https://www.chedong.com/phpMan.php/perldoc/Mail%3A%3ABox%3A%3ASearch/markdown) $obj->inHead($part, $head) Inherited, see "Searching" in [Mail::Box::Search](https://www.chedong.com/phpMan.php/perldoc/Mail%3A%3ABox%3A%3ASearch/markdown) $obj->search($folder|$thread|$message|ARRAY) Inherited, see "Searching" in [Mail::Box::Search](https://www.chedong.com/phpMan.php/perldoc/Mail%3A%3ABox%3A%3ASearch/markdown) $obj->searchPart($part) Inherited, see "Searching" in [Mail::Box::Search](https://www.chedong.com/phpMan.php/perldoc/Mail%3A%3ABox%3A%3ASearch/markdown) The Results Extends "The Results" in [Mail::Box::Search](https://www.chedong.com/phpMan.php/perldoc/Mail%3A%3ABox%3A%3ASearch/markdown). $obj->printMatch( [$fh], HASH ) Inherited, see "The Results" in [Mail::Box::Search](https://www.chedong.com/phpMan.php/perldoc/Mail%3A%3ABox%3A%3ASearch/markdown) Error handling Extends "Error handling" in [Mail::Box::Search](https://www.chedong.com/phpMan.php/perldoc/Mail%3A%3ABox%3A%3ASearch/markdown). $obj->AUTOLOAD() Inherited, see "Error handling" in [Mail::Reporter](https://www.chedong.com/phpMan.php/perldoc/Mail%3A%3AReporter/markdown) $obj->addReport($object) Inherited, see "Error handling" in [Mail::Reporter](https://www.chedong.com/phpMan.php/perldoc/Mail%3A%3AReporter/markdown) $obj->defaultTrace( [$level]|[$loglevel, $tracelevel]|[$level, $callback] ) [Mail::Box::Search::SpamAssassin](https://www.chedong.com/phpMan.php/perldoc/Mail%3A%3ABox%3A%3ASearch%3A%3ASpamAssassin/markdown)->defaultTrace( [$level]|[$loglevel, $tracelevel]|[$level, $callback] ) Inherited, see "Error handling" in [Mail::Reporter](https://www.chedong.com/phpMan.php/perldoc/Mail%3A%3AReporter/markdown) $obj->errors() Inherited, see "Error handling" in [Mail::Reporter](https://www.chedong.com/phpMan.php/perldoc/Mail%3A%3AReporter/markdown) $obj->log( [$level, [$strings]] ) [Mail::Box::Search::SpamAssassin](https://www.chedong.com/phpMan.php/perldoc/Mail%3A%3ABox%3A%3ASearch%3A%3ASpamAssassin/markdown)->log( [$level, [$strings]] ) Inherited, see "Error handling" in [Mail::Reporter](https://www.chedong.com/phpMan.php/perldoc/Mail%3A%3AReporter/markdown) $obj->logPriority($level) [Mail::Box::Search::SpamAssassin](https://www.chedong.com/phpMan.php/perldoc/Mail%3A%3ABox%3A%3ASearch%3A%3ASpamAssassin/markdown)->logPriority($level) Inherited, see "Error handling" in [Mail::Reporter](https://www.chedong.com/phpMan.php/perldoc/Mail%3A%3AReporter/markdown) $obj->logSettings() Inherited, see "Error handling" in [Mail::Reporter](https://www.chedong.com/phpMan.php/perldoc/Mail%3A%3AReporter/markdown) $obj->notImplemented() Inherited, see "Error handling" in [Mail::Reporter](https://www.chedong.com/phpMan.php/perldoc/Mail%3A%3AReporter/markdown) $obj->report( [$level] ) Inherited, see "Error handling" in [Mail::Reporter](https://www.chedong.com/phpMan.php/perldoc/Mail%3A%3AReporter/markdown) $obj->reportAll( [$level] ) Inherited, see "Error handling" in [Mail::Reporter](https://www.chedong.com/phpMan.php/perldoc/Mail%3A%3AReporter/markdown) $obj->trace( [$level] ) Inherited, see "Error handling" in [Mail::Reporter](https://www.chedong.com/phpMan.php/perldoc/Mail%3A%3AReporter/markdown) $obj->warnings() Inherited, see "Error handling" in [Mail::Reporter](https://www.chedong.com/phpMan.php/perldoc/Mail%3A%3AReporter/markdown) Cleanup Extends "Cleanup" in [Mail::Box::Search](https://www.chedong.com/phpMan.php/perldoc/Mail%3A%3ABox%3A%3ASearch/markdown). $obj->DESTROY() Inherited, see "Cleanup" in [Mail::Reporter](https://www.chedong.com/phpMan.php/perldoc/Mail%3A%3AReporter/markdown) ## 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 3.009, built on August 18, 2020. Website: ## LICENSE Copyrights 2001-2020 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 perl v5.30.3 2020-08-[Mail::Box::Search](https://www.chedong.com/phpMan.php/perldoc/Mail%3A%3ABox%3A%3ASearch/markdown)::[SpamAssassin(3pm)](https://www.chedong.com/phpMan.php/man/SpamAssassin/3pm/markdown)