.\" $Id: milter-spamd.8,v 1.4 2006/10/04 04:04:08 ca Exp $ */
.\"
.\" Copyright (c) 2004 Daniel Hartmeier
.\" All rights reserved.
.\"
.\" Redistribution and use in source and binary forms, with or without
.\" modification, are permitted provided that the following conditions
.\" are met:
.\"
.\"    - Redistributions of source code must retain the above copyright
.\"      notice, this list of conditions and the following disclaimer. 
.\"    - Redistributions in binary form must reproduce the above
.\"      copyright notice, this list of conditions and the following
.\"      disclaimer in the documentation and/or other materials provided
.\"      with the distribution. 
.\"
.\" THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
.\" "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
.\" LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS
.\" FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE
.\" COPYRIGHT HOLDERS OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT,
.\" INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING,
.\" BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
.\" LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
.\" CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN
.\" ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
.\" POSSIBILITY OF SUCH DAMAGE.
.\"
.\" Modified for meta1 policy milter by Claus Assmann
.\"
.Dd September 24, 2003
.Dt MILTER-SPAMD 8
.Os
.Sh NAME
.Nm milter-spamd
.Nd meta1 policy milter plugin for SpamAssassin spamd
.Sh SYNOPSIS
.Nm
.Op Fl d
.Op Fl i Ar RE
.Op Fl P Ar spamd port
.Op Fl p Ar pipe
.Op Fl t Ar timeout
.Op Fl U Ar spamd user
.Sh DESCRIPTION
The
.Nm
plugin can be used with the policy milter API of
.Xr meta1 8
to filter mails using regular expressions matching SMTP envelope
parameters and mail headers and body.
.Pp
The options are as follows:
.Bl -tag -width "-c config"
.It Fl d
Produce verbose debug output on stdout.
.It Fl i Ar RE
Accept mails without invoking spamd for peers whose host names
or IP addresses match the specified regular expression.
The argument is a case-insensitive extended regular expression
(like an argument of
.Xr egrep 1
-i).
Example:
.Bd -literal -offset indent
# milter-spamd -i '(^127\\.|^10\\.1\\.|\\.benzedrine\\.cx$)'
.Ed
.Pp
would skip filtering for senders whose host names end
in .benzedrine.cx or whose IP addresses start with 127. or
10.1.
.It Fl P Ar port
Use the specified port to interface
.Xr spamd .
.It Fl p Ar pipe
Use the specified pipe to interface
.Xr meta1 8 .
Default is /var/spool/milter-spamd/sock.
.It Fl t Ar timeout
Use the specified timeout when sending data to spamd.
.It Fl U Ar spamd user
Pass the specified user to spamd, so that user's SpamAssassin
settings are used instead of the system-wide ones (default).
.El
.Pp
.Sh META1 CONFIGURATION
.Xr meta1 8
needs to be compiled with pmilter support.
.Pp
.Sh LOGGING
.Nm
sends log messages to
.Xr syslogd 8
using
.Em facility
daemon and, with increasing verbosity,
.Em level
err, notice, info and debug.
The following
.Xr syslog.conf 5
section can be used to log messages to a dedicated file:
.Bd -literal
!milter-spamd
daemon.err;daemon.notice	/var/log/milter-spamd
.Ed
.Sh SEE ALSO
.Xr egrep 1 ,
.Xr mailstats 1 ,
.Xr regex 3 ,
.Xr syslog.conf 5 ,
.Xr re_format 7 ,
.Xr meta1 8 ,
.Xr syslogd 8
.Rs
.%T Simple Mail Transfer Protocol
.%O RFC 2821
.Re
.Rs
.%T Enhanced Mail System Status Codes
.%O RFC 1893
.Re
.Sh HISTORY
The first version of
.Nm
was written in 2004.
.Sh AUTHORS
Daniel Hartmeier
.Aq daniel@benzedrine.cx