NAME

       Mail::SpamAssassin::Plugin::Pyzor - perform Pyzor check of messages

SYNOPSIS

         loadplugin     Mail::SpamAssassin::Plugin::Pyzor

DESCRIPTION

       Pyzor is a collaborative, networked system to detect and block spam using identifying
       digests of messages.

       See http://pyzor.org/ for more information about Pyzor.

USER OPTIONS

       use_pyzor (0|1)          (default: 1)
           Whether to use Pyzor, if it is available.

       pyzor_fork (0|1)         (default: 1)
           Instead of running Pyzor synchronously, fork separate process for it and read the
           results in later (similar to async DNS lookups).  Increases throughput. Considered
           experimental on Windows, where default is 0.

       pyzor_count_min NUMBER   (default: 5)
           This option sets how often a message's body checksum must have been reported to the
           Pyzor server before SpamAssassin will consider the Pyzor check as matched.

           As most clients should not be auto-reporting these checksums, you should set this to a
           relatively low value, e.g. 5.

       pyzor_welcomelist_min NUMBER  (default: 10)
           Previously pyzor_whitelist_min which will work interchangeably until 4.1.

           This option sets how often a message's body checksum must have been welcomelisted to
           the Pyzor server for SpamAssassin to consider ignoring the result.  Final decision is
           made by pyzor_welcomelist_factor.

       pyzor_welcomelist_factor NUMBER    (default: 0.2)
           Previously pyzor_whitelist_factor which will work interchangeably until 4.1.

           Ignore Pyzor result if REPORTCOUNT x NUMBER >= pyzor_welcomelist_min.  For default
           setting this means: 50 reports requires 10 welcomelistings.

ADMINISTRATOR OPTIONS

       pyzor_timeout n          (default: 5)
           How many seconds you wait for Pyzor to complete, before scanning continues without the
           Pyzor results. A numeric value is optionally suffixed by a time unit (s, m, h, d, w,
           indicating seconds (default), minutes, hours, days, weeks).

           You can configure Pyzor to have its own per-server timeout.  Set this plugin's timeout
           with that in mind.  This plugin's timeout is a maximum ceiling.  If Pyzor takes longer
           than this to complete its communication with all servers, no results are used by
           SpamAssassin.

           Pyzor servers do not yet synchronize their servers, so it can be beneficial to check
           and report to more than one.  See the pyzor-users mailing list for alternate servers
           that are not published via 'pyzor discover'.

           If you are using multiple Pyzor servers, a good rule of thumb would be to set the
           SpamAssassin plugin's timeout to be the same or just a bit more than the per-server
           Pyzor timeout (e.g., 3.5 and 2 for two Pyzor servers).  If more than one of your Pyzor
           servers is always timing out, consider removing one of them.

       pyzor_options options
           Specify additional options to the pyzor(1) command. Please note that only characters
           in the range [0-9A-Za-z =,._/-] are allowed for security reasons.

       pyzor_path STRING
           This option tells SpamAssassin specifically where to find the "pyzor" client instead
           of relying on SpamAssassin to find it in the current PATH.  Note that if taint mode is
           enabled in the Perl interpreter, you should use this, as the current PATH will have
           been cleared.