Mercurial > masqmail
annotate man/masqmail.route.5 @ 434:f2a7271746d1 default tip
Removes Freshmeat.net from the docs
The site, which was later renamed to freecode.com, is no longer
maintained (contains only a static copy).
author | markus schnalke <meillo@marmaro.de> |
---|---|
date | Sat, 07 Feb 2015 11:45:07 +0100 |
parents | 34c919a8d74e |
children |
rev | line source |
---|---|
431
34c919a8d74e
Bumps version number and updates Changelog and NEWS
markus schnalke <meillo@marmaro.de>
parents:
429
diff
changeset
|
1 .TH masqmail.route 5 2015-02-07 masqmail-0.3.5 "File Formats" |
34 | 2 |
0 | 3 .SH NAME |
4 masqmail.route \- masqmail route configuration file | |
34 | 5 |
6 | |
0 | 7 .SH DESCRIPTION |
8 | |
34 | 9 This man page describes the syntax of the route configuration files of \fBmasqmail (8)\fR. |
10 Their usual locations are in \fI/etc/masqmail/\fR. | |
0 | 11 |
311
e230bcd0f1c6
removed protocol option from route config
meillo@marmaro.de
parents:
291
diff
changeset
|
12 Mail will be sent with the SMTP protocol to its destination, unless |
e230bcd0f1c6
removed protocol option from route config
meillo@marmaro.de
parents:
291
diff
changeset
|
13 `pipe' is given. |
e230bcd0f1c6
removed protocol option from route config
meillo@marmaro.de
parents:
291
diff
changeset
|
14 In this case the message will be piped to the given program. |
0 | 15 |
311
e230bcd0f1c6
removed protocol option from route config
meillo@marmaro.de
parents:
291
diff
changeset
|
16 |
316
d596ac8b5afb
heavy restructuring of masqmail.route(5) (sections)
meillo@marmaro.de
parents:
311
diff
changeset
|
17 .SH ROUTE CONDITIONS |
d596ac8b5afb
heavy restructuring of masqmail.route(5) (sections)
meillo@marmaro.de
parents:
311
diff
changeset
|
18 |
d596ac8b5afb
heavy restructuring of masqmail.route(5) (sections)
meillo@marmaro.de
parents:
311
diff
changeset
|
19 .TP |
317
55b7bde95d37
reworked allowed and denied addrs for routes
meillo@marmaro.de
parents:
316
diff
changeset
|
20 \fBallowed_senders\fR = \fIlist\fR |
316
d596ac8b5afb
heavy restructuring of masqmail.route(5) (sections)
meillo@marmaro.de
parents:
311
diff
changeset
|
21 |
317
55b7bde95d37
reworked allowed and denied addrs for routes
meillo@marmaro.de
parents:
316
diff
changeset
|
22 This is a semicolon `;' separated list of envelope sender addresses. |
55b7bde95d37
reworked allowed and denied addrs for routes
meillo@marmaro.de
parents:
316
diff
changeset
|
23 Messages which have one of these addresses as the return path (= mail |
55b7bde95d37
reworked allowed and denied addrs for routes
meillo@marmaro.de
parents:
316
diff
changeset
|
24 from) are allowed to use this route |
55b7bde95d37
reworked allowed and denied addrs for routes
meillo@marmaro.de
parents:
316
diff
changeset
|
25 (if not also in \fBdenied_senders\fR). |
316
d596ac8b5afb
heavy restructuring of masqmail.route(5) (sections)
meillo@marmaro.de
parents:
311
diff
changeset
|
26 |
317
55b7bde95d37
reworked allowed and denied addrs for routes
meillo@marmaro.de
parents:
316
diff
changeset
|
27 Glob patterns containing `?' and `*' can be used. |
55b7bde95d37
reworked allowed and denied addrs for routes
meillo@marmaro.de
parents:
316
diff
changeset
|
28 The special item "<>" matches the null sender address |
55b7bde95d37
reworked allowed and denied addrs for routes
meillo@marmaro.de
parents:
316
diff
changeset
|
29 (eg. failure notices or delivery notifications). |
55b7bde95d37
reworked allowed and denied addrs for routes
meillo@marmaro.de
parents:
316
diff
changeset
|
30 If the pattern doesn't contain an `@', it is seen as a pattern for the |
55b7bde95d37
reworked allowed and denied addrs for routes
meillo@marmaro.de
parents:
316
diff
changeset
|
31 local part only. |
316
d596ac8b5afb
heavy restructuring of masqmail.route(5) (sections)
meillo@marmaro.de
parents:
311
diff
changeset
|
32 |
317
55b7bde95d37
reworked allowed and denied addrs for routes
meillo@marmaro.de
parents:
316
diff
changeset
|
33 Example: \fImeillo;*@*example.org;web*@example.com\fP |
55b7bde95d37
reworked allowed and denied addrs for routes
meillo@marmaro.de
parents:
316
diff
changeset
|
34 |
55b7bde95d37
reworked allowed and denied addrs for routes
meillo@marmaro.de
parents:
316
diff
changeset
|
35 (``meillo'' equals ``meillo@*'', i.e. the local part.) |
316
d596ac8b5afb
heavy restructuring of masqmail.route(5) (sections)
meillo@marmaro.de
parents:
311
diff
changeset
|
36 |
d596ac8b5afb
heavy restructuring of masqmail.route(5) (sections)
meillo@marmaro.de
parents:
311
diff
changeset
|
37 .TP |
317
55b7bde95d37
reworked allowed and denied addrs for routes
meillo@marmaro.de
parents:
316
diff
changeset
|
38 \fBdenied_senders\fR = \fIlist\fR |
316
d596ac8b5afb
heavy restructuring of masqmail.route(5) (sections)
meillo@marmaro.de
parents:
311
diff
changeset
|
39 |
317
55b7bde95d37
reworked allowed and denied addrs for routes
meillo@marmaro.de
parents:
316
diff
changeset
|
40 This is a semicolon `;' separated list of envelope sender addresses. |
316
d596ac8b5afb
heavy restructuring of masqmail.route(5) (sections)
meillo@marmaro.de
parents:
311
diff
changeset
|
41 Messages which have one of these addresses as the return path (= |
317
55b7bde95d37
reworked allowed and denied addrs for routes
meillo@marmaro.de
parents:
316
diff
changeset
|
42 mail from) will not |
55b7bde95d37
reworked allowed and denied addrs for routes
meillo@marmaro.de
parents:
316
diff
changeset
|
43 be sent using this route (even if also in \fBallowed_senders\fR). |
316
d596ac8b5afb
heavy restructuring of masqmail.route(5) (sections)
meillo@marmaro.de
parents:
311
diff
changeset
|
44 |
317
55b7bde95d37
reworked allowed and denied addrs for routes
meillo@marmaro.de
parents:
316
diff
changeset
|
45 Glob patterns containing `?' and `*' can be used. |
55b7bde95d37
reworked allowed and denied addrs for routes
meillo@marmaro.de
parents:
316
diff
changeset
|
46 The special item "<>" matches the null sender address |
55b7bde95d37
reworked allowed and denied addrs for routes
meillo@marmaro.de
parents:
316
diff
changeset
|
47 (eg. failure notices or delivery notifications). |
55b7bde95d37
reworked allowed and denied addrs for routes
meillo@marmaro.de
parents:
316
diff
changeset
|
48 If the pattern doesn't contain an `@', it is seen as a pattern for the |
55b7bde95d37
reworked allowed and denied addrs for routes
meillo@marmaro.de
parents:
316
diff
changeset
|
49 local part only. |
55b7bde95d37
reworked allowed and denied addrs for routes
meillo@marmaro.de
parents:
316
diff
changeset
|
50 |
55b7bde95d37
reworked allowed and denied addrs for routes
meillo@marmaro.de
parents:
316
diff
changeset
|
51 Example: (see \fIallowed_senders\fP) |
316
d596ac8b5afb
heavy restructuring of masqmail.route(5) (sections)
meillo@marmaro.de
parents:
311
diff
changeset
|
52 |
d596ac8b5afb
heavy restructuring of masqmail.route(5) (sections)
meillo@marmaro.de
parents:
311
diff
changeset
|
53 .TP |
317
55b7bde95d37
reworked allowed and denied addrs for routes
meillo@marmaro.de
parents:
316
diff
changeset
|
54 \fBallowed_recipients\fR = \fIlist\fR |
316
d596ac8b5afb
heavy restructuring of masqmail.route(5) (sections)
meillo@marmaro.de
parents:
311
diff
changeset
|
55 |
317
55b7bde95d37
reworked allowed and denied addrs for routes
meillo@marmaro.de
parents:
316
diff
changeset
|
56 A list of envelope recipient addresses where mail can be sent to using |
55b7bde95d37
reworked allowed and denied addrs for routes
meillo@marmaro.de
parents:
316
diff
changeset
|
57 this route. |
55b7bde95d37
reworked allowed and denied addrs for routes
meillo@marmaro.de
parents:
316
diff
changeset
|
58 This is for example useful if you use this route configuration when connected to another LAN via ppp. |
55b7bde95d37
reworked allowed and denied addrs for routes
meillo@marmaro.de
parents:
316
diff
changeset
|
59 Glob patterns containing `?' and `*' can be used. |
316
d596ac8b5afb
heavy restructuring of masqmail.route(5) (sections)
meillo@marmaro.de
parents:
311
diff
changeset
|
60 |
317
55b7bde95d37
reworked allowed and denied addrs for routes
meillo@marmaro.de
parents:
316
diff
changeset
|
61 Example: \fI*@example.org;*@*foo.bar\fP |
55b7bde95d37
reworked allowed and denied addrs for routes
meillo@marmaro.de
parents:
316
diff
changeset
|
62 |
55b7bde95d37
reworked allowed and denied addrs for routes
meillo@marmaro.de
parents:
316
diff
changeset
|
63 (See also examples for \fIallowed_senders\fP) |
316
d596ac8b5afb
heavy restructuring of masqmail.route(5) (sections)
meillo@marmaro.de
parents:
311
diff
changeset
|
64 |
d596ac8b5afb
heavy restructuring of masqmail.route(5) (sections)
meillo@marmaro.de
parents:
311
diff
changeset
|
65 .TP |
317
55b7bde95d37
reworked allowed and denied addrs for routes
meillo@marmaro.de
parents:
316
diff
changeset
|
66 \fBdenied_recipients\fR = \fIlist\fR |
316
d596ac8b5afb
heavy restructuring of masqmail.route(5) (sections)
meillo@marmaro.de
parents:
311
diff
changeset
|
67 |
317
55b7bde95d37
reworked allowed and denied addrs for routes
meillo@marmaro.de
parents:
316
diff
changeset
|
68 A list of envelope recipient addresses where mail will not be sent to |
55b7bde95d37
reworked allowed and denied addrs for routes
meillo@marmaro.de
parents:
316
diff
changeset
|
69 using this route. |
316
d596ac8b5afb
heavy restructuring of masqmail.route(5) (sections)
meillo@marmaro.de
parents:
311
diff
changeset
|
70 This is for example useful if you send mail directly (\fBmail_host\fR is not set) |
d596ac8b5afb
heavy restructuring of masqmail.route(5) (sections)
meillo@marmaro.de
parents:
311
diff
changeset
|
71 and you know of hosts that will not accept mail from you because they use a dialup list |
d596ac8b5afb
heavy restructuring of masqmail.route(5) (sections)
meillo@marmaro.de
parents:
311
diff
changeset
|
72 (eg. \fBhttp://maps.vix.com/dul/\fR). |
317
55b7bde95d37
reworked allowed and denied addrs for routes
meillo@marmaro.de
parents:
316
diff
changeset
|
73 \fBdenied_recipients\fR overrules \fBallowed_recipients\fR. |
55b7bde95d37
reworked allowed and denied addrs for routes
meillo@marmaro.de
parents:
316
diff
changeset
|
74 Glob patterns containing `?' and `*' can be used. |
55b7bde95d37
reworked allowed and denied addrs for routes
meillo@marmaro.de
parents:
316
diff
changeset
|
75 |
55b7bde95d37
reworked allowed and denied addrs for routes
meillo@marmaro.de
parents:
316
diff
changeset
|
76 Example: \fI*@spamblocker.example.org\fP |
55b7bde95d37
reworked allowed and denied addrs for routes
meillo@marmaro.de
parents:
316
diff
changeset
|
77 |
55b7bde95d37
reworked allowed and denied addrs for routes
meillo@marmaro.de
parents:
316
diff
changeset
|
78 (See also examples for \fIallowed_senders\fP) |
316
d596ac8b5afb
heavy restructuring of masqmail.route(5) (sections)
meillo@marmaro.de
parents:
311
diff
changeset
|
79 |
d596ac8b5afb
heavy restructuring of masqmail.route(5) (sections)
meillo@marmaro.de
parents:
311
diff
changeset
|
80 .TP |
429
5593964ec779
Added route conditions based on the From header
markus schnalke <meillo@marmaro.de>
parents:
380
diff
changeset
|
81 \fBallowed_from_hdrs\fR = \fIlist\fR |
5593964ec779
Added route conditions based on the From header
markus schnalke <meillo@marmaro.de>
parents:
380
diff
changeset
|
82 |
5593964ec779
Added route conditions based on the From header
markus schnalke <meillo@marmaro.de>
parents:
380
diff
changeset
|
83 This is a semicolon `;' separated list of From header addresses. |
5593964ec779
Added route conditions based on the From header
markus schnalke <meillo@marmaro.de>
parents:
380
diff
changeset
|
84 Messages which have one of these addresses as the From header |
5593964ec779
Added route conditions based on the From header
markus schnalke <meillo@marmaro.de>
parents:
380
diff
changeset
|
85 are allowed to use this route |
5593964ec779
Added route conditions based on the From header
markus schnalke <meillo@marmaro.de>
parents:
380
diff
changeset
|
86 (if not also in \fBdenied_from_hdrs\fR). |
5593964ec779
Added route conditions based on the From header
markus schnalke <meillo@marmaro.de>
parents:
380
diff
changeset
|
87 |
5593964ec779
Added route conditions based on the From header
markus schnalke <meillo@marmaro.de>
parents:
380
diff
changeset
|
88 Glob patterns containing `?' and `*' can be used. |
5593964ec779
Added route conditions based on the From header
markus schnalke <meillo@marmaro.de>
parents:
380
diff
changeset
|
89 If the pattern doesn't contain an `@', it is seen as a pattern for the |
5593964ec779
Added route conditions based on the From header
markus schnalke <meillo@marmaro.de>
parents:
380
diff
changeset
|
90 local part only. |
5593964ec779
Added route conditions based on the From header
markus schnalke <meillo@marmaro.de>
parents:
380
diff
changeset
|
91 |
5593964ec779
Added route conditions based on the From header
markus schnalke <meillo@marmaro.de>
parents:
380
diff
changeset
|
92 Example: \fImeillo;*@*example.org;web*@example.com\fP |
5593964ec779
Added route conditions based on the From header
markus schnalke <meillo@marmaro.de>
parents:
380
diff
changeset
|
93 |
5593964ec779
Added route conditions based on the From header
markus schnalke <meillo@marmaro.de>
parents:
380
diff
changeset
|
94 (``meillo'' equals ``meillo@*'', i.e. the local part.) |
5593964ec779
Added route conditions based on the From header
markus schnalke <meillo@marmaro.de>
parents:
380
diff
changeset
|
95 |
5593964ec779
Added route conditions based on the From header
markus schnalke <meillo@marmaro.de>
parents:
380
diff
changeset
|
96 .TP |
5593964ec779
Added route conditions based on the From header
markus schnalke <meillo@marmaro.de>
parents:
380
diff
changeset
|
97 \fBdenied_from_hdrs\fR = \fIlist\fR |
5593964ec779
Added route conditions based on the From header
markus schnalke <meillo@marmaro.de>
parents:
380
diff
changeset
|
98 |
5593964ec779
Added route conditions based on the From header
markus schnalke <meillo@marmaro.de>
parents:
380
diff
changeset
|
99 This is a semicolon `;' separated list of From header addresses. |
5593964ec779
Added route conditions based on the From header
markus schnalke <meillo@marmaro.de>
parents:
380
diff
changeset
|
100 Messages which have one of these addresses as the From header |
5593964ec779
Added route conditions based on the From header
markus schnalke <meillo@marmaro.de>
parents:
380
diff
changeset
|
101 will not be sent using this route (even if also in |
5593964ec779
Added route conditions based on the From header
markus schnalke <meillo@marmaro.de>
parents:
380
diff
changeset
|
102 \fBallowed_from_hdrs\fR). |
5593964ec779
Added route conditions based on the From header
markus schnalke <meillo@marmaro.de>
parents:
380
diff
changeset
|
103 |
5593964ec779
Added route conditions based on the From header
markus schnalke <meillo@marmaro.de>
parents:
380
diff
changeset
|
104 Glob patterns containing `?' and `*' can be used. |
5593964ec779
Added route conditions based on the From header
markus schnalke <meillo@marmaro.de>
parents:
380
diff
changeset
|
105 If the pattern doesn't contain an `@', it is seen as a pattern for the |
5593964ec779
Added route conditions based on the From header
markus schnalke <meillo@marmaro.de>
parents:
380
diff
changeset
|
106 local part only. |
5593964ec779
Added route conditions based on the From header
markus schnalke <meillo@marmaro.de>
parents:
380
diff
changeset
|
107 |
5593964ec779
Added route conditions based on the From header
markus schnalke <meillo@marmaro.de>
parents:
380
diff
changeset
|
108 Example: (see \fIallowed_from_hdrs\fP) |
5593964ec779
Added route conditions based on the From header
markus schnalke <meillo@marmaro.de>
parents:
380
diff
changeset
|
109 |
5593964ec779
Added route conditions based on the From header
markus schnalke <meillo@marmaro.de>
parents:
380
diff
changeset
|
110 .TP |
316
d596ac8b5afb
heavy restructuring of masqmail.route(5) (sections)
meillo@marmaro.de
parents:
311
diff
changeset
|
111 \fBlast_route\fR = \fIboolean\fR |
d596ac8b5afb
heavy restructuring of masqmail.route(5) (sections)
meillo@marmaro.de
parents:
311
diff
changeset
|
112 |
d596ac8b5afb
heavy restructuring of masqmail.route(5) (sections)
meillo@marmaro.de
parents:
311
diff
changeset
|
113 If this is set, a mail which would have been delivered using this route, |
d596ac8b5afb
heavy restructuring of masqmail.route(5) (sections)
meillo@marmaro.de
parents:
311
diff
changeset
|
114 but has failed temporarily, will not be tried to be delivered using the next route. |
d596ac8b5afb
heavy restructuring of masqmail.route(5) (sections)
meillo@marmaro.de
parents:
311
diff
changeset
|
115 |
317
55b7bde95d37
reworked allowed and denied addrs for routes
meillo@marmaro.de
parents:
316
diff
changeset
|
116 If you have set up a special route with filters using the lists |
55b7bde95d37
reworked allowed and denied addrs for routes
meillo@marmaro.de
parents:
316
diff
changeset
|
117 `allowed_recipients' and `allowed_senders' or their complements |
55b7bde95d37
reworked allowed and denied addrs for routes
meillo@marmaro.de
parents:
316
diff
changeset
|
118 (denied_), |
316
d596ac8b5afb
heavy restructuring of masqmail.route(5) (sections)
meillo@marmaro.de
parents:
311
diff
changeset
|
119 and the mail passing these rules should be delivered using this route only, |
d596ac8b5afb
heavy restructuring of masqmail.route(5) (sections)
meillo@marmaro.de
parents:
311
diff
changeset
|
120 you should set this to `true'. |
d596ac8b5afb
heavy restructuring of masqmail.route(5) (sections)
meillo@marmaro.de
parents:
311
diff
changeset
|
121 Otherwise the mail would be passed to the next route (if any), |
d596ac8b5afb
heavy restructuring of masqmail.route(5) (sections)
meillo@marmaro.de
parents:
311
diff
changeset
|
122 unless that route has rules which prevent that. |
d596ac8b5afb
heavy restructuring of masqmail.route(5) (sections)
meillo@marmaro.de
parents:
311
diff
changeset
|
123 |
d596ac8b5afb
heavy restructuring of masqmail.route(5) (sections)
meillo@marmaro.de
parents:
311
diff
changeset
|
124 Default is false. |
d596ac8b5afb
heavy restructuring of masqmail.route(5) (sections)
meillo@marmaro.de
parents:
311
diff
changeset
|
125 |
318
290da1595311
connect_error_fail affects pipe commands too
meillo@marmaro.de
parents:
317
diff
changeset
|
126 .TP |
290da1595311
connect_error_fail affects pipe commands too
meillo@marmaro.de
parents:
317
diff
changeset
|
127 \fBconnect_error_fail\fR = \fIboolean\fR |
290da1595311
connect_error_fail affects pipe commands too
meillo@marmaro.de
parents:
317
diff
changeset
|
128 |
290da1595311
connect_error_fail affects pipe commands too
meillo@marmaro.de
parents:
317
diff
changeset
|
129 If this is set, a connection error (or if a pipe command could not be |
290da1595311
connect_error_fail affects pipe commands too
meillo@marmaro.de
parents:
317
diff
changeset
|
130 executed) will cause a mail delivery to fail, ie. it will be bounced. |
290da1595311
connect_error_fail affects pipe commands too
meillo@marmaro.de
parents:
317
diff
changeset
|
131 If it is unset, it will just be defered. |
290da1595311
connect_error_fail affects pipe commands too
meillo@marmaro.de
parents:
317
diff
changeset
|
132 |
290da1595311
connect_error_fail affects pipe commands too
meillo@marmaro.de
parents:
317
diff
changeset
|
133 Default is false. |
290da1595311
connect_error_fail affects pipe commands too
meillo@marmaro.de
parents:
317
diff
changeset
|
134 The reason for this is that masqmail is designed for non permanent internet connections, |
290da1595311
connect_error_fail affects pipe commands too
meillo@marmaro.de
parents:
317
diff
changeset
|
135 where such errors may occur quite often, and a bounce would be annoying. |
290da1595311
connect_error_fail affects pipe commands too
meillo@marmaro.de
parents:
317
diff
changeset
|
136 |
354
08932c629849
reworked the route concept; removed the idea of the localnet
markus schnalke <meillo@marmaro.de>
parents:
337
diff
changeset
|
137 You probably want to set this to true for permanent routes. |
318
290da1595311
connect_error_fail affects pipe commands too
meillo@marmaro.de
parents:
317
diff
changeset
|
138 |
316
d596ac8b5afb
heavy restructuring of masqmail.route(5) (sections)
meillo@marmaro.de
parents:
311
diff
changeset
|
139 |
d596ac8b5afb
heavy restructuring of masqmail.route(5) (sections)
meillo@marmaro.de
parents:
311
diff
changeset
|
140 .SH SMTP CONFIGURATION |
0 | 141 |
34 | 142 .TP |
143 \fBmail_host\fR = \fIstring\fR | |
0 | 144 |
34 | 145 This is preferably the mail server of your ISP. |
146 All outgoing messages will be sent to this host which will distribute them to their destinations. | |
147 If you do not set this mails will be sent directly. | |
148 Because the mail server is probably `near' to you, mail transfer will be much faster if you use it. | |
0 | 149 |
150 You can optionally give a port number following the host name and a colon, eg mail_host="mail.foo.com:25". | |
34 | 151 |
0 | 152 .TP |
34 | 153 \fBresolve_list\fR = \fIlist\fR |
0 | 154 |
34 | 155 Specify the method how the domain of the server is resolved. |
156 Possible values are dns_mx, dns_a, byname. | |
157 For `dns_mx', the domain is assumed to be an MX pointer to a list of host names, | |
354
08932c629849
reworked the route concept; removed the idea of the localnet
markus schnalke <meillo@marmaro.de>
parents:
337
diff
changeset
|
158 these will be tried each in order |
08932c629849
reworked the route concept; removed the idea of the localnet
markus schnalke <meillo@marmaro.de>
parents:
337
diff
changeset
|
159 (lowest preference value first, equal preference values in random order). |
34 | 160 For `dns_a', the domain is assumed to be an A pointer. |
161 For `byname', the library function \fBgethostbyname(3)\fR will be used. | |
0 | 162 |
354
08932c629849
reworked the route concept; removed the idea of the localnet
markus schnalke <meillo@marmaro.de>
parents:
337
diff
changeset
|
163 For routes to a local network, where you likely don't have a DNS service, |
08932c629849
reworked the route concept; removed the idea of the localnet
markus schnalke <meillo@marmaro.de>
parents:
337
diff
changeset
|
164 use only `byname'. |
08932c629849
reworked the route concept; removed the idea of the localnet
markus schnalke <meillo@marmaro.de>
parents:
337
diff
changeset
|
165 |
0 | 166 The default is "dns_mx;dns_a;byname". |
34 | 167 |
0 | 168 .TP |
34 | 169 \fBhelo_name\fR = \fIstring\fR |
0 | 170 |
34 | 171 Set the name given with the HELO/EHLO command. If this is not set, |
172 \fBhost_name\fR from \fImasqmail.conf\fR will be used, | |
173 if the \fBdo_correct_helo\fR option (see below) is unset. | |
0 | 174 |
175 .TP | |
34 | 176 \fBdo_correct_helo\fR = \fIboolean\fR |
0 | 177 |
34 | 178 If this is set, masqmail tries to look up your host name as it appears |
179 on the internet and sends this in the HELO/EHLO command. | |
180 Some servers are so picky that they want this. | |
181 Which is really crazy. | |
182 It just does not make any sense to lie about ones own identity, | |
183 because it can always be looked up by the server. | |
184 Nobody should believe in the name given by HELO/EHLO anyway. | |
185 If this is not set, \fBhost_name\fR from \fImasqmail.conf\fR or as given with | |
186 the \fBhelo_name\fR (see above) will be used. | |
0 | 187 |
188 .TP | |
222 | 189 \fBinstant_helo\fR = \fIboolean\fR |
190 | |
191 If this is set, masqmail does not wait for the greeting of the SMTP server | |
192 after opening the connection. | |
193 Instead it says EHLO right away (ESMTP is assumed). | |
194 Use this option with wrappers that eat the 220 greeting of the SMTP server. | |
337
fe00f7952a7c
Minor fixes in man pages, reported by lintian(1)
markus schnalke <meillo@marmaro.de>
parents:
335
diff
changeset
|
195 Common examples are STARTTLS wrappers, like `openssl s_client \-starttls smtp ...'. |
222 | 196 |
197 If this option is set and a 220 greeting is received though, | |
198 everything should still work. | |
199 Please don't rely on that and keep in mind that RFC 2821 says that the client | |
200 SHOULD wait for the 220 greeting of the server. | |
201 | |
202 Default: false | |
203 | |
204 .TP | |
34 | 205 \fBdo_pipelining\fR = \fIboolean\fR |
0 | 206 |
34 | 207 If this is set to false, masqmail will not use ESMTP PIPELINING, |
208 even if the server announces that it is able to cope with it. | |
209 Default is true. | |
0 | 210 |
34 | 211 You do not want to set this to false unless the mail setup on the |
212 remote server side is really broken. | |
213 Keywords: wingate. | |
0 | 214 |
34 | 215 |
316
d596ac8b5afb
heavy restructuring of masqmail.route(5) (sections)
meillo@marmaro.de
parents:
311
diff
changeset
|
216 .TP |
d596ac8b5afb
heavy restructuring of masqmail.route(5) (sections)
meillo@marmaro.de
parents:
311
diff
changeset
|
217 \fBauth_name\fR = \fIstring\fR |
d596ac8b5afb
heavy restructuring of masqmail.route(5) (sections)
meillo@marmaro.de
parents:
311
diff
changeset
|
218 |
d596ac8b5afb
heavy restructuring of masqmail.route(5) (sections)
meillo@marmaro.de
parents:
311
diff
changeset
|
219 Set the authentication type for ESMTP AUTH authentication. |
d596ac8b5afb
heavy restructuring of masqmail.route(5) (sections)
meillo@marmaro.de
parents:
311
diff
changeset
|
220 Currently only `cram-md5' and `login' are supported. |
0 | 221 |
222 .TP | |
316
d596ac8b5afb
heavy restructuring of masqmail.route(5) (sections)
meillo@marmaro.de
parents:
311
diff
changeset
|
223 \fBauth_login\fR = \fIstring\fR |
0 | 224 |
316
d596ac8b5afb
heavy restructuring of masqmail.route(5) (sections)
meillo@marmaro.de
parents:
311
diff
changeset
|
225 Your account name for ESMTP AUTH authentication. |
0 | 226 |
34 | 227 .TP |
316
d596ac8b5afb
heavy restructuring of masqmail.route(5) (sections)
meillo@marmaro.de
parents:
311
diff
changeset
|
228 \fBauth_secret\fR = \fIstring\fR |
34 | 229 |
316
d596ac8b5afb
heavy restructuring of masqmail.route(5) (sections)
meillo@marmaro.de
parents:
311
diff
changeset
|
230 Your secret for ESMTP AUTH authentication. |
0 | 231 |
34 | 232 .TP |
316
d596ac8b5afb
heavy restructuring of masqmail.route(5) (sections)
meillo@marmaro.de
parents:
311
diff
changeset
|
233 \fBwrapper\fR = \fIcommand\fR |
d596ac8b5afb
heavy restructuring of masqmail.route(5) (sections)
meillo@marmaro.de
parents:
311
diff
changeset
|
234 |
d596ac8b5afb
heavy restructuring of masqmail.route(5) (sections)
meillo@marmaro.de
parents:
311
diff
changeset
|
235 If set, instead of opening a connection to a remote server, |
d596ac8b5afb
heavy restructuring of masqmail.route(5) (sections)
meillo@marmaro.de
parents:
311
diff
changeset
|
236 \fIcommand\fR will be called and all traffic will be piped to its stdin and from its stdout. |
d596ac8b5afb
heavy restructuring of masqmail.route(5) (sections)
meillo@marmaro.de
parents:
311
diff
changeset
|
237 Purpose is to tunnel ip traffic, eg. for ssl. |
d596ac8b5afb
heavy restructuring of masqmail.route(5) (sections)
meillo@marmaro.de
parents:
311
diff
changeset
|
238 |
d596ac8b5afb
heavy restructuring of masqmail.route(5) (sections)
meillo@marmaro.de
parents:
311
diff
changeset
|
239 Example for SMTP over SSL tunneling: |
d596ac8b5afb
heavy restructuring of masqmail.route(5) (sections)
meillo@marmaro.de
parents:
311
diff
changeset
|
240 .nf |
d596ac8b5afb
heavy restructuring of masqmail.route(5) (sections)
meillo@marmaro.de
parents:
311
diff
changeset
|
241 wrapper="/usr/bin/openssl s_client \-quiet \-connect mail.gmx.net:465 2>/dev/null" |
d596ac8b5afb
heavy restructuring of masqmail.route(5) (sections)
meillo@marmaro.de
parents:
311
diff
changeset
|
242 .fi |
d596ac8b5afb
heavy restructuring of masqmail.route(5) (sections)
meillo@marmaro.de
parents:
311
diff
changeset
|
243 |
d596ac8b5afb
heavy restructuring of masqmail.route(5) (sections)
meillo@marmaro.de
parents:
311
diff
changeset
|
244 SMTP over SSL is supported since masqmail-0.1.8. |
d596ac8b5afb
heavy restructuring of masqmail.route(5) (sections)
meillo@marmaro.de
parents:
311
diff
changeset
|
245 It is marked obsolete by the IETF but is still in use. |
d596ac8b5afb
heavy restructuring of masqmail.route(5) (sections)
meillo@marmaro.de
parents:
311
diff
changeset
|
246 |
0 | 247 |
316
d596ac8b5afb
heavy restructuring of masqmail.route(5) (sections)
meillo@marmaro.de
parents:
311
diff
changeset
|
248 Example for encryption with STARTTLS (RFC-3207): |
d596ac8b5afb
heavy restructuring of masqmail.route(5) (sections)
meillo@marmaro.de
parents:
311
diff
changeset
|
249 .nf |
d596ac8b5afb
heavy restructuring of masqmail.route(5) (sections)
meillo@marmaro.de
parents:
311
diff
changeset
|
250 # don't forget the instant_helo, otherwise it won't work |
d596ac8b5afb
heavy restructuring of masqmail.route(5) (sections)
meillo@marmaro.de
parents:
311
diff
changeset
|
251 instant_helo=true |
d596ac8b5afb
heavy restructuring of masqmail.route(5) (sections)
meillo@marmaro.de
parents:
311
diff
changeset
|
252 wrapper="/usr/bin/openssl s_client \-quiet \-starttls smtp \-connect mail.gmx.net:25 2>/dev/null" |
d596ac8b5afb
heavy restructuring of masqmail.route(5) (sections)
meillo@marmaro.de
parents:
311
diff
changeset
|
253 .fi |
0 | 254 |
316
d596ac8b5afb
heavy restructuring of masqmail.route(5) (sections)
meillo@marmaro.de
parents:
311
diff
changeset
|
255 This is supported since masqmail-0.2.28. |
d596ac8b5afb
heavy restructuring of masqmail.route(5) (sections)
meillo@marmaro.de
parents:
311
diff
changeset
|
256 STARTTLS supersedes SMTP over SSL. |
d596ac8b5afb
heavy restructuring of masqmail.route(5) (sections)
meillo@marmaro.de
parents:
311
diff
changeset
|
257 |
d596ac8b5afb
heavy restructuring of masqmail.route(5) (sections)
meillo@marmaro.de
parents:
311
diff
changeset
|
258 Note for openssl: |
d596ac8b5afb
heavy restructuring of masqmail.route(5) (sections)
meillo@marmaro.de
parents:
311
diff
changeset
|
259 Ensure that stderr is redirected. |
d596ac8b5afb
heavy restructuring of masqmail.route(5) (sections)
meillo@marmaro.de
parents:
311
diff
changeset
|
260 Do *not* use \-crlf in the wrapper command, because masqmail does already insert CRLF. |
d596ac8b5afb
heavy restructuring of masqmail.route(5) (sections)
meillo@marmaro.de
parents:
311
diff
changeset
|
261 However, you might want to specify \-crlf if you want to test your wrapper command |
d596ac8b5afb
heavy restructuring of masqmail.route(5) (sections)
meillo@marmaro.de
parents:
311
diff
changeset
|
262 interactively on the command line. |
d596ac8b5afb
heavy restructuring of masqmail.route(5) (sections)
meillo@marmaro.de
parents:
311
diff
changeset
|
263 |
d596ac8b5afb
heavy restructuring of masqmail.route(5) (sections)
meillo@marmaro.de
parents:
311
diff
changeset
|
264 |
d596ac8b5afb
heavy restructuring of masqmail.route(5) (sections)
meillo@marmaro.de
parents:
311
diff
changeset
|
265 .SH PIPE CONFIGURATION |
34 | 266 |
0 | 267 .TP |
316
d596ac8b5afb
heavy restructuring of masqmail.route(5) (sections)
meillo@marmaro.de
parents:
311
diff
changeset
|
268 \fBpipe\fR = \fIcommand\fR |
0 | 269 |
316
d596ac8b5afb
heavy restructuring of masqmail.route(5) (sections)
meillo@marmaro.de
parents:
311
diff
changeset
|
270 \fIcommand\fR will be called and the message will be piped to its stdin. |
d596ac8b5afb
heavy restructuring of masqmail.route(5) (sections)
meillo@marmaro.de
parents:
311
diff
changeset
|
271 Purpose is to use gateways to uucp, fax, sms or whatever else. |
d596ac8b5afb
heavy restructuring of masqmail.route(5) (sections)
meillo@marmaro.de
parents:
311
diff
changeset
|
272 |
d596ac8b5afb
heavy restructuring of masqmail.route(5) (sections)
meillo@marmaro.de
parents:
311
diff
changeset
|
273 You can use variables to give as arguments to the command, |
d596ac8b5afb
heavy restructuring of masqmail.route(5) (sections)
meillo@marmaro.de
parents:
311
diff
changeset
|
274 these are the same as for the mda in the main configuration, see \fBmasqmail.conf(5)\fR. |
34 | 275 |
0 | 276 .TP |
316
d596ac8b5afb
heavy restructuring of masqmail.route(5) (sections)
meillo@marmaro.de
parents:
311
diff
changeset
|
277 \fBpipe_fromline = \fIboolean\fR |
d596ac8b5afb
heavy restructuring of masqmail.route(5) (sections)
meillo@marmaro.de
parents:
311
diff
changeset
|
278 |
d596ac8b5afb
heavy restructuring of masqmail.route(5) (sections)
meillo@marmaro.de
parents:
311
diff
changeset
|
279 Only if `pipe' is used. |
d596ac8b5afb
heavy restructuring of masqmail.route(5) (sections)
meillo@marmaro.de
parents:
311
diff
changeset
|
280 A from line will be prepended to the output stream whenever a pipe command is called. |
d596ac8b5afb
heavy restructuring of masqmail.route(5) (sections)
meillo@marmaro.de
parents:
311
diff
changeset
|
281 Default is false. |
0 | 282 |
316
d596ac8b5afb
heavy restructuring of masqmail.route(5) (sections)
meillo@marmaro.de
parents:
311
diff
changeset
|
283 .TP |
d596ac8b5afb
heavy restructuring of masqmail.route(5) (sections)
meillo@marmaro.de
parents:
311
diff
changeset
|
284 \fBpipe_fromhack = \fIboolean\fR |
d596ac8b5afb
heavy restructuring of masqmail.route(5) (sections)
meillo@marmaro.de
parents:
311
diff
changeset
|
285 |
d596ac8b5afb
heavy restructuring of masqmail.route(5) (sections)
meillo@marmaro.de
parents:
311
diff
changeset
|
286 Only if `pipe' is used. |
d596ac8b5afb
heavy restructuring of masqmail.route(5) (sections)
meillo@marmaro.de
parents:
311
diff
changeset
|
287 Each line beginning with `From ' is replaced with `>From ' whenever a pipe command is called. |
d596ac8b5afb
heavy restructuring of masqmail.route(5) (sections)
meillo@marmaro.de
parents:
311
diff
changeset
|
288 You probably want this if you have set \fBpipe_fromline\fR above. |
d596ac8b5afb
heavy restructuring of masqmail.route(5) (sections)
meillo@marmaro.de
parents:
311
diff
changeset
|
289 Default is false. |
d596ac8b5afb
heavy restructuring of masqmail.route(5) (sections)
meillo@marmaro.de
parents:
311
diff
changeset
|
290 |
d596ac8b5afb
heavy restructuring of masqmail.route(5) (sections)
meillo@marmaro.de
parents:
311
diff
changeset
|
291 |
d596ac8b5afb
heavy restructuring of masqmail.route(5) (sections)
meillo@marmaro.de
parents:
311
diff
changeset
|
292 .SH ADDRESS REWRITE RULES |
0 | 293 |
34 | 294 .TP |
295 \fBset_h_from_domain\fR = \fIstring\fR | |
0 | 296 |
34 | 297 Replace the domain part in `From:' headers with this value. |
298 This may be useful if you use a private, outside unknown address on your local LAN | |
141 | 299 and want this to be replaced by the domain of the address of your email address on the internet. |
34 | 300 Note that this is different to \fBset_return_path_domain\fR, see below. |
0 | 301 |
302 .TP | |
138
80b207e8b8af
documented, yet undocumented, set_h_reply_to_domain config option
meillo@marmaro.de
parents:
95
diff
changeset
|
303 \fBset_h_reply_to_domain\fR = \fIstring\fR |
80b207e8b8af
documented, yet undocumented, set_h_reply_to_domain config option
meillo@marmaro.de
parents:
95
diff
changeset
|
304 |
80b207e8b8af
documented, yet undocumented, set_h_reply_to_domain config option
meillo@marmaro.de
parents:
95
diff
changeset
|
305 Same as \fBset_h_from_domain\fP, but for the `Reply-To' header. |
80b207e8b8af
documented, yet undocumented, set_h_reply_to_domain config option
meillo@marmaro.de
parents:
95
diff
changeset
|
306 |
80b207e8b8af
documented, yet undocumented, set_h_reply_to_domain config option
meillo@marmaro.de
parents:
95
diff
changeset
|
307 .TP |
34 | 308 \fBset_return_path_domain\fR = \fIstring\fR |
0 | 309 |
34 | 310 Sets the domain part of the envelope from address. |
311 Some hosts check whether this is the same as the net the connection is coming from. | |
312 If not, they reject the mail because they suspect spamming. | |
313 It should be a valid address, because some mail servers also check that. | |
314 You can also use this to set it to your usual address on the internet | |
315 and put a local address only known on your LAN in the configuration of your mailer. | |
316 Only the domain part will be changed, the local part remains unchanged. | |
317 Use \fBmap_return_path_addresses\fR for rewriting local parts. | |
0 | 318 |
34 | 319 .TP |
320 \fBmap_h_from_addresses\fR = \fIlist\fR | |
321 | |
322 This is similar to \fBset_h_from_domain\fR, but more flexible. | |
323 Set this to a list which maps local parts to a full RFC 822 compliant email address, | |
324 the local parts (the keys) are separated from the addresses (the values) by colons (`:'). | |
0 | 325 |
326 Example: | |
223 | 327 .nf |
0 | 328 map_h_from_addresses = "john: John Smith <jsmith@mail.academic.edu>; charlie: Charlie Miller <cmiller@mx.commercial.com>" |
223 | 329 .fi |
0 | 330 |
331 You can use patterns, eg. * as keys. | |
34 | 332 |
0 | 333 .TP |
34 | 334 \fBmap_h_reply_to_addresses\fR = \fIlist\fR |
0 | 335 |
34 | 336 Same as \fBmap_h_from_addresses\fR, but for the `Reply-To:' header. |
0 | 337 |
338 .TP | |
34 | 339 \fBmap_h_mail_followup_to_addresses\fR = \fIlist\fR |
0 | 340 |
34 | 341 Same as \fBmap_h_from_addresses\fR, but for the `Mail-Followup-To:' header. |
342 Useful when replying to mailing lists. | |
0 | 343 |
344 .TP | |
34 | 345 \fBmap_return_path_addresses\fR = \fIlist\fR |
0 | 346 |
34 | 347 This is similar to \fBset_return_path_domain\fR, but more flexible. |
348 Set this to a list which maps local parts to a full RFC 821 compliant email address, | |
349 the local parts (the keys) are separated from the addresses (the values) by colons (`:'). | |
350 Note that this option takes RFC 821 addresses while \fBmap_h_from_addresses\fR takes RFC 822 addresses. | |
351 The most important difference is that RFC 821 addresses have no full name. | |
0 | 352 |
353 Example: | |
223 | 354 .nf |
0 | 355 map_return_path_addresses = "john: <jsmith@mail.academic.edu>; charlie: <cmiller@mx.commercial.com>" |
223 | 356 .fi |
0 | 357 |
358 You can use patterns, eg. * as keys. | |
34 | 359 |
0 | 360 .TP |
34 | 361 \fBexpand_h_sender_address\fR = \fIboolean\fR |
0 | 362 |
34 | 363 This sets the domain of the sender address as given by the Sender: header |
364 to the same address as in the envelope return path address | |
365 (which can be set by either \fBset_return_path_domain\fR or \fBmap_return_path_addresses\fR). | |
366 This is for mail clients (eg. Microsoft Outlook) which use this address as the sender address. | |
367 Though they should use the From: address, see RFC 821. | |
368 If \fBfetchmail(1)\fR encounters an unqualified Sender: address, | |
369 it will be expanded to the domain of the pop server, which is almost never correct. | |
370 Default is true. | |
371 | |
0 | 372 .TP |
34 | 373 \fBexpand_h_sender_domain\fR = \fIboolean\fR |
0 | 374 |
34 | 375 Like \fBexpand_h_sender_address\fR, but sets the domain only. |
376 Deprecated, will be removed in a later version. | |
377 | |
378 | |
0 | 379 .SH AUTHOR |
380 | |
34 | 381 Masqmail was written by Oliver Kurth. |
382 It is now maintained by Markus Schnalke <meillo@marmaro.de>. | |
0 | 383 |
95
e01fed4846e4
masqmail's homepage moved prog.marmaro.de/masqmail -> marmaro.de/prog/masqmail
meillo@marmaro.de
parents:
57
diff
changeset
|
384 You will find the newest version of masqmail at \fBhttp://marmaro.de/prog/masqmail/\fR. |
26
607221b0dac1
added myself as maintainer; updated URL of the website
meillo@marmaro.de
parents:
24
diff
changeset
|
385 There is also a mailing list, you will find information about it at masqmail's main site. |
0 | 386 |
34 | 387 |
0 | 388 .SH BUGS |
389 | |
34 | 390 Please report bugs to the mailing list. |
0 | 391 |
392 .SH SEE ALSO | |
393 | |
192 | 394 \fBmasqmail(8)\fR, \fBmasqmail.conf(5)\fR |