Login or Register to Ask a Question and Join Our Community

Linux and UNIX Man Pages

Linux & Unix Commands - Search Man Pages

mail::spamassassin::plugin::autolearnthreshold(3pm) [debian man page]

Mail::SpamAssassin::Plugin::AutoLearnThreshold(3pm)	User Contributed Perl Documentation    Mail::SpamAssassin::Plugin::AutoLearnThreshold(3pm)

NAME

       Mail::SpamAssassin::Plugin::AutoLearnThreshold - threshold-based discriminator for Bayes auto-learning

SYNOPSIS

	 loadplugin	Mail::SpamAssassin::Plugin::AutoLearnThreshold

DESCRIPTION

       This plugin implements the threshold-based auto-learning discriminator for SpamAssassin's Bayes subsystem.  Auto-learning is a mechanism
       whereby high-scoring mails (or low-scoring mails, for non-spam) are fed into its learning systems without user intervention, during
       scanning.

       Note that certain tests are ignored when determining whether a message should be trained upon:

       o   rules with tflags set to 'learn' (the Bayesian rules)

       o   rules with tflags set to 'userconf' (user configuration)

       o   rules with tflags set to 'noautolearn'

       Also note that auto-learning occurs using scores from either scoreset 0 or 1, depending on what scoreset is used during message check.  It
       is likely that the message check and auto-learn scores will be different.

USER OPTIONS

       The following configuration settings are used to control auto-learning:

       bayes_auto_learn_threshold_nonspam n.nn	 (default: 0.1)
	   The score threshold below which a mail has to score, to be fed into SpamAssassin's learning systems automatically as a non-spam
	   message.

       bayes_auto_learn_threshold_spam n.nn	 (default: 12.0)
	   The score threshold above which a mail has to score, to be fed into SpamAssassin's learning systems automatically as a spam message.

	   Note: SpamAssassin requires at least 3 points from the header, and 3 points from the body to auto-learn as spam.  Therefore, the
	   minimum working value for this option is 6.

       bayes_auto_learn_on_error (0 | 1)	(default: 0)
	   With "bayes_auto_learn_on_error" off, autolearning will be performed even if bayes classifier already agrees with the new
	   classification (i.e.  yielded BAYES_00 for what we are now trying to teach it as ham, or yielded BAYES_99 for spam). This is a
	   traditional setting, the default was chosen to retain backwards compatibility.

	   With "bayes_auto_learn_on_error" turned on, autolearning will be performed only when a bayes classifier had a different opinion from
	   what the autolearner is now trying to teach it (i.e. it made an error in judgement). This strategy may or may not produce better future
	   classifications, but usually works very well, while also preventing unnecessary overlearning and slows down database growth.

perl v5.14.2							    2011-06-06		       Mail::SpamAssassin::Plugin::AutoLearnThreshold(3pm)

Check Out this Related Man Page

Courier::Filter::Module::SpamAssassin(3pm)		User Contributed Perl Documentation		Courier::Filter::Module::SpamAssassin(3pm)

NAME

       Courier::Filter::Module::SpamAssassin - SpamAssassin message filter module for the Courier::Filter framework

SYNOPSIS

	   use Courier::Filter::Module::SpamAssassin;

	   my $module = Courier::Filter::Module::SpamAssassin->new(
	       prefs_file  => '/etc/courier/filters/courier-filter-spamassassin.cf',
	       sa_options  => {
		   # any Mail::SpamAssassin options
	       },

	       logger	   => $logger,
	       inverse	   => 0,
	       trusting    => 0,
	       testing	   => 0,
	       debugging   => 0
	   );

	   my $filter = Courier::Filter->new(
	       ...
	       modules	   => [ $module ],
	       ...
	   );

DESCRIPTION

       This class is a filter module class for use with Courier::Filter.  It matches a message if its SpamAssassin spam score exceeds the
       configured threshold.

   Constructor
       The following constructor is provided:

       new(%options): returns Courier::Filter::Module::SpamAssassin
	   Creates a new SpamAssassin filter module.

	   %options is a list of key/value pairs representing any of the following options:

	   prefs_file
	       The path of a SpamAssassin preferences file.  If this option is specified, its value is passed to the Mail::SpamAssassin
	       constructor's "userprefs_filename" option .  If undef, SpamAssassin is instructed not to read any preferences besides its default
	       configuration files.  Defaults to undef.

	   sa_options
	       A hash-ref specifying options for the Mail::SpamAssassin object used by this filter module.  See "new" in Mail::SpamAssassin for
	       the supported options.

	   All options of the Courier::Filter::Module constructor are also supported.  Please see "new" in Courier::Filter::Module for their
	   descriptions.

   Instance methods
       See "Instance methods" in Courier::Filter::Module for a description of the provided instance methods.

SEE ALSO

       Courier::Filter::Module, Courier::Filter::Overview.

       For AVAILABILITY, SUPPORT, COPYRIGHT, and LICENSE information, see Courier::Filter::Overview.

AUTHOR

       Julian Mehnle <julian@mehnle.net>

perl v5.14.2							    2011-12-27				Courier::Filter::Module::SpamAssassin(3pm)
Man Page