masqmail-0.2

annotate docs/xml/masqmail.conf.5.xml @ 2:653aef34b225

find changesets by author, revision, files, or words in the commit message
removed distribution specific data
author meillo@marmaro.de
date Fri, 26 Sep 2008 21:26:36 +0200
parents
children
rev   line source
meillo@0 1 <?xml version="1.0" standalone='no'?>
meillo@0 2 <!DOCTYPE spec SYSTEM "man.dtd">
meillo@0 3
meillo@0 4 <manpage name="masqmail.conf" section="5" desc="masqmail configuration file">
meillo@0 5
meillo@0 6 <description>
meillo@0 7 <p>This man page describes the syntax of the main configuration file
meillo@0 8 of masqmail. Its usual location is <file>/etc/masqmail/masqmail.conf</file></p>
meillo@0 9
meillo@0 10 <p>The configuration consists of lines of the form</p>
meillo@0 11
meillo@0 12 <p><opt>val</opt> = <arg>expression</arg></p>
meillo@0 13
meillo@0 14 <p>Where <opt>val</opt> is a variable name and <arg>expression</arg> a string,
meillo@0 15 which can be quoted with '"'. If the expression is on multiple lines
meillo@0 16 or contains characters other than letters, digits or the characters
meillo@0 17 '.', '-', '_', '/', it <em>must</em> be quoted. You can use quotes inside quotes
meillo@0 18 by escaping them with a backslash.</p>
meillo@0 19
meillo@0 20 <p>Each val has a <i>type</i>, which can be boolean, numeric, string
meillo@0 21 or list. A boolean variable can be set with one of the values 'on',
meillo@0 22 'yes', and 'true' or 'off', 'no' and 'false'. List items are separated
meillo@0 23 with ';'. For some values patterns (like '*','?') can be used. The
meillo@0 24 spaces before and after the '=' are optional.</p>
meillo@0 25
meillo@0 26 <p>Most lists (exceptions: <opt>local_hosts</opt>,
meillo@0 27 <opt>local_nets</opt>, <opt>listen_addresses</opt>, <opt>online_routes</opt> and <opt>online_gets</opt>) accept
meillo@0 28 files. These will be recognized by a leading slash '/'. The contents
meillo@0 29 of these files will be included at the position of the file name,
meillo@0 30 there can be items or other files before and after the file entry. The
meillo@0 31 format of the files is different though, within these files each entry
meillo@0 32 is on another line. (And not separated by semicolons). This makes it
meillo@0 33 easy to include large lists which are common in different
meillo@0 34 configuration files, so they do not have to appear in every
meillo@0 35 configuration file.</p>
meillo@0 36
meillo@0 37 <p>Blank lines and lines starting with '#' are ignored.</p>
meillo@0 38
meillo@0 39 </description>
meillo@0 40
meillo@0 41 <options>
meillo@0 42 <option>
meillo@0 43 <p><opt>run_as_user = <arg>boolean</arg></opt></p>
meillo@0 44 <optdesc>
meillo@0 45 <p>If this is set, masqmail runs with the user id of the user who
meillo@0 46 invoked it and never changes it. This is for debugging purposes
meillo@0 47 <em>only</em>. If the user is not root, masqmail will not be able to
meillo@0 48 listen on a port &lt; 1024 and will not be able to deliver local mail
meillo@0 49 to others than the user.</p>
meillo@0 50 </optdesc>
meillo@0 51 </option>
meillo@0 52
meillo@0 53 <option>
meillo@0 54 <p><opt>use_syslog = <arg>boolean</arg></opt></p>
meillo@0 55 <optdesc>
meillo@0 56 <p>If this is set, masqmail uses syslogd for logging. It uses facility
meillo@0 57 MAIL. You still have to set <opt>log_dir</opt> for debug files.</p>
meillo@0 58 </optdesc>
meillo@0 59 </option>
meillo@0 60
meillo@0 61 <option>
meillo@0 62 <p><opt>debug_level = <arg>n</arg></opt></p>
meillo@0 63 <optdesc>
meillo@0 64 <p>Set the debug level. Valid values are 0 to 6, increasing it further
meillo@0 65 makes no difference. Be careful if you set this as high as 5 or higher,
meillo@0 66 the logs may very soon fill your hard drive.</p>
meillo@0 67 </optdesc>
meillo@0 68 </option>
meillo@0 69
meillo@0 70 <option>
meillo@0 71 <p><opt>mail_dir = <arg>file</arg></opt></p>
meillo@0 72 <optdesc>
meillo@0 73 <p>The directory where local mail is stored,
meillo@0 74 usually <file>/var/spool/mail</file> or <file>/var/mail</file>.</p>
meillo@0 75 </optdesc>
meillo@0 76 </option>
meillo@0 77
meillo@0 78 <option>
meillo@0 79 <p><opt>spool_dir = <arg>file</arg></opt></p>
meillo@0 80 <optdesc>
meillo@0 81 <p>The directory where masqmail stores its spool files (and later also
meillo@0 82 other stuff). It <em>must</em> have a subdirectory <file>input</file>.
meillo@0 83 Masqmail needs read and write permissions for this
meillo@0 84 directory. I suggest to use <file>/var/spool/masqmail</file>.</p>
meillo@0 85 </optdesc>
meillo@0 86 </option>
meillo@0 87
meillo@0 88 <option>
meillo@0 89 <p><opt>host_name = <arg>string</arg></opt></p>
meillo@0 90 <optdesc>
meillo@0 91 <p>This is used in different places: Masqmail identifies itself in the
meillo@0 92 greeting banner on incoming connections and in the HELO/EHLO command
meillo@0 93 for outgoing connections with this name, it is used in the Received:
meillo@0 94 header and to qualify the sender of a locally originating message.</p>
meillo@0 95
meillo@0 96 <p>If the string begins with a slash '/', it it assumed that it is a
meillo@0 97 filename, and the first line of this file will be used. Usually this will
meillo@0 98 be '/etc/mailname' to make masqmail conform to Debian policies.</p>
meillo@0 99
meillo@0 100 <p>It is <em>not</em> used to find whether an address is local.
meillo@0 101 Use <opt>local_hosts</opt> for that.</p>
meillo@0 102 </optdesc>
meillo@0 103 </option>
meillo@0 104
meillo@0 105 <option>
meillo@0 106 <p><opt>remote_port = <arg>n</arg></opt></p>
meillo@0 107 <optdesc>
meillo@0 108 <p>The remote port number to be used. This defaults to port 25.</p>
meillo@0 109 <p>This option is deprecated. Use <opt>host_name</opt> in the route
meillo@0 110 configuration instead. See <manref name="masqmail.route" section="5"
meillo@0 111 href="masqmail.route.5.html"/>.</p>
meillo@0 112 </optdesc>
meillo@0 113 </option>
meillo@0 114
meillo@0 115 <option>
meillo@0 116 <p><opt>local_hosts = <arg>list</arg></opt></p>
meillo@0 117 <optdesc>
meillo@0 118 <p>A semicolon ';' separated list of hostnames which are considered
meillo@0 119 local. Normally you set it to "localhost;foo;foo.bar.com" if your host
meillo@0 120 has the fully qualified domain name 'foo.bar.com'.</p>
meillo@0 121 </optdesc>
meillo@0 122 </option>
meillo@0 123
meillo@0 124 <option>
meillo@0 125 <p><opt>local_nets = <arg>list</arg></opt></p>
meillo@0 126 <optdesc>
meillo@0 127 <p>A semicolon ';' separated list of hostnames which are on the
meillo@0 128 'local' net. Delivery to these hosts is attempted immediately. You can
meillo@0 129 use patterns with '*', eg. "*.bar.com".</p>
meillo@0 130 </optdesc>
meillo@0 131 </option>
meillo@0 132
meillo@0 133 <option>
meillo@0 134 <p><opt>local_addresses = <arg>list</arg></opt></p>
meillo@0 135 <optdesc>
meillo@0 136 <p>A semicolon ';' separated list of fully qualified email-addresses
meillo@0 137 which are considered local although their domain name part is not in
meillo@0 138 the list of <opt>local_hosts</opt>. </p>
meillo@0 139 <p>For example: There are two people working at your
meillo@0 140 LAN: person1@yourdomain and person2@yourdomain. But there are
meillo@0 141 other persons @yourdomain which are NOT local. So you can not put
meillo@0 142 yourdomain to the list of local_hosts. If person1 now wants
meillo@0 143 to write to person2@yourdomain and this mail should not leave the LAN
meillo@0 144 then you can put</p>
meillo@0 145 <p>local_addresses = "person1@yourdomain;person2@yourdomain"</p>
meillo@0 146 <p>to your masqmail.conf.</p>
meillo@0 147 </optdesc>
meillo@0 148 </option>
meillo@0 149
meillo@0 150 <option>
meillo@0 151 <p><opt>not_local_addresses = <arg>list</arg></opt></p>
meillo@0 152 <optdesc>
meillo@0 153 <p>A semicolon ';' separated list of fully qualified email-addresses
meillo@0 154 which are considered not local although their domain name part is in
meillo@0 155 the list of <opt>local_hosts</opt>. </p>
meillo@0 156 <p>This ist the opposite of the previous case. The majority of addresses
meillo@0 157 of a specific domain are local. But some users are not. With this
meillo@0 158 option you can easily exclude these users.</p>
meillo@0 159 <p>Example:</p>
meillo@0 160 <p>local_hosts = "localhost;myhost;mydomain.net"</p>
meillo@0 161 <p>not_local_addresses = "eric@mydomain.net"</p>
meillo@0 162 </optdesc>
meillo@0 163 </option>
meillo@0 164
meillo@0 165 <option>
meillo@0 166 <p><opt>listen_addresses = <arg>list</arg></opt></p>
meillo@0 167 <optdesc>
meillo@0 168 <p>A semicolon ';' separated list of interfaces on which connections
meillo@0 169 will be accepted. An interface ist defined by a hostname, optionally
meillo@0 170 followed by a colon ':' and a number for the port. If this is left out,
meillo@0 171 port 25 will be used.</p>
meillo@0 172 <p>You can set this to "localhost:25;foo:25" if your hostname is 'foo'.</p>
meillo@0 173 <p>Note that the names are resolved to IP addreses. If your host has
meillo@0 174 different names which resolve to the same IP, use only one of them,
meillo@0 175 otherwise you will get an error message.
meillo@0 176 </p>
meillo@0 177 </optdesc>
meillo@0 178 </option>
meillo@0 179
meillo@0 180 <option>
meillo@0 181 <p><opt>do_save_envelope_to = <arg>boolean</arg></opt></p>
meillo@0 182 <optdesc>
meillo@0 183 <p>If this is set to true, a possibly existing Envelope-to: header in an
meillo@0 184 incoming mail which is received via either pop3 or smtp will be saved as
meillo@0 185 an X-Orig-Envelope-to: header.</p>
meillo@0 186 <p>This is useful if you retrieve mail from a pop3 server with either masqmail
meillo@0 187 or fetchmail, and the server supports Envelope-to: headers, and you want to make use
meillo@0 188 of those with a mail filtering tool, eg. procmail. It cannot be preserved because
meillo@0 189 masqmail sets such a header by itself.</p>
meillo@0 190 <p>Default is false.</p>
meillo@0 191 </optdesc>
meillo@0 192 </option>
meillo@0 193
meillo@0 194 <option>
meillo@0 195 <p><opt>do_relay = <arg>boolean</arg></opt></p>
meillo@0 196 <optdesc>
meillo@0 197 <p>If this is set to false, mail with a return path that is not local and a
meillo@0 198 destination that is also not local will not be accepted via smtp and a 550
meillo@0 199 reply will be given. Default is true.</p>
meillo@0 200 <p>Note that this will not protect you from spammers using open relays, but from
meillo@0 201 users unable to set their address in their mail clients.</p>
meillo@0 202 </optdesc>
meillo@0 203 </option>
meillo@0 204
meillo@0 205 <option>
meillo@0 206 <p><opt>do_queue = <arg>boolean</arg></opt></p>
meillo@0 207 <optdesc>
meillo@0 208 <p>If this is set, mail will not be delivered immediately when
meillo@0 209 accepted. Same as calling masqmail with the <opt>-odq</opt> option.</p>
meillo@0 210 </optdesc>
meillo@0 211 </option>
meillo@0 212
meillo@0 213 <option>
meillo@0 214 <p><opt>online_routes.<arg>name</arg> = <arg>list</arg></opt></p>
meillo@0 215 <optdesc>
meillo@0 216
meillo@0 217 <p>Replace <arg>name</arg> with a name to identify a connection. Set this
meillo@0 218 to a filename (or a list of filenames) for the special route configuration for that
meillo@0 219 connection. You will use that name to call masqmail with the
meillo@0 220 <opt>-qo</opt> option every time a connection to your ISP is set
meillo@0 221 up.</p>
meillo@0 222
meillo@0 223 <p>Example: Your ISP has the name <i>FastNet</i>. Then you write the
meillo@0 224 following line in the main configuration:</p>
meillo@0 225
meillo@0 226 <p><opt>online_routes.FastNet</opt> = <arg>"/etc/masqmail/fastnet.route"</arg></p>
meillo@0 227
meillo@0 228 <p><file>/etc/masqmail/fastnet.route</file> is the route configuration
meillo@0 229 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
meillo@0 230 call masqmail <opt>-qo</opt> <arg>FastNet</arg>. Masqmail will then
meillo@0 231 read the specified file and send the mails.</p>
meillo@0 232
meillo@0 233 </optdesc>
meillo@0 234 </option>
meillo@0 235
meillo@0 236 <option>
meillo@0 237 <p><opt>connect_route.<arg>name</arg> = <arg>list</arg></opt></p>
meillo@0 238 <optdesc>
meillo@0 239 <p>Old name for <opt>online_routes</opt>.</p>
meillo@0 240 </optdesc>
meillo@0 241 </option>
meillo@0 242
meillo@0 243
meillo@0 244 <option>
meillo@0 245 <p><opt>local_net_route = <arg>file</arg></opt></p>
meillo@0 246 <optdesc>
meillo@0 247 <p>This is similar to <opt>online_routes.<arg>name</arg></opt> but for the
meillo@0 248 local net. Recipient addresses that are in <b>local_nets</b> will be
meillo@0 249 routed using this route configuration. Main purpose is to define a
meillo@0 250 mail server with <b>mail_host</b> in your local network. In simple
meillo@0 251 environments this can be left unset. If unset, a default route
meillo@0 252 configuration will be used.</p>
meillo@0 253 </optdesc>
meillo@0 254 </option>
meillo@0 255
meillo@0 256 <option>
meillo@0 257 <p><opt>alias_file = <arg>file</arg></opt></p>
meillo@0 258 <optdesc>
meillo@0 259 <p>Set this to the location of your alias file. If unset, no aliasing
meillo@0 260 will be done.</p>
meillo@0 261 </optdesc>
meillo@0 262 </option>
meillo@0 263
meillo@0 264 <option>
meillo@0 265 <p><opt>alias_local_caseless = <arg>boolean</arg></opt></p>
meillo@0 266 <optdesc>
meillo@0 267 <p>If this is set, local parts in the alias file will be matched
meillo@0 268 disregarding upper/lower case.</p>
meillo@0 269 </optdesc>
meillo@0 270 </option>
meillo@0 271
meillo@0 272 <option>
meillo@0 273 <p><opt>pipe_fromline = <arg>boolean</arg></opt></p>
meillo@0 274 <optdesc>
meillo@0 275 <p>If this is set, a from line will be prepended to the output stream whenever
meillo@0 276 a pipe command is called after an alias expansion. Default is false.</p>
meillo@0 277 </optdesc>
meillo@0 278 </option>
meillo@0 279
meillo@0 280 <option>
meillo@0 281 <p><opt>pipe_fromhack = <arg>boolean</arg></opt></p>
meillo@0 282 <optdesc>
meillo@0 283 <p>If this is set, each line beginning with 'From ' is replaced with '>From ' whenever
meillo@0 284 a pipe command is called after an alias expansion. You probably want this if you have
meillo@0 285 set <opt>pipe_fromline</opt> above. Default is false.</p>
meillo@0 286 </optdesc>
meillo@0 287 </option>
meillo@0 288
meillo@0 289 <option>
meillo@0 290 <p><opt>mbox_default = <arg>string</arg></opt></p>
meillo@0 291 <optdesc>
meillo@0 292 <p>The default local delivery method. Can be one of mbox, mda or
meillo@0 293 maildir (the latter only if maildir support is enabled at compile
meillo@0 294 time). Default is mbox. You can override this for each user by using
meillo@0 295 the <opt>mbox_users</opt>, <opt>mda_users</opt> or <opt>maildir_users</opt> options
meillo@0 296 (see below).
meillo@0 297 </p>
meillo@0 298 </optdesc>
meillo@0 299 </option>
meillo@0 300
meillo@0 301 <option>
meillo@0 302 <p><opt>mbox_users = <arg>list</arg></opt></p>
meillo@0 303 <optdesc>
meillo@0 304 <p>A list of users which wish delivery to an mbox style mail folder.</p>
meillo@0 305 </optdesc>
meillo@0 306 </option>
meillo@0 307
meillo@0 308 <option>
meillo@0 309 <p><opt>mda_users = <arg>list</arg></opt></p>
meillo@0 310 <optdesc>
meillo@0 311 <p>A list of users which wish local delivery to an mda. You have to
meillo@0 312 set <opt>mda</opt> (see below) as well.</p>
meillo@0 313 </optdesc>
meillo@0 314 </option>
meillo@0 315
meillo@0 316 <option>
meillo@0 317 <p><opt>maildir_users = <arg>list</arg></opt></p>
meillo@0 318 <optdesc>
meillo@0 319 <p>A list of users which wish delivery to a qmail style maildir. The
meillo@0 320 path to maildir is ~/Maildir/. The maildir will be created if it
meillo@0 321 does not exist.</p>
meillo@0 322 </optdesc>
meillo@0 323 </option>
meillo@0 324
meillo@0 325 <option>
meillo@0 326 <p><opt>mda = <arg>expand string</arg></opt></p>
meillo@0 327 <optdesc>
meillo@0 328 <p>If you want local delivery to be transferred to an mda (Mail
meillo@0 329 Delivery Agent), set this to a command. The argument will be expanded
meillo@0 330 on delivery time, you can use variables beginning with a '$' sign,
meillo@0 331 optionally enclosed in curly braces. Variables you can use are:</p>
meillo@0 332 <p>uid - the unique message id. This is not necessarily identical with
meillo@0 333 the Message ID as given in the Message ID: header.</p>
meillo@0 334 <p>received_host - the host the mail was received from</p>
meillo@0 335 <p>ident - the ident, this is either the ident delivered by the ident
meillo@0 336 protocol or the user id of the sender if the message was received locally.</p>
meillo@0 337 <p>return_path_local - the local part of the return path (sender).</p>
meillo@0 338 <p>return_path_domain - the domain part of the return path (sender).</p>
meillo@0 339 <p>return_path - the complete return path (sender).</p>
meillo@0 340 <p>rcpt_local - the local part of the recipient.</p>
meillo@0 341 <p>rcpt_domain - the domain part of the recipient.</p>
meillo@0 342 <p>rcpt - the complete recipient address.</p>
meillo@0 343 <p>Example:</p><p>mda="/usr/bin/procmail -Y -d ${rcpt_local}"</p>
meillo@0 344 <p>For the mda, as for pipe commands, a few environment variables will
meillo@0 345 be set as well. See <manref name="masqmail" section="8"
meillo@0 346 href="masqmail.8.html"/>. To use environment variables for the mda,
meillo@0 347 the '$' sign has to be escaped with a backslash, otherwise they will
meillo@0 348 be tried to be expanded with the internal variables.</p>
meillo@0 349
meillo@0 350 </optdesc>
meillo@0 351 </option>
meillo@0 352
meillo@0 353 <option>
meillo@0 354 <p><opt>mda_fromline = <arg>boolean</arg></opt></p>
meillo@0 355 <optdesc>
meillo@0 356 <p>If this is set, a from line will be prepended to the output stream whenever
meillo@0 357 a message is delivered to an mda. Default is false.</p>
meillo@0 358 </optdesc>
meillo@0 359 </option>
meillo@0 360
meillo@0 361 <option>
meillo@0 362 <p><opt>mda_fromhack = <arg>boolean</arg></opt></p>
meillo@0 363 <optdesc>
meillo@0 364 <p>If this is set, each line beginning with 'From ' is replaced with '>From ' whenever
meillo@0 365 a message is delivered to an mda. You probably want this if you have
meillo@0 366 set <opt>mda_fromline</opt> above. Default is false.</p>
meillo@0 367 </optdesc>
meillo@0 368 </option>
meillo@0 369
meillo@0 370 <option>
meillo@0 371 <p><opt>online_detect = <arg>string</arg></opt></p>
meillo@0 372 <optdesc>
meillo@0 373 <p>Defines the method MasqMail uses to detect whether there is
meillo@0 374 currently an online connection. It can have the
meillo@0 375 values <opt>file</opt>, <opt>pipe</opt> or <opt>mserver</opt>.</p>
meillo@0 376
meillo@0 377 <p>When it is set to <opt>file</opt>, MasqMail first checks for the
meillo@0 378 existence of <opt>online_file</opt> (see below) and if it exists, it reads
meillo@0 379 it. The content of the file should be the name of the current
meillo@0 380 connection as defined with <opt>connect_route.<arg>name</arg></opt> (without
meillo@0 381 a trailing newline character).</p>
meillo@0 382
meillo@0 383 <p>When it is set to <opt>pipe</opt>, MasqMail calls the executable given by
meillo@0 384 the <opt>online_pipe</opt> option (see below) and reads the current online
meillo@0 385 status from its standard output.</p>
meillo@0 386
meillo@0 387 <p>When it is set to <opt>mserver</opt>, MasqMail connects to the
meillo@0 388 masqdialer server using the value of <opt>mserver_iface</opt> and asks it
meillo@0 389 whether a connection exists and for the name, which should be the name
meillo@0 390 of the current connection as defined with <opt>connect_route.<arg>name</arg></opt>.</p>
meillo@0 391
meillo@0 392 <p>No matter how MasqMail detects the online status, only messages
meillo@0 393 that are accepted at online time will be delivered using the
meillo@0 394 connection. The spool still has to be emptied with masqmail <opt>-qo</opt>
meillo@0 395 <arg>connection</arg>.</p>
meillo@0 396 </optdesc>
meillo@0 397 </option>
meillo@0 398
meillo@0 399 <option>
meillo@0 400 <p><opt>online_file = <arg>file</arg></opt></p>
meillo@0 401 <optdesc>
meillo@0 402 <p>This is the name of the file checked for when MasqMail determines
meillo@0 403 whether it is online. The file should only exist when there is
meillo@0 404 currently a connection. Create it in your ip-up script with eg.</p>
meillo@0 405
meillo@0 406 <p>echo -n &lt;name&gt; &gt; /tmp/connect_route</p>
meillo@0 407 <p>chmod 0644 /tmp/connect_route</p>
meillo@0 408
meillo@0 409 <p>Do not forget to delete it in your ip-down script.</p>
meillo@0 410 </optdesc>
meillo@0 411 </option>
meillo@0 412
meillo@0 413 <option>
meillo@0 414 <p><opt>online_pipe = <arg>file</arg></opt></p>
meillo@0 415 <optdesc>
meillo@0 416 <p>This is the name of the executable which will be called to determine
meillo@0 417 the online status. This executable should just print the name oif the current
meillo@0 418 connection to the standard output and return a zero status code. masqmail assumes
meillo@0 419 it is offline if the script returns with a non zero status. Simple example:</p>
meillo@0 420
meillo@0 421 <p>#!/bin/sh</p>
meillo@0 422 <p></p>
meillo@0 423 <p>[ -e /tmp/connect_route ] || exit 1</p>
meillo@0 424 <p>cat /tmp/connect_route</p>
meillo@0 425 <p>exit 0</p>
meillo@0 426
meillo@0 427 <p>Of course, instead of the example above you could as well use <opt>file</opt> as
meillo@0 428 the online detection method, but you can do something more sophisticated.</p>
meillo@0 429 </optdesc>
meillo@0 430 </option>
meillo@0 431
meillo@0 432 <option>
meillo@0 433 <p><opt>mserver_iface = <arg>interface</arg></opt></p>
meillo@0 434 <optdesc>
meillo@0 435 <p>The interface the masqdialer server is listening to. Usually this
meillo@0 436 will be "localhost:224" if mserver is running on the same host as
meillo@0 437 masqmail. But using this option, you can also let masqmail run on
meillo@0 438 another host by setting <opt>mserver_iface</opt> to another hostname,
meillo@0 439 eg. "foo:224".</p>
meillo@0 440 </optdesc>
meillo@0 441 </option>
meillo@0 442
meillo@0 443 <option>
meillo@0 444 <p><opt>get.<arg>name</arg> = <arg>file</arg></opt></p>
meillo@0 445 <optdesc>
meillo@0 446 <p>Replace <arg>name</arg> with a name to identify a get
meillo@0 447 configuration. Set this to a filename for the get configuration. These
meillo@0 448 files will be used to retrieve mail when called with the -g option.</p>
meillo@0 449 </optdesc>
meillo@0 450 </option>
meillo@0 451
meillo@0 452 <option>
meillo@0 453 <p><opt>online_gets.<arg>name</arg> = <arg>list</arg></opt></p>
meillo@0 454 <optdesc>
meillo@0 455 <p>Replace <arg>name</arg> with a name to identify an online
meillo@0 456 configuration. Set this to a filename (or a list of filenames) for the get configuration. These
meillo@0 457 files will be used to retrieve mail when called with the -go option.</p>
meillo@0 458 </optdesc>
meillo@0 459 </option>
meillo@0 460
meillo@0 461 <option>
meillo@0 462 <p><opt>ident_trusted_nets = <arg>list</arg></opt></p>
meillo@0 463 <optdesc>
meillo@0 464 <p><arg>list</arg> is a list of networks of the form a.b.c.d/e
meillo@0 465 (eg. 192.168.1.0/24), from which the ident given by the ident protocol
meillo@0 466 will be trusted, so a user can delete his mail from the queue if the
meillo@0 467 ident is identical to his login name.</p>
meillo@0 468 </optdesc>
meillo@0 469 </option>
meillo@0 470
meillo@0 471 <option>
meillo@0 472 <p><opt>errmsg_file = <arg>file</arg></opt></p>
meillo@0 473 <optdesc>
meillo@0 474 <p>Set this to a template which will be used to generate delivery failure
meillo@0 475 reports. Variable parts within the template begin with a dollar sign and
meillo@0 476 are identical to those which can be used as arguments for the mda command,
meillo@0 477 see <opt>mda</opt> above. Additional information can be included with
meillo@0 478 @failed_rcpts, @msg_headers and @msg_body, these <b>must</b> be at the
meillo@0 479 beginning of a line and will be replaced with the list of the failed recipients,
meillo@0 480 the message headers and the message body of the failed message.</p>
meillo@0 481 <p>Default is /usr/share/masqmail/tpl/failmsg.tpl.</p>
meillo@0 482 </optdesc>
meillo@0 483 </option>
meillo@0 484
meillo@0 485 <option>
meillo@0 486 <p><opt>warnmsg_file = <arg>file</arg></opt></p>
meillo@0 487 <optdesc>
meillo@0 488 <p>Set this to a template which will be used to generate delivery warning
meillo@0 489 reports. It uses the same mechanisms for variables as <opt>errmsg_file</opt>,
meillo@0 490 see above.
meillo@0 491 </p>
meillo@0 492 <p>Default is /usr/share/masqmail/tpl/warnmsg.tpl.</p>
meillo@0 493 </optdesc>
meillo@0 494 </option>
meillo@0 495
meillo@0 496 <option>
meillo@0 497 <p><opt>warn_intervals</opt> = <arg>list</arg></p>
meillo@0 498 <optdesc>
meillo@0 499 <p>Set this to a list of time intervals, at which delivery warnings (starting
meillo@0 500 with the receiving time of the message) shall be generated.</p>
meillo@0 501 <p>A warning will only be generated just after an attempt to deliver the
meillo@0 502 mail and if that attempt failed temporarily. So a warning may be generated after
meillo@0 503 a longer time, if there was no attempt before.</p>
meillo@0 504 <p>Default is "1h;4h;8h;1d;2d;3d"</p>
meillo@0 505 </optdesc>
meillo@0 506 </option>
meillo@0 507
meillo@0 508 <option>
meillo@0 509 <p><opt>max_defer_time</opt> = <arg>time</arg></p>
meillo@0 510 <optdesc>
meillo@0 511 <p>This is the maximum time, in which a temporarily failed mail will be kept
meillo@0 512 in the spool. When this time is exceeded, it will be handled as a delivery failure,
meillo@0 513 and the message will be bounced.</p>
meillo@0 514 <p>The excedence of this time will only be noticed if the message was actually
meillo@0 515 tried to be delivered. If, for example, the message can only be delivered when
meillo@0 516 online, but you have not been online for that time, no bounce will be generated.</p>
meillo@0 517 <p>Default is 4d (4 days)</p>
meillo@0 518 </optdesc>
meillo@0 519 </option>
meillo@0 520
meillo@0 521 <option>
meillo@0 522 <p><opt>log_user = <arg>name</arg></opt></p>
meillo@0 523 <optdesc>
meillo@0 524 <p>Replace <arg>name</arg> with a valid local or remote mail address.</p>
meillo@0 525 <p>If this option is not empty, then a copy of every mail,
meillo@0 526 that passes trough the masqmail system will also be sent to the
meillo@0 527 given mail address.</p>
meillo@0 528 <p>For example you can feed your mails into a program like <i>hypermail</i> for
meillo@0 529 archiving purpose by placing an appropriate pipe command in masqmail.alias</p>
meillo@0 530 </optdesc>
meillo@0 531 </option>
meillo@0 532
meillo@0 533 </options>
meillo@0 534
meillo@0 535 <section name = "Author">
meillo@0 536 <p>masqmail was written by Oliver Kurth
meillo@0 537 &lt;oku@masqmail.cx&gt;</p><p>You will find the newest version of
meillo@0 538 masqmail at <url href="http://masqmail.cx/masqmail/"/> or search for it
meillo@0 539 in freshmeat (<url href="http://www.freshmeat.net"/>). There is also a mailing list,
meillo@0 540 you will find information about it at masqmails main site.</p>
meillo@0 541 </section>
meillo@0 542
meillo@0 543 <section name = "Bugs">
meillo@0 544 <p>You should report them to the mailing list.</p>
meillo@0 545 </section>
meillo@0 546
meillo@0 547 <section name = "See also">
meillo@0 548 <p>
meillo@0 549 <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"/>
meillo@0 550 </p>
meillo@0 551 </section>
meillo@0 552
meillo@0 553
meillo@0 554 <section name = "Comments">
meillo@0 555 <p>This man page was written using <manref name="xml2man" section="1"
meillo@0 556 href="http://masqmail.cx/xml2man/"/> by the same
meillo@0 557 author.</p>
meillo@0 558 </section>
meillo@0 559
meillo@0 560 </manpage>
meillo@0 561