| 1 | .\" -*-nroff-*- |
| 2 | .TH qmail-checkspam 8 "9 October 2003" "Straylight/Edgeware" |
| 3 | .SH NAME |
| 4 | qmail-checkspam \- check messages for spam before queueing them |
| 5 | .SH SYNOPSIS |
| 6 | .B qmail-checkspam |
| 7 | .SH DESCRIPTION |
| 8 | The |
| 9 | .B qmail-checkspam |
| 10 | program provides the same interface as |
| 11 | .BR qmail-queue (8). |
| 12 | It reads a message on file descriptor 0, and passes it to |
| 13 | .BR spamd (8). |
| 14 | If |
| 15 | .B spamd |
| 16 | thinks the message is spam, then |
| 17 | .B qmail-checkspam |
| 18 | exits 31, indicating a permanent refusal. |
| 19 | Otherwise, |
| 20 | .B qmail-checkspam |
| 21 | feeds the message, augmented by SpamAssassin's |
| 22 | .B X-Spam-Status |
| 23 | header, to |
| 24 | .BR qmail-queue (8). |
| 25 | .PP |
| 26 | You will usually run |
| 27 | .B qmail-checkspam |
| 28 | by applying the |
| 29 | .B QMAILQUEUE |
| 30 | patch to |
| 31 | .BR qmail (7) |
| 32 | and setting the |
| 33 | .B QMAILQUEUE |
| 34 | environment variable to refer to |
| 35 | .B qmail-checkspam |
| 36 | in, e.g., the |
| 37 | .B /etc/hosts.deny |
| 38 | file (see |
| 39 | .BR hosts_options (5)). |
| 40 | .SH ENVIRONMENT |
| 41 | .TP |
| 42 | .B QMAIL_CHECKSPAM_SPAMDHOST |
| 43 | The hostname or IP address of the |
| 44 | .B spamd |
| 45 | to connect to. Default is |
| 46 | .BR localhost . |
| 47 | .TP |
| 48 | .B QMAIL_CHECKSPAM_SPAMDPORT |
| 49 | The port number to connect to. The default is |
| 50 | .BR 783 . |
| 51 | .TP |
| 52 | .B QMAIL_CHECKSPAM_THRESH |
| 53 | The threshold score for rejection. The default is whatever |
| 54 | .B spamd |
| 55 | is configured to. |
| 56 | .TP |
| 57 | .B QMAIL_CHECKSPAM_QUEUE |
| 58 | The |
| 59 | .BR qmail-queue -compatible |
| 60 | program to pass good mail to. The default is |
| 61 | .BR /var/qmail/bin/qmail-queue . |
| 62 | .SH BUGS |
| 63 | None known. |
| 64 | .SH AUTHOR |
| 65 | Mark Wooding, <mdw@distorted.org.uk> |
| 66 | |