spamass-milter.1.in

   1 .\" $Id: spamass-milter.1.in,v 1.19 2004/03/18 18:37:08 dnelson Exp $
   2 .Dd July 25, 2001
   3 .Os
   4 .Dt SPAMASS_MILTER 8
   5 .Sh NAME
   6 .Nm spamass-milter
   7 .Nd sendmail milter for passing emails through SpamAssassin
   8 .Sh SYNOPSIS
   9 .Nm
  10 .Fl p Ar socket
  11 .Op Fl b Ns | Ns Fl B Ar spamaddress
  12 .Op Fl d Ar debugflags
  13 .Op Fl D Ar host
  14 .Op Fl e Ar defaultdomain
  15 .Op Fl f
  16 .Op Fl i Ar networks
  17 .Op Fl I
  18 .Op Fl m
  19 .Op Fl M
  20 .Op Fl P Ar pidfile
  21 .Op Fl r Ar nn
  22 .Op Fl u Ar defaultuser
  23 .Op Fl x
  24 .Op Fl - Ar spamc flags ...
  25 .Sh DESCRIPTION
  26 The
  27 .Nm
  28 utility is a sendmail milter that checks and modifies incoming email
  29 messages with SpamAssassin.
  30 .Pp
  31 The following options are available:
  32 .Bl -tag -width "indent"
  33 .It Fl p Ar socket
  34 Specifies the pathname of a socket to create for communication with
  35 .Nm sendmail .
  36 If it is removed,
  37 .Nm sendmail
  38 will not be able to access the milter.
  39 This may cause messages to bounce, queue, or be passed through
  40 unmiltered, depending on the parameters in
  41 .Nm sendmail Ns 's .cf file.
  42 .It Fl b Ar spamaddress
  43 Redirects tagged spam to the specified email address.
  44 All envelope recipients are removed, and inserted into the message as
  45 .Ql X-Spam-Orig-To:
  46 headers.
  47 .It Fl B Ar spamaddress
  48 Same as
  49 .Fl b ,
  50 except the original recipients are retained.
  51 Only one of
  52 .Fl b
  53 and
  54 .Fl B
  55 may be used.
  56 .It Fl d Ar debugflags
  57 Enables logging.
  58 .Ar debugflags
  59 is a comma-separated list of tokens:
  60 .Bl -tag -width "indent"
  61 .It func
  62 Entry and exit of internal functions.
  63 .It misc
  64 Other non-verbose logging.
  65 .It net
  66 Lookups of the ignored netblocks list.
  67 .It poll
  68 Low-level I/O to the child spamc process.
  69 .It rcpt
  70 Recipient processing.
  71 .It spamc
  72 High-level I/O to the child spamc process.
  73 .It str
  74 Calls to field lookup and string comparison functions.
  75 .It uori
  76 Calls to the update_or_insert function.
  77 .It 1
  78 (historical) Same as
  79 .Ar func,misc .
  80 .It 2
  81 (historical) Same as
  82 .Ar func,misc,poll .
  83 .It 3
  84 (historical) Same as
  85 .Ar func,misc,poll,str,uori .
  86 .El
  87 .It Fl D Ar host
  88 Connects to a remote spamd server on
  89 .Ar host ,
  90 instead of using one on localhost.
  91 This option is deprecated; use
  92 .Fl - Fl d Ar host
  93 instead.
  94 .It Fl e Ar defaultdomain
  95 Pass the full user@domain address to spamc.
  96 The default is to pass only the username part on the assumption that
  97 all users are local.
  98 This flag is useful if you are using an SQL (or other username) backend
  99 with spamassassin and have listed the full address there.
 100 If the recipient name has no domain part (if the recipient is on the
 101 local machine for example),
 102 .Ar defaultdomain
 103 is added.
 104 Requires the
 105 .Fl u
 106 flag.
 107 .It Fl f
 108 Causes
 109 .Nm
 110 to fork into the background.
 111 .It Fl i Ar networks
 112 Ignores messages if the originating IP is in the network(s) listed.
 113 The message will be passed through without calling SpamAssassin at all.
 114 .Ar networks
 115 is a comma-separated list, where each element can be either an IP address
 116 (nnn.nnn.nnn.nnn), a CIDR network (nnn.nnn.nnn.nnn/nn), or a network/netmask
 117 pair (nnn.nnn.nnn.nnn/nnn.nnn.nnn.nnn).
 118 Multiple
 119 .Fl i
 120 flags will append to the list.
 121 For example, if you list all your internal networks, no outgoing emails
 122 will be filtered.
 123 .It Fl I
 124 Ignores messages if the sender has authenticated via SMTP AUTH.
 125 .It Fl m
 126 Disables modification of the
 127 .Ql Subject:
 128 and
 129 .Ql Content-Type:
 130 headers and
 131 message body.
 132 This is useful when SpamAssassin is configured with
 133 .Ql "defang_mime 0"
 134 and
 135 .Ql "report_header 1" ,
 136 or when SA is simply used to add headers for postprocessing later.
 137 Updating the body through the milter interface can be slow for large
 138 messages.
 139 .It Fl M
 140 Like
 141 .Fl m ,
 142 but also disables creation of any SpamAssassin
 143 .Ql X-Spam-*
 144 headers as well.
 145 Both tagged and untagged mail gets passed through unchanged.
 146 To be useful, this option should be used with the
 147 .Fl r ,
 148 .Fl b ,
 149 or
 150 .Fl B
 151 flags.
 152 If
 153 .Fl b
 154 is used, the
 155 .Ql X-Spam-Orig-To:
 156 headers will still be added.
 157 .It Fl P Ar pidfile
 158 Create the file
 159 .Ar pidfile ,
 160 containing the processid of the milter.
 161 .It Fl r Ar nn
 162 Reject scanned email if it greater than or equal to
 163 .Ar nn .
 164 If
 165 .Ar -1 ,
 166 reject scanned email if SpamAssassin tags it as spam (useful if you
 167 are also using the
 168 .Fl u
 169 flag, and users have changed their required_hits value).
 170 .Pp
 171 For example, if you usually use procmail to redirect tagged email into
 172 a separate folder just in case of false positives, you can use
 173 .Fl r Ar 15
 174 and reject flagrant spam outright while still receiving low-scoring
 175 messages.
 176 .It Fl u Ar defaultuser
 177 Pass the username part of the first recipient to spamc with the
 178 .Fl u
 179 flag.
 180 This allows user preferences files to be used.
 181 If the message is addressed to multiple recipients, the username
 182 .Ar defaultuser
 183 is passed instead.
 184 .Pp
 185 Note that
 186 .Nm
 187 does not know whether an email is incoming or outgoing, so a message
 188 from
 189 .Aq user1@localdomain.com
 190 to
 191 .Aq user2@yahoo.com
 192 will make
 193 .Nm
 194 pass
 195 .Fl u Ar user2
 196 to spamc.
 197 .It Fl x
 198 Pass the recipient address through
 199 .Nm sendmail Fl bv ,
 200 which will perform virtusertable and alias expansion.
 201 The resulting username is then passed to spamc.
 202 Requires the
 203 .Fl u
 204 flag.
 205 .It Fl - Ar spamc flags ...
 206 Pass all remaining options to spamc.
 207 This allows you to connect to a remote spamd with
 208 .Fl d
 209 or
 210 .Fl p .
 211 .El
 212 .Sh FILES
 213 .Bl -tag -width "indent"
 214 .It Pa @SPAMC@
 215 client interface to SpamAssassin
 216 .El
 217 .Sh SEE ALSO
 218 .Xr spamassassin 1 ,
 219 .Xr spamd 1
 220 .Sh AUTHORS
 221 .An "Georg C. F. Greve" Aq greve@gnu.org
 222 .An "Dan Nelson" Aq dnelson@allantgroup.com