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