.TH qmail-spamt 5
.SH NAME
qmail-spamt \- assign spam throttle parameters to IP blocks
.SH OVERVIEW
The file
.B /var/qmail/control/spamt
assigns spam throttle parameters to IP blocks. For example,

.EX
   192.168.0.0/24:private:2000:120000::::::
.EE

says that mail originating from IP block
.B 192.168.0.0/24
will use
.B /var/qmail/spam/private
as the spam throttle directory, with a spam throttle
delay of 2000 and a spam throttle maximum delay of 120000 
(both in milliseconds).  All other spam throttle parameters
are unaffected.  To define the default spam throttle parameters,
define an entry in
.B /var/qmail/control/spamt
with an empty IP block.

Assignments fed to
.B qmail-newst
will be used by
.B qmail-smtpd
to control spam throttling.
See
.BR qmail-newst (8).
A change to
.B /var/qmail/control/spamt
will have no effect until
.B qmail-newst
is run.
.SH STRUCTURE
.B /var/qmail/control/spamt
is a series of assignments, one per line.
It ends with a line containing a single dot.
Lines must not contain NUL.
.SH "ASSIGNMENTS"
A simple assignment is a line of the form

.EX
   ipblock:dir:st:stmax:flush:rcpt:tg:tg_resp:
.EE

Here
.I ipblock
is an IP block (format
.I \fR[\fIa\fR.\fIb\fR.\fIc\fR.\fId\fR][/\fIn\fR]]);
.IR dir ,
.IR st ,
.IR stmax ,
.IR flush ,
.IR rcpt ,
.IR tg ,
and
.I tg_resp
are the spam throttle parameters for directory (relative path),
delay (ms), maximum delay (ms), post-DATA flush, reasonable receipt count,
teergrube periodicity (s), and teergrube response.  Real-time values
for
.I ipblock
will be stored in
.BR /var/qmail/spam/\fIdir .
See
.BR qmail-spamthrottle (9).
 
If there are several assignments for the same
.IR ipblock ,
.B qmail-smtpd
will use the first one.

If an entry exists with an empty
.IR ipblock,
it is always used to define default (initial) values.

If several, distinct
.IR ipblock s
match a given IP address, as specified by environment variable
.BR TCPREMOTEIP ,
the most specific (smallest network block) entry is used.

If, after applying all applicable rules,
.I dir 
is empty, then it will be set to
.IR a\fR/\fIb\fR/\fIc\fR/\fId ,
where
.IR a ,
.IR b ,
.IR c ,
and
.I d
are the first four octets (in decimal) for the remote IP address,
.IR a\fR.\fIb\fR.\fIc\fR.\fId .

If
.I dir
starts with a slash (\fB/\fR), then it will be used to generate an \fIn\fR-bit masked
IP address (format 
.I \fR[/\fIn\fR])
based on the remote IP address.  For example, if
.I dir
is set to
.B /16
and the remote IP address is
.BR 192.168.10.3 ,
then the spam throttle directory will be
.BR 192/168/0/0 .


.SH EXAMPLES

.EX
   192.168.0.0/24::0::::::
   192.168.0.2:specific:2000::::::
   192.168.1.0/16:testing:10000:::1:2:hold your horses!:
   # empty network ==> default entry
   ::1501:120000::::::
.EE

The IP address
.B 192.168.2.1
is handled by the fourth line;
the IP address
.B 192.168.1.2
is handled by the third line;
the IP address
.B 192.168.0.2
is handled by the second line;
the address
.B 192.168.0.1
is handled by the first line.
.SH "SEE ALSO"
qmail-newst(8),
qmail-spamthrottle(5)

.SH AUTHOR
Dale Woolridge, James Law, and Moto Kawasaki.  Contact the authors
via email: <spamthrottle@qmail.ca>.