Mercurial > masqmail

comparison man/masqmail.route.5 @ 316:d596ac8b5afb

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
heavy restructuring of masqmail.route(5) (sections)
author meillo@marmaro.de
date Mon, 25 Apr 2011 15:17:30 +0200
parents e230bcd0f1c6
children 55b7bde95d37
comparison
equal deleted inserted replaced
315:c98aa884d2cb 316:d596ac8b5afb
10 Their usual locations are in \fI/etc/masqmail/\fR. 10 Their usual locations are in \fI/etc/masqmail/\fR.
11 11
12 Mail will be sent with the SMTP protocol to its destination, unless 12 Mail will be sent with the SMTP protocol to its destination, unless
13 `pipe' is given. 13 `pipe' is given.
14 In this case the message will be piped to the given program. 14 In this case the message will be piped to the given program.
15 See option `pipe' below. 15
16 16
17 17 .SH ROUTE CONDITIONS
18 .SH OPTIONS 18
19 .TP
20 \fBallowed_mail_locals\fR = \fIlist\fR
21
22 This is a semicolon `;' separated list of local parts of envelope
23 senders (= mail from = return path) which will be allowed
24 to send mail through this connection.
25 If unset and \fBnot_allowed_mail_locals\fR is also unset, all users are allowed.
26
27 .TP
28 \fBnot_allowed_mail_locals\fR = \fIlist\fR
29
30 This is a semicolon `;' separated list of local parts of envelope
31 senders (= mail from = return path) which will be not allowed
32 to send mail through this connection.
33 Local parts in this list will not be allowed to use this route even if they
34 are part of \fBallowed_mail_locals\fR (see above).
35
36 .TP
37 \fBallowed_return_paths\fR = \fIlist\fR
38
39 This is a semicolon `;' separated list of addresses.
40 Messages which have one of these addresses as the return path (=
41 envelope sender = mail from) will be used using this route
42 (if not also in \fBnot_allowed_return_paths\fR or an item in \fBnot_allowed_mail_locals\fR matches).
43
44 Patterns containing `?' and `*' can be used.
45 The special item "<>" matches the null sender address (eg. failure notices or delivery notifications).
46
47 .TP
48 \fBnot_allowed_return_paths\fR = \fIlist\fR
49
50 This is a semicolon `;' separated list of addresses.
51 Messages which have one of these addresses as the return path (=
52 envelope sender = mail from) will not
53 be used using this route (even if also in \fBallowed_return_paths\fR
54 or an item in \fBallowed_mail_locals\fR matches).
55
56 Patterns containing `?' and `*' can be used.
57 The special item "<>" matches the null sender address (eg. failure notices or delivery notifications).
58
59 .TP
60 \fBallowed_rcpt_domains\fR = \fIlist\fR
61
62 A list of recipient domains (of envelope recipients) where mail will be sent to.
63 This is for example useful if you use this route configuration when connected to another LAN via ppp.
64 Patterns containing `?' and `*' can be used.
65
66 .TP
67 \fBnot_allowed_rcpt_domains\fR = \fIlist\fR
68
69 A list of recipient domains (of envelope recipients) where mail will not be sent to.
70 This is for example useful if you send mail directly (\fBmail_host\fR is not set)
71 and you know of hosts that will not accept mail from you because they use a dialup list
72 (eg. \fBhttp://maps.vix.com/dul/\fR).
73 If any domain matches both \fBallowed_rcpt_domains\fR and \fBnot_allowed_rcpt_domains\fR,
74 mail will not be sent to this domain.
75 Patterns containing `?' and `*' can be used.
76
77 .TP
78 \fBlast_route\fR = \fIboolean\fR
79
80 If this is set, a mail which would have been delivered using this route,
81 but has failed temporarily, will not be tried to be delivered using the next route.
82
83 If you have set up a special route with filters using the lists `allowed_rcpt_domains',
84 `allowed_return_paths', and `allowed_mail_locals' or their complements (not_),
85 and the mail passing these rules should be delivered using this route only,
86 you should set this to `true'.
87 Otherwise the mail would be passed to the next route (if any),
88 unless that route has rules which prevent that.
89
90 Default is false.
91
92
93 .SH SMTP CONFIGURATION
19 94
20 .TP 95 .TP
21 \fBmail_host\fR = \fIstring\fR 96 \fBmail_host\fR = \fIstring\fR
22 97
23 This is preferably the mail server of your ISP. 98 This is preferably the mail server of your ISP.
85 Please don't rely on that and keep in mind that RFC 2821 says that the client 160 Please don't rely on that and keep in mind that RFC 2821 says that the client
86 SHOULD wait for the 220 greeting of the server. 161 SHOULD wait for the 220 greeting of the server.
87 162
88 Default: false 163 Default: false
89 164
90
91 .TP 165 .TP
92 \fBdo_pipelining\fR = \fIboolean\fR 166 \fBdo_pipelining\fR = \fIboolean\fR
93 167
94 If this is set to false, masqmail will not use ESMTP PIPELINING, 168 If this is set to false, masqmail will not use ESMTP PIPELINING,
95 even if the server announces that it is able to cope with it. 169 even if the server announces that it is able to cope with it.
97 171
98 You do not want to set this to false unless the mail setup on the 172 You do not want to set this to false unless the mail setup on the
99 remote server side is really broken. 173 remote server side is really broken.
100 Keywords: wingate. 174 Keywords: wingate.
101 175
102 .TP 176
103 \fBallowed_mail_locals\fR = \fIlist\fR 177 .TP
104 178 \fBauth_name\fR = \fIstring\fR
105 This is a semicolon `;' separated list of local parts which will be allowed 179
106 to send mail through this connection. 180 Set the authentication type for ESMTP AUTH authentication.
107 If unset and \fBnot_allowed_mail_locals\fR is also unset, all users are allowed. 181 Currently only `cram-md5' and `login' are supported.
108 182
109 .TP 183 .TP
110 \fBnot_allowed_mail_locals\fR = \fIlist\fR 184 \fBauth_login\fR = \fIstring\fR
111 185
112 This is a semicolon `;' separated list of local parts which will be not allowed 186 Your account name for ESMTP AUTH authentication.
113 to send mail through this connection. 187
114 Local parts in this list will not be allowed to use this route even if they 188 .TP
115 are part of \fBallowed_mail_locals\fR (see above). 189 \fBauth_secret\fR = \fIstring\fR
116 190
117 .TP 191 Your secret for ESMTP AUTH authentication.
118 \fBallowed_return_paths\fR = \fIlist\fR 192
119 193 .TP
120 This is a semicolon `;' separated list of addresses. 194 \fBwrapper\fR = \fIcommand\fR
121 Messages which have one of these addresses as the return path will be used using this route 195
122 (if not also in \fBnot_allowed_return_paths\fR or an item in \fBnot_allowed_mail_locals\fR matches). 196 If set, instead of opening a connection to a remote server,
123 197 \fIcommand\fR will be called and all traffic will be piped to its stdin and from its stdout.
124 Patterns containing `?' and `*' can be used. 198 Purpose is to tunnel ip traffic, eg. for ssl.
125 The special item "<>" matches the null sender address (eg. failure notices or delivery notifications). 199
126 200 Example for SMTP over SSL tunneling:
127 .TP 201 .nf
128 \fBnot_allowed_return_paths\fR = \fIlist\fR 202 wrapper="/usr/bin/openssl s_client \-quiet \-connect mail.gmx.net:465 2>/dev/null"
129 203 .fi
130 This is a semicolon `;' separated list of addresses. 204
131 Messages which have one of these addresses as the return path will not 205 SMTP over SSL is supported since masqmail-0.1.8.
132 be used using this route (even if also in \fBallowed_return_paths\fR 206 It is marked obsolete by the IETF but is still in use.
133 or an item in \fBallowed_mail_locals\fR matches). 207
134 208
135 Patterns containing `?' and `*' can be used. 209 Example for encryption with STARTTLS (RFC-3207):
136 The special item "<>" matches the null sender address (eg. failure notices or delivery notifications). 210 .nf
137 211 # don't forget the instant_helo, otherwise it won't work
138 .TP 212 instant_helo=true
139 \fBallowed_rcpt_domains\fR = \fIlist\fR 213 wrapper="/usr/bin/openssl s_client \-quiet \-starttls smtp \-connect mail.gmx.net:25 2>/dev/null"
140 214 .fi
141 A list of recipient domains where mail will be sent to. 215
142 This is for example useful if you use this route configuration when connected to another LAN via ppp. 216 This is supported since masqmail-0.2.28.
143 Patterns containing `?' and `*' can be used. 217 STARTTLS supersedes SMTP over SSL.
144 218
145 .TP 219 Note for openssl:
146 \fBnot_allowed_rcpt_domains\fR = \fIlist\fR 220 Ensure that stderr is redirected.
147 221 Do *not* use \-crlf in the wrapper command, because masqmail does already insert CRLF.
148 A list of recipient domains where mail will not be sent to. 222 However, you might want to specify \-crlf if you want to test your wrapper command
149 This is for example useful if you send mail directly (\fBmail_host\fR is not set) 223 interactively on the command line.
150 and you know of hosts that will not accept mail from you because they use a dialup list 224
151 (eg. \fBhttp://maps.vix.com/dul/\fR). 225
152 If any domain matches both \fBallowed_rcpt_domains\fR and \fBnot_allowed_rcpt_domains\fR, 226 .SH PIPE CONFIGURATION
153 mail will not be sent to this domain. 227
154 Patterns containing `?' and `*' can be used. 228 .TP
229 \fBpipe\fR = \fIcommand\fR
230
231 \fIcommand\fR will be called and the message will be piped to its stdin.
232 Purpose is to use gateways to uucp, fax, sms or whatever else.
233
234 You can use variables to give as arguments to the command,
235 these are the same as for the mda in the main configuration, see \fBmasqmail.conf(5)\fR.
236
237 .TP
238 \fBpipe_fromline = \fIboolean\fR
239
240 Only if `pipe' is used.
241 A from line will be prepended to the output stream whenever a pipe command is called.
242 Default is false.
243
244 .TP
245 \fBpipe_fromhack = \fIboolean\fR
246
247 Only if `pipe' is used.
248 Each line beginning with `From ' is replaced with `>From ' whenever a pipe command is called.
249 You probably want this if you have set \fBpipe_fromline\fR above.
250 Default is false.
251
252
253 .SH ADDRESS REWRITE RULES
155 254
156 .TP 255 .TP
157 \fBset_h_from_domain\fR = \fIstring\fR 256 \fBset_h_from_domain\fR = \fIstring\fR
158 257
159 Replace the domain part in `From:' headers with this value. 258 Replace the domain part in `From:' headers with this value.
235 \fBexpand_h_sender_domain\fR = \fIboolean\fR 334 \fBexpand_h_sender_domain\fR = \fIboolean\fR
236 335
237 Like \fBexpand_h_sender_address\fR, but sets the domain only. 336 Like \fBexpand_h_sender_address\fR, but sets the domain only.
238 Deprecated, will be removed in a later version. 337 Deprecated, will be removed in a later version.
239 338
240 .TP
241 \fBlast_route\fR = \fIboolean\fR
242
243 If this is set, a mail which would have been delivered using this route,
244 but has failed temporarily, will not be tried to be delivered using the next route.
245
246 If you have set up a special route with filters using the lists `allowed_rcpt_domains',
247 `allowed_return_paths', and `allowed_mail_locals' or their complements (not_),
248 and the mail passing these rules should be delivered using this route only,
249 you should set this to `true'.
250 Otherwise the mail would be passed to the next route (if any),
251 unless that route has rules which prevent that.
252
253 Default is false.
254
255 .TP
256 \fBauth_name\fR = \fIstring\fR
257
258 Set the authentication type for ESMTP AUTH authentication.
259 Currently only `cram-md5' and `login' are supported.
260
261 .TP
262 \fBauth_login\fR = \fIstring\fR
263
264 Your account name for ESMTP AUTH authentication.
265
266 .TP
267 \fBauth_secret\fR = \fIstring\fR
268
269 Your secret for ESMTP AUTH authentication.
270
271 .TP
272 \fBwrapper\fR = \fIcommand\fR
273
274 If set, instead of opening a connection to a remote server,
275 \fIcommand\fR will be called and all traffic will be piped to its stdin and from its stdout.
276 Purpose is to tunnel ip traffic, eg. for ssl.
277
278 Example for SMTP over SSL tunneling:
279 .nf
280 wrapper="/usr/bin/openssl s_client \-quiet \-connect mail.gmx.net:465 2>/dev/null"
281 .fi
282
283 SMTP over SSL is supported since masqmail-0.1.8.
284 It is marked obsolete by the IETF but is still in use.
285
286
287 Example for encryption with STARTTLS (RFC-3207):
288 .nf
289 # don't forget the instant_helo, otherwise it won't work
290 instant_helo=true
291 wrapper="/usr/bin/openssl s_client \-quiet \-starttls smtp \-connect mail.gmx.net:25 2>/dev/null"
292 .fi
293
294 This is supported since masqmail-0.2.28.
295 STARTTLS supersedes SMTP over SSL.
296
297 Note for openssl:
298 Ensure that stderr is redirected.
299 Do *not* use \-crlf in the wrapper command, because masqmail does already insert CRLF.
300 However, you might want to specify \-crlf if you want to test your wrapper command
301 interactively on the command line.
302
303 .TP
304 \fBpipe\fR = \fIcommand\fR
305
306 \fIcommand\fR will be called and the message will be piped to its stdin.
307 Purpose is to use gateways to uucp, fax, sms or whatever else.
308
309 You can use variables to give as arguments to the command,
310 these are the same as for the mda in the main configuration, see \fBmasqmail.conf(5)\fR.
311
312 .TP
313 \fBpipe_fromline = \fIboolean\fR
314
315 Only if `pipe' is used.
316 A from line will be prepended to the output stream whenever a pipe command is called.
317 Default is false.
318
319 .TP
320 \fBpipe_fromhack = \fIboolean\fR
321
322 Only if `pipe' is used.
323 Each line beginning with `From ' is replaced with `>From ' whenever a pipe command is called.
324 You probably want this if you have set \fBpipe_fromline\fR above.
325 Default is false.
326
327 339
328 .SH AUTHOR 340 .SH AUTHOR
329 341
330 Masqmail was written by Oliver Kurth. 342 Masqmail was written by Oliver Kurth.
331 It is now maintained by Markus Schnalke <meillo@marmaro.de>. 343 It is now maintained by Markus Schnalke <meillo@marmaro.de>.