| rev |
line source |
|
meillo@56
|
1 <body text="#000000" link="#0000ff" bgcolor="#ffffff"><center><table width="80%">
|
|
meillo@56
|
2 <tr><td><h1>masqmail.conf</h1>
|
|
meillo@56
|
3 <h2>masqmail configuration file</h2>
|
|
meillo@56
|
4
|
|
meillo@56
|
5
|
|
meillo@56
|
6 <h2>Description</h2>
|
|
meillo@56
|
7
|
|
meillo@56
|
8 <p>This man page describes the syntax of the main configuration file
|
|
meillo@56
|
9 of masqmail. Its usual location is <em>/etc/masqmail/masqmail.conf</em></p>
|
|
meillo@56
|
10
|
|
meillo@56
|
11 <p>The configuration consists of lines of the form</p>
|
|
meillo@56
|
12
|
|
meillo@56
|
13 <p><b>val</b> = <em>expression</em></p>
|
|
meillo@56
|
14
|
|
meillo@56
|
15 <p>Where <b>val</b> is a variable name and <em>expression</em> a string,
|
|
meillo@56
|
16 which can be quoted with '"'. If the expression is on multiple lines
|
|
meillo@56
|
17 or contains characters other than letters, digits or the characters
|
|
meillo@56
|
18 '.', '-', '_', '/', it must be quoted. You can use quotes inside quotes
|
|
meillo@56
|
19 by escaping them with a backslash.</p>
|
|
meillo@56
|
20
|
|
meillo@56
|
21 <p>Each val has a type, which can be boolean, numeric, string
|
|
meillo@56
|
22 or list. A boolean variable can be set with one of the values 'on',
|
|
meillo@56
|
23 'yes', and 'true' or 'off', 'no' and 'false'. List items are separated
|
|
meillo@56
|
24 with ';'. For some values patterns (like '*','?') can be used. The
|
|
meillo@56
|
25 spaces before and after the '=' are optional.</p>
|
|
meillo@56
|
26
|
|
meillo@56
|
27 <p>Most lists (exceptions: <b>local_hosts</b>,
|
|
meillo@56
|
28 <b>local_nets</b>, <b>listen_addresses</b>, <b>online_routes</b> and <b>online_gets</b>) accept
|
|
meillo@56
|
29 files. These will be recognized by a leading slash '/'. The contents
|
|
meillo@56
|
30 of these files will be included at the position of the file name,
|
|
meillo@56
|
31 there can be items or other files before and after the file entry. The
|
|
meillo@56
|
32 format of the files is different though, within these files each entry
|
|
meillo@56
|
33 is on another line. (And not separated by semicolons). This makes it
|
|
meillo@56
|
34 easy to include large lists which are common in different
|
|
meillo@56
|
35 configuration files, so they do not have to appear in every
|
|
meillo@56
|
36 configuration file.</p>
|
|
meillo@56
|
37
|
|
meillo@56
|
38 <p>Blank lines and lines starting with '#' are ignored.</p>
|
|
meillo@56
|
39
|
|
meillo@56
|
40
|
|
meillo@56
|
41
|
|
meillo@56
|
42
|
|
meillo@56
|
43 <h2>Options</h2>
|
|
meillo@56
|
44
|
|
meillo@56
|
45
|
|
meillo@56
|
46 <p><b>run_as_user = <em>boolean</em></b></p>
|
|
meillo@56
|
47
|
|
meillo@56
|
48 <p>If this is set, masqmail runs with the user id of the user who
|
|
meillo@56
|
49 invoked it and never changes it. This is for debugging purposes
|
|
meillo@56
|
50 only. If the user is not root, masqmail will not be able to
|
|
meillo@56
|
51 listen on a port < 1024 and will not be able to deliver local mail
|
|
meillo@56
|
52 to others than the user.</p>
|
|
meillo@56
|
53
|
|
meillo@56
|
54
|
|
meillo@56
|
55
|
|
meillo@56
|
56
|
|
meillo@56
|
57 <p><b>use_syslog = <em>boolean</em></b></p>
|
|
meillo@56
|
58
|
|
meillo@56
|
59 <p>If this is set, masqmail uses syslogd for logging. It uses facility
|
|
meillo@56
|
60 MAIL. You still have to set <b>log_dir</b> for debug files.</p>
|
|
meillo@56
|
61
|
|
meillo@56
|
62
|
|
meillo@56
|
63
|
|
meillo@56
|
64
|
|
meillo@56
|
65 <p><b>debug_level = <em>n</em></b></p>
|
|
meillo@56
|
66
|
|
meillo@56
|
67 <p>Set the debug level. Valid values are 0 to 6, increasing it further
|
|
meillo@56
|
68 makes no difference. Be careful if you set this as high as 5 or higher,
|
|
meillo@56
|
69 the logs may very soon fill your hard drive.</p>
|
|
meillo@56
|
70
|
|
meillo@56
|
71
|
|
meillo@56
|
72
|
|
meillo@56
|
73
|
|
meillo@56
|
74 <p><b>mail_dir = <em>file</em></b></p>
|
|
meillo@56
|
75
|
|
meillo@56
|
76 <p>The directory where local mail is stored,
|
|
meillo@56
|
77 usually <em>/var/spool/mail</em> or <em>/var/mail</em>.</p>
|
|
meillo@56
|
78
|
|
meillo@56
|
79
|
|
meillo@56
|
80
|
|
meillo@56
|
81
|
|
meillo@56
|
82 <p><b>spool_dir = <em>file</em></b></p>
|
|
meillo@56
|
83
|
|
meillo@56
|
84 <p>The directory where masqmail stores its spool files (and later also
|
|
meillo@56
|
85 other stuff). It must have a subdirectory <em>input</em>.
|
|
meillo@56
|
86 Masqmail needs read and write permissions for this
|
|
meillo@56
|
87 directory. I suggest to use <em>/var/spool/masqmail</em>.</p>
|
|
meillo@56
|
88
|
|
meillo@56
|
89
|
|
meillo@56
|
90
|
|
meillo@56
|
91
|
|
meillo@56
|
92 <p><b>host_name = <em>string</em></b></p>
|
|
meillo@56
|
93
|
|
meillo@56
|
94 <p>This is used in different places: Masqmail identifies itself in the
|
|
meillo@56
|
95 greeting banner on incoming connections and in the HELO/EHLO command
|
|
meillo@56
|
96 for outgoing connections with this name, it is used in the Received:
|
|
meillo@56
|
97 header and to qualify the sender of a locally originating message.</p>
|
|
meillo@56
|
98
|
|
meillo@56
|
99 <p>If the string begins with a slash '/', it it assumed that it is a
|
|
meillo@56
|
100 filename, and the first line of this file will be used. Usually this will
|
|
meillo@56
|
101 be '/etc/mailname' to make masqmail conform to Debian policies.</p>
|
|
meillo@56
|
102
|
|
meillo@56
|
103 <p>It is not used to find whether an address is local.
|
|
meillo@56
|
104 Use <b>local_hosts</b> for that.</p>
|
|
meillo@56
|
105
|
|
meillo@56
|
106
|
|
meillo@56
|
107
|
|
meillo@56
|
108
|
|
meillo@56
|
109 <p><b>remote_port = <em>n</em></b></p>
|
|
meillo@56
|
110
|
|
meillo@56
|
111 <p>The remote port number to be used. This defaults to port 25.</p>
|
|
meillo@56
|
112 <p>This option is deprecated. Use <b>host_name</b> in the route
|
|
meillo@56
|
113 configuration instead. See <a href="masqmail.route.5.html">masqmail.route</a>.</p>
|
|
meillo@56
|
114
|
|
meillo@56
|
115
|
|
meillo@56
|
116
|
|
meillo@56
|
117
|
|
meillo@56
|
118 <p><b>local_hosts = <em>list</em></b></p>
|
|
meillo@56
|
119
|
|
meillo@56
|
120 <p>A semicolon ';' separated list of hostnames which are considered
|
|
meillo@56
|
121 local. Normally you set it to "localhost;foo;foo.bar.com" if your host
|
|
meillo@56
|
122 has the fully qualified domain name 'foo.bar.com'.</p>
|
|
meillo@56
|
123
|
|
meillo@56
|
124
|
|
meillo@56
|
125
|
|
meillo@56
|
126
|
|
meillo@56
|
127 <p><b>local_nets = <em>list</em></b></p>
|
|
meillo@56
|
128
|
|
meillo@56
|
129 <p>A semicolon ';' separated list of hostnames which are on the
|
|
meillo@56
|
130 'local' net. Delivery to these hosts is attempted immediately. You can
|
|
meillo@56
|
131 use patterns with '*', eg. "*.bar.com".</p>
|
|
meillo@56
|
132
|
|
meillo@56
|
133
|
|
meillo@56
|
134
|
|
meillo@56
|
135
|
|
meillo@56
|
136 <p><b>local_addresses = <em>list</em></b></p>
|
|
meillo@56
|
137
|
|
meillo@56
|
138 <p>A semicolon ';' separated list of fully qualified email-addresses
|
|
meillo@56
|
139 which are considered local although their domain name part is not in
|
|
meillo@56
|
140 the list of <b>local_hosts</b>. </p>
|
|
meillo@56
|
141 <p>For example: There are two people working at your
|
|
meillo@56
|
142 LAN: person1@yourdomain and person2@yourdomain. But there are
|
|
meillo@56
|
143 other persons @yourdomain which are NOT local. So you can not put
|
|
meillo@56
|
144 yourdomain to the list of local_hosts. If person1 now wants
|
|
meillo@56
|
145 to write to person2@yourdomain and this mail should not leave the LAN
|
|
meillo@56
|
146 then you can put</p>
|
|
meillo@56
|
147 <p>local_addresses = "person1@yourdomain;person2@yourdomain"</p>
|
|
meillo@56
|
148 <p>to your masqmail.conf.</p>
|
|
meillo@56
|
149
|
|
meillo@56
|
150
|
|
meillo@56
|
151
|
|
meillo@56
|
152
|
|
meillo@56
|
153 <p><b>not_local_addresses = <em>list</em></b></p>
|
|
meillo@56
|
154
|
|
meillo@56
|
155 <p>A semicolon ';' separated list of fully qualified email-addresses
|
|
meillo@56
|
156 which are considered not local although their domain name part is in
|
|
meillo@56
|
157 the list of <b>local_hosts</b>. </p>
|
|
meillo@56
|
158 <p>This ist the opposite of the previous case. The majority of addresses
|
|
meillo@56
|
159 of a specific domain are local. But some users are not. With this
|
|
meillo@56
|
160 option you can easily exclude these users.</p>
|
|
meillo@56
|
161 <p>Example:</p>
|
|
meillo@56
|
162 <p>local_hosts = "localhost;myhost;mydomain.net"</p>
|
|
meillo@56
|
163 <p>not_local_addresses = "eric@mydomain.net"</p>
|
|
meillo@56
|
164
|
|
meillo@56
|
165
|
|
meillo@56
|
166
|
|
meillo@56
|
167
|
|
meillo@56
|
168 <p><b>listen_addresses = <em>list</em></b></p>
|
|
meillo@56
|
169
|
|
meillo@56
|
170 <p>A semicolon ';' separated list of interfaces on which connections
|
|
meillo@56
|
171 will be accepted. An interface ist defined by a hostname, optionally
|
|
meillo@56
|
172 followed by a colon ':' and a number for the port. If this is left out,
|
|
meillo@56
|
173 port 25 will be used.</p>
|
|
meillo@56
|
174 <p>You can set this to "localhost:25;foo:25" if your hostname is 'foo'.</p>
|
|
meillo@56
|
175 <p>Note that the names are resolved to IP addreses. If your host has
|
|
meillo@56
|
176 different names which resolve to the same IP, use only one of them,
|
|
meillo@56
|
177 otherwise you will get an error message.
|
|
meillo@56
|
178 </p>
|
|
meillo@56
|
179
|
|
meillo@56
|
180
|
|
meillo@56
|
181
|
|
meillo@56
|
182
|
|
meillo@56
|
183 <p><b>do_save_envelope_to = <em>boolean</em></b></p>
|
|
meillo@56
|
184
|
|
meillo@56
|
185 <p>If this is set to true, a possibly existing Envelope-to: header in an
|
|
meillo@56
|
186 incoming mail which is received via either pop3 or smtp will be saved as
|
|
meillo@56
|
187 an X-Orig-Envelope-to: header.</p>
|
|
meillo@56
|
188 <p>This is useful if you retrieve mail from a pop3 server with either masqmail
|
|
meillo@56
|
189 or fetchmail, and the server supports Envelope-to: headers, and you want to make use
|
|
meillo@56
|
190 of those with a mail filtering tool, eg. procmail. It cannot be preserved because
|
|
meillo@56
|
191 masqmail sets such a header by itself.</p>
|
|
meillo@56
|
192 <p>Default is false.</p>
|
|
meillo@56
|
193
|
|
meillo@56
|
194
|
|
meillo@56
|
195
|
|
meillo@56
|
196
|
|
meillo@56
|
197 <p><b>do_relay = <em>boolean</em></b></p>
|
|
meillo@56
|
198
|
|
meillo@56
|
199 <p>If this is set to false, mail with a return path that is not local and a
|
|
meillo@56
|
200 destination that is also not local will not be accepted via smtp and a 550
|
|
meillo@56
|
201 reply will be given. Default is true.</p>
|
|
meillo@56
|
202 <p>Note that this will not protect you from spammers using open relays, but from
|
|
meillo@56
|
203 users unable to set their address in their mail clients.</p>
|
|
meillo@56
|
204
|
|
meillo@56
|
205
|
|
meillo@56
|
206
|
|
meillo@56
|
207
|
|
meillo@56
|
208 <p><b>do_queue = <em>boolean</em></b></p>
|
|
meillo@56
|
209
|
|
meillo@56
|
210 <p>If this is set, mail will not be delivered immediately when
|
|
meillo@56
|
211 accepted. Same as calling masqmail with the <b>-odq</b> option.</p>
|
|
meillo@56
|
212
|
|
meillo@56
|
213
|
|
meillo@56
|
214
|
|
meillo@56
|
215
|
|
meillo@56
|
216 <p><b>online_routes.<em>name</em> = <em>list</em></b></p>
|
|
meillo@56
|
217
|
|
meillo@56
|
218
|
|
meillo@56
|
219 <p>Replace <em>name</em> with a name to identify a connection. Set this
|
|
meillo@56
|
220 to a filename (or a list of filenames) for the special route configuration for that
|
|
meillo@56
|
221 connection. You will use that name to call masqmail with the
|
|
meillo@56
|
222 <b>-qo</b> option every time a connection to your ISP is set
|
|
meillo@56
|
223 up.</p>
|
|
meillo@56
|
224
|
|
meillo@56
|
225 <p>Example: Your ISP has the name FastNet. Then you write the
|
|
meillo@56
|
226 following line in the main configuration:</p>
|
|
meillo@56
|
227
|
|
meillo@56
|
228 <p><b>online_routes.FastNet</b> = <em>"/etc/masqmail/fastnet.route"</em></p>
|
|
meillo@56
|
229
|
|
meillo@56
|
230 <p><em>/etc/masqmail/fastnet.route</em> is the route configuration
|
|
meillo@56
|
231 file, see <a href="masqmail.route.5.html">masqmail.route</a>. As soon as a link to FastNet has been set up, you
|
|
meillo@56
|
232 call masqmail <b>-qo</b> <em>FastNet</em>. Masqmail will then
|
|
meillo@56
|
233 read the specified file and send the mails.</p>
|
|
meillo@56
|
234
|
|
meillo@56
|
235
|
|
meillo@56
|
236
|
|
meillo@56
|
237
|
|
meillo@56
|
238
|
|
meillo@56
|
239 <p><b>connect_route.<em>name</em> = <em>list</em></b></p>
|
|
meillo@56
|
240
|
|
meillo@56
|
241 <p>Old name for <b>online_routes</b>.</p>
|
|
meillo@56
|
242
|
|
meillo@56
|
243
|
|
meillo@56
|
244
|
|
meillo@56
|
245
|
|
meillo@56
|
246
|
|
meillo@56
|
247 <p><b>local_net_route = <em>file</em></b></p>
|
|
meillo@56
|
248
|
|
meillo@56
|
249 <p>This is similar to <b>online_routes.<em>name</em></b> but for the
|
|
meillo@56
|
250 local net. Recipient addresses that are in local_nets will be
|
|
meillo@56
|
251 routed using this route configuration. Main purpose is to define a
|
|
meillo@56
|
252 mail server with mail_host in your local network. In simple
|
|
meillo@56
|
253 environments this can be left unset. If unset, a default route
|
|
meillo@56
|
254 configuration will be used.</p>
|
|
meillo@56
|
255
|
|
meillo@56
|
256
|
|
meillo@56
|
257
|
|
meillo@56
|
258
|
|
meillo@56
|
259 <p><b>alias_file = <em>file</em></b></p>
|
|
meillo@56
|
260
|
|
meillo@56
|
261 <p>Set this to the location of your alias file. If unset, no aliasing
|
|
meillo@56
|
262 will be done.</p>
|
|
meillo@56
|
263
|
|
meillo@56
|
264
|
|
meillo@56
|
265
|
|
meillo@56
|
266
|
|
meillo@56
|
267 <p><b>alias_local_caseless = <em>boolean</em></b></p>
|
|
meillo@56
|
268
|
|
meillo@56
|
269 <p>If this is set, local parts in the alias file will be matched
|
|
meillo@56
|
270 disregarding upper/lower case.</p>
|
|
meillo@56
|
271
|
|
meillo@56
|
272
|
|
meillo@56
|
273
|
|
meillo@56
|
274
|
|
meillo@56
|
275 <p><b>pipe_fromline = <em>boolean</em></b></p>
|
|
meillo@56
|
276
|
|
meillo@56
|
277 <p>If this is set, a from line will be prepended to the output stream whenever
|
|
meillo@56
|
278 a pipe command is called after an alias expansion. Default is false.</p>
|
|
meillo@56
|
279
|
|
meillo@56
|
280
|
|
meillo@56
|
281
|
|
meillo@56
|
282
|
|
meillo@56
|
283 <p><b>pipe_fromhack = <em>boolean</em></b></p>
|
|
meillo@56
|
284
|
|
meillo@56
|
285 <p>If this is set, each line beginning with 'From ' is replaced with '>From ' whenever
|
|
meillo@56
|
286 a pipe command is called after an alias expansion. You probably want this if you have
|
|
meillo@56
|
287 set <b>pipe_fromline</b> above. Default is false.</p>
|
|
meillo@56
|
288
|
|
meillo@56
|
289
|
|
meillo@56
|
290
|
|
meillo@56
|
291
|
|
meillo@56
|
292 <p><b>mbox_default = <em>string</em></b></p>
|
|
meillo@56
|
293
|
|
meillo@56
|
294 <p>The default local delivery method. Can be one of mbox, mda or
|
|
meillo@56
|
295 maildir (the latter only if maildir support is enabled at compile
|
|
meillo@56
|
296 time). Default is mbox. You can override this for each user by using
|
|
meillo@56
|
297 the <b>mbox_users</b>, <b>mda_users</b> or <b>maildir_users</b> options
|
|
meillo@56
|
298 (see below).
|
|
meillo@56
|
299 </p>
|
|
meillo@56
|
300
|
|
meillo@56
|
301
|
|
meillo@56
|
302
|
|
meillo@56
|
303
|
|
meillo@56
|
304 <p><b>mbox_users = <em>list</em></b></p>
|
|
meillo@56
|
305
|
|
meillo@56
|
306 <p>A list of users which wish delivery to an mbox style mail folder.</p>
|
|
meillo@56
|
307
|
|
meillo@56
|
308
|
|
meillo@56
|
309
|
|
meillo@56
|
310
|
|
meillo@56
|
311 <p><b>mda_users = <em>list</em></b></p>
|
|
meillo@56
|
312
|
|
meillo@56
|
313 <p>A list of users which wish local delivery to an mda. You have to
|
|
meillo@56
|
314 set <b>mda</b> (see below) as well.</p>
|
|
meillo@56
|
315
|
|
meillo@56
|
316
|
|
meillo@56
|
317
|
|
meillo@56
|
318
|
|
meillo@56
|
319 <p><b>maildir_users = <em>list</em></b></p>
|
|
meillo@56
|
320
|
|
meillo@56
|
321 <p>A list of users which wish delivery to a qmail style maildir. The
|
|
meillo@56
|
322 path to maildir is ~/Maildir/. The maildir will be created if it
|
|
meillo@56
|
323 does not exist.</p>
|
|
meillo@56
|
324
|
|
meillo@56
|
325
|
|
meillo@56
|
326
|
|
meillo@56
|
327
|
|
meillo@56
|
328 <p><b>mda = <em>expand string</em></b></p>
|
|
meillo@56
|
329
|
|
meillo@56
|
330 <p>If you want local delivery to be transferred to an mda (Mail
|
|
meillo@56
|
331 Delivery Agent), set this to a command. The argument will be expanded
|
|
meillo@56
|
332 on delivery time, you can use variables beginning with a '$' sign,
|
|
meillo@56
|
333 optionally enclosed in curly braces. Variables you can use are:</p>
|
|
meillo@56
|
334 <p>uid - the unique message id. This is not necessarily identical with
|
|
meillo@56
|
335 the Message ID as given in the Message ID: header.</p>
|
|
meillo@56
|
336 <p>received_host - the host the mail was received from</p>
|
|
meillo@56
|
337 <p>ident - the ident, this is either the ident delivered by the ident
|
|
meillo@56
|
338 protocol or the user id of the sender if the message was received locally.</p>
|
|
meillo@56
|
339 <p>return_path_local - the local part of the return path (sender).</p>
|
|
meillo@56
|
340 <p>return_path_domain - the domain part of the return path (sender).</p>
|
|
meillo@56
|
341 <p>return_path - the complete return path (sender).</p>
|
|
meillo@56
|
342 <p>rcpt_local - the local part of the recipient.</p>
|
|
meillo@56
|
343 <p>rcpt_domain - the domain part of the recipient.</p>
|
|
meillo@56
|
344 <p>rcpt - the complete recipient address.</p>
|
|
meillo@56
|
345 <p>Example:</p><p>mda="/usr/bin/procmail -Y -d ${rcpt_local}"</p>
|
|
meillo@56
|
346 <p>For the mda, as for pipe commands, a few environment variables will
|
|
meillo@56
|
347 be set as well. See <a href="masqmail.8.html">masqmail</a>. To use environment variables for the mda,
|
|
meillo@56
|
348 the '$' sign has to be escaped with a backslash, otherwise they will
|
|
meillo@56
|
349 be tried to be expanded with the internal variables.</p>
|
|
meillo@56
|
350
|
|
meillo@56
|
351
|
|
meillo@56
|
352
|
|
meillo@56
|
353
|
|
meillo@56
|
354
|
|
meillo@56
|
355 <p><b>mda_fromline = <em>boolean</em></b></p>
|
|
meillo@56
|
356
|
|
meillo@56
|
357 <p>If this is set, a from line will be prepended to the output stream whenever
|
|
meillo@56
|
358 a message is delivered to an mda. Default is false.</p>
|
|
meillo@56
|
359
|
|
meillo@56
|
360
|
|
meillo@56
|
361
|
|
meillo@56
|
362
|
|
meillo@56
|
363 <p><b>mda_fromhack = <em>boolean</em></b></p>
|
|
meillo@56
|
364
|
|
meillo@56
|
365 <p>If this is set, each line beginning with 'From ' is replaced with '>From ' whenever
|
|
meillo@56
|
366 a message is delivered to an mda. You probably want this if you have
|
|
meillo@56
|
367 set <b>mda_fromline</b> above. Default is false.</p>
|
|
meillo@56
|
368
|
|
meillo@56
|
369
|
|
meillo@56
|
370
|
|
meillo@56
|
371
|
|
meillo@56
|
372 <p><b>online_detect = <em>string</em></b></p>
|
|
meillo@56
|
373
|
|
meillo@56
|
374 <p>Defines the method MasqMail uses to detect whether there is
|
|
meillo@56
|
375 currently an online connection. It can have the
|
|
meillo@56
|
376 values <b>file</b>, <b>pipe</b> or <b>mserver</b>.</p>
|
|
meillo@56
|
377
|
|
meillo@56
|
378 <p>When it is set to <b>file</b>, MasqMail first checks for the
|
|
meillo@56
|
379 existence of <b>online_file</b> (see below) and if it exists, it reads
|
|
meillo@56
|
380 it. The content of the file should be the name of the current
|
|
meillo@56
|
381 connection as defined with <b>connect_route.<em>name</em></b> (without
|
|
meillo@56
|
382 a trailing newline character).</p>
|
|
meillo@56
|
383
|
|
meillo@56
|
384 <p>When it is set to <b>pipe</b>, MasqMail calls the executable given by
|
|
meillo@56
|
385 the <b>online_pipe</b> option (see below) and reads the current online
|
|
meillo@56
|
386 status from its standard output.</p>
|
|
meillo@56
|
387
|
|
meillo@56
|
388 <p>When it is set to <b>mserver</b>, MasqMail connects to the
|
|
meillo@56
|
389 masqdialer server using the value of <b>mserver_iface</b> and asks it
|
|
meillo@56
|
390 whether a connection exists and for the name, which should be the name
|
|
meillo@56
|
391 of the current connection as defined with <b>connect_route.<em>name</em></b>.</p>
|
|
meillo@56
|
392
|
|
meillo@56
|
393 <p>No matter how MasqMail detects the online status, only messages
|
|
meillo@56
|
394 that are accepted at online time will be delivered using the
|
|
meillo@56
|
395 connection. The spool still has to be emptied with masqmail <b>-qo</b>
|
|
meillo@56
|
396 <em>connection</em>.</p>
|
|
meillo@56
|
397
|
|
meillo@56
|
398
|
|
meillo@56
|
399
|
|
meillo@56
|
400
|
|
meillo@56
|
401 <p><b>online_file = <em>file</em></b></p>
|
|
meillo@56
|
402
|
|
meillo@56
|
403 <p>This is the name of the file checked for when MasqMail determines
|
|
meillo@56
|
404 whether it is online. The file should only exist when there is
|
|
meillo@56
|
405 currently a connection. Create it in your ip-up script with eg.</p>
|
|
meillo@56
|
406
|
|
meillo@56
|
407 <p>echo -n <name> > /tmp/connect_route</p>
|
|
meillo@56
|
408 <p>chmod 0644 /tmp/connect_route</p>
|
|
meillo@56
|
409
|
|
meillo@56
|
410 <p>Do not forget to delete it in your ip-down script.</p>
|
|
meillo@56
|
411
|
|
meillo@56
|
412
|
|
meillo@56
|
413
|
|
meillo@56
|
414
|
|
meillo@56
|
415 <p><b>online_pipe = <em>file</em></b></p>
|
|
meillo@56
|
416
|
|
meillo@56
|
417 <p>This is the name of the executable which will be called to determine
|
|
meillo@56
|
418 the online status. This executable should just print the name oif the current
|
|
meillo@56
|
419 connection to the standard output and return a zero status code. masqmail assumes
|
|
meillo@56
|
420 it is offline if the script returns with a non zero status. Simple example:</p>
|
|
meillo@56
|
421
|
|
meillo@56
|
422 <p>#!/bin/sh</p>
|
|
meillo@56
|
423 <p></p>
|
|
meillo@56
|
424 <p>[ -e /tmp/connect_route ] || exit 1</p>
|
|
meillo@56
|
425 <p>cat /tmp/connect_route</p>
|
|
meillo@56
|
426 <p>exit 0</p>
|
|
meillo@56
|
427
|
|
meillo@56
|
428 <p>Of course, instead of the example above you could as well use <b>file</b> as
|
|
meillo@56
|
429 the online detection method, but you can do something more sophisticated.</p>
|
|
meillo@56
|
430
|
|
meillo@56
|
431
|
|
meillo@56
|
432
|
|
meillo@56
|
433
|
|
meillo@56
|
434 <p><b>mserver_iface = <em>interface</em></b></p>
|
|
meillo@56
|
435
|
|
meillo@56
|
436 <p>The interface the masqdialer server is listening to. Usually this
|
|
meillo@56
|
437 will be "localhost:224" if mserver is running on the same host as
|
|
meillo@56
|
438 masqmail. But using this option, you can also let masqmail run on
|
|
meillo@56
|
439 another host by setting <b>mserver_iface</b> to another hostname,
|
|
meillo@56
|
440 eg. "foo:224".</p>
|
|
meillo@56
|
441
|
|
meillo@56
|
442
|
|
meillo@56
|
443
|
|
meillo@56
|
444
|
|
meillo@56
|
445 <p><b>get.<em>name</em> = <em>file</em></b></p>
|
|
meillo@56
|
446
|
|
meillo@56
|
447 <p>Replace <em>name</em> with a name to identify a get
|
|
meillo@56
|
448 configuration. Set this to a filename for the get configuration. These
|
|
meillo@56
|
449 files will be used to retrieve mail when called with the -g option.</p>
|
|
meillo@56
|
450
|
|
meillo@56
|
451
|
|
meillo@56
|
452
|
|
meillo@56
|
453
|
|
meillo@56
|
454 <p><b>online_gets.<em>name</em> = <em>list</em></b></p>
|
|
meillo@56
|
455
|
|
meillo@56
|
456 <p>Replace <em>name</em> with a name to identify an online
|
|
meillo@56
|
457 configuration. Set this to a filename (or a list of filenames) for the get configuration. These
|
|
meillo@56
|
458 files will be used to retrieve mail when called with the -go option.</p>
|
|
meillo@56
|
459
|
|
meillo@56
|
460
|
|
meillo@56
|
461
|
|
meillo@56
|
462
|
|
meillo@56
|
463 <p><b>ident_trusted_nets = <em>list</em></b></p>
|
|
meillo@56
|
464
|
|
meillo@56
|
465 <p><em>list</em> is a list of networks of the form a.b.c.d/e
|
|
meillo@56
|
466 (eg. 192.168.1.0/24), from which the ident given by the ident protocol
|
|
meillo@56
|
467 will be trusted, so a user can delete his mail from the queue if the
|
|
meillo@56
|
468 ident is identical to his login name.</p>
|
|
meillo@56
|
469
|
|
meillo@56
|
470
|
|
meillo@56
|
471
|
|
meillo@56
|
472
|
|
meillo@56
|
473 <p><b>errmsg_file = <em>file</em></b></p>
|
|
meillo@56
|
474
|
|
meillo@56
|
475 <p>Set this to a template which will be used to generate delivery failure
|
|
meillo@56
|
476 reports. Variable parts within the template begin with a dollar sign and
|
|
meillo@56
|
477 are identical to those which can be used as arguments for the mda command,
|
|
meillo@56
|
478 see <b>mda</b> above. Additional information can be included with
|
|
meillo@56
|
479 @failed_rcpts, @msg_headers and @msg_body, these must be at the
|
|
meillo@56
|
480 beginning of a line and will be replaced with the list of the failed recipients,
|
|
meillo@56
|
481 the message headers and the message body of the failed message.</p>
|
|
meillo@56
|
482 <p>Default is /usr/share/masqmail/tpl/failmsg.tpl.</p>
|
|
meillo@56
|
483
|
|
meillo@56
|
484
|
|
meillo@56
|
485
|
|
meillo@56
|
486
|
|
meillo@56
|
487 <p><b>warnmsg_file = <em>file</em></b></p>
|
|
meillo@56
|
488
|
|
meillo@56
|
489 <p>Set this to a template which will be used to generate delivery warning
|
|
meillo@56
|
490 reports. It uses the same mechanisms for variables as <b>errmsg_file</b>,
|
|
meillo@56
|
491 see above.
|
|
meillo@56
|
492 </p>
|
|
meillo@56
|
493 <p>Default is /usr/share/masqmail/tpl/warnmsg.tpl.</p>
|
|
meillo@56
|
494
|
|
meillo@56
|
495
|
|
meillo@56
|
496
|
|
meillo@56
|
497
|
|
meillo@56
|
498 <p><b>warn_intervals</b> = <em>list</em></p>
|
|
meillo@56
|
499
|
|
meillo@56
|
500 <p>Set this to a list of time intervals, at which delivery warnings (starting
|
|
meillo@56
|
501 with the receiving time of the message) shall be generated.</p>
|
|
meillo@56
|
502 <p>A warning will only be generated just after an attempt to deliver the
|
|
meillo@56
|
503 mail and if that attempt failed temporarily. So a warning may be generated after
|
|
meillo@56
|
504 a longer time, if there was no attempt before.</p>
|
|
meillo@56
|
505 <p>Default is "1h;4h;8h;1d;2d;3d"</p>
|
|
meillo@56
|
506
|
|
meillo@56
|
507
|
|
meillo@56
|
508
|
|
meillo@56
|
509
|
|
meillo@56
|
510 <p><b>max_defer_time</b> = <em>time</em></p>
|
|
meillo@56
|
511
|
|
meillo@56
|
512 <p>This is the maximum time, in which a temporarily failed mail will be kept
|
|
meillo@56
|
513 in the spool. When this time is exceeded, it will be handled as a delivery failure,
|
|
meillo@56
|
514 and the message will be bounced.</p>
|
|
meillo@56
|
515 <p>The excedence of this time will only be noticed if the message was actually
|
|
meillo@56
|
516 tried to be delivered. If, for example, the message can only be delivered when
|
|
meillo@56
|
517 online, but you have not been online for that time, no bounce will be generated.</p>
|
|
meillo@56
|
518 <p>Default is 4d (4 days)</p>
|
|
meillo@56
|
519
|
|
meillo@56
|
520
|
|
meillo@56
|
521
|
|
meillo@56
|
522
|
|
meillo@56
|
523 <p><b>log_user = <em>name</em></b></p>
|
|
meillo@56
|
524
|
|
meillo@56
|
525 <p>Replace <em>name</em> with a valid local or remote mail address.</p>
|
|
meillo@56
|
526 <p>If this option is not empty, then a copy of every mail,
|
|
meillo@56
|
527 that passes trough the masqmail system will also be sent to the
|
|
meillo@56
|
528 given mail address.</p>
|
|
meillo@56
|
529 <p>For example you can feed your mails into a program like hypermail for
|
|
meillo@56
|
530 archiving purpose by placing an appropriate pipe command in masqmail.alias</p>
|
|
meillo@56
|
531
|
|
meillo@56
|
532
|
|
meillo@56
|
533
|
|
meillo@56
|
534
|
|
meillo@56
|
535
|
|
meillo@56
|
536 <h2>Author</h2>
|
|
meillo@56
|
537
|
|
meillo@56
|
538 <p>masqmail was written by Oliver Kurth
|
|
meillo@56
|
539 <oku@masqmail.cx></p><p>You will find the newest version of
|
|
meillo@56
|
540 masqmail at <a href = "http://masqmail.cx/masqmail/">http://masqmail.cx/masqmail/</a> or search for it
|
|
meillo@56
|
541 in freshmeat (<a href = "http://www.freshmeat.net">http://www.freshmeat.net</a>). There is also a mailing list,
|
|
meillo@56
|
542 you will find information about it at masqmails main site.</p>
|
|
meillo@56
|
543
|
|
meillo@56
|
544
|
|
meillo@56
|
545
|
|
meillo@56
|
546 <h2>Bugs</h2>
|
|
meillo@56
|
547
|
|
meillo@56
|
548 <p>You should report them to the mailing list.</p>
|
|
meillo@56
|
549
|
|
meillo@56
|
550
|
|
meillo@56
|
551
|
|
meillo@56
|
552 <h2>See also</h2>
|
|
meillo@56
|
553
|
|
meillo@56
|
554 <p>
|
|
meillo@56
|
555 <a href="masqmail.8.html">masqmail</a>, <a href="masqmail.route.5.html">masqmail.route</a>, <a href="masqmail.get.5.html">masqmail.get</a>
|
|
meillo@56
|
556 </p>
|
|
meillo@56
|
557
|
|
meillo@56
|
558
|
|
meillo@56
|
559
|
|
meillo@56
|
560
|
|
meillo@56
|
561 <h2>Comments</h2>
|
|
meillo@56
|
562
|
|
meillo@56
|
563 <p>This man page was written using <a href="http://masqmail.cx/xml2man/">xml2man</a> by the same
|
|
meillo@56
|
564 author.</p>
|
|
meillo@56
|
565
|
|
meillo@56
|
566
|
|
meillo@56
|
567
|
|
meillo@56
|
568 </td></tr></table></center>
|
|
meillo@56
|
569 </body>
|
