diff options
Diffstat (limited to 'antispam.7')
| -rw-r--r-- | antispam.7 | 77 |
1 files changed, 51 insertions, 26 deletions
@@ -61,7 +61,7 @@ protocol imap { .SH BACKENDS -The plugin supports multiple backends, there are currently two working +The plugin supports multiple backends, there are currently a few working backends included in the distribution: .SS dspam executable backend (dspam specific) @@ -71,12 +71,13 @@ problems with this approach including (1) it can take a long time during which the IMAP session is blocked (2) when many users retrain many messages at once server load may spike -.SS email sender backend (spam filter agnostic) +.SS pipe backend (spam filter agnostic) -This backend sends mail to ham@example.com or spam@example.com -(actual addresses are configurable) for retraining. This backend can -be very fast to set up if you already have a working setup that uses -training addresses as recommended by many spam filter setups. +This backend simply pipes the mail to train to a process it executes. +This can for example be used to send it as email to mail aliases for +retraining. This backend can be very easy to set up if you already +have a working setup that uses training addresses as recommended by +many spam filter setups. Since this backend simply pipes the message to a program (by default sendmail) it can also be used for all kinds of other spam filters, @@ -92,7 +93,7 @@ You need to use the unsure folder option (see below) together with this plugin and deliver unsure mail into an unsure folder, spam mail into a spam folder and other mail regularly. -Has the same drawbacks as the dspam-exec approach. +Has the same drawbacks as the dspam approach. .SS spool2dir backend (general) @@ -111,6 +112,23 @@ plugin { ################## # GENERIC OPTIONS + # Debugging options + # Uncomment to get the desired debugging behaviour. + # Note that in some cases stderr debugging will not be as + # verbose as syslog debugging due to internal limitations. + # + # antispam_debug_target = syslog + # antispam_debug_target = stderr + # antispam_verbose_debug = 1 + + # backend selection, MUST be configured first, + # there's no default so you need to set one of + # these options: + # antispam_backend = crm114 + # antispam_backend = dspam + # antispam_backend = pipe + # antispam_backend = spool2dir + # mail signature (used with any backend requiring a signature) antispam_signature = X-DSPAM-Signature @@ -170,7 +188,7 @@ plugin { # #=================== - # dspam-exec plugin + # dspam plugin # dspam binary antispam_dspam_binary = /usr/bin/dspam @@ -189,34 +207,41 @@ plugin { # antispam_dspam_result_blacklist = Virus #===================== - # mail sending plugin + # pipe plugin + # + # This plug can be used to train via an arbitrary program that + # receives the message on standard input. Since sendmail can be + # such a program, it can be used to send the message to another + # email address for training there. # - # Because of the way this plugin works, you can also use it - # to train via an arbitrary program that receives the message - # on standard input, in that case you can use the config - # options antispam_mail_spam and antispam_mail_notspam for - # the argument that distinguishes between ham and spam. # For example: - # antispam_mail_sendmail = /path/to/mailtrain - # antispam_mail_sendmail_args = --for;%u - # antispam_mail_spam = --spam - # antispam_mail_notspam = --ham + # antispam_pipe_program = /path/to/mailtrain + # (defaults to /usr/sbin/sendmail) + # antispam_pipe_program_args = --for;%u + # antispam_pipe_program_spam_arg = --spam + # antispam_pipe_program_notspam_arg = --ham + # antispam_pipe_tmpdir = /tmp # will call it, for example, like this: # /path/to/mailtrain --for jberg --spam + # + # The old configuration options from when this plugin was called + # "mailtrain" are still valid, these are, in the same order as + # above: antispam_mail_sendmail, antispam_mail_sendmail_args, + # antispam_mail_spam, antispam_mail_notspam and antispam_mail_tmpdir. # temporary directory - antispam_mail_tmpdir = /tmp + antispam_pipe_tmpdir = /tmp - # spam/not-spam addresses (default unset which will give errors) - # antispam_mail_spam = - # antispam_mail_notspam = + # spam/not-spam argument (default unset which will is not what you want) + # antispam_pipe_program_spam_arg = + # antispam_pipe_program_notspam_arg = - # sendmail binary - antispam_mail_sendmail = /usr/sbin/sendmail - #antispam_mail_sendmail_args = -f;%u@example.com # % expansion done by dovecot + # binary to pipe mail to + antispam_pipe_program = /usr/sbin/sendmail + #antispam_pipe_program_args = -f;%u@example.com # % expansion done by dovecot #=================== - # crm114-exec plugin + # crm114 plugin # mailreaver binary antispam_crm_binary = /bin/false |