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

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

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.sourceforge.net/ for more information about Pyzor.

USER OPTIONS

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

       pyzor_max 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.

ADMINISTRATOR OPTIONS

       pyzor_timeout n		(default: 3.5)
	   How many seconds you wait for Pyzor to complete, before scanning continues without the Pyzor results.

	   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.

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

PYZOR(1)						      General Commands Manual							  PYZOR(1)

NAME

       pyzor - spam-catcher using a collaborative filtering network

SYNOPSIS

       pyzor [-d] [--homedir dir] command [command_options]

OPTIONS

       -d     turn on debugging

       --homedir dir
	      use  dir	as the home directory for Pyzor instead of the default ~/.pyzor.  See the files section for more information on what files
	      are inside of the homedir.

COMMANDS

       check[--mbox]
	      Reads on standard input an RFC 822 (email) message. Exit code is zero (0) if and only if a match is found and the  global  whitelist
	      count is zero.   If --mbox is provided, then the input is assumed to be a unix mailbox, and all messages in it will be checked.	If
	      multiple servers are listed in the configuration file, the exit code will be zero (0) if and only if there is a match  found  on	at
	      least one server (without it being whitelisted anyplace).

       report [--mbox]
	      Reads on standard input an RFC 822 (email) message. Reports to the server a digest of each message in the mailbox as spam. Writes to
	      standard output a tuple of (error-code, message) from the server.   If --mbox is provided, then the input is assumed to  be  a  unix
	      mailbox, and all messages in it will be sent to the server.

       whitelist [--mbox]
	      Reads  on  standard  input an RFC 822 (email) message. Sends to the server a digest of each message in the mailbox for whitelisting.
	      Writes to standard output a tuple of (error-code, message) from the server.   If --mbox is provided, then the input is assumed to be
	      a unix mailbox, and all messages in it will be sent to the server.

       discover
	      Finds  Pyzor  servers,  and writes them to ~/.pyzor/servers. This may accomplished through querying already-known servers or an HTTP
	      call to a hard-coded address.

       ping   Merely requests a response from the servers.

       genkey Based upon a secret passphrase gathered from the user and salt gathered from /dev/random, prints	to  standard  output  a  tuple	of
	      "salt,key".  Used to put account information into the accounts file.  See the section Using Accounts for more information.

       digest [--mbox]
	      Reads  on  standard  input an RFC 822 (email) message. Writes the digest of the message to standard output.   If --mbox is provided,
	      then the input is assumed to be a unix mailbox, each message's digest is written to standard output, separated by newlines.

       predigest
	      Reads on standard input an RFC 822 (email) message. Writes to standard output the normalized lines of data that are  digested,  with
	      the exception that the lines printed have newlines (all whitespace is removed before digesting).

USING PYZOR WITH READYEXEC

       ReadyExec  is  a system to eliminate the high startup-cost of executing scripts repeatedly. If you execute pyzor a lot, you might be inter-
       ested in installing ReadyExec and using it with pyzor.

       To use pyzor with ReadyExec, the readyexecd.py server needs to be started as:

	  readyexecd.py socket_file pyzor

       socket_file can be any (non-existing) filename you wish ReadyExec to use, such as /tmp/pyzor:

	  readyexecd.py /tmp/pyzor pyzor

       Individual clients are then executed as:

	  readyexec socket_file options command cmd_options

       For example:

	  readyexec /tmp/pyzor check
	  readyexec /tmp/pyzor report
	  readyexec /tmp/pyzor whitelist --mbox
	  readyexec /tmp/pyzor -d ping

       ReadyExec can be found at: http://readyexec.sourceforge.net/

INTEGRATION WITH MUTT

       Add the following line to mutt.conf:

	  macro index S "|/usr/bin/pyzor report"

       Then press S on the spam message in mutt to report it with pyzor.

FILES

       ~/.pyzor/config

       The format of this file is INI-style (name=value, divided into [sections]).  Names are case insensitive. All values which are filenames can
       have shell-style tildes (~) in them. All values which are relative filenames are interpreted to be relative to the Pyzor homedir.

       Defaults
	[client]
	ServersFile = servers
	AccountsFile = accounts
	DiscoverServersURL = http://pyzor.sourceforge.net/cgi-bin/inform-servers-0-3-x
	Timeout = 5

SEE ALSO

       pyzord(1)

AUTHOR

       This  manpage was originally written by Bastian Kleineidam <calvin@debian.org> for the Debian distribution of pyzor but may be used by oth-
       ers.   The main author of pyzor is Frank J. Tobin <ftobin@neverending.org>.  The main project page for pyzor can be found at http://source-
       forge.net/projects/pyzor

								    10 Oct 2002 							  PYZOR(1)