masqmail
view man/masqmail.conf.5 @ 347:53cf6be5843a
Minor refactoring
| author | markus schnalke <meillo@marmaro.de> |
|---|---|
| date | Thu, 14 Jul 2011 11:15:27 +0200 |
| parents | fe00f7952a7c |
| children | 08932c629849 |
line source
1 .TH masqmail.conf 5 2011-08-27 masqmail-0.3.3 "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 \fBval\fP 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 in front of and after the equal sign `=' are optional.
28 Most lists (exceptions: \fBlocal_hosts\fR, \fBlocal_nets\fR, \fBlisten_addresses\fR,
29 and \fBonline_routes\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 the entries are 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 and 9.
63 Be careful if you set this as high as 5 or higher,
64 the logs may very soon fill your hard drive.
65 Level 9 enables printing of debug messages to stderr during reading of
66 the config file.
67 The debug file comes available for the first time after this step.
68 Thus nothing but stderr is available.
69 Level 9 is almost never interesting.
71 .TP
72 \fBlog_dir = \fIfile\fR
74 The directory where logs are stored, if syslog is not used.
75 Debug files are always stored in this directory if debugging is enabled.
76 \fIfile\fR must be an absolute path.
78 Default: \fI/var/log/masqmail\fR
80 .TP
81 \fBmail_dir = \fIfile\fR
83 The directory where local mail is stored, usually \fI/var/spool/mail\fR or \fI/var/mail\fR.
84 \fIfile\fR must be an absolute path.
86 Default: \fI/var/mail\fR
88 .TP
89 \fBspool_dir = \fIfile\fR
91 The directory where masqmail stores its spool files (and later also other stuff).
92 It must have a subdirectory \fIinput\fR.
93 Masqmail needs read and write permissions for this directory.
94 \fIfile\fR must be an absolute path.
96 Default: \fI/var/spool/masqmail\fR
98 .TP
99 \fBlock_dir = \fIfile\fR
101 The directory where masqmail stores its lock files.
102 Masqmail needs read and write permissions for this directory.
103 By default it is a directory ``lock'' inside of \fIspool_dir\fP.
104 \fIfile\fR must be an absolute path.
106 .TP
107 \fBhost_name = \fIstring\fR
109 This is used in different places: Masqmail identifies itself in the greeting banner
110 on incoming connections and in the HELO/EHLO command for outgoing connections with this name,
111 it is used in the Received: header and to qualify the sender of a locally originating message.
113 If the string begins with a slash `/', it it assumed that it is a filename,
114 and the first line of this file will be used.
115 Usually this will be `/etc/mailname' to make masqmail conform to Debian policies.
117 It is not used to find whether an address is local. Use \fBlocal_hosts\fR for that.
119 Default: none; \fBhost_name\fP MUST be set in the config file
121 .TP
122 \fBlocal_hosts = \fIlist\fR
124 A semicolon `;' separated list of hostnames which are considered local.
125 Normally you should set it to "localhost;foo;foo.bar.com" if your host has the
126 fully qualified domain name `foo.bar.com'.
128 Default: localhost ; <value of \fBhost_name\fR cut at the first dot> ; <value of \fBhost_name\fR>
130 Example: \fIlocalhost;foo;foo.example.org\fR
131 (if you have set \fBhost_name\fR to \fIfoo.example.org\fR)
133 .TP
134 \fBlocal_addresses = \fIlist\fR
136 A semicolon `;' separated list of fully qualified email-addresses which are
137 considered local although their domain name part is not in the list of \fBlocal_hosts\fR.
138 This list can be seen as an addition to \fBlocal_hosts\fP.
140 Further more only the local part of the addresses will be regarded,
141 seeing it as a local user.
143 Example: \fIlocal_addresses = "person1@yourdomain;person2@yourdomain"\fP
145 This means mail to person1@yourdomain will effectively go to
146 person1@localhost, if not redirected by an alias.
148 .TP
149 \fBnot_local_addresses = \fIlist\fR
151 A semicolon `;' separated list of fully qualified email-addresses which are
152 considered not local although their domain name part is in the list of \fBlocal_hosts\fR.
153 This list can be seen as a substraction to \fBlocal_hosts\fP.
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 \fBlocal_nets = \fIlist\fR
169 A semicolon `;' separated list of hostnames which are on the `local' net.
170 Delivery to these hosts is attempted immediately.
171 You can use patterns with `*', e.g. "*.bar.com".
173 .TP
174 \fBlisten_addresses = \fIlist\fR
176 A semicolon `;' separated list of interfaces on which connections will be accepted.
177 An interface ist defined by a hostname, optionally followed by a colon `:' and a number for the port.
178 If this is left out, port 25 will be used.
180 You can set this to "localhost:25;foo:25" if your hostname is `foo'.
182 Note that the names are resolved to IP addresses.
183 If your host has different names which resolve to the same IP,
184 use only one of them, otherwise you will get an error message.
186 Default: \fIlocalhost:25\fR (i.e. only local processes can connect)
188 .TP
189 \fBdo_save_envelope_to = \fIboolean\fR
191 If this is set to true, a possibly existing Envelope-to: header in an incoming mail
192 which is received via either pop3 or smtp will be saved as an X-Orig-Envelope-to: header.
194 This is useful if you retrieve mail from a pop3 server with fetchmail,
195 and the server supports Envelope-to: headers,
196 and you want to make use of those with a mail filtering tool, e.g. procmail.
197 It cannot be preserved because masqmail sets such a header by itself.
199 Default is false.
201 .TP
202 \fBdo_relay = \fIboolean\fR
204 If this is set to false, mail with a return path that is not local and a destination
205 that is also not local will not be accepted via smtp and a 550 reply will be given.
206 Default is true.
208 Note that this will not protect you from spammers using open relays,
209 but from users unable to set their address in their mail clients.
211 .TP
212 \fBdo_queue = \fIboolean\fR
214 If this is set, masqmail will not try to deliver mail immediately when accepted.
215 Instead it will always queue it.
216 (Note: Masqmail will always automatically queue mail if neccesary,
217 i.e. if it cannot deliver because no suitable route was available for example.)
219 Same as calling masqmail with the \fB\-odq\fR option.
220 Usually you should leave this option unset.
222 Default: false
224 .TP
225 \fBonline_routes.\fIname\fR = \fIlist\fR
227 Replace \fIname\fR with a name to identify a connection.
228 Set this to a filename (or a list of filenames) for the special route configuration for that connection.
229 You will use that name to call masqmail with the \fB\-qo\fR option every time a
230 connection to your ISP is set up.
232 Example: Your ISP has the name FastNet.
233 Then you write the following line in the main configuration:
235 \fBonline_routes.FastNet\fR = \fI"/etc/masqmail/fastnet.route"\fR
237 \fI/etc/masqmail/fastnet.route\fR is the route configuration file, see \fBmasqmail.route(5)\fR.
238 As soon as a link to FastNet has been set up, you call masqmail \fB\-qo \fIFastNet\fR.
239 Masqmail will then read the specified file and send the mails.
241 .TP
242 \fBconnect_route.\fIname\fR = \fIlist\fR
244 Old name for \fBonline_routes\fR.
246 .TP
247 \fBlocal_net_route = \fIfile\fR
249 This is similar to \fBonline_routes.\fIname\fR but used for delilvery to the local net.
250 Recipient addresses that are in local_nets will be routed using this route configuration.
251 Main purpose is to define a mail server with mail_host in your local network.
252 In simple environments this can be left unset.
253 If unset, a default route configuration (named ``default local_net_route'') will be used.
255 .TP
256 \fBalias_file = \fIfile\fR
258 Set this to the location of your alias file.
259 If not set, no aliasing will be done.
261 Default: <not set> (i.e. no aliasing is done)
263 .TP
264 \fBcaseless_matching = \fIboolean\fR
266 If this is set, aliasing and the matching for \fBlocal_addresses\fP and
267 \fBnot_local_addresses\fP will be done caseless.
269 Note: Be sure to change this option only if the queue is empty as
270 correct processing of queued messages is not guaranteed otherwise.
272 Default: false
274 .TP
275 \fBpipe_fromline = \fIboolean\fR
277 If this is set, a from line will be prepended to the output stream whenever
278 a pipe command is called after an alias expansion.
279 Default is false.
281 .TP
282 \fBpipe_fromhack = \fIboolean\fR
284 If this is set, each line beginning with `From ' is replaced with `>From '
285 whenever a pipe command is called after an alias expansion.
286 You probably want this if you have set \fBpipe_fromline\fR above.
287 Default is false.
289 .TP
290 \fBmbox_default = \fIstring\fR
292 The default local delivery method.
293 Can be mbox or mda.
294 You can override this for each user by using the \fBmbox_users\fR or \fBmda_users\fR (see below).
296 Default: mbox.
298 .TP
299 \fBmbox_users = \fIlist\fR
301 A list of users which wish delivery to an mbox style mail folder.
303 .TP
304 \fBmda_users = \fIlist\fR
306 A list of users which wish local delivery to an mda.
307 You have to set \fBmda\fR (see below) as well.
309 .TP
310 \fBmda = \fIexpand string\fR
312 If you want local delivery to be transferred to an mda (Mail Delivery Agent),
313 set this to a command.
314 The argument will be expanded on delivery time,
315 you can use variables beginning with a dolloar sign `$', optionally enclosed in curly braces.
316 Variables you can use are:
318 uid - the unique message id.
319 This is not necessarily identical with the Message ID as given in the Message ID: header.
321 received_host - the host the mail was received from
323 ident - the ident, this is either the ident delivered by the ident protocol
324 or the user id of the sender if the message was received locally.
326 return_path_local - the local part of the return path (sender).
328 return_path_domain - the domain part of the return path (sender).
330 return_path - the complete return path (sender).
332 rcpt_local - the local part of the recipient.
334 rcpt_domain - the domain part of the recipient.
336 rcpt - the complete recipient address.
338 Example:
340 mda="/usr/bin/procmail \-Y \-d ${rcpt_local}"
342 For the mda, as for pipe commands, a few environment variables will be set as well.
343 See \fBmasqmail(8)\fR.
344 To use environment variables for the mda, the dollar sign `$' has to be escaped with a backslash,
345 otherwise they will be tried to be expanded with the internal variables.
347 .TP
348 \fBmda_fromline = \fIboolean\fR
350 If this is set, a from line will be prepended to the output stream whenever
351 a message is delivered to an mda.
352 Default is false.
354 .TP
355 \fBmda_fromhack = \fIboolean\fR
357 If this is set, each line beginning with `From ' is replaced with `>From '
358 whenever a message is delivered to an mda.
359 You probably want this if you have set \fBmda_fromline\fR above.
360 Default is false.
362 .TP
363 \fBonline_query = \fIcommand line\fR
365 Defines the method masqmail uses to detect whether there exists an online connection currently.
367 Masqmail executes the command given and reads from its standard output.
368 The command should just print a route name, as defined
369 with \fBonline_routes.\fIname\fR, to standard output and return a zero status code.
370 Masqmail assumes it is offline if the script returns with a non-zero status.
371 Leading and trailing whitespace is removed from the output.
373 Simple example:
375 .nf
376 #!/bin/sh
377 test \-e /var/run/masqmail/masqmail-route || exit 1
378 cat /var/run/masqmail/masqmail-route
379 exit 0
380 .fi
382 No matter how masqmail detects the online status,
383 only messages that are accepted at online time will be delivered using the connection.
384 The mail spool still needs to be emptied manually
385 (\fB\-qo\fIconnection\fR).
387 \fIcommand line\fR must start with an absolute path to an executable program.
388 It can contain optional arguments.
390 To simulate the old online_method=file, use:
391 \fI/bin/cat /path/to/file\fP
393 To be always online with connection `foo', use:
394 \fI/bin/echo foo\fP
396 To query a masqdialer server
397 (i.e. asking it whether a connection exists and what its name is)
398 use:
399 \fI/usr/bin/mservdetect localhost 224\fP
402 .TP
403 \fBident_trusted_nets = \fIlist\fR
405 \fIlist\fR is a list of networks of the form a.b.c.d/e (e.g. 192.168.1.0/24),
406 from which the ident given by the ident protocol will be trusted,
407 so a user can delete his mail from the queue if the ident is identical to his login name.
409 .TP
410 \fBerrmsg_file = \fIfile\fR
412 Set this to a template which will be used to generate delivery failure reports.
413 Variable parts within the template begin with a dollar sign and are identical
414 to those which can be used as arguments for the mda command, see \fBmda\fR above.
415 Additional information can be included with @failed_rcpts, @msg_headers and @msg_body,
416 these must be at the beginning of a line and will be replaced with the list of the failed recipients,
417 the message headers and the message body of the failed message.
419 Default is /usr/share/masqmail/tpl/failmsg.tpl.
421 .TP
422 \fBwarnmsg_file = \fIfile\fR
424 Set this to a template which will be used to generate delivery warning reports.
425 It uses the same mechanisms for variables as \fBerrmsg_file\fR, see above.
427 Default is /usr/share/masqmail/tpl/warnmsg.tpl.
429 .TP
430 \fBwarn_intervals\fR = \fIlist\fR
432 Set this to a list of time intervals, at which delivery warnings
433 (starting with the receiving time of the message) shall be generated.
435 A warning will only be generated just after an attempt to deliver the mail
436 and if that attempt failed temporarily.
437 So a warning may be generated after a longer time, if there was no attempt before.
439 Default is "1h;4h;8h;1d;2d;3d"
441 .TP
442 \fBmax_defer_time\fR = \fItime\fR
444 This is the maximum time, in which a temporarily failed mail will be kept in the spool.
445 When this time is exceeded, it will be handled as a delivery failure,
446 and the message will be bounced.
448 The excedence of this time will only be noticed if the message was actually tried to be delivered.
449 If, for example, the message can only be delivered when online,
450 but you have not been online for that time, no bounce will be generated.
452 Default is 4d (4 days)
454 .TP
455 \fBlog_user = \fIname\fR
457 Replace \fIname\fR with a valid local or remote mail address.
459 If this option is set, then a copy of every mail,
460 that passes through the masqmail system will also be sent to the given mail address.
462 For example you can feed your mails into a program like hypermail
463 for archiving purpose by placing an appropriate pipe command in masqmail.alias
465 .TP
466 \fBmax_msg_size\fR = \fIbytes\fR
468 This option sets the maximum size in bytes masqmail will accept for delivery.
469 This value is advertised to the SMTP client by the `SIZE' message during SMTP
470 session setup.
471 Clients pretending to send, or actually send,
472 more than \fIbytes\fR will get a 552 error message.
474 `0' means no fixed maximum size limit is in force.
476 Default is 0 (= unlimited).
478 .TP
479 \fBdefer_all\fR = \fIboolean\fR
481 If set to true, masqmail replies with ``421 service temporarily unavailable''
482 to any SMTP request and shuts the connection down.
483 Note: This option is for debugging purposes only.
485 Default: false
488 .SH AUTHOR
490 Masqmail was written by Oliver Kurth.
491 It is now maintained by Markus Schnalke <meillo@marmaro.de>.
493 You will find the newest version of masqmail at \fBhttp://marmaro.de/prog/masqmail/\fR.
494 There is also a mailing list, you will find information about it at masqmail's main site.
497 .SH BUGS
499 Please report bugs to the mailing list.
502 .SH SEE ALSO
504 \fBmasqmail(8)\fR, \fBmasqmail.route(5)\fR