masqmail
view man/masqmail.conf.5 @ 151:e20fe8c9936a
default values for logdir and spooldir
we also have defines for LOG_DIR and SPOOL_DIR now
| author | meillo@marmaro.de |
|---|---|
| date | Wed, 07 Jul 2010 10:32:00 +0200 |
| parents | 4d32eb75d3bc |
| children | dfb6143e7832 |
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 .TP
81 \fBspool_dir = \fIfile\fR
83 The directory where masqmail stores its spool files (and later also other stuff).
84 It must have a subdirectory \fIinput\fR.
85 Masqmail needs read and write permissions for this directory.
86 \fIfile\fR must be an absolute path.
88 Default: \fI/var/spool/masqmail\fR
90 .TP
91 \fBlock_dir = \fIfile\fR
93 The directory where masqmail stores its lock files.
94 Masqmail needs read and write permissions for this directory.
95 By default it is a directory ``lock'' inside of \fIspool_dir\fP.
96 \fIfile\fR must be an absolute path.
98 .TP
99 \fBhost_name = \fIstring\fR
101 This is used in different places: Masqmail identifies itself in the greeting banner
102 on incoming connections and in the HELO/EHLO command for outgoing connections with this name,
103 it is used in the Received: header and to qualify the sender of a locally originating message.
105 If the string begins with a slash `/', it it assumed that it is a filename,
106 and the first line of this file will be used.
107 Usually this will be `/etc/mailname' to make masqmail conform to Debian policies.
109 It is not used to find whether an address is local. Use \fBlocal_hosts\fR for that.
111 .TP
112 \fBremote_port = \fIn\fR
114 The remote port number to be used. This defaults to port 25.
116 This option is deprecated.
117 Use \fBhost_name\fR in the route configuration instead.
118 See \fBmasqmail.route(5)\fR.
120 .TP
121 \fBlocal_hosts = \fIlist\fR
123 A semicolon `;' separated list of hostnames which are considered local.
124 Normally you set it to "localhost;foo;foo.bar.com" if your host has the
125 fully qualified domain name `foo.bar.com'.
127 .TP
128 \fBlocal_nets = \fIlist\fR
130 A semicolon `;' separated list of hostnames which are on the `local' net.
131 Delivery to these hosts is attempted immediately.
132 You can use patterns with `*', e.g. "*.bar.com".
134 .TP
135 \fBlocal_addresses = \fIlist\fR
137 A semicolon `;' separated list of fully qualified email-addresses which are
138 considered local although their domain name part is not in the list of \fBlocal_hosts\fR.
140 For example: There are two people working at your LAN: person1@yourdomain and person2@yourdomain.
141 But there are other persons @yourdomain which are NOT local.
142 So you can not put yourdomain to the list of local_hosts.
143 If person1 now wants to write to person2@yourdomain and this mail should not leave the LAN then you can put
145 local_addresses = "person1@yourdomain;person2@yourdomain"
147 to your masqmail.conf.
149 .TP
150 \fBnot_local_addresses = \fIlist\fR
152 A semicolon `;' separated list of fully qualified email-addresses which are
153 considered not local although their domain name part is in the list of \fBlocal_hosts\fR.
155 This is the opposite of the previous case.
156 The majority of addresses of a specific domain are local.
157 But some users are not.
158 With this option you can easily exclude these users.
160 Example:
162 local_hosts = "localhost;myhost;mydomain.net"
164 not_local_addresses = "eric@mydomain.net"
166 .TP
167 \fBlisten_addresses = \fIlist\fR
169 A semicolon `;' separated list of interfaces on which connections will be accepted.
170 An interface ist defined by a hostname, optionally followed by a colon `:' and a number for the port.
171 If this is left out, port 25 will be used.
173 You can set this to "localhost:25;foo:25" if your hostname is `foo'.
175 Note that the names are resolved to IP addreses.
176 If your host has different names which resolve to the same IP,
177 use only one of them, otherwise you will get an error message.
179 .TP
180 \fBdo_save_envelope_to = \fIboolean\fR
182 If this is set to true, a possibly existing Envelope-to: header in an incoming mail
183 which is received via either pop3 or smtp will be saved as an X-Orig-Envelope-to: header.
185 This is useful if you retrieve mail from a pop3 server with either masqmail or fetchmail,
186 and the server supports Envelope-to: headers,
187 and you want to make use of those with a mail filtering tool, e.g. procmail.
188 It cannot be preserved because masqmail sets such a header by itself.
190 Default is false.
192 .TP
193 \fBdo_relay = \fIboolean\fR
195 If this is set to false, mail with a return path that is not local and a destination
196 that is also not local will not be accepted via smtp and a 550 reply will be given.
197 Default is true.
199 Note that this will not protect you from spammers using open relays,
200 but from users unable to set their address in their mail clients.
202 .TP
203 \fBdo_queue = \fIboolean\fR
205 If this is set, mail will not be delivered immediately when accepted.
206 Same as calling masqmail with the \fB\-odq\fR option.
208 .TP
209 \fBonline_routes.\fIname\fR = \fIlist\fR
211 Replace \fIname\fR with a name to identify a connection.
212 Set this to a filename (or a list of filenames) for the special route configuration for that connection.
213 You will use that name to call masqmail with the \fB\-qo\fR option every time a
214 connection to your ISP is set up.
216 Example: Your ISP has the name FastNet.
217 Then you write the following line in the main configuration:
219 \fBonline_routes.FastNet\fR = \fI"/etc/masqmail/fastnet.route"\fR
221 \fI/etc/masqmail/fastnet.route\fR is the route configuration file, see \fBmasqmail.route(5)\fR.
222 As soon as a link to FastNet has been set up, you call masqmail \fB\-qo \fIFastNet\fR.
223 Masqmail will then read the specified file and send the mails.
225 .TP
226 \fBconnect_route.\fIname\fR = \fIlist\fR
228 Old name for \fBonline_routes\fR.
230 .TP
231 \fBlocal_net_route = \fIfile\fR
233 This is similar to \fBonline_routes.\fIname\fR but for the local net.
234 Recipient addresses that are in local_nets will be routed using this route configuration.
235 Main purpose is to define a mail server with mail_host in your local network.
236 In simple environments this can be left unset.
237 If unset, a default route configuration will be used.
239 .TP
240 \fBalias_file = \fIfile\fR
242 Set this to the location of your alias file.
243 If unset, no aliasing will be done.
245 .TP
246 \fBalias_local_caseless = \fIboolean\fR
248 If this is set, local parts in the alias file will be matched disregarding upper/lower case.
250 .TP
251 \fBpipe_fromline = \fIboolean\fR
253 If this is set, a from line will be prepended to the output stream whenever
254 a pipe command is called after an alias expansion.
255 Default is false.
257 .TP
258 \fBpipe_fromhack = \fIboolean\fR
260 If this is set, each line beginning with `From ' is replaced with `>From '
261 whenever a pipe command is called after an alias expansion.
262 You probably want this if you have set \fBpipe_fromline\fR above.
263 Default is false.
265 .TP
266 \fBmbox_default = \fIstring\fR
268 The default local delivery method.
269 Can be one of mbox, mda or maildir (the latter only if maildir support is enabled at compile time).
270 Default is mbox.
271 You can override this for each user by using the \fBmbox_users\fR, \fBmda_users\fR,
272 or \fBmaildir_users\fR options (see below).
274 .TP
275 \fBmbox_users = \fIlist\fR
277 A list of users which wish delivery to an mbox style mail folder.
279 .TP
280 \fBmda_users = \fIlist\fR
282 A list of users which wish local delivery to an mda.
283 You have to set \fBmda\fR (see below) as well.
285 .TP
286 \fBmaildir_users = \fIlist\fR
288 A list of users which wish delivery to a qmail style maildir.
289 The path to maildir is ~/Maildir/.
290 The maildir will be created if it does not exist.
292 .TP
293 \fBmda = \fIexpand string\fR
295 If you want local delivery to be transferred to an mda (Mail Delivery Agent),
296 set this to a command.
297 The argument will be expanded on delivery time,
298 you can use variables beginning with a dolloar sign `$', optionally enclosed in curly braces.
299 Variables you can use are:
301 uid - the unique message id.
302 This is not necessarily identical with the Message ID as given in the Message ID: header.
304 received_host - the host the mail was received from
306 ident - the ident, this is either the ident delivered by the ident protocol
307 or the user id of the sender if the message was received locally.
309 return_path_local - the local part of the return path (sender).
311 return_path_domain - the domain part of the return path (sender).
313 return_path - the complete return path (sender).
315 rcpt_local - the local part of the recipient.
317 rcpt_domain - the domain part of the recipient.
319 rcpt - the complete recipient address.
321 Example:
323 mda="/usr/bin/procmail \-Y \-d ${rcpt_local}"
325 For the mda, as for pipe commands, a few environment variables will be set as well.
326 See \fBmasqmail(8)\fR.
327 To use environment variables for the mda, the dollar sign `$' has to be escaped with a backslash,
328 otherwise they will be tried to be expanded with the internal variables.
330 .TP
331 \fBmda_fromline = \fIboolean\fR
333 If this is set, a from line will be prepended to the output stream whenever
334 a message is delivered to an mda.
335 Default is false.
337 .TP
338 \fBmda_fromhack = \fIboolean\fR
340 If this is set, each line beginning with `From ' is replaced with `>From '
341 whenever a message is delivered to an mda.
342 You probably want this if you have set \fBmda_fromline\fR above.
343 Default is false.
345 .TP
346 \fBonline_detect = \fIstring\fR
348 Defines the method masqmail uses to detect whether there is currently an online connection.
349 It can have the values \fIfile\fR, \fIpipe\fR, or \fImserver\fR.
351 When it is set to \fIfile\fR, masqmail first checks for the existence of \fBonline_file\fR
352 (see below) and if it exists, it reads it.
353 The content of the file should be the name of the current connection as defined
354 with \fBconnect_route.\fIname\fR (trailing whitespace is removed).
356 When it is set to \fIpipe\fR, masqmail calls the executable given by the
357 \fBonline_pipe\fR option (see below) and reads the current online status from its standard output.
359 When it is set to \fImserver\fR, masqmail connects to the masqdialer server
360 using the value of \fBmserver_iface\fR and asks it whether a connection exists and for the name,
361 which should be the name of the current connection as defined with \fBconnect_route.\fIname\fR.
362 \fBThe mserver detection method is OBSOLETE.\fR
363 See mserver_iface for a note on how to replace it.
365 No matter how masqmail detects the online status,
366 only messages that are accepted at online time will be delivered using the connection.
367 The spool still has to be emptied with masqmail \fB\-qo\fIconnection\fR.
369 .TP
370 \fBonline_file = \fIfile\fR
372 This is the name of the file checked for when masqmail determines whether it is online.
373 The file should only exist when there is currently a connection.
374 Create it in your ip-up script with e.g.
376 echo "connection-name" >/var/run/masqmail/masqmail-route
378 chmod 0644 /var/run/masqmail/masqmail-route
380 Do not forget to delete it in your ip-down script.
382 .TP
383 \fBonline_pipe = \fIfile\fR
385 This is the name of the executable which will be called to determine the online status.
386 This executable should just print the name of the current connection to
387 the standard output and return a zero status code.
388 masqmail assumes it is offline if the script returns with a non zero status.
389 Simple example:
391 #!/bin/sh
393 [ \-e /var/run/masqmail/masqmail-route ] || exit 1
395 cat /var/run/masqmail/masqmail-route
397 exit 0
399 Of course, instead of the example above you could as well use \fIfile\fR as
400 the online detection method, but you can do something more sophisticated.
402 .TP
403 \fBmserver_iface = \fIinterface\fR
405 \fBThis option is OBSOLETE\fP, use
407 online_method=pipe
409 online_pipe="/usr/bin/mservdetect localhost 222"
411 instead.
413 The interface the masqdialer server is listening to.
414 Usually this will be "localhost:224" if mserver is running on the same host as masqmail.
415 But using this option, you can also let masqmail run on another host by setting
416 \fBmserver_iface\fR to another hostname, e.g. "foo:224".
418 .TP
419 \fBget.\fIname\fR = \fIfile\fR
421 Replace \fIname\fR with a name to identify a get configuration.
422 Set this to a filename for the get configuration.
423 These files will be used to retrieve mail when called with the \-g option.
425 .TP
426 \fBonline_gets.\fIname\fR = \fIlist\fR
428 Replace \fIname\fR with a name to identify an online configuration.
429 Set this to a filename (or a list of filenames) for the get configuration.
430 These files will be used to retrieve mail when called with the \-go option.
432 .TP
433 \fBident_trusted_nets = \fIlist\fR
435 \fIlist\fR is a list of networks of the form a.b.c.d/e (e.g. 192.168.1.0/24),
436 from which the ident given by the ident protocol will be trusted,
437 so a user can delete his mail from the queue if the ident is identical to his login name.
439 .TP
440 \fBerrmsg_file = \fIfile\fR
442 Set this to a template which will be used to generate delivery failure reports.
443 Variable parts within the template begin with a dollar sign and are identical
444 to those which can be used as arguments for the mda command, see \fBmda\fR above.
445 Additional information can be included with @failed_rcpts, @msg_headers and @msg_body,
446 these must be at the beginning of a line and will be replaced with the list of the failed recipients,
447 the message headers and the message body of the failed message.
449 Default is /usr/share/masqmail/tpl/failmsg.tpl.
451 .TP
452 \fBwarnmsg_file = \fIfile\fR
454 Set this to a template which will be used to generate delivery warning reports.
455 It uses the same mechanisms for variables as \fBerrmsg_file\fR, see above.
457 Default is /usr/share/masqmail/tpl/warnmsg.tpl.
459 .TP
460 \fBwarn_intervals\fR = \fIlist\fR
462 Set this to a list of time intervals, at which delivery warnings
463 (starting with the receiving time of the message) shall be generated.
465 A warning will only be generated just after an attempt to deliver the mail
466 and if that attempt failed temporarily.
467 So a warning may be generated after a longer time, if there was no attempt before.
469 Default is "1h;4h;8h;1d;2d;3d"
471 .TP
472 \fBmax_defer_time\fR = \fItime\fR
474 This is the maximum time, in which a temporarily failed mail will be kept in the spool.
475 When this time is exceeded, it will be handled as a delivery failure,
476 and the message will be bounced.
478 The excedence of this time will only be noticed if the message was actually tried to be delivered.
479 If, for example, the message can only be delivered when online,
480 but you have not been online for that time, no bounce will be generated.
482 Default is 4d (4 days)
484 .TP
485 \fBlog_user = \fIname\fR
487 Replace \fIname\fR with a valid local or remote mail address.
489 If this option is set, then a copy of every mail,
490 that passes through the masqmail system will also be sent to the given mail address.
492 For example you can feed your mails into a program like hypermail
493 for archiving purpose by placing an appropriate pipe command in masqmail.alias
495 .TP
496 \fBmax_msg_size\fR = \fIbytes\fR
498 This option sets the maximum size in bytes masqmail will accept for delivery.
499 This value is advertised to the SMTP client by the `SIZE' message during SMTP
500 session setup.
501 Clients pretending to send, or actually send,
502 more than \fIbytes\fR will get a 552 error message.
504 `0' means no fixed maximum size limit is in force.
506 Default is 0 (= unlimited).
508 .TP
509 \fBdefer_all\fR = \fIboolean\fR
511 If set to true, masqmail replies with ``421 service temporarily unavailable''
512 to any SMTP request and shuts the connection down.
513 Note: This option is for debugging purposes only.
515 Default: false
518 .SH AUTHOR
520 Masqmail was written by Oliver Kurth.
521 It is now maintained by Markus Schnalke <meillo@marmaro.de>.
523 You will find the newest version of masqmail at \fBhttp://marmaro.de/prog/masqmail/\fR.
524 There is also a mailing list, you will find information about it at masqmail's main site.
527 .SH BUGS
529 Please report bugs to the mailing list.
532 .SH SEE ALSO
534 \fBmasqmail(8)\fR, \fBmasqmail.route(5)\fR, \fBmasqmail.get(5)\fR