masqmail
view man/masqmail.conf.5 @ 166:0ef0f756280b
moved the PPP setup documentation from INSTALL to an own file
| author | meillo@marmaro.de |
|---|---|
| date | Thu, 08 Jul 2010 22:02:58 +0200 |
| parents | 6dd3a289989b |
| children | 25b769efafe6 |
line source
1 .TH masqmail.conf 5 2010-07-06 masqmail-0.2.25 "File Formats"
3 .SH NAME
4 masqmail.conf \- masqmail configuration file
7 .SH DESCRIPTION
9 This man page describes the syntax of the main configuration file of masqmail.
10 Its usual location is \fI/etc/masqmail/masqmail.conf\fR
12 The configuration consists of lines of the form
14 \fBval\fR = \fIexpression\fR
16 Where \fBval\fR is a variable name and \fIexpression\fR a string,
17 which can be quoted with double quotes `"'.
18 If the expression is on multiple lines or contains characters other than letters,
19 digits or the characters `.', `-', `_', `/', ';', '@', ':' it must be quoted.
20 You can use quotes inside quotes by escaping them with a backslash.
22 Each val has a type, which can be boolean, numeric, string or list.
23 A boolean variable can be set with one of the values `on', `yes', and `true' or `off', `no' and `false'.
24 List items are separated with semicolons `;'.
25 For some values patterns (like `*',`?') can be used.
26 The spaces before and after the equal sign `=' are optional.
28 Most lists (exceptions: \fBlocal_hosts\fR, \fBlocal_nets\fR, \fBlisten_addresses\fR,
29 \fBonline_routes\fR, and \fBonline_gets\fR) accept files.
30 These will be recognized by a leading slash `/'.
31 The contents of these files will be included at the position of the file name,
32 there can be items or other files before and after the file entry.
33 The format of the files is different though, within these files each entry is on another line.
34 (And not separated by semicolons).
35 This makes it easy to include large lists which are common in different configuration files,
36 so they do not have to appear in every configuration file.
38 Blank lines and lines starting with a hash `#' are ignored.
41 .SH OPTIONS
43 .TP
44 \fBrun_as_user = \fIboolean\fR
46 If this is set, masqmail runs with the user id of the user who invoked it and never changes it.
47 This is for debugging purposes only.
48 If the user is not root, masqmail will not be able to listen on a port < 1024
49 and will not be able to deliver local mail to others than the user.
51 .TP
52 \fBuse_syslog = \fIboolean\fR
54 If this is set, masqmail uses syslogd for logging.
55 It uses facility MAIL.
56 You still have to set \fBlog_dir\fR for debug files.
58 .TP
59 \fBdebug_level = \fIn\fR
61 Set the debug level.
62 Valid values are 0 to 6, increasing it further makes no difference.
63 Be careful if you set this as high as 5 or higher, the logs may very soon fill your hard drive.
65 .TP
66 \fBlog_dir = \fIfile\fR
68 The directory where log are stored, if syslog is not used.
69 Debug files are stored in this directory anyways.
70 \fIfile\fR must be an absolute path.
72 Default: \fI/var/log/masqmail\fR
74 .TP
75 \fBmail_dir = \fIfile\fR
77 The directory where local mail is stored, usually \fI/var/spool/mail\fR or \fI/var/mail\fR.
78 \fIfile\fR must be an absolute path.
80 Default: \fI/var/mail\fR
82 .TP
83 \fBspool_dir = \fIfile\fR
85 The directory where masqmail stores its spool files (and later also other stuff).
86 It must have a subdirectory \fIinput\fR.
87 Masqmail needs read and write permissions for this directory.
88 \fIfile\fR must be an absolute path.
90 Default: \fI/var/spool/masqmail\fR
92 .TP
93 \fBlock_dir = \fIfile\fR
95 The directory where masqmail stores its lock files.
96 Masqmail needs read and write permissions for this directory.
97 By default it is a directory ``lock'' inside of \fIspool_dir\fP.
98 \fIfile\fR must be an absolute path.
100 .TP
101 \fBhost_name = \fIstring\fR
103 This is used in different places: Masqmail identifies itself in the greeting banner
104 on incoming connections and in the HELO/EHLO command for outgoing connections with this name,
105 it is used in the Received: header and to qualify the sender of a locally originating message.
107 If the string begins with a slash `/', it it assumed that it is a filename,
108 and the first line of this file will be used.
109 Usually this will be `/etc/mailname' to make masqmail conform to Debian policies.
111 It is not used to find whether an address is local. Use \fBlocal_hosts\fR for that.
113 Default: none; \fBhost_name\fP MUST be set in the config file
115 .TP
116 \fBremote_port = \fIn\fR
118 The remote port number to be used. This defaults to port 25.
120 This option is deprecated.
121 Use \fBhost_name\fR in the route configuration instead.
122 See \fBmasqmail.route(5)\fR.
124 .TP
125 \fBlocal_hosts = \fIlist\fR
127 A semicolon `;' separated list of hostnames which are considered local.
128 Normally you should set it to "localhost;foo;foo.bar.com" if your host has the
129 fully qualified domain name `foo.bar.com'.
131 Default: localhost ; <value of \fBhost_name\fR cut at the first dot> ; <value of \fBhost_name\fR>
133 Example: \fIlocalhost;foo;foo.example.org\fR
134 (if you have set \fBhost_name\fR to \fIfoo.example.org\fR)
136 .TP
137 \fBlocal_nets = \fIlist\fR
139 A semicolon `;' separated list of hostnames which are on the `local' net.
140 Delivery to these hosts is attempted immediately.
141 You can use patterns with `*', e.g. "*.bar.com".
143 .TP
144 \fBlocal_addresses = \fIlist\fR
146 A semicolon `;' separated list of fully qualified email-addresses which are
147 considered local although their domain name part is not in the list of \fBlocal_hosts\fR.
149 For example: There are two people working at your LAN: person1@yourdomain and person2@yourdomain.
150 But there are other persons @yourdomain which are NOT local.
151 So you can not put yourdomain to the list of local_hosts.
152 If person1 now wants to write to person2@yourdomain and this mail should not leave the LAN then you can put
154 local_addresses = "person1@yourdomain;person2@yourdomain"
156 to your masqmail.conf.
158 .TP
159 \fBnot_local_addresses = \fIlist\fR
161 A semicolon `;' separated list of fully qualified email-addresses which are
162 considered not local although their domain name part is in the list of \fBlocal_hosts\fR.
164 This is the opposite of the previous case.
165 The majority of addresses of a specific domain are local.
166 But some users are not.
167 With this option you can easily exclude these users.
169 Example:
171 local_hosts = "localhost;myhost;mydomain.net"
173 not_local_addresses = "eric@mydomain.net"
175 .TP
176 \fBlisten_addresses = \fIlist\fR
178 A semicolon `;' separated list of interfaces on which connections will be accepted.
179 An interface ist defined by a hostname, optionally followed by a colon `:' and a number for the port.
180 If this is left out, port 25 will be used.
182 You can set this to "localhost:25;foo:25" if your hostname is `foo'.
184 Note that the names are resolved to IP addreses.
185 If your host has different names which resolve to the same IP,
186 use only one of them, otherwise you will get an error message.
188 Default: \fIlocalhost:25\fR (i.e. only local processes can connect)
190 .TP
191 \fBdo_save_envelope_to = \fIboolean\fR
193 If this is set to true, a possibly existing Envelope-to: header in an incoming mail
194 which is received via either pop3 or smtp will be saved as an X-Orig-Envelope-to: header.
196 This is useful if you retrieve mail from a pop3 server with either masqmail or fetchmail,
197 and the server supports Envelope-to: headers,
198 and you want to make use of those with a mail filtering tool, e.g. procmail.
199 It cannot be preserved because masqmail sets such a header by itself.
201 Default is false.
203 .TP
204 \fBdo_relay = \fIboolean\fR
206 If this is set to false, mail with a return path that is not local and a destination
207 that is also not local will not be accepted via smtp and a 550 reply will be given.
208 Default is true.
210 Note that this will not protect you from spammers using open relays,
211 but from users unable to set their address in their mail clients.
213 .TP
214 \fBdo_queue = \fIboolean\fR
216 If this is set, mail will not be delivered immediately when accepted.
217 Same as calling masqmail with the \fB\-odq\fR option.
219 .TP
220 \fBonline_routes.\fIname\fR = \fIlist\fR
222 Replace \fIname\fR with a name to identify a connection.
223 Set this to a filename (or a list of filenames) for the special route configuration for that connection.
224 You will use that name to call masqmail with the \fB\-qo\fR option every time a
225 connection to your ISP is set up.
227 Example: Your ISP has the name FastNet.
228 Then you write the following line in the main configuration:
230 \fBonline_routes.FastNet\fR = \fI"/etc/masqmail/fastnet.route"\fR
232 \fI/etc/masqmail/fastnet.route\fR is the route configuration file, see \fBmasqmail.route(5)\fR.
233 As soon as a link to FastNet has been set up, you call masqmail \fB\-qo \fIFastNet\fR.
234 Masqmail will then read the specified file and send the mails.
236 .TP
237 \fBconnect_route.\fIname\fR = \fIlist\fR
239 Old name for \fBonline_routes\fR.
241 .TP
242 \fBlocal_net_route = \fIfile\fR
244 This is similar to \fBonline_routes.\fIname\fR but for the local net.
245 Recipient addresses that are in local_nets will be routed using this route configuration.
246 Main purpose is to define a mail server with mail_host in your local network.
247 In simple environments this can be left unset.
248 If unset, a default route configuration will be used.
250 .TP
251 \fBalias_file = \fIfile\fR
253 Set this to the location of your alias file.
254 If unset, no aliasing will be done.
256 .TP
257 \fBalias_local_caseless = \fIboolean\fR
259 If this is set, local parts in the alias file will be matched disregarding upper/lower case.
261 .TP
262 \fBpipe_fromline = \fIboolean\fR
264 If this is set, a from line will be prepended to the output stream whenever
265 a pipe command is called after an alias expansion.
266 Default is false.
268 .TP
269 \fBpipe_fromhack = \fIboolean\fR
271 If this is set, each line beginning with `From ' is replaced with `>From '
272 whenever a pipe command is called after an alias expansion.
273 You probably want this if you have set \fBpipe_fromline\fR above.
274 Default is false.
276 .TP
277 \fBmbox_default = \fIstring\fR
279 The default local delivery method.
280 Can be one of mbox, mda or maildir (the latter only if maildir support is enabled at compile time).
281 Default is mbox.
282 You can override this for each user by using the \fBmbox_users\fR, \fBmda_users\fR,
283 or \fBmaildir_users\fR options (see below).
285 .TP
286 \fBmbox_users = \fIlist\fR
288 A list of users which wish delivery to an mbox style mail folder.
290 .TP
291 \fBmda_users = \fIlist\fR
293 A list of users which wish local delivery to an mda.
294 You have to set \fBmda\fR (see below) as well.
296 .TP
297 \fBmaildir_users = \fIlist\fR
299 A list of users which wish delivery to a qmail style maildir.
300 The path to maildir is ~/Maildir/.
301 The maildir will be created if it does not exist.
303 .TP
304 \fBmda = \fIexpand string\fR
306 If you want local delivery to be transferred to an mda (Mail Delivery Agent),
307 set this to a command.
308 The argument will be expanded on delivery time,
309 you can use variables beginning with a dolloar sign `$', optionally enclosed in curly braces.
310 Variables you can use are:
312 uid - the unique message id.
313 This is not necessarily identical with the Message ID as given in the Message ID: header.
315 received_host - the host the mail was received from
317 ident - the ident, this is either the ident delivered by the ident protocol
318 or the user id of the sender if the message was received locally.
320 return_path_local - the local part of the return path (sender).
322 return_path_domain - the domain part of the return path (sender).
324 return_path - the complete return path (sender).
326 rcpt_local - the local part of the recipient.
328 rcpt_domain - the domain part of the recipient.
330 rcpt - the complete recipient address.
332 Example:
334 mda="/usr/bin/procmail \-Y \-d ${rcpt_local}"
336 For the mda, as for pipe commands, a few environment variables will be set as well.
337 See \fBmasqmail(8)\fR.
338 To use environment variables for the mda, the dollar sign `$' has to be escaped with a backslash,
339 otherwise they will be tried to be expanded with the internal variables.
341 .TP
342 \fBmda_fromline = \fIboolean\fR
344 If this is set, a from line will be prepended to the output stream whenever
345 a message is delivered to an mda.
346 Default is false.
348 .TP
349 \fBmda_fromhack = \fIboolean\fR
351 If this is set, each line beginning with `From ' is replaced with `>From '
352 whenever a message is delivered to an mda.
353 You probably want this if you have set \fBmda_fromline\fR above.
354 Default is false.
356 .TP
357 \fBonline_detect = \fIstring\fR
359 Defines the method masqmail uses to detect whether there is currently an online connection.
360 It can have the values \fIfile\fR or \fIpipe\fR.
362 When it is set to \fIfile\fR, masqmail first checks for the existence of \fBonline_file\fR
363 (see below) and if it exists, it reads it.
364 The content of the file should be the name of the current connection as defined
365 with \fBconnect_route.\fIname\fR (trailing whitespace is removed).
367 When it is set to \fIpipe\fR, masqmail calls the executable given by the
368 \fBonline_pipe\fR option (see below) and reads the current online status from its standard output.
370 No matter how masqmail detects the online status,
371 only messages that are accepted at online time will be delivered using the connection.
372 The spool still has to be emptied with masqmail \fB\-qo\fIconnection\fR.
374 .TP
375 \fBonline_file = \fIfile\fR
377 This is the name of the file checked for when masqmail determines whether it is online.
378 The file should only exist when there is currently a connection.
379 Create it in your ip-up script with e.g.
381 echo "connection-name" >/var/run/masqmail/masqmail-route
383 chmod 0644 /var/run/masqmail/masqmail-route
385 Do not forget to delete it in your ip-down script.
387 .TP
388 \fBonline_pipe = \fIfile\fR
390 This is the name of the executable which will be called to determine the online status.
391 This executable should just print the name of the current connection to
392 the standard output and return a zero status code.
393 masqmail assumes it is offline if the script returns with a non zero status.
394 Simple example:
396 #!/bin/sh
398 [ \-e /var/run/masqmail/masqmail-route ] || exit 1
400 cat /var/run/masqmail/masqmail-route
402 exit 0
404 Of course, instead of the example above you could as well use \fIfile\fR as
405 the online detection method, but you can do something more sophisticated.
407 \fIfile\fR must contain an absolute path to an executable program.
408 It can contain optional arguments.
410 Example: \fI/bin/echo foo\fR
411 (This tells masqmail to be always online with connection `foo'.)
413 For querying a masqdialer server
414 (= asking it whether a connection exists and what its name is)
415 use:
417 online_method=pipe
419 online_pipe="/usr/bin/mservdetect localhost 224"
422 .TP
423 \fBget.\fIname\fR = \fIfile\fR
425 Replace \fIname\fR with a name to identify a get configuration.
426 Set this to a filename for the get configuration.
427 These files will be used to retrieve mail when called with the \-g option.
429 .TP
430 \fBonline_gets.\fIname\fR = \fIlist\fR
432 Replace \fIname\fR with a name to identify an online configuration.
433 Set this to a filename (or a list of filenames) for the get configuration.
434 These files will be used to retrieve mail when called with the \-go option.
436 .TP
437 \fBident_trusted_nets = \fIlist\fR
439 \fIlist\fR is a list of networks of the form a.b.c.d/e (e.g. 192.168.1.0/24),
440 from which the ident given by the ident protocol will be trusted,
441 so a user can delete his mail from the queue if the ident is identical to his login name.
443 .TP
444 \fBerrmsg_file = \fIfile\fR
446 Set this to a template which will be used to generate delivery failure reports.
447 Variable parts within the template begin with a dollar sign and are identical
448 to those which can be used as arguments for the mda command, see \fBmda\fR above.
449 Additional information can be included with @failed_rcpts, @msg_headers and @msg_body,
450 these must be at the beginning of a line and will be replaced with the list of the failed recipients,
451 the message headers and the message body of the failed message.
453 Default is /usr/share/masqmail/tpl/failmsg.tpl.
455 .TP
456 \fBwarnmsg_file = \fIfile\fR
458 Set this to a template which will be used to generate delivery warning reports.
459 It uses the same mechanisms for variables as \fBerrmsg_file\fR, see above.
461 Default is /usr/share/masqmail/tpl/warnmsg.tpl.
463 .TP
464 \fBwarn_intervals\fR = \fIlist\fR
466 Set this to a list of time intervals, at which delivery warnings
467 (starting with the receiving time of the message) shall be generated.
469 A warning will only be generated just after an attempt to deliver the mail
470 and if that attempt failed temporarily.
471 So a warning may be generated after a longer time, if there was no attempt before.
473 Default is "1h;4h;8h;1d;2d;3d"
475 .TP
476 \fBmax_defer_time\fR = \fItime\fR
478 This is the maximum time, in which a temporarily failed mail will be kept in the spool.
479 When this time is exceeded, it will be handled as a delivery failure,
480 and the message will be bounced.
482 The excedence of this time will only be noticed if the message was actually tried to be delivered.
483 If, for example, the message can only be delivered when online,
484 but you have not been online for that time, no bounce will be generated.
486 Default is 4d (4 days)
488 .TP
489 \fBlog_user = \fIname\fR
491 Replace \fIname\fR with a valid local or remote mail address.
493 If this option is set, then a copy of every mail,
494 that passes through the masqmail system will also be sent to the given mail address.
496 For example you can feed your mails into a program like hypermail
497 for archiving purpose by placing an appropriate pipe command in masqmail.alias
499 .TP
500 \fBmax_msg_size\fR = \fIbytes\fR
502 This option sets the maximum size in bytes masqmail will accept for delivery.
503 This value is advertised to the SMTP client by the `SIZE' message during SMTP
504 session setup.
505 Clients pretending to send, or actually send,
506 more than \fIbytes\fR will get a 552 error message.
508 `0' means no fixed maximum size limit is in force.
510 Default is 0 (= unlimited).
512 .TP
513 \fBdefer_all\fR = \fIboolean\fR
515 If set to true, masqmail replies with ``421 service temporarily unavailable''
516 to any SMTP request and shuts the connection down.
517 Note: This option is for debugging purposes only.
519 Default: false
522 .SH AUTHOR
524 Masqmail was written by Oliver Kurth.
525 It is now maintained by Markus Schnalke <meillo@marmaro.de>.
527 You will find the newest version of masqmail at \fBhttp://marmaro.de/prog/masqmail/\fR.
528 There is also a mailing list, you will find information about it at masqmail's main site.
531 .SH BUGS
533 Please report bugs to the mailing list.
536 .SH SEE ALSO
538 \fBmasqmail(8)\fR, \fBmasqmail.route(5)\fR, \fBmasqmail.get(5)\fR