masqmail

annotate man/masqmail.conf.5 @ 421:f37384470855

find changesets by author, revision, files, or words in the commit message
Changed lockdir to /var/lock/masqmail; Create lockdir and piddir on startup. Moved the lockdir out of the spool dir. (When /var/lock is a ramdisk we do well to have the lock files there.) Added the new configure option --with-lockdir to change that location. Nontheless, if we run_as_user, then lock files are always stored in the spool dir directly. Instead of installing the lockdir and piddir at installation time, we create them on startup time now if they are missing. This is necessary if lockdir or piddir are a tmpfs.
author markus schnalke <meillo@marmaro.de>
date Wed, 30 May 2012 09:38:38 +0200
parents 4cbaf6d6793f
children bdbedce60247
rev   line source
meillo@380 1 .TH masqmail.conf 5 2012-01-18 masqmail-0.3.4 "File Formats"
meillo@34 2
meillo@0 3 .SH NAME
meillo@0 4 masqmail.conf \- masqmail configuration file
meillo@34 5
meillo@34 6
meillo@0 7 .SH DESCRIPTION
meillo@0 8
meillo@34 9 This man page describes the syntax of the main configuration file of masqmail.
meillo@34 10 Its usual location is \fI/etc/masqmail/masqmail.conf\fR
meillo@0 11
meillo@0 12 The configuration consists of lines of the form
meillo@0 13
meillo@398 14 .RS 8
meillo@34 15 \fBval\fR = \fIexpression\fR
meillo@398 16 .RE
meillo@0 17
meillo@34 18 Where \fBval\fR is a variable name and \fIexpression\fR a string,
meillo@34 19 which can be quoted with double quotes `"'.
meillo@398 20 If the expression is on multiple lines or contains characters other
meillo@398 21 than letters,
meillo@398 22 digits or the characters `.', `\-', `_', `/', ';', '@', ':', it must be quoted.
meillo@34 23 You can use quotes inside quotes by escaping them with a backslash.
meillo@0 24
meillo@174 25 Each \fBval\fP has a type, which can be boolean, numeric, string or list.
meillo@398 26 A boolean variable can be set with one of the values `on', `yes', and `true'
meillo@398 27 or `off', `no' and `false'.
meillo@34 28 List items are separated with semicolons `;'.
meillo@398 29 The spaces around the equal sign `=' are optional.
meillo@0 30
meillo@398 31 All lists, except
meillo@398 32 \fBquery_routes.\fIname\fR and \fBpermanent_routes\fR, accept absolute
meillo@398 33 pathnames (leading slash `/') as entries, too.
meillo@398 34 They can be intermixed with normal entries.
meillo@398 35 The contents of these files will be included at this position in the list.
meillo@398 36 This makes including large lists more convenient.
meillo@398 37 Within these files, each line is one entry; the semicolon is no separator.
meillo@0 38
meillo@34 39 Blank lines and lines starting with a hash `#' are ignored.
meillo@34 40
meillo@0 41
meillo@0 42 .SH OPTIONS
meillo@34 43
meillo@0 44 .TP
meillo@34 45 \fBrun_as_user = \fIboolean\fR
meillo@0 46
meillo@398 47 If this is set, masqmail runs with the user id of the user who
meillo@398 48 invoked it and never changes it.
meillo@34 49 This is for debugging purposes only.
meillo@34 50 If the user is not root, masqmail will not be able to listen on a port < 1024
meillo@34 51 and will not be able to deliver local mail to others than the user.
meillo@0 52
meillo@0 53 .TP
meillo@34 54 \fBuse_syslog = \fIboolean\fR
meillo@0 55
meillo@34 56 If this is set, masqmail uses syslogd for logging.
meillo@34 57 It uses facility MAIL.
meillo@34 58 You still have to set \fBlog_dir\fR for debug files.
meillo@0 59
meillo@0 60 .TP
meillo@34 61 \fBdebug_level = \fIn\fR
meillo@0 62
meillo@34 63 Set the debug level.
meillo@333 64 Valid values are 0 to 6 and 9.
meillo@333 65 Be careful if you set this as high as 5 or higher,
meillo@333 66 the logs may very soon fill your hard drive.
meillo@333 67 Level 9 enables printing of debug messages to stderr during reading of
meillo@333 68 the config file.
meillo@333 69 The debug file comes available for the first time after this step.
meillo@333 70 Thus nothing but stderr is available.
meillo@333 71 Level 9 is almost never interesting.
meillo@0 72
meillo@0 73 .TP
meillo@44 74 \fBlog_dir = \fIfile\fR
meillo@44 75
meillo@174 76 The directory where logs are stored, if syslog is not used.
meillo@174 77 Debug files are always stored in this directory if debugging is enabled.
meillo@44 78 \fIfile\fR must be an absolute path.
meillo@44 79
meillo@151 80 Default: \fI/var/log/masqmail\fR
meillo@151 81
meillo@44 82 .TP
meillo@34 83 \fBmail_dir = \fIfile\fR
meillo@0 84
meillo@398 85 The directory where local mail is stored,
meillo@398 86 usually \fI/var/spool/mail\fR or \fI/var/mail\fR.
meillo@44 87 \fIfile\fR must be an absolute path.
meillo@0 88
meillo@152 89 Default: \fI/var/mail\fR
meillo@152 90
meillo@0 91 .TP
meillo@34 92 \fBspool_dir = \fIfile\fR
meillo@0 93
meillo@398 94 The directory where masqmail stores its spool files
meillo@421 95 (and lock files if \fIrun_as_user\fP).
meillo@34 96 It must have a subdirectory \fIinput\fR.
meillo@34 97 Masqmail needs read and write permissions for this directory.
meillo@44 98 \fIfile\fR must be an absolute path.
meillo@0 99
meillo@151 100 Default: \fI/var/spool/masqmail\fR
meillo@151 101
meillo@0 102 .TP
meillo@133 103 \fBlock_dir = \fIfile\fR
meillo@133 104
meillo@133 105 The directory where masqmail stores its lock files.
meillo@133 106 Masqmail needs read and write permissions for this directory.
meillo@421 107 The default is \fI/var/lock/masqmail\fR for normal operation.
meillo@133 108 \fIfile\fR must be an absolute path.
meillo@421 109 The directory is created on startup if yet missing.
meillo@421 110
meillo@421 111 If \fIrun_as_user\fP then lock files are stored in the \fIspool_dir\fP
meillo@421 112 directly and the \fBlock_dir\fP setting is ignored.
meillo@133 113
meillo@133 114 .TP
meillo@34 115 \fBhost_name = \fIstring\fR
meillo@0 116
meillo@398 117 This is used in different places: Masqmail identifies itself in
meillo@398 118 the greeting banner on incoming connections and in the HELO/EHLO command
meillo@398 119 for outgoing connections with this name, it is used in the Received: header
meillo@398 120 and to qualify the sender of a locally originating message.
meillo@0 121
meillo@34 122 If the string begins with a slash `/', it it assumed that it is a filename,
meillo@34 123 and the first line of this file will be used.
meillo@398 124 Usually this will be `/etc/mailname' to make masqmail conform to
meillo@398 125 Debian policies.
meillo@0 126
meillo@398 127 It is not used to find whether an address is local.
meillo@398 128 Use \fBlocal_hosts\fR for that.
meillo@0 129
meillo@156 130 Default: none; \fBhost_name\fP MUST be set in the config file
meillo@156 131
meillo@0 132 .TP
meillo@34 133 \fBlocal_hosts = \fIlist\fR
meillo@0 134
meillo@34 135 A semicolon `;' separated list of hostnames which are considered local.
meillo@375 136 Can contain glob patterns, like
meillo@375 137 `*example.org' or `mail?.*mydomain.net'.
meillo@153 138 Normally you should set it to "localhost;foo;foo.bar.com" if your host has the
meillo@34 139 fully qualified domain name `foo.bar.com'.
meillo@0 140
meillo@398 141 Default: localhost ; <value of \fBhost_name\fR cut at the first dot> ;
meillo@398 142 <value of \fBhost_name\fR>
meillo@157 143
meillo@157 144 Example: \fIlocalhost;foo;foo.example.org\fR
meillo@157 145 (if you have set \fBhost_name\fR to \fIfoo.example.org\fR)
meillo@153 146
meillo@0 147 .TP
meillo@34 148 \fBlocal_addresses = \fIlist\fR
meillo@0 149
meillo@34 150 A semicolon `;' separated list of fully qualified email-addresses which are
meillo@398 151 considered local although their domain name part is not in the list of
meillo@398 152 \fBlocal_hosts\fR.
meillo@238 153 This list can be seen as an addition to \fBlocal_hosts\fP.
meillo@398 154 .IP
meillo@306 155 Further more only the local part of the addresses will be regarded,
meillo@306 156 seeing it as a local user.
meillo@0 157
meillo@398 158 Example:
meillo@0 159
meillo@398 160 .RS 8
meillo@398 161 .nf
meillo@398 162 local_hosts = "localhost;myhost"
meillo@398 163 local_addresses = "bob@somewhere;alice@foo"
meillo@398 164 .fi
meillo@398 165 .RE
meillo@398 166 .IP
meillo@306 167 This means mail to person1@yourdomain will effectively go to
meillo@306 168 person1@localhost, if not redirected by an alias.
meillo@34 169
meillo@0 170 .TP
meillo@34 171 \fBnot_local_addresses = \fIlist\fR
meillo@0 172
meillo@34 173 A semicolon `;' separated list of fully qualified email-addresses which are
meillo@398 174 considered not local although their domain name part is in the list of
meillo@398 175 \fBlocal_hosts\fR.
meillo@238 176 This list can be seen as a substraction to \fBlocal_hosts\fP.
meillo@0 177
meillo@34 178 This is the opposite of the previous case.
meillo@34 179 The majority of addresses of a specific domain are local.
meillo@34 180 But some users are not.
meillo@34 181 With this option you can easily exclude these users.
meillo@0 182
meillo@0 183 Example:
meillo@0 184
meillo@398 185 .RS 8
meillo@398 186 .nf
meillo@0 187 local_hosts = "localhost;myhost;mydomain.net"
meillo@0 188 not_local_addresses = "eric@mydomain.net"
meillo@398 189 .fi
meillo@398 190 .RE
meillo@398 191 .IP
meillo@34 192
meillo@0 193 .TP
meillo@34 194 \fBlisten_addresses = \fIlist\fR
meillo@0 195
meillo@398 196 A semicolon `;' separated list of interfaces on which connections will
meillo@398 197 be accepted.
meillo@398 198 An interface ist defined by a hostname, optionally followed by a colon `:'
meillo@398 199 and a number for the port.
meillo@34 200 If this is left out, port 25 will be used.
meillo@0 201
meillo@34 202 You can set this to "localhost:25;foo:25" if your hostname is `foo'.
meillo@0 203
meillo@337 204 Note that the names are resolved to IP addresses.
meillo@34 205 If your host has different names which resolve to the same IP,
meillo@34 206 use only one of them, otherwise you will get an error message.
meillo@0 207
meillo@329 208 Default: \fIlocalhost:25\fR (i.e. only local processes can connect)
meillo@161 209
meillo@0 210 .TP
meillo@34 211 \fBdo_save_envelope_to = \fIboolean\fR
meillo@0 212
meillo@398 213 If this is set to true, a possibly existing Envelope-to: header in
meillo@398 214 an incoming mail which is received via either pop3 or smtp will be saved
meillo@398 215 as an X-Orig-Envelope-to: header.
meillo@0 216
meillo@192 217 This is useful if you retrieve mail from a pop3 server with fetchmail,
meillo@34 218 and the server supports Envelope-to: headers,
meillo@34 219 and you want to make use of those with a mail filtering tool, e.g. procmail.
meillo@34 220 It cannot be preserved because masqmail sets such a header by itself.
meillo@0 221
meillo@0 222 Default is false.
meillo@34 223
meillo@0 224 .TP
meillo@34 225 \fBdo_relay = \fIboolean\fR
meillo@0 226
meillo@398 227 If this is set to false, mail with a return path that is not local
meillo@398 228 and a destination that is also not local will not be accepted via smtp
meillo@398 229 and a 550 reply will be given.
meillo@34 230 Default is true.
meillo@0 231
meillo@34 232 Note that this will not protect you from spammers using open relays,
meillo@34 233 but from users unable to set their address in their mail clients.
meillo@0 234
meillo@0 235 .TP
meillo@34 236 \fBdo_queue = \fIboolean\fR
meillo@0 237
meillo@398 238 If this is set, masqmail will not try to deliver mail
meillo@398 239 immediately when accepted.
meillo@346 240 Instead it will always queue it.
meillo@346 241 (Note: Masqmail will always automatically queue mail if neccesary,
meillo@346 242 i.e. if it cannot deliver because no suitable route was available for example.)
meillo@346 243
meillo@34 244 Same as calling masqmail with the \fB\-odq\fR option.
meillo@346 245 Usually you should leave this option unset.
meillo@346 246
meillo@346 247 Default: false
meillo@0 248
meillo@0 249 .TP
meillo@354 250 \fBpermanent_routes\fR = \fIlist\fR
meillo@0 251
meillo@354 252 Set this to the filename (or a semicolon-separated list of filenames)
meillo@354 253 of the route configuration for always available connections.
meillo@354 254 Main purpose is to define a mail server with mail_host in your local network,
meillo@354 255 or if masqmail should send mail directly to the target host.
meillo@354 256 If you have only a single host, you can leave it unset.
meillo@354 257
meillo@354 258 A setting `\fBlocal_nets\fR = \fI"*home.net"\fR' in versions <= 0.3.3
meillo@354 259 is in newer versions configured as:
meillo@354 260 `\fBpermanent_routes\fR = \fI"/etc/masqmail/homenet.route"\fR'
meillo@354 261 and the route file `homenet.route' containing:
meillo@398 262
meillo@398 263 .RS 8
meillo@354 264 .nf
meillo@354 265 allowed_recipients = "*@*home.net"
meillo@354 266 connect_error_fail = true
meillo@354 267 resolve_list = byname
meillo@354 268 .fi
meillo@398 269 .RE
meillo@398 270 .IP
meillo@398 271
meillo@354 272 This is just as it had been with \fBlocal_net_route\fP,
meillo@354 273 with the exception that the filtering for appropriate addresses
meillo@354 274 is only in the route file and not with \fBlocal_nets\fR.
meillo@354 275
meillo@354 276 .TP
meillo@354 277 \fBquery_routes.\fIname\fR = \fIlist\fR
meillo@354 278
meillo@354 279 Replace \fIname\fR with a name to identify the connection.
meillo@354 280 Set this to a filename (or a semicolon-separated list of filenames)
meillo@354 281 for the route configuration for that connection.
meillo@354 282
meillo@354 283 Routes of this kind cannot be expected to be online always.
meillo@354 284 Masqmail will query which of the routes are online.
meillo@354 285
meillo@354 286 You can use the name to call masqmail with the \fB\-qo\fR option every time a
meillo@354 287 connection to your ISP is set up, in order to send queued mail through this
meillo@354 288 route.
meillo@0 289
meillo@34 290 Example: Your ISP has the name FastNet.
meillo@34 291 Then you write the following line in the main configuration:
meillo@0 292
meillo@398 293 .RS 8
meillo@398 294 .nf
meillo@354 295 \fBquery_routes.\fBFastNet\fR = \fI"/etc/masqmail/fastnet.route"\fR
meillo@398 296 .fi
meillo@398 297 .RE
meillo@398 298 .IP
meillo@0 299
meillo@354 300 \fI/etc/masqmail/fastnet.route\fR is the route configuration file,
meillo@354 301 see \fBmasqmail.route(5)\fR.
meillo@354 302 As soon as a link to FastNet has been set up,
meillo@354 303 you call `masqmail \fB\-qo \fIFastNet\fR'.
meillo@34 304 Masqmail will then read the specified file and send the mails.
meillo@0 305
meillo@354 306 See \fBonline_query\fP.
meillo@0 307
meillo@0 308 .TP
meillo@34 309 \fBalias_file = \fIfile\fR
meillo@0 310
meillo@34 311 Set this to the location of your alias file.
meillo@238 312 If not set, no aliasing will be done.
meillo@238 313
meillo@238 314 Default: <not set> (i.e. no aliasing is done)
meillo@0 315
meillo@0 316 .TP
meillo@387 317 \fBglobalias_file = \fIfile\fR
meillo@387 318
meillo@387 319 Set this to the location of a glob-pattern alias file.
meillo@387 320 This kind of aliasing matches glob patterns against full email addresses,
meillo@387 321 not strings against local parts like in normal aliasing.
meillo@387 322 You can use this to handle catch-all maildrops (``*@example.org'')
meillo@387 323 and to split between virtual hosts on a single machine
meillo@387 324 (e.g. ``info@foo.ex.org'' and ``info@bar.ex.org'').
meillo@387 325
meillo@387 326 Glob aliasing is done before normal aliasing.
meillo@387 327 If you have both kinds, glob and normal aliasing, then the results of the
meillo@387 328 glob aliasing may be expanded further by the normal aliasing mechanism.
meillo@387 329
meillo@387 330 Default: <not set> (i.e. no glob aliasing is done)
meillo@387 331
meillo@387 332 .TP
meillo@243 333 \fBcaseless_matching = \fIboolean\fR
meillo@0 334
meillo@242 335 If this is set, aliasing and the matching for \fBlocal_addresses\fP and
meillo@242 336 \fBnot_local_addresses\fP will be done caseless.
meillo@242 337
meillo@242 338 Note: Be sure to change this option only if the queue is empty as
meillo@242 339 correct processing of queued messages is not guaranteed otherwise.
meillo@34 340
meillo@238 341 Default: false
meillo@238 342
meillo@0 343 .TP
meillo@34 344 \fBpipe_fromline = \fIboolean\fR
meillo@0 345
meillo@34 346 If this is set, a from line will be prepended to the output stream whenever
meillo@34 347 a pipe command is called after an alias expansion.
meillo@34 348 Default is false.
meillo@0 349
meillo@0 350 .TP
meillo@34 351 \fBpipe_fromhack = \fIboolean\fR
meillo@0 352
meillo@34 353 If this is set, each line beginning with `From ' is replaced with `>From '
meillo@34 354 whenever a pipe command is called after an alias expansion.
meillo@34 355 You probably want this if you have set \fBpipe_fromline\fR above.
meillo@34 356 Default is false.
meillo@0 357
meillo@0 358 .TP
meillo@34 359 \fBmbox_default = \fIstring\fR
meillo@0 360
meillo@34 361 The default local delivery method.
meillo@205 362 Can be mbox or mda.
meillo@398 363 You can override this for each user by using the \fBmbox_users\fR or
meillo@398 364 \fBmda_users\fR (see below).
meillo@0 365
meillo@238 366 Default: mbox.
meillo@238 367
meillo@0 368 .TP
meillo@34 369 \fBmbox_users = \fIlist\fR
meillo@0 370
meillo@0 371 A list of users which wish delivery to an mbox style mail folder.
meillo@34 372
meillo@0 373 .TP
meillo@34 374 \fBmda_users = \fIlist\fR
meillo@0 375
meillo@34 376 A list of users which wish local delivery to an mda.
meillo@34 377 You have to set \fBmda\fR (see below) as well.
meillo@0 378
meillo@0 379 .TP
meillo@34 380 \fBmda = \fIexpand string\fR
meillo@0 381
meillo@34 382 If you want local delivery to be transferred to an mda (Mail Delivery Agent),
meillo@34 383 set this to a command.
meillo@34 384 The argument will be expanded on delivery time,
meillo@398 385 you can use variables beginning with a dolloar sign `$',
meillo@398 386 optionally enclosed in curly braces.
meillo@34 387 Variables you can use are:
meillo@0 388
meillo@398 389 .RS 8
meillo@398 390 .TP
meillo@398 391 uid
meillo@398 392 the unique message id.
meillo@398 393 (This is not necessarily identical with the Message ID
meillo@398 394 as given in the Message ID: header.)
meillo@0 395
meillo@398 396 .TP
meillo@398 397 received_host
meillo@398 398 the host the mail was received from
meillo@0 399
meillo@398 400 .TP
meillo@398 401 ident
meillo@398 402 the user id of the sender if the message was received locally.
meillo@0 403
meillo@398 404 .TP
meillo@398 405 return_path_local
meillo@398 406 the local part of the return path (sender).
meillo@0 407
meillo@398 408 .TP
meillo@398 409 return_path_domain
meillo@398 410 the domain part of the return path (sender).
meillo@0 411
meillo@398 412 .TP
meillo@398 413 return_path
meillo@398 414 the complete return path (sender).
meillo@0 415
meillo@398 416 .TP
meillo@398 417 rcpt_local
meillo@398 418 the local part of the recipient.
meillo@0 419
meillo@398 420 .TP
meillo@398 421 rcpt_domain
meillo@398 422 the domain part of the recipient.
meillo@0 423
meillo@398 424 .TP
meillo@398 425 rcpt
meillo@398 426 the complete recipient address.
meillo@398 427 .RE
meillo@398 428 .IP
meillo@0 429
meillo@0 430 Example:
meillo@0 431
meillo@398 432 .RS 8
meillo@16 433 mda="/usr/bin/procmail \-Y \-d ${rcpt_local}"
meillo@398 434 .RE
meillo@398 435 .IP
meillo@0 436
meillo@398 437 For the mda, as for pipe commands,
meillo@398 438 a few environment variables will be set as well.
meillo@34 439 See \fBmasqmail(8)\fR.
meillo@398 440 To use environment variables for the mda,
meillo@398 441 the dollar sign `$' has to be escaped with a backslash,
meillo@34 442 otherwise they will be tried to be expanded with the internal variables.
meillo@34 443
meillo@0 444 .TP
meillo@34 445 \fBmda_fromline = \fIboolean\fR
meillo@0 446
meillo@34 447 If this is set, a from line will be prepended to the output stream whenever
meillo@34 448 a message is delivered to an mda.
meillo@34 449 Default is false.
meillo@0 450
meillo@0 451 .TP
meillo@34 452 \fBmda_fromhack = \fIboolean\fR
meillo@0 453
meillo@34 454 If this is set, each line beginning with `From ' is replaced with `>From '
meillo@34 455 whenever a message is delivered to an mda.
meillo@34 456 You probably want this if you have set \fBmda_fromline\fR above.
meillo@34 457 Default is false.
meillo@0 458
meillo@0 459 .TP
meillo@310 460 \fBonline_query = \fIcommand line\fR
meillo@0 461
meillo@398 462 Defines the method masqmail uses to detect whether there exists
meillo@398 463 an online connection currently.
meillo@0 464
meillo@310 465 Masqmail executes the command given and reads from its standard output.
meillo@310 466 The command should just print a route name, as defined
meillo@398 467 with \fBquery_routes.\fIname\fR, to standard output and return
meillo@398 468 a zero status code.
meillo@310 469 Masqmail assumes it is offline if the script returns with a non-zero status.
meillo@310 470 Leading and trailing whitespace is removed from the output.
meillo@0 471
meillo@310 472 Simple example:
meillo@310 473
meillo@398 474 .RS 8
meillo@310 475 .nf
meillo@310 476 #!/bin/sh
meillo@418 477 test \-e /var/tmp/masqmail-route || exit 1
meillo@418 478 cat /var/tmp/masqmail-route
meillo@310 479 exit 0
meillo@310 480 .fi
meillo@398 481 .RE
meillo@398 482 .IP
meillo@0 483
meillo@34 484 No matter how masqmail detects the online status,
meillo@398 485 only messages that are accepted at online time will be
meillo@398 486 delivered using the connection.
meillo@310 487 The mail spool still needs to be emptied manually
meillo@310 488 (\fB\-qo\fIconnection\fR).
meillo@0 489
meillo@310 490 \fIcommand line\fR must start with an absolute path to an executable program.
meillo@158 491 It can contain optional arguments.
meillo@0 492
meillo@310 493 To simulate the old online_method=file, use:
meillo@398 494
meillo@398 495 .RS 8
meillo@310 496 \fI/bin/cat /path/to/file\fP
meillo@398 497 .RE
meillo@398 498 .IP
meillo@158 499
meillo@310 500 To be always online with connection `foo', use:
meillo@398 501
meillo@398 502 .RS 8
meillo@310 503 \fI/bin/echo foo\fP
meillo@398 504 .RE
meillo@398 505 .IP
meillo@310 506
meillo@310 507 To query a masqdialer server
meillo@310 508 (i.e. asking it whether a connection exists and what its name is)
meillo@164 509 use:
meillo@398 510
meillo@398 511 .RS 8
meillo@310 512 \fI/usr/bin/mservdetect localhost 224\fP
meillo@398 513 .RE
meillo@398 514 .IP
meillo@92 515
meillo@0 516 .TP
meillo@34 517 \fBerrmsg_file = \fIfile\fR
meillo@0 518
meillo@34 519 Set this to a template which will be used to generate delivery failure reports.
meillo@34 520 Variable parts within the template begin with a dollar sign and are identical
meillo@398 521 to those which can be used as arguments for the mda command,
meillo@398 522 see \fBmda\fR above.
meillo@398 523 Additional information can be included with @failed_rcpts,
meillo@398 524 @msg_headers and @msg_body,
meillo@398 525 these must be at the beginning of a line and will be replaced
meillo@398 526 with the list of the failed recipients,
meillo@34 527 the message headers and the message body of the failed message.
meillo@0 528
meillo@0 529 Default is /usr/share/masqmail/tpl/failmsg.tpl.
meillo@34 530
meillo@0 531 .TP
meillo@34 532 \fBwarnmsg_file = \fIfile\fR
meillo@0 533
meillo@34 534 Set this to a template which will be used to generate delivery warning reports.
meillo@34 535 It uses the same mechanisms for variables as \fBerrmsg_file\fR, see above.
meillo@0 536
meillo@0 537 Default is /usr/share/masqmail/tpl/warnmsg.tpl.
meillo@34 538
meillo@0 539 .TP
meillo@34 540 \fBwarn_intervals\fR = \fIlist\fR
meillo@0 541
meillo@34 542 Set this to a list of time intervals, at which delivery warnings
meillo@34 543 (starting with the receiving time of the message) shall be generated.
meillo@0 544
meillo@34 545 A warning will only be generated just after an attempt to deliver the mail
meillo@34 546 and if that attempt failed temporarily.
meillo@398 547 So a warning may be generated after a longer time,
meillo@398 548 if there was no attempt before.
meillo@0 549
meillo@0 550 Default is "1h;4h;8h;1d;2d;3d"
meillo@34 551
meillo@0 552 .TP
meillo@34 553 \fBmax_defer_time\fR = \fItime\fR
meillo@0 554
meillo@398 555 This is the maximum time,
meillo@398 556 in which a temporarily failed mail will be kept in the spool.
meillo@34 557 When this time is exceeded, it will be handled as a delivery failure,
meillo@34 558 and the message will be bounced.
meillo@0 559
meillo@398 560 The excedence of this time will only be noticed if the message
meillo@398 561 was actually tried to be delivered.
meillo@34 562 If, for example, the message can only be delivered when online,
meillo@34 563 but you have not been online for that time, no bounce will be generated.
meillo@0 564
meillo@0 565 Default is 4d (4 days)
meillo@34 566
meillo@0 567 .TP
meillo@34 568 \fBlog_user = \fIname\fR
meillo@0 569
meillo@34 570 Replace \fIname\fR with a valid local or remote mail address.
meillo@0 571
meillo@44 572 If this option is set, then a copy of every mail,
meillo@398 573 that passes through the masqmail system will also be sent
meillo@398 574 to the given mail address.
meillo@0 575
meillo@34 576 For example you can feed your mails into a program like hypermail
meillo@398 577 for archiving purpose by placing an appropriate pipe command
meillo@398 578 in masqmail.alias.
meillo@0 579
meillo@117 580 .TP
meillo@117 581 \fBmax_msg_size\fR = \fIbytes\fR
meillo@117 582
meillo@117 583 This option sets the maximum size in bytes masqmail will accept for delivery.
meillo@117 584 This value is advertised to the SMTP client by the `SIZE' message during SMTP
meillo@117 585 session setup.
meillo@117 586 Clients pretending to send, or actually send,
meillo@117 587 more than \fIbytes\fR will get a 552 error message.
meillo@117 588
meillo@398 589 A zero value disables the maximum size limit.
meillo@120 590
meillo@120 591 Default is 0 (= unlimited).
meillo@117 592
meillo@134 593 .TP
meillo@134 594 \fBdefer_all\fR = \fIboolean\fR
meillo@134 595
meillo@134 596 If set to true, masqmail replies with ``421 service temporarily unavailable''
meillo@134 597 to any SMTP request and shuts the connection down.
meillo@134 598 Note: This option is for debugging purposes only.
meillo@134 599
meillo@134 600 Default: false
meillo@134 601
meillo@34 602
meillo@0 603 .SH AUTHOR
meillo@0 604
meillo@34 605 Masqmail was written by Oliver Kurth.
meillo@34 606 It is now maintained by Markus Schnalke <meillo@marmaro.de>.
meillo@0 607
meillo@398 608 You will find the newest version of masqmail at
meillo@398 609 \fBhttp://marmaro.de/prog/masqmail/\fR.
meillo@398 610 There is also a mailing list,
meillo@398 611 you will find information about it at masqmail's main site.
meillo@0 612
meillo@34 613
meillo@0 614 .SH BUGS
meillo@0 615
meillo@34 616 Please report bugs to the mailing list.
meillo@34 617
meillo@0 618
meillo@0 619 .SH SEE ALSO
meillo@0 620
meillo@192 621 \fBmasqmail(8)\fR, \fBmasqmail.route(5)\fR