masqmail

annotate man/masqmail.conf.5 @ 427:c96a755b5fc4

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