|
56
|
1 <body text="#000000" link="#0000ff" bgcolor="#ffffff"><center><table width="80%">
|
|
|
2 <tr><td><h1>masqmail.route</h1>
|
|
|
3 <h2>masqmail route configuration file</h2>
|
|
|
4
|
|
|
5
|
|
|
6 <h2>Description</h2>
|
|
|
7
|
|
|
8 <p>This man page describes the syntax of the route configuration files
|
|
|
9 of <a href="masqmail.8.html">masqmail</a>. Their usual locations are in <em>/etc/masqmail/</em>.</p>
|
|
|
10
|
|
|
11
|
|
|
12
|
|
|
13 <h2>Options</h2>
|
|
|
14
|
|
|
15
|
|
|
16
|
|
|
17 <p><b>protocol</b> = <em>string</em></p>
|
|
|
18
|
|
|
19 <p><em>string</em> can be one of 'smtp' or 'pipe', default is
|
|
|
20 'smtp'. If set to 'smtp', mail will be sent with the SMTP protocol to
|
|
|
21 its destination. If set to 'pipe', you also have to set 'pipe'
|
|
|
22 to a command, the message will then be piped to a program. See option 'pipe' below.</p>
|
|
|
23
|
|
|
24
|
|
|
25
|
|
|
26
|
|
|
27 <p><b>mail_host</b> = <em>string</em></p>
|
|
|
28
|
|
|
29 <p>This is preferably the mail server of your ISP. All outgoing
|
|
|
30 messages will be sent to this host which will distribute them to their
|
|
|
31 destinations. If you do not set this mails will be sent
|
|
|
32 directly. Because the mail server is probably 'near' to you, mail
|
|
|
33 transfer will be much faster if you use it.</p>
|
|
|
34 <p>You can optionally give a port number following the host name
|
|
|
35 and a colon, eg mail_host="mail.foo.com:25".</p>
|
|
|
36
|
|
|
37
|
|
|
38
|
|
|
39
|
|
|
40 <p><b>resolve_list</b> = <em>list</em></p>
|
|
|
41
|
|
|
42 <p>Specify the method how the domain of the server is resolved. Possible values are
|
|
|
43 dns_mx, dns_a, byname. For 'dns_mx', the domain is assumed to be an MX
|
|
|
44 pointer to a list of host names, these will be tried each in order
|
|
|
45 (lowest preference value first, equal preference values in random
|
|
|
46 order). For 'dns_a', the domain is assumed to be an A pointer. For
|
|
|
47 'byname', the library function <b>gethostbyname (3)</b> will be used.</p>
|
|
|
48 <p>The default is "dns_mx;dns_a;byname".</p>
|
|
|
49
|
|
|
50
|
|
|
51
|
|
|
52
|
|
|
53 <p><b>connect_error_fail</b> = <em>boolean</em></p>
|
|
|
54
|
|
|
55 <p>If this is set, a connection error will cause a mail delivery to
|
|
|
56 fail, ie. it will be bounced. If it is unset, it will just be defered.</p>
|
|
|
57 <p>Default is false. The reason for this is that masqmail is designed
|
|
|
58 for non permanent internet connections, where such errors may occur
|
|
|
59 quite often, and a bounce would be annoying.</p>
|
|
|
60 <p>For the default local_net route is is set to true.</p>
|
|
|
61
|
|
|
62
|
|
|
63
|
|
|
64
|
|
|
65 <p><b>helo_name</b> = <em>string</em></p>
|
|
|
66
|
|
|
67 <p>Set the name given with the HELO/EHLO command. If this is not
|
|
|
68 set, <b>host_name</b> from <em>masqmail.conf</em> will be used, if
|
|
|
69 the <b>do_correct_helo</b> option (see below) is unset.</p>
|
|
|
70
|
|
|
71
|
|
|
72
|
|
|
73
|
|
|
74 <p><b>do_correct_helo</b> = <em>boolean</em></p>
|
|
|
75
|
|
|
76 <p>If this is set, masqmail tries to look up your host name as it
|
|
|
77 appears on the internet and sends this in the HELO/EHLO command. Some
|
|
|
78 servers are so picky that they want this. Which is really
|
|
|
79 crazy. It just does not make any sense to lie about ones own identity,
|
|
|
80 because it can always be looked up by the server. Nobody should
|
|
|
81 believe in the name given by HELO/EHLO anyway. If this is not
|
|
|
82 set, <b>host_name</b> from <em>masqmail.conf</em> or as given with
|
|
|
83 the <b>helo_name</b> (see above) will be used.</p>
|
|
|
84
|
|
|
85
|
|
|
86
|
|
|
87
|
|
|
88 <p><b>do_pipelining</b> = <em>boolean</em></p>
|
|
|
89
|
|
|
90 <p>If this is set to false, masqmail will not use ESMTP PIPELINING, even
|
|
|
91 if the server announces that it is able to cope with it. Default is true.</p>
|
|
|
92 <p>You do not want to set this to false unless the mail setup on the
|
|
|
93 remote server side is really broken. Keywords: wingate.</p>
|
|
|
94
|
|
|
95
|
|
|
96
|
|
|
97
|
|
|
98 <p><b>allowed_mail_locals</b> = <em>list</em></p>
|
|
|
99
|
|
|
100 <p>This is a semicolon ';' separated list of local parts which will be
|
|
|
101 allowed to send mail through this connection. If unset
|
|
|
102 and <b>not_allowed_mail_locals</b> is also unset, all users are
|
|
|
103 allowed.</p>
|
|
|
104
|
|
|
105
|
|
|
106
|
|
|
107
|
|
|
108 <p><b>not_allowed_mail_locals</b> = <em>list</em></p>
|
|
|
109
|
|
|
110 <p>This is a semicolon ';' separated list of local parts which will be
|
|
|
111 not allowed to send mail through this connection. Local
|
|
|
112 parts in this list will not be allowed to use this route even if they
|
|
|
113 are part of <b>allowed_mail_locals</b> (see above).</p>
|
|
|
114
|
|
|
115
|
|
|
116
|
|
|
117
|
|
|
118 <p><b>allowed_return_paths</b> = <em>list</em></p>
|
|
|
119
|
|
|
120 <p>This is a semicolon ';' separated list of addresses. Messages which
|
|
|
121 have one one of these addresses as the return path will be used using
|
|
|
122 this route (if not also in <b>not_allowed_return_paths</b> or an item
|
|
|
123 in <b>not_allowed_mail_locals</b> matches).</p>
|
|
|
124 <p>Patterns containing '?' and '*' can be used. The special item "<>" matches
|
|
|
125 the null sender address (eg. failure notices or delivery notifications).</p>
|
|
|
126
|
|
|
127
|
|
|
128
|
|
|
129
|
|
|
130 <p><b>not_allowed_return_paths</b> = <em>list</em></p>
|
|
|
131
|
|
|
132 <p>This is a semicolon ';' separated list of addresses. Messages which
|
|
|
133 have one one of these addresses as the return path will not be used using
|
|
|
134 this route (even if also in <b>allowed_return_paths</b> or an item
|
|
|
135 in <b>allowed_mail_locals</b> matches).</p>
|
|
|
136 <p>Patterns containing '?' and '*' can be used. The special item "<>" matches
|
|
|
137 the null sender address (eg. failure notices or delivery notifications).</p>
|
|
|
138
|
|
|
139
|
|
|
140
|
|
|
141
|
|
|
142 <p><b>allowed_rcpt_domains</b> = <em>list</em></p>
|
|
|
143
|
|
|
144 <p>A list of recipient domains where mail will be sent to. This is for
|
|
|
145 example useful if you use this route configuration when connected to
|
|
|
146 another LAN via ppp. Patterns containing '?' and '*' can be used.</p>
|
|
|
147
|
|
|
148
|
|
|
149
|
|
|
150
|
|
|
151 <p><b>not_allowed_rcpt_domains</b> = <em>list</em></p>
|
|
|
152
|
|
|
153 <p>A list of recipient domains where mail will not be sent
|
|
|
154 to. This is for example useful if you send mail directly (<b>mail_host</b> is
|
|
|
155 not set) and you know of hosts that will not accept mail from you
|
|
|
156 because they use a dialup list (eg. <a href = "http://maps.vix.com/dul/">http://maps.vix.com/dul/</a>. If any domain
|
|
|
157 matches both <b>allowed_rcpt_domains</b> and <b>not_allowed_rcpt_domains</b>,
|
|
|
158 mail will not be sent to this domain. Patterns containing '?' and '*' can be used.</p>
|
|
|
159
|
|
|
160
|
|
|
161
|
|
|
162
|
|
|
163 <p><b>set_h_from_domain</b> = <em>string</em></p>
|
|
|
164
|
|
|
165 <p>Replace the domain part in 'From:' headers with this value. This
|
|
|
166 may be useful if you use a private, outside unknown address on your
|
|
|
167 local LAN and want this to be replaced by the domain of the address of
|
|
|
168 your email addrsss on the internet. Note that this is different to <b>
|
|
|
169 set_return_path_domain</b>, see below.</p>
|
|
|
170
|
|
|
171
|
|
|
172
|
|
|
173
|
|
|
174 <p><b>set_return_path_domain</b> = <em>string</em></p>
|
|
|
175
|
|
|
176 <p>Sets the domain part of the envelope from address. Some hosts check
|
|
|
177 whether this is the same as the net the connection is coming from. If
|
|
|
178 not, they reject the mail because they suspect spamming. It should be
|
|
|
179 a valid address, because some mail servers also check
|
|
|
180 that. You can also use this to set it to your usual address on the
|
|
|
181 internet and put a local address only known on your LAN in the
|
|
|
182 configuration of your mailer. Only the domain part will
|
|
|
183 be changed, the local part remains unchanged. Use <b>
|
|
|
184 map_return_path_addresses</b> for rewriting local parts.</p>
|
|
|
185
|
|
|
186
|
|
|
187
|
|
|
188
|
|
|
189 <p><b>map_h_from_addresses</b> = <em>list</em></p>
|
|
|
190
|
|
|
191 <p>This is similar to <b>set_h_from_domain</b>, but more flexible. Set
|
|
|
192 this to a list which maps local parts to a full RFC 822 compliant
|
|
|
193 email address, the local parts (the keys) are separated from
|
|
|
194 the addresses (the values) by colons (':').</p>
|
|
|
195
|
|
|
196 <p>Example:</p>
|
|
|
197
|
|
|
198 <p>map_h_from_addresses = "john: John Smith <jsmith@mail.academic.edu>;
|
|
|
199 charlie: Charlie Miller <cmiller@mx.commercial.com>"</p>
|
|
|
200 <p>You can use patterns, eg. * as keys.</p>
|
|
|
201
|
|
|
202
|
|
|
203
|
|
|
204
|
|
|
205 <p><b>map_h_reply_to_addresses</b> = <em>list</em></p>
|
|
|
206
|
|
|
207 <p>Same as <b>map_h_from_addresses</b>, but for the 'Reply-To:' header.</p>
|
|
|
208
|
|
|
209
|
|
|
210
|
|
|
211
|
|
|
212 <p><b>map_h_mail_followup_to_addresses</b> = <em>list</em></p>
|
|
|
213
|
|
|
214 <p>Same as <b>map_h_from_addresses</b>, but for the 'Mail-Followup-To:'
|
|
|
215 header. Useful when replying to mailing lists.</p>
|
|
|
216
|
|
|
217
|
|
|
218
|
|
|
219
|
|
|
220 <p><b>map_return_path_addresses</b> = <em>list</em></p>
|
|
|
221
|
|
|
222 <p>This is similar to <b>set_return_path_domain</b>, but more
|
|
|
223 flexible. Set this to a list which maps local parts to a full RFC 821
|
|
|
224 compliant email address, the local parts (the keys) are
|
|
|
225 separated from the addresses (the values) by colons
|
|
|
226 (':'). Note that this option takes RFC 821 addresses
|
|
|
227 while <b>map_h_from_addresses</b> takes RFC 822 addresses. The
|
|
|
228 most important difference is that RFC 821 addresses have no full
|
|
|
229 name.</p>
|
|
|
230
|
|
|
231 <p>Example:</p>
|
|
|
232 <p>
|
|
|
233 map_return_path_addresses =
|
|
|
234 "john: <jsmith@mail.academic.edu>;
|
|
|
235 charlie: <cmiller@mx.commercial.com>"
|
|
|
236 </p>
|
|
|
237 <p>You can use patterns, eg. * as keys.</p>
|
|
|
238
|
|
|
239
|
|
|
240
|
|
|
241
|
|
|
242 <p><b>expand_h_sender_address</b> = <em>boolean</em></p>
|
|
|
243
|
|
|
244 <p>This sets the domain of the sender address as given by the Sender:
|
|
|
245 header to the same address as in the envelope return path address
|
|
|
246 (which can be set by either <b>set_return_path_domain</b> or <b>map_return_path_addresses</b>).
|
|
|
247 This is for mail clients (eg. Microsoft Outlook) which use this address as the sender
|
|
|
248 address. Though they should use the From: address, see RFC
|
|
|
249 821. If <a href="http://www.fetchmail.org">fetchmail</a> encounters an unqualified Sender:
|
|
|
250 address, it will be expanded to the domain of the pop server, which is
|
|
|
251 almost never correct. Default is true.</p>
|
|
|
252
|
|
|
253
|
|
|
254
|
|
|
255
|
|
|
256 <p><b>expand_h_sender_domain</b> = <em>boolean</em></p>
|
|
|
257
|
|
|
258 <p>Like <b>expand_h_sender_address</b>, but sets the domain only.
|
|
|
259 Deprecated, will be removed in a later version.</p>
|
|
|
260
|
|
|
261
|
|
|
262
|
|
|
263
|
|
|
264 <p><b>last_route</b> = <em>boolean</em></p>
|
|
|
265
|
|
|
266 <p>If this is set, a mail which would have been delivered using this
|
|
|
267 route, but has failed temporarily, will not be tried to be delivered
|
|
|
268 using the next route.</p>
|
|
|
269 <p>If you have set up a special route with filters using the lists
|
|
|
270 'allowed_rcpt_domains', 'allowed_return_paths', and
|
|
|
271 'allowed_mail_locals' or their complements (not_), and the mail
|
|
|
272 passing these rules should be delivered using this route only, you
|
|
|
273 should set this to 'true'. Otherwise the mail would be passed to the
|
|
|
274 next route (if any), unless that route has rules which prevent
|
|
|
275 that.</p>
|
|
|
276 <p>Default is false.</p>
|
|
|
277
|
|
|
278
|
|
|
279
|
|
|
280
|
|
|
281 <p><b>auth_name</b> = <em>string</em></p>
|
|
|
282
|
|
|
283 <p>Set the authentication type for ESMTP AUTH authentification.
|
|
|
284 Currently only 'cram-md5' and 'login' are supported.</p>
|
|
|
285
|
|
|
286
|
|
|
287
|
|
|
288
|
|
|
289 <p><b>auth_login</b> = <em>string</em></p>
|
|
|
290
|
|
|
291 <p>Your account name for ESMTP AUTH authentification.</p>
|
|
|
292
|
|
|
293
|
|
|
294
|
|
|
295
|
|
|
296 <p><b>auth_secret</b> = <em>string</em></p>
|
|
|
297
|
|
|
298 <p>Your secret for ESMTP AUTH authentification.</p>
|
|
|
299
|
|
|
300
|
|
|
301
|
|
|
302
|
|
|
303 <p><b>pop3_login</b> = <em>file</em></p>
|
|
|
304
|
|
|
305 <p>If your Mail server requires SMTP-after-POP, set this to a
|
|
|
306 get configuration (see <a href="masqmail.get.5.html">masqmail.get</a>).
|
|
|
307 If you login to the POP server
|
|
|
308 before you send, this is not necessary.</p>
|
|
|
309
|
|
|
310
|
|
|
311
|
|
|
312
|
|
|
313 <p><b>wrapper</b> = <em>command</em></p>
|
|
|
314
|
|
|
315 <p>If set, instead of opening a connection to a remote server, <em>command</em> will
|
|
|
316 be called and all traffic will be piped to its
|
|
|
317 stdin and from its stdout. Purpose is to tunnel ip traffic, eg. for ssl.</p>
|
|
|
318 <p>Example for ssl tunneling:</p>
|
|
|
319 <p>wrapper="/usr/bin/openssl s_client -quiet -connect pop.gmx.net:995 2>/dev/null"</p>
|
|
|
320
|
|
|
321
|
|
|
322
|
|
|
323
|
|
|
324 <p><b>pipe</b> = <em>command</em></p>
|
|
|
325
|
|
|
326 <p>If set, and protocol is set to 'pipe', <em>command</em> will be
|
|
|
327 called and the message will be piped to its stdin. Purpose is to use
|
|
|
328 gateways to uucp, fax, sms or whatever else.</p>
|
|
|
329 <p>You can use variables to give as arguments to the command, these
|
|
|
330 are the same as for the mda in the main configuration, see <a href="masqmail.conf.5.html">masqmail.conf</a>.</p>
|
|
|
331
|
|
|
332
|
|
|
333
|
|
|
334
|
|
|
335 <p><b>pipe_fromline = <em>boolean</em></b></p>
|
|
|
336
|
|
|
337 <p>If this is set, and protocol is set to 'pipe', a from line will be prepended to the output stream whenever
|
|
|
338 a pipe command is called. Default is false.</p>
|
|
|
339
|
|
|
340
|
|
|
341
|
|
|
342
|
|
|
343 <p><b>pipe_fromhack = <em>boolean</em></b></p>
|
|
|
344
|
|
|
345 <p>If this is set, and protocol is set to 'pipe', each line beginning with 'From '
|
|
|
346 is replaced with '>From ' whenever a pipe command is called. You probably want this if you have
|
|
|
347 set <b>pipe_fromline</b> above. Default is false.</p>
|
|
|
348
|
|
|
349
|
|
|
350
|
|
|
351
|
|
|
352
|
|
|
353 <h2>Author</h2>
|
|
|
354
|
|
|
355 <p>masqmail was written by Oliver Kurth
|
|
|
356 <oku@masqmail.cx></p><p>You will find the newest version of
|
|
|
357 masqmail at <a href = "http://masqmail.cx/masqmail/">http://masqmail.cx/masqmail/</a> or search for it
|
|
|
358 in freshmeat (<a href = "http://www.freshmeat.net">http://www.freshmeat.net</a>). There is also a mailing list,
|
|
|
359 you will find information about it at masqmails main site.</p>
|
|
|
360
|
|
|
361
|
|
|
362
|
|
|
363 <h2>Bugs</h2>
|
|
|
364
|
|
|
365 <p>You should report them to the mailing list.</p>
|
|
|
366
|
|
|
367
|
|
|
368
|
|
|
369 <h2>See also</h2>
|
|
|
370
|
|
|
371 <p>
|
|
|
372 <a href="masqmail.8.html">masqmail</a>, <a href="masqmail.conf.5.html">masqmail.conf</a>, <a href="masqmail.get.5.html">masqmail.get</a>
|
|
|
373 </p>
|
|
|
374
|
|
|
375
|
|
|
376
|
|
|
377 <h2>Comments</h2>
|
|
|
378
|
|
|
379 <p>This man page was written using <a href="http://masqmail.cx/xml2man/">xml2man</a> by the same
|
|
|
380 author.</p>
|
|
|
381
|
|
|
382
|
|
|
383
|
|
|
384 </td></tr></table></center>
|
|
|
385 </body>
|
