1.1 --- /dev/null	Thu Jan 01 00:00:00 1970 +0000
     1.2 +++ b/docs/xml/masqmail.conf.5.xml	Fri Sep 26 17:05:23 2008 +0200
     1.3 @@ -0,0 +1,561 @@
     1.4 +<?xml version="1.0" standalone='no'?>
     1.5 +<!DOCTYPE spec SYSTEM "man.dtd">
     1.6 +
     1.7 +<manpage name="masqmail.conf" section="5" desc="masqmail configuration file">
     1.8 +
     1.9 +<description>
    1.10 +<p>This man page describes the syntax of the main configuration file
    1.11 +of masqmail. Its usual location is <file>/etc/masqmail/masqmail.conf</file></p>
    1.12 +
    1.13 +<p>The configuration consists of lines of the form</p>
    1.14 +
    1.15 +<p><opt>val</opt> = <arg>expression</arg></p>
    1.16 +
    1.17 +<p>Where <opt>val</opt> is a variable name and <arg>expression</arg> a string,
    1.18 +which can be quoted with '"'. If the expression is on multiple lines
    1.19 +or contains characters other than letters, digits or the characters
    1.20 +'.', '-', '_', '/', it <em>must</em> be quoted. You can use quotes inside quotes
    1.21 +by escaping them with a backslash.</p>
    1.22 +
    1.23 +<p>Each val has a <i>type</i>, which can be boolean, numeric, string
    1.24 +or list. A boolean variable can be set with one of the values 'on',
    1.25 +'yes', and 'true' or 'off', 'no' and 'false'. List items are separated
    1.26 +with ';'. For some values patterns (like '*','?') can be used. The
    1.27 +spaces before and after the '=' are optional.</p>
    1.28 +
    1.29 +<p>Most lists (exceptions: <opt>local_hosts</opt>,
    1.30 +<opt>local_nets</opt>, <opt>listen_addresses</opt>, <opt>online_routes</opt> and <opt>online_gets</opt>) accept
    1.31 +files. These will be recognized by a leading slash '/'. The contents
    1.32 +of these files will be included at the position of the file name,
    1.33 +there can be items or other files before and after the file entry. The
    1.34 +format of the files is different though, within these files each entry
    1.35 +is on another line. (And not separated by semicolons). This makes it
    1.36 +easy to include large lists which are common in different
    1.37 +configuration files, so they do not have to appear in every
    1.38 +configuration file.</p>
    1.39 +
    1.40 +<p>Blank lines and lines starting with '#' are ignored.</p>
    1.41 +
    1.42 +</description>
    1.43 +
    1.44 +<options>
    1.45 +<option>
    1.46 +<p><opt>run_as_user = <arg>boolean</arg></opt></p>
    1.47 +<optdesc>
    1.48 +<p>If this is set, masqmail runs with the user id of the user who
    1.49 +invoked it and never changes it. This is for debugging purposes 
    1.50 +<em>only</em>. If the user is not root, masqmail will not be able to
    1.51 +listen on a port &lt; 1024 and will not be able to deliver local mail
    1.52 +to others than the user.</p>
    1.53 +</optdesc>
    1.54 +</option>
    1.55 +
    1.56 +<option>
    1.57 +<p><opt>use_syslog = <arg>boolean</arg></opt></p>
    1.58 +<optdesc>
    1.59 +<p>If this is set, masqmail uses syslogd for logging. It uses facility
    1.60 +MAIL. You still have to set <opt>log_dir</opt> for debug files.</p>
    1.61 +</optdesc>
    1.62 +</option>
    1.63 +
    1.64 +<option>
    1.65 +<p><opt>debug_level = <arg>n</arg></opt></p>
    1.66 +<optdesc>
    1.67 +<p>Set the debug level. Valid values are 0 to 6, increasing it further
    1.68 +makes no difference. Be careful if you set this as high as 5 or higher,
    1.69 +the logs may very soon fill your hard drive.</p>
    1.70 +</optdesc>
    1.71 +</option>
    1.72 +
    1.73 +<option>
    1.74 +<p><opt>mail_dir = <arg>file</arg></opt></p>
    1.75 +<optdesc>
    1.76 +<p>The directory where local mail is stored,
    1.77 +usually <file>/var/spool/mail</file> or <file>/var/mail</file>.</p>
    1.78 +</optdesc>
    1.79 +</option>
    1.80 +
    1.81 +<option>
    1.82 +<p><opt>spool_dir = <arg>file</arg></opt></p>
    1.83 +<optdesc>
    1.84 +<p>The directory where masqmail stores its spool files (and later also
    1.85 +other stuff). It <em>must</em> have a subdirectory <file>input</file>.
    1.86 +Masqmail needs read and write permissions for this
    1.87 +directory. I suggest to use <file>/var/spool/masqmail</file>.</p>
    1.88 +</optdesc>
    1.89 +</option>
    1.90 +
    1.91 +<option>
    1.92 +<p><opt>host_name = <arg>string</arg></opt></p>
    1.93 +<optdesc>
    1.94 +<p>This is used in different places: Masqmail identifies itself in the
    1.95 +greeting banner on incoming connections and in the HELO/EHLO command
    1.96 +for outgoing connections with this name, it is used in the Received:
    1.97 +header and to qualify the sender of a locally originating message.</p>
    1.98 +
    1.99 +<p>If the string begins with a slash '/', it it assumed that it is a
   1.100 +filename, and the first line of this file will be used. Usually this will
   1.101 +be '/etc/mailname' to make masqmail conform to Debian policies.</p>
   1.102 +
   1.103 +<p>It is <em>not</em> used to find whether an address is local.
   1.104 +Use <opt>local_hosts</opt> for that.</p>
   1.105 +</optdesc>
   1.106 +</option>
   1.107 +
   1.108 +<option>
   1.109 +<p><opt>remote_port = <arg>n</arg></opt></p>
   1.110 +<optdesc>
   1.111 +<p>The remote port number to be used. This defaults to port 25.</p>
   1.112 +<p>This option is deprecated. Use <opt>host_name</opt> in the route
   1.113 +configuration instead. See <manref name="masqmail.route" section="5"
   1.114 +href="masqmail.route.5.html"/>.</p>
   1.115 +</optdesc>
   1.116 +</option>
   1.117 +
   1.118 +<option>
   1.119 +<p><opt>local_hosts = <arg>list</arg></opt></p>
   1.120 +<optdesc>
   1.121 +<p>A semicolon ';' separated list of hostnames which are considered
   1.122 +local. Normally you set it to "localhost;foo;foo.bar.com" if your host
   1.123 +has the fully qualified domain name 'foo.bar.com'.</p>
   1.124 +</optdesc>
   1.125 +</option>
   1.126 +
   1.127 +<option>
   1.128 +<p><opt>local_nets = <arg>list</arg></opt></p>
   1.129 +<optdesc>
   1.130 +<p>A semicolon ';' separated list of hostnames which are on the
   1.131 +'local' net. Delivery to these hosts is attempted immediately. You can
   1.132 +use patterns with '*', eg. "*.bar.com".</p>
   1.133 +</optdesc>
   1.134 +</option>
   1.135 +
   1.136 +<option>
   1.137 +<p><opt>local_addresses = <arg>list</arg></opt></p>
   1.138 +<optdesc>
   1.139 +<p>A semicolon ';' separated list of fully qualified email-addresses
   1.140 +which are considered local although their domain name part is not in
   1.141 +the list of <opt>local_hosts</opt>. </p>
   1.142 +<p>For example: There are two people working at your
   1.143 +LAN: person1@yourdomain and person2@yourdomain. But there are
   1.144 +other persons @yourdomain which are NOT local. So you can not put
   1.145 +yourdomain to the list of local_hosts. If person1 now wants
   1.146 +to write to person2@yourdomain and this mail should not leave the LAN
   1.147 +then you can put</p>
   1.148 +<p>local_addresses = "person1@yourdomain;person2@yourdomain"</p>
   1.149 +<p>to your masqmail.conf.</p>
   1.150 +</optdesc>
   1.151 +</option>
   1.152 +
   1.153 +<option>
   1.154 +<p><opt>not_local_addresses = <arg>list</arg></opt></p>
   1.155 +<optdesc>
   1.156 +<p>A semicolon ';' separated list of fully qualified email-addresses
   1.157 +which are considered not local although their domain name part is in
   1.158 +the list of <opt>local_hosts</opt>. </p>
   1.159 +<p>This ist the opposite of the previous case. The majority of addresses
   1.160 +of a specific domain are local. But some users are not. With this
   1.161 +option you can easily exclude these users.</p>
   1.162 +<p>Example:</p>
   1.163 +<p>local_hosts = "localhost;myhost;mydomain.net"</p>
   1.164 +<p>not_local_addresses = "eric@mydomain.net"</p>
   1.165 +</optdesc>
   1.166 +</option>
   1.167 +
   1.168 +<option>
   1.169 +<p><opt>listen_addresses = <arg>list</arg></opt></p>
   1.170 +<optdesc>
   1.171 +<p>A semicolon ';' separated list of interfaces on which connections
   1.172 +will be accepted. An interface ist defined by a hostname, optionally
   1.173 +followed by a colon ':' and a number for the port. If this is left out,
   1.174 +port 25 will be used.</p>
   1.175 +<p>You can set this to "localhost:25;foo:25" if your hostname is 'foo'.</p>
   1.176 +<p>Note that the names are resolved to IP addreses. If your host has
   1.177 +different names which resolve to the same IP, use only one of them,
   1.178 +otherwise you will get an error message.
   1.179 +</p>
   1.180 +</optdesc>
   1.181 +</option>
   1.182 +
   1.183 +<option>
   1.184 +<p><opt>do_save_envelope_to = <arg>boolean</arg></opt></p>
   1.185 +<optdesc>
   1.186 +<p>If this is set to true, a possibly existing Envelope-to: header in an
   1.187 +incoming mail which is received via either pop3 or smtp will be saved as
   1.188 +an X-Orig-Envelope-to: header.</p>
   1.189 +<p>This is useful if you retrieve mail from a pop3 server with either masqmail
   1.190 +or fetchmail, and the server supports Envelope-to: headers, and you want to make use
   1.191 +of those with a mail filtering tool, eg. procmail. It cannot be preserved because
   1.192 +masqmail sets such a header by itself.</p>
   1.193 +<p>Default is false.</p>
   1.194 +</optdesc>
   1.195 +</option>
   1.196 +
   1.197 +<option>
   1.198 +<p><opt>do_relay = <arg>boolean</arg></opt></p>
   1.199 +<optdesc>
   1.200 +<p>If this is set to false, mail with a return path that is not local and a
   1.201 +destination that is also not local will not be accepted via smtp and a 550
   1.202 +reply will be given. Default is true.</p>
   1.203 +<p>Note that this will not protect you from spammers using open relays, but from
   1.204 +users unable to set their address in their mail clients.</p>
   1.205 +</optdesc>
   1.206 +</option>
   1.207 +
   1.208 +<option>
   1.209 +<p><opt>do_queue = <arg>boolean</arg></opt></p>
   1.210 +<optdesc>
   1.211 +<p>If this is set, mail will not be delivered immediately when
   1.212 +accepted. Same as calling masqmail with the <opt>-odq</opt> option.</p>
   1.213 +</optdesc>
   1.214 +</option>
   1.215 +
   1.216 +<option>
   1.217 +<p><opt>online_routes.<arg>name</arg> = <arg>list</arg></opt></p>
   1.218 +<optdesc>
   1.219 +
   1.220 +<p>Replace <arg>name</arg> with a name to identify a connection. Set this
   1.221 +to a filename (or a list of filenames) for the special route configuration for that
   1.222 +connection. You will use that name to call masqmail with the
   1.223 + <opt>-qo</opt> option every time a connection to your ISP is set
   1.224 +up.</p>
   1.225 +
   1.226 +<p>Example: Your ISP has the name <i>FastNet</i>. Then you write the
   1.227 +following line in the main configuration:</p>
   1.228 +
   1.229 +<p><opt>online_routes.FastNet</opt> = <arg>"/etc/masqmail/fastnet.route"</arg></p>
   1.230 +
   1.231 +<p><file>/etc/masqmail/fastnet.route</file> is the route configuration
   1.232 +file, see <manref name="masqmail.route" section="5" href="masqmail.route.5.html"/>. As soon as a link to FastNet has been set up, you
   1.233 +call masqmail <opt>-qo</opt> <arg>FastNet</arg>. Masqmail will then
   1.234 +read the specified file and send the mails.</p>
   1.235 +
   1.236 +</optdesc>
   1.237 +</option>
   1.238 +
   1.239 +<option>
   1.240 +<p><opt>connect_route.<arg>name</arg> = <arg>list</arg></opt></p>
   1.241 +<optdesc>
   1.242 +<p>Old name for <opt>online_routes</opt>.</p>
   1.243 +</optdesc>
   1.244 +</option>
   1.245 +
   1.246 +
   1.247 +<option>
   1.248 +<p><opt>local_net_route = <arg>file</arg></opt></p>
   1.249 +<optdesc>
   1.250 +<p>This is similar to <opt>online_routes.<arg>name</arg></opt> but for the
   1.251 +local net. Recipient addresses that are in <b>local_nets</b> will be
   1.252 +routed using this route configuration. Main purpose is to define a
   1.253 +mail server with <b>mail_host</b> in your local network. In simple
   1.254 +environments this can be left unset. If unset, a default route
   1.255 +configuration will be used.</p>
   1.256 +</optdesc>
   1.257 +</option>
   1.258 +
   1.259 +<option>
   1.260 +<p><opt>alias_file = <arg>file</arg></opt></p>
   1.261 +<optdesc>
   1.262 +<p>Set this to the location of your alias file. If unset, no aliasing
   1.263 +will be done.</p>
   1.264 +</optdesc>
   1.265 +</option>
   1.266 +
   1.267 +<option>
   1.268 +<p><opt>alias_local_caseless = <arg>boolean</arg></opt></p>
   1.269 +<optdesc>
   1.270 +<p>If this is set, local parts in the alias file will be matched
   1.271 +disregarding upper/lower case.</p>
   1.272 +</optdesc>
   1.273 +</option>
   1.274 +
   1.275 +<option>
   1.276 +<p><opt>pipe_fromline = <arg>boolean</arg></opt></p>
   1.277 +<optdesc>
   1.278 +<p>If this is set, a from line will be prepended to the output stream whenever
   1.279 +a pipe command is called after an alias expansion. Default is false.</p>
   1.280 +</optdesc>
   1.281 +</option>
   1.282 +
   1.283 +<option>
   1.284 +<p><opt>pipe_fromhack = <arg>boolean</arg></opt></p>
   1.285 +<optdesc>
   1.286 +<p>If this is set, each line beginning with 'From ' is replaced with '>From ' whenever
   1.287 +a pipe command is called after an alias expansion. You probably want this if you have
   1.288 +set <opt>pipe_fromline</opt> above. Default is false.</p>
   1.289 +</optdesc>
   1.290 +</option>
   1.291 +
   1.292 +<option>
   1.293 +<p><opt>mbox_default = <arg>string</arg></opt></p>
   1.294 +<optdesc>
   1.295 +<p>The default local delivery method. Can be one of mbox, mda or
   1.296 +maildir (the latter only if maildir support is enabled at compile
   1.297 +time). Default is mbox. You can override this for each user by using
   1.298 +the <opt>mbox_users</opt>, <opt>mda_users</opt> or <opt>maildir_users</opt> options
   1.299 +(see below).
   1.300 +</p>
   1.301 +</optdesc>
   1.302 +</option>
   1.303 +
   1.304 +<option>
   1.305 +<p><opt>mbox_users = <arg>list</arg></opt></p>
   1.306 +<optdesc>
   1.307 +<p>A list of users which wish delivery to an mbox style mail folder.</p>
   1.308 +</optdesc>
   1.309 +</option>
   1.310 +
   1.311 +<option>
   1.312 +<p><opt>mda_users = <arg>list</arg></opt></p>
   1.313 +<optdesc>
   1.314 +<p>A list of users which wish local delivery to an mda. You have to
   1.315 +set <opt>mda</opt> (see below) as well.</p>
   1.316 +</optdesc>
   1.317 +</option>
   1.318 +
   1.319 +<option>
   1.320 +<p><opt>maildir_users = <arg>list</arg></opt></p>
   1.321 +<optdesc>
   1.322 +<p>A list of users which wish delivery to a qmail style maildir. The
   1.323 +path to maildir is ~/Maildir/. The maildir will be created if it
   1.324 +does not exist.</p>
   1.325 +</optdesc>
   1.326 +</option>
   1.327 +
   1.328 +<option>
   1.329 +<p><opt>mda = <arg>expand string</arg></opt></p>
   1.330 +<optdesc>
   1.331 +<p>If you want local delivery to be transferred to an mda (Mail
   1.332 +Delivery Agent), set this to a command. The argument will be expanded
   1.333 +on delivery time, you can use variables beginning with a '$' sign,
   1.334 +optionally enclosed in curly braces. Variables you can use are:</p>
   1.335 +<p>uid - the unique message id. This is not necessarily identical with
   1.336 +the Message ID as given in the Message ID: header.</p>
   1.337 +<p>received_host - the host the mail was received from</p>
   1.338 +<p>ident - the ident, this is either the ident delivered by the ident
   1.339 +protocol or the user id of the sender if the message was received locally.</p>
   1.340 +<p>return_path_local - the local part of the return path (sender).</p>
   1.341 +<p>return_path_domain - the domain part of the return path (sender).</p>
   1.342 +<p>return_path - the complete return path (sender).</p>
   1.343 +<p>rcpt_local - the local part of the recipient.</p>
   1.344 +<p>rcpt_domain - the domain part of the recipient.</p>
   1.345 +<p>rcpt - the complete recipient address.</p>
   1.346 +<p>Example:</p><p>mda="/usr/bin/procmail -Y -d ${rcpt_local}"</p>
   1.347 +<p>For the mda, as for pipe commands, a few environment variables will
   1.348 +be set as well. See <manref name="masqmail" section="8"
   1.349 +href="masqmail.8.html"/>. To use environment variables for the mda,
   1.350 +the '$' sign has to be escaped with a backslash, otherwise they will
   1.351 +be tried to be expanded with the internal variables.</p>
   1.352 +
   1.353 +</optdesc>
   1.354 +</option>
   1.355 +
   1.356 +<option>
   1.357 +<p><opt>mda_fromline = <arg>boolean</arg></opt></p>
   1.358 +<optdesc>
   1.359 +<p>If this is set, a from line will be prepended to the output stream whenever
   1.360 +a message is delivered to an mda. Default is false.</p>
   1.361 +</optdesc>
   1.362 +</option>
   1.363 +
   1.364 +<option>
   1.365 +<p><opt>mda_fromhack = <arg>boolean</arg></opt></p>
   1.366 +<optdesc>
   1.367 +<p>If this is set, each line beginning with 'From ' is replaced with '>From ' whenever
   1.368 +a message is delivered to an mda. You probably want this if you have
   1.369 +set <opt>mda_fromline</opt> above. Default is false.</p>
   1.370 +</optdesc>
   1.371 +</option>
   1.372 +
   1.373 +<option>
   1.374 +<p><opt>online_detect = <arg>string</arg></opt></p>
   1.375 +<optdesc>
   1.376 +<p>Defines the method MasqMail uses to detect whether there is
   1.377 +currently an online connection. It can have the
   1.378 +values <opt>file</opt>, <opt>pipe</opt> or <opt>mserver</opt>.</p>
   1.379 +
   1.380 +<p>When it is set to <opt>file</opt>, MasqMail first checks for the
   1.381 +existence of <opt>online_file</opt> (see below) and if it exists, it reads
   1.382 +it. The content of the file should be the name of the current
   1.383 +connection as defined with <opt>connect_route.<arg>name</arg></opt> (without
   1.384 +a trailing newline character).</p>
   1.385 +
   1.386 +<p>When it is set to <opt>pipe</opt>, MasqMail calls the executable given by
   1.387 +the <opt>online_pipe</opt> option (see below) and reads the current online
   1.388 +status from its standard output.</p>
   1.389 +
   1.390 +<p>When it is set to <opt>mserver</opt>, MasqMail connects to the
   1.391 +masqdialer server using the value of <opt>mserver_iface</opt> and asks it
   1.392 +whether a connection exists and for the name, which should be the name
   1.393 +of the current connection as defined with <opt>connect_route.<arg>name</arg></opt>.</p>
   1.394 +
   1.395 +<p>No matter how MasqMail detects the online status, only messages
   1.396 +that are accepted at online time will be delivered using the
   1.397 +connection. The spool still has to be emptied with masqmail <opt>-qo</opt>
   1.398 +<arg>connection</arg>.</p>
   1.399 +</optdesc>
   1.400 +</option>
   1.401 +
   1.402 +<option>
   1.403 +<p><opt>online_file = <arg>file</arg></opt></p>
   1.404 +<optdesc>
   1.405 +<p>This is the name of the file checked for when MasqMail determines
   1.406 +whether it is online. The file should only exist when there is
   1.407 +currently a connection. Create it in your ip-up script with eg.</p>
   1.408 +
   1.409 +<p>echo -n &lt;name&gt; &gt; /tmp/connect_route</p>
   1.410 +<p>chmod 0644 /tmp/connect_route</p>
   1.411 +
   1.412 +<p>Do not forget to delete it in your ip-down script.</p>
   1.413 +</optdesc>
   1.414 +</option>
   1.415 +
   1.416 +<option>
   1.417 +<p><opt>online_pipe = <arg>file</arg></opt></p>
   1.418 +<optdesc>
   1.419 +<p>This is the name of the executable which will be called to determine
   1.420 +the online status. This executable should just print the name oif the current
   1.421 +connection to the standard output and return a zero status code. masqmail assumes
   1.422 +it is offline if the script returns with a non zero status. Simple example:</p>
   1.423 +
   1.424 +<p>#!/bin/sh</p>
   1.425 +<p></p>
   1.426 +<p>[ -e /tmp/connect_route ] || exit 1</p>
   1.427 +<p>cat /tmp/connect_route</p>
   1.428 +<p>exit 0</p>
   1.429 +
   1.430 +<p>Of course, instead of the example above you could as well use <opt>file</opt> as
   1.431 +the online detection method, but you can do something more sophisticated.</p>
   1.432 +</optdesc>
   1.433 +</option>
   1.434 +
   1.435 +<option>
   1.436 +<p><opt>mserver_iface = <arg>interface</arg></opt></p>
   1.437 +<optdesc>
   1.438 +<p>The interface the masqdialer server is listening to. Usually this
   1.439 +will be "localhost:224" if mserver is running on the same host as
   1.440 +masqmail. But using this option, you can also let masqmail run on
   1.441 +another host by setting <opt>mserver_iface</opt> to another hostname,
   1.442 +eg. "foo:224".</p>
   1.443 +</optdesc>
   1.444 +</option>
   1.445 +
   1.446 +<option>
   1.447 +<p><opt>get.<arg>name</arg> = <arg>file</arg></opt></p>
   1.448 +<optdesc>
   1.449 +<p>Replace <arg>name</arg> with a name to identify a get
   1.450 +configuration. Set this to a filename for the get configuration. These
   1.451 +files will be used to retrieve mail when called with the -g option.</p>
   1.452 +</optdesc>
   1.453 +</option>
   1.454 +
   1.455 +<option>
   1.456 +<p><opt>online_gets.<arg>name</arg> = <arg>list</arg></opt></p>
   1.457 +<optdesc>
   1.458 +<p>Replace <arg>name</arg> with a name to identify an online
   1.459 +configuration. Set this to a filename (or a list of filenames) for the get configuration. These
   1.460 +files will be used to retrieve mail when called with the -go option.</p>
   1.461 +</optdesc>
   1.462 +</option>
   1.463 +
   1.464 +<option>
   1.465 +<p><opt>ident_trusted_nets = <arg>list</arg></opt></p>
   1.466 +<optdesc>
   1.467 +<p><arg>list</arg> is a list of networks of the form a.b.c.d/e
   1.468 +(eg. 192.168.1.0/24), from which the ident given by the ident protocol
   1.469 +will be trusted, so a user can delete his mail from the queue if the
   1.470 +ident is identical to his login name.</p>
   1.471 +</optdesc>
   1.472 +</option>
   1.473 +
   1.474 +<option>
   1.475 +<p><opt>errmsg_file = <arg>file</arg></opt></p>
   1.476 +<optdesc>
   1.477 +<p>Set this to a template which will be used to generate delivery failure
   1.478 +reports. Variable parts within the template begin with a dollar sign and
   1.479 +are identical to those which can be used as arguments for the mda command,
   1.480 +see <opt>mda</opt> above. Additional information can be included with
   1.481 +@failed_rcpts, @msg_headers and @msg_body, these <b>must</b> be at the
   1.482 +beginning of a line and will be replaced with the list of the failed recipients,
   1.483 +the message headers and the message body of the failed message.</p>
   1.484 +<p>Default is /usr/share/masqmail/tpl/failmsg.tpl.</p>
   1.485 +</optdesc>
   1.486 +</option>
   1.487 +
   1.488 +<option>
   1.489 +<p><opt>warnmsg_file = <arg>file</arg></opt></p>
   1.490 +<optdesc>
   1.491 +<p>Set this to a template which will be used to generate delivery warning
   1.492 +reports. It uses the same mechanisms for variables as <opt>errmsg_file</opt>,
   1.493 +see above.
   1.494 +</p>
   1.495 +<p>Default is /usr/share/masqmail/tpl/warnmsg.tpl.</p>
   1.496 +</optdesc>
   1.497 +</option>
   1.498 +
   1.499 +<option>
   1.500 +<p><opt>warn_intervals</opt> = <arg>list</arg></p>
   1.501 +<optdesc>
   1.502 +<p>Set this to a list of time intervals, at which delivery warnings (starting
   1.503 +with the receiving time of the message) shall be generated.</p>
   1.504 +<p>A warning will only be generated just after an attempt to deliver the
   1.505 +mail and if that attempt failed temporarily. So a warning may be generated after
   1.506 +a longer time, if there was no attempt before.</p>
   1.507 +<p>Default is "1h;4h;8h;1d;2d;3d"</p>
   1.508 +</optdesc>
   1.509 +</option>
   1.510 +
   1.511 +<option>
   1.512 +<p><opt>max_defer_time</opt> = <arg>time</arg></p>
   1.513 +<optdesc>
   1.514 +<p>This is the maximum time, in which a temporarily failed mail will be kept
   1.515 +in the spool. When this time is exceeded, it will be handled as a delivery failure,
   1.516 +and the message will be bounced.</p>
   1.517 +<p>The excedence of this time will only be noticed if the message was actually
   1.518 +tried to be delivered. If, for example, the message can only be delivered when
   1.519 +online, but you have not been online for that time, no bounce will be generated.</p>
   1.520 +<p>Default is 4d (4 days)</p>
   1.521 +</optdesc>
   1.522 +</option>
   1.523 +
   1.524 +<option>
   1.525 +<p><opt>log_user = <arg>name</arg></opt></p>
   1.526 +<optdesc>
   1.527 +<p>Replace <arg>name</arg> with a valid local or remote mail address.</p>
   1.528 +<p>If this option is not empty, then a copy of every mail,
   1.529 +that passes trough the masqmail system will also be sent to the
   1.530 +given mail address.</p>
   1.531 +<p>For example you can feed your mails into a program like <i>hypermail</i> for
   1.532 +archiving purpose by placing an appropriate pipe command in masqmail.alias</p>
   1.533 +</optdesc>
   1.534 +</option>
   1.535 +
   1.536 +</options>
   1.537 +
   1.538 +<section name = "Author">
   1.539 +<p>masqmail was written by Oliver Kurth
   1.540 +&lt;oku@masqmail.cx&gt;</p><p>You will find the newest version of
   1.541 +masqmail at <url href="http://masqmail.cx/masqmail/"/> or search for it
   1.542 +in freshmeat (<url href="http://www.freshmeat.net"/>). There is also a mailing list,
   1.543 +you will find information about it at masqmails main site.</p>
   1.544 +</section>
   1.545 +
   1.546 +<section name = "Bugs">
   1.547 +<p>You should report them to the mailing list.</p>
   1.548 +</section>
   1.549 +
   1.550 +<section name = "See also">
   1.551 +<p>
   1.552 +<manref name="masqmail" section="8" href="masqmail.8.html"/>, <manref name="masqmail.route" section="5" href="masqmail.route.5.html"/>, <manref name="masqmail.get" section="5" href="masqmail.get.5.html"/>
   1.553 +</p>
   1.554 +</section>
   1.555 +
   1.556 +
   1.557 +<section name = "Comments">
   1.558 +<p>This man page was written using <manref name="xml2man" section="1"
   1.559 +href="http://masqmail.cx/xml2man/"/> by the same
   1.560 +author.</p>
   1.561 +</section>
   1.562 +
   1.563 +</manpage>
   1.564 +