.\" -*-nroff-*-
.TH qmail-checkspam 8 "9 October 2003" "Straylight/Edgeware"
.SH NAME
qmail-checkspam \- check messages for spam before queueing them
.SH SYNOPSIS
.B qmail-checkspam
.SH DESCRIPTION
The
.B qmail-checkspam
program provides the same interface as
.BR qmail-queue (8).
It reads a message on file descriptor 0, and passes it to
.BR spamd (8).
If
.B spamd
thinks the message is spam, then
.B qmail-checkspam
exits 31, indicating a permanent refusal.
Otherwise,
.B qmail-checkspam
feeds the message, augmented by SpamAssassin's
.B X-Spam-Status
header, to
.BR qmail-queue (8).
.PP
You will usually run
.B qmail-checkspam
by applying the
.B QMAILQUEUE
patch to
.BR qmail (7)
and setting the
.B QMAILQUEUE
environment variable to refer to
.B qmail-checkspam
in, e.g., the
.B /etc/hosts.deny
file (see
.BR hosts_options (5)).
.SH ENVIRONMENT
.TP
.B QMAIL_CHECKSPAM_SPAMDHOST
The hostname or IP address of the
.B spamd
to connect to.  Default is
.BR localhost .
.TP
.B QMAIL_CHECKSPAM_SPAMDPORT
The port number to connect to.  The default is
.BR 783 .
.TP
.B QMAIL_CHECKSPAM_THRESH
The threshold score for rejection.  The default is whatever
.B spamd
is configured to.
.TP
.B QMAIL_CHECKSPAM_QUEUE
The
.BR qmail-queue -compatible
program to pass good mail to.  The default is
.BR /var/qmail/bin/qmail-queue .
.SH BUGS
None known.
.SH AUTHOR
Mark Wooding, <mdw@distorted.org.uk>