docs/diploma

annotate docs/masqmail.cx/config.html @ 391:16d8eacf60e1

created index (it is not finished)
author meillo@marmaro.de
date Fri, 06 Feb 2009 21:09:21 +0100
parents
children
rev   line source
meillo@1 1
meillo@1 2
meillo@1 3
meillo@1 4
meillo@1 5
meillo@1 6
meillo@1 7
meillo@1 8
meillo@1 9 <HTML>
meillo@1 10 <HEAD>
meillo@1 11 <TITLE>MasqMail - Manual
meillo@1 12 </TITLE>
meillo@1 13 </HEAD>
meillo@1 14 <BODY TEXT="#000000" LINK="#0000ff" BGCOLOR="#ffffff">
meillo@1 15
meillo@1 16 <center>
meillo@1 17 <table width="80%">
meillo@1 18 <tr><td>
meillo@1 19 <table width="100%" bgcolor="#0000aa" cellspacing=0 cellpadding=0>
meillo@1 20 <tr>
meillo@1 21 <td>
meillo@1 22 <a href="manual.html">
meillo@1 23 <img width="20" src = "../images/u_arrow.gif" alt = "manual">
meillo@1 24 </a>
meillo@1 25 </td>
meillo@1 26 <td align=center width="100%"><font size="6" color = "#ffffff">Configuration</font></td>
meillo@1 27 <td>
meillo@1 28 <a href="alias.html">
meillo@1 29 <img width="20" src = "../images/l_arrow.gif" alt = "Alias Format">
meillo@1 30 </a>
meillo@1 31 </td>
meillo@1 32 <td>
meillo@1 33 <a href="faq.html">
meillo@1 34 <img width="20" src = "../images/r_arrow.gif" alt = "Frequently Asked Questions">
meillo@1 35 </a>
meillo@1 36 </td>
meillo@1 37 </tr>
meillo@1 38 </table>
meillo@1 39
meillo@1 40
meillo@1 41 <p>The configuration consists of lines of the form</p>
meillo@1 42
meillo@1 43 <i>val</i> = <i>expression</i>
meillo@1 44
meillo@1 45 <p>Where <i>val</i> is a variable name and <i>expression</i> a string,
meillo@1 46 which can be quoted with '"'. If the expression is on multiple lines
meillo@1 47 or contains characters other than letters, digits or the charcaters
meillo@1 48 '.', '-', '_', '/', it <em>must</em> be quoted. Unfortunately, you
meillo@1 49 cannot use quotes inside quotes. (Will be implemented in a later
meillo@1 50 version.)</p>
meillo@1 51
meillo@1 52 <p>Each val has a <i>type</i>, which can be boolean, numeric, string
meillo@1 53 or list. A boolean variable can be set with one of the values 'on',
meillo@1 54 'yes', and 'true' or 'off', 'no' and 'false'. List items are separated
meillo@1 55 with ';'. For some values patterns (like '*','?') can be used. The
meillo@1 56 spaces before and after the '=' are optional.</p>
meillo@1 57
meillo@1 58 <p>Most lists (exceptions: local_hosts, local_nets and
meillo@1 59 listen_addresses) accept files. These will be recognized by a leading
meillo@1 60 slash '/'. The contents of these files will be included at the
meillo@1 61 position of the file name, there can be items or other files before
meillo@1 62 and after the file entry. The format of the files is different
meillo@1 63 though, within these files each entry is on another line. (And not
meillo@1 64 separated by semicolons). This makes it easy to include large lists
meillo@1 65 which are common in different configuration files, so they do not have
meillo@1 66 to appear in every configuration file.</p>
meillo@1 67
meillo@1 68 <p>Blank lines and lines starting with '#' are ignored.</p>
meillo@1 69
meillo@1 70 <h4><font color = "#ff0000">Main Configuration</font></h4>
meillo@1 71
meillo@1 72 <b>run_as_user</b>, Type: <i>boolean</i>, default: <i>false</i>
meillo@1 73
meillo@1 74 <p>If this is set, masqmail runs with the user id of the user who
meillo@1 75 invoked it and never changes it. This is for debugging purposes
meillo@1 76 <em>only</em>. If the user is not root, masqmail will not be able to
meillo@1 77 listen on a port &lt; 1000 and will not be able to deliver local mail
meillo@1 78 to others than the user.</p>
meillo@1 79
meillo@1 80 <b>use_syslog</b>, Type: <i>boolean</i>, default: <i>false</i>
meillo@1 81
meillo@1 82 <p>If this is set, masqmail uses syslogd for logging. It uses facility
meillo@1 83 <i>MAIL</i>. You still have to set <b>log_dir</b> for debug files.</p>
meillo@1 84
meillo@1 85 <b>debug_level</b>, Type: <i>numeric</i>, default: <i>0</i>
meillo@1 86
meillo@1 87 <p>Set the debug level. Valid values are 0 to 6, increasing it further
meillo@1 88 makes no difference. Be careful if you set this as high as 5 or higher,
meillo@1 89 the logs may very soon fill your hard drive.</p>
meillo@1 90
meillo@1 91 <b>mail_dir</b>, Type: <i>string</i>, default: <i>none</i>
meillo@1 92
meillo@1 93 <p>The directory where local mail is stored, usually /var/spool/mail.</p>
meillo@1 94
meillo@1 95 <b>spool_dir</b>, Type: <i>string</i>, default: <i>none</i>
meillo@1 96
meillo@1 97 <p>The directory where masqmail stores its spool files (and later also
meillo@1 98 other stuff). It <em>must</em> have a subdirectory
meillo@1 99 <i>input</i>. Masqmail needs read and write permissions for this
meillo@1 100 directory. I suggest to use /var/spool/masqmail.</p>
meillo@1 101
meillo@1 102 <b>log_dir</b>, Type: <i>string</i>, default: <i>none</i>
meillo@1 103
meillo@1 104 <p>The directory where masqmail puts its log files, these are
meillo@1 105 <i>masqmail.log</i> and <i>debug.log</i>. Masqmail needs write
meillo@1 106 permission.</p>
meillo@1 107
meillo@1 108 <b>host_name</b>, Type: <i>string</i>, default: <i>none</i>
meillo@1 109
meillo@1 110 <p>This is used in different places: Masqmail identifies itself in the
meillo@1 111 greeting banner on incoming connections and in the HELO/EHLO command
meillo@1 112 for outgoing connections with this name, it is used in the Received:
meillo@1 113 header and to qualify the sender of a locally originating message.</p>
meillo@1 114
meillo@1 115 <p>It is <em>not</em> used to find whether an address is local. Use
meillo@1 116 <b>local_hosts</b> for that.</p>
meillo@1 117
meillo@1 118 <b>local_hosts</b>, Type: <i>list</i>, default: <i>none</i>
meillo@1 119
meillo@1 120 <p>A semicolon ';' separated list of hostnames which are considered
meillo@1 121 local. Normally you set it to "localhost;foo;foo.bar.com" if your host
meillo@1 122 has the fully qualified domain name 'foo.bar.com'.</p>
meillo@1 123
meillo@1 124 <b>local_nets</b>, Type: <i>list</i>, default: <i>none</i>
meillo@1 125
meillo@1 126 <p>A semicolon ';' separated list of hostnames which are on the
meillo@1 127 'local' net. Delivery to these hosts is attempted immediately. You can
meillo@1 128 use patterns with '*', eg. "*.bar.com".</p>
meillo@1 129
meillo@1 130 <b>listen_addresses</b>, Type: <i>list</i>, default: <i>none</i>
meillo@1 131
meillo@1 132 <p>A semicolon ';' separated list of interfaces on which connections
meillo@1 133 will be accepted. An interface ist defined by a hostname, optionally
meillo@1 134 followed by a colon ':' and a number for the port. If this is left out,
meillo@1 135 port 25 will be used.</p>
meillo@1 136
meillo@1 137 <p>You can set this to "localhost:25;foo:25" if your hostname is 'foo'.</p>
meillo@1 138
meillo@1 139 <b>do_queue</b>, Type: <i>boolean</i>, default: <i>false</i>
meillo@1 140
meillo@1 141 <p>If this is set, mail will not be delivered immediately when
meillo@1 142 accepted. Same as calling masqmail with the -odq option.</p>
meillo@1 143
meillo@1 144 <b>connect_route.&lt;name&gt;</b>, Type: <i>string</i>, default: <i>none</i>
meillo@1 145
meillo@1 146 <p>Replace &lt;name&gt; with a name to identify a connection. Set this
meillo@1 147 to a filename for the special <i>route</i> configuration for that
meillo@1 148 connection. You will use that name to call masqmail with the -qo option
meillo@1 149 every time a connection to your ISP is set up.</p>
meillo@1 150
meillo@1 151 <p>Example: Your ISP has the name <i>FastNet</i>. Then you write the
meillo@1 152 following line in the main configuration:</p>
meillo@1 153
meillo@1 154 <p><pre>connect_route.FastNet = "/etc/masqmail/fastnet.route"</pre></p>
meillo@1 155
meillo@1 156 <p>/etc/masqmail/fastnet.route is the route configuration file, see
meillo@1 157 below. As soon as a link to FastNet has been set up, you call masqmail
meillo@1 158 -qoFastNet. Masqmail will then read the specified file and send the
meillo@1 159 mails.</p>
meillo@1 160
meillo@1 161 <b>local_net_route</b>, Type: <i>string</i>, default: <i>none</i>
meillo@1 162
meillo@1 163 <p>This is similar to <b>connect_route.&lt;name&gt;</b> but for the
meillo@1 164 local net. Recipient addresses that are in <b>local_nets</b> will be
meillo@1 165 routed using this route configuration. Main purpose is to define a
meillo@1 166 mail server with <b>mail_host</b> in your local network. In simple
meillo@1 167 environments this can be left unset. If unset, a default route
meillo@1 168 configuration will be used.</p>
meillo@1 169
meillo@1 170 <b>alias_file</b>
meillo@1 171
meillo@1 172 <p>Set this to the location of your alias file. If unset, no aliasing
meillo@1 173 will be done.</p>
meillo@1 174
meillo@1 175 <b>online_detect</b>, Type: <i>string</i>, default: <i>none</i>
meillo@1 176
meillo@1 177 <p>Defines the method MasqMail uses to detect whether there is
meillo@1 178 currently an online connection. It can have the values <em>file</em>
meillo@1 179 or <em>mserver</em>.</p>
meillo@1 180
meillo@1 181 <p>When it is set to <em>file</em>, MasqMail first checks for the
meillo@1 182 existence of <b>online_file</b> (see below) and if it exists, it reads
meillo@1 183 it. The content of the file should be the name of the current
meillo@1 184 connection as defined with <b>connect_route.&lt;name&gt;</b> (without
meillo@1 185 a trailing newline character).</p>
meillo@1 186
meillo@1 187 <p>When it is set to <em>mserver</em>, MasqMail connects to the
meillo@1 188 masqdialer server using the value of <b>mserver_iface</b> and asks it
meillo@1 189 whether a connection exists and for the name, which should be the name
meillo@1 190 of the current connection as defined with
meillo@1 191 <b>connect_route.&lt;name&gt;</b>.</p>
meillo@1 192
meillo@1 193 <p>The online status is checked either when masqmail receives a mail
meillo@1 194 with an address outside your LAN or when called with the -qo option
meillo@1 195 (without arguments).</p>
meillo@1 196
meillo@1 197 <b>online_file</b>, Type: <i>string</i>, default: <i>none</i>
meillo@1 198
meillo@1 199 <p>This is the name of the file checked for when MasqMail determines
meillo@1 200 whether it is online. The file should only exist when there is
meillo@1 201 currently a connection. Create it in your ip-up script with eg.</p>
meillo@1 202
meillo@1 203 <p><pre>
meillo@1 204 echo -n &lt;name&gt; &gt; /tmp/connect_route
meillo@1 205 chmod 0644 /tmp/connect_route
meillo@1 206 </pre></p>
meillo@1 207
meillo@1 208 <p>Do not forget to delete it in your ip-down script.</p>
meillo@1 209
meillo@1 210 <b>mserver_iface</b>, Type: <i>string</i>, default: <i>none</i>
meillo@1 211
meillo@1 212 <p>The interface the masqdialer server is listening to. Usually this
meillo@1 213 will be "localhost:224" if mserver is running on the same host as
meillo@1 214 masqmail. But using this option, you can also let masqmail run on
meillo@1 215 another host by setting mserver_iface to another hostname,
meillo@1 216 eg. "foo:224".</p>
meillo@1 217
meillo@1 218 <b>get.&lt;name&gt;</b>, Type: <i>string</i>, default: <i>none</i>
meillo@1 219
meillo@1 220 <p>Replace &lt;name&gt; with a name to identify a <i>get</i>
meillo@1 221 configuration. Set this to a filename for the <i>get</i>
meillo@1 222 configuration. These files will be used to retrieve mail when called
meillo@1 223 with the -g option.</p>
meillo@1 224
meillo@1 225 <h4><font color = "#ff0000">Route Configuration</font></h4>
meillo@1 226
meillo@1 227 <b>mail_host</b>, Type: <i>string</i>, default: <i>none</i>
meillo@1 228
meillo@1 229 <p>This is preferably the mail server of your ISP. All outgoing
meillo@1 230 messages will be sent to this host which will distribute them to their
meillo@1 231 destinations. If you do not set this mails will be sent
meillo@1 232 directly. Because the mail server is probably 'near' to you, mail
meillo@1 233 transfer will be much faster if you use it.</p>
meillo@1 234
meillo@1 235 <b>do_correct_helo</b>, Type: <i>boolean</i>, default: <i>false</i>
meillo@1 236
meillo@1 237 <p>If this is set, masqmail tries to look up your host name as it
meillo@1 238 appears on the internet and sends this in the HELO/EHLO command. Some
meillo@1 239 servers are so picky that they want this. <em>Which is really
meillo@1 240 crazy. It just does not make any sense to lie about ones own identity,
meillo@1 241 because it can always be looked up by the server. Nobody should
meillo@1 242 believe in the name given by HELO/EHLO anyway.</em> If this is not
meillo@1 243 set, <b>host_name</b> will be used.</p>
meillo@1 244
meillo@1 245 <b>allowed_mail_locals</b>, Type: <i>list</i>, default: <i>none(all)</i>
meillo@1 246
meillo@1 247 <p>This is a semicolon ';' separated list of local parts which will be
meillo@1 248 allowed to send mail through this connection. If unset and
meillo@1 249 <b>not_allowed_mail_locals</b> is also unset, all users are
meillo@1 250 allowed.</p>
meillo@1 251
meillo@1 252 <b>not_allowed_mail_locals</b>, Type: <i>list</i>, default: <i>none</i>
meillo@1 253
meillo@1 254 <p>This is a semicolon ';' separated list of local parts which will be
meillo@1 255 <em>not</em> allowed to send mail through this connection. <em>Local
meillo@1 256 parts in this list will not be allowed to use this route even if they
meillo@1 257 are part of <b>allowed_mail_locals</b> (see above).</em></p>
meillo@1 258
meillo@1 259 <b>allowed_rcpt_domains</b>, Type: <i>list</i>, default: <i>none(all)</i>
meillo@1 260
meillo@1 261 <p>A list of recipient domains where mail will be sent to. This is for
meillo@1 262 example useful if you use this route configuration when connected to
meillo@1 263 another LAN via ppp. Patterns containing '?' and '*' can be used.</p>
meillo@1 264
meillo@1 265 <b>not_allowed_rcpt_domains</b>, Type: <i>list</i>, default: <i>none</i>
meillo@1 266
meillo@1 267 <p>A list of recipient domains where mail will <em>not</em> be sent
meillo@1 268 to. This is for example useful if you send mail directly (mail_host
meillo@1 269 ist not set) and you know of hosts that will not accept mail from you
meillo@1 270 because they use a dialup list (eg. <a
meillo@1 271 href="http://maps.vix.com/dul/"> maps.vix.com/dul/</a>). If any domain
meillo@1 272 matches <em>both</em> <b>allowed_rcpt_domains</b> and
meillo@1 273 <b>not_allowed_rcpt_domains</b>, mail will <em>not</em> be sent to
meillo@1 274 this domain. Patterns containing '?' and '*' can be used.</p>
meillo@1 275
meillo@1 276 <b>set_h_from_domain</b>, Type: <i>string</i>, default: <i>none</i>
meillo@1 277
meillo@1 278 <p>Replace the domain part in 'From:' headers with this value. This
meillo@1 279 may be useful if you use a private, outside unknown address on your
meillo@1 280 local LAN and want this to be replaced by the domain of the address of
meillo@1 281 your email addrsss on the internet. <em>Note that this is different to
meillo@1 282 <b>set_return_path_domain</b>, see below.</em></p>
meillo@1 283
meillo@1 284 <b>set_h_reply_to_domain</b>, Type: <i>string</i>, default: <i>none</i>
meillo@1 285
meillo@1 286 <p>Same as <b>set_h_from_domain</b>, but for the 'Reply-To' header.</p>
meillo@1 287
meillo@1 288 <b>set_return_path_domain</b>, Type: <i>string</i>, default: <i>none</i>
meillo@1 289
meillo@1 290 <p>Sets the domain part of the envelope from address. Some hosts check
meillo@1 291 whether this is the same as the net the connection is coming from. If
meillo@1 292 not, they reject the mail because they suspect spamming. It should be
meillo@1 293 a <em>valid</em> address, because some mail servers also check
meillo@1 294 that. You can also use this to set it to your usual address on the
meillo@1 295 internet and put a local address only known on your LAN in the
meillo@1 296 configuration of your mailer. <em>Only the <em>domain</em> part will
meillo@1 297 be changed, the local part remains unchanged. Use
meillo@1 298 <b>map_return_path_addresses</b> for rewriting local parts</em>.</p>
meillo@1 299
meillo@1 300 <b>map_h_from_addresses</b>, Type: <i>list</i>, default: <i>none</i>
meillo@1 301
meillo@1 302 <p>This is similar to <b>set_h_from_domain</b>, but more flexible. Set
meillo@1 303 this to a list which maps local parts to a full RFC 822 compliant
meillo@1 304 email address, the local parts (the <em>keys</em>) are separated from
meillo@1 305 the addresses (the <em>values</em>) by colons (':').</p>
meillo@1 306
meillo@1 307 <p>Example:</p>
meillo@1 308
meillo@1 309 <p><pre>
meillo@1 310 map_h_from_addresses =
meillo@1 311 "john: John Smith &lt;jsmith@mail.academic.edu&gt;;
meillo@1 312 charlie: Charlie Miller &lt;cmiller@mx.commercial.com&gt;"
meillo@1 313 </pre></p>
meillo@1 314
meillo@1 315 <b>map_h_reply_to_addresses</b>, Type: <i>list</i>, default: <i>none</i>
meillo@1 316
meillo@1 317 <p>Same as <b>map_h_from_addresses</b>, but for the 'Reply-To:' header.</p>
meillo@1 318
meillo@1 319 <b>map_return_path_addresses</b>, Type: <i>list</i>, default: <i>none</i>
meillo@1 320
meillo@1 321 <p>This is similar to <b>set_return_path_domain</b>, but more
meillo@1 322 flexible. Set this to a list which maps local parts to a full RFC 821
meillo@1 323 compliant email address, the local parts (the <em>keys</em>) are
meillo@1 324 separated from the addresses (the <em>values</em>) by colons
meillo@1 325 (':'). Note that this option takes <em>RFC 821</em> addresses
meillo@1 326 while <b>map_h_from_addresses</b> takes <em>RFC 822</em> addresses. The
meillo@1 327 most important difference is that RFC 821 addresses have no full
meillo@1 328 name.</p>
meillo@1 329
meillo@1 330 <p>Example:</p>
meillo@1 331 <p><pre>
meillo@1 332 map_return_path_addresses =
meillo@1 333 "john: &lt;jsmith@mail.academic.edu&gt;;
meillo@1 334 charlie: &lt;cmiller@mx.commercial.com&gt;"
meillo@1 335 </pre></p>
meillo@1 336
meillo@1 337 <b>expand_h_sender_domain</b>, Type: <i>boolean</i>, default: <i>true</i>
meillo@1 338
meillo@1 339 <p>This sets the domain of the sender address as given by the Sender:
meillo@1 340 header to the same domain as in the envelope return path address
meillo@1 341 (which can be set by either <b>set_return_path_domain</b> or
meillo@1 342 <b>map_return_path_addresses</b>). This is for mail clients
meillo@1 343 (eg. Microsoft Outlook) which use this address as the sender
meillo@1 344 address. <em>Though they should use the From: address, see RFC
meillo@1 345 821. </em>If <i>fetchmail</i> encounters an unqualified Sender:
meillo@1 346 address, it will be expanded to the domain of the pop server, which is
meillo@1 347 almost never correct. </p>
meillo@1 348
meillo@1 349 <b>auth_name</b>, Type: <i>string</i>, default: <i>none</i>
meillo@1 350
meillo@1 351 <p>Set the authentication type for ESMTP AUTH authentification.
meillo@1 352 Currently only 'cram-md5' is supported.</p>
meillo@1 353
meillo@1 354 <b>auth_login</b>, Type: <i>string</i>, default: <i>none</i>
meillo@1 355
meillo@1 356 <p>Your account name for ESMTP AUTH authentification.</p>
meillo@1 357
meillo@1 358 <b>auth_secret</b>, Type: <i>string</i>, default: <i>none</i>
meillo@1 359
meillo@1 360 <p>Your secret for ESMTP AUTH authentification.</p>
meillo@1 361
meillo@1 362 <b>pop_login</b>, Type: <i>string</i>, default: <i>none</i>
meillo@1 363
meillo@1 364 <p>If your Mail server requires SMTP-after-POP, set this to a
meillo@1 365 <i>get</i> configuration. If you login to the POP server
meillo@1 366 <em>before</em> you send, this is not necessary. See the <a href =
meillo@1 367 "get.html"</a>get configuration</a> for more information.</p>
meillo@1 368
meillo@1 369 </td></tr>
meillo@1 370
meillo@1 371 <tr><td>
meillo@1 372 <p>
meillo@1 373 <hr>
meillo@1 374 <address><a href = "mailto:kurth@innominate.de">Oliver Kurth</a></address>
meillo@1 375 Last modified: Tue May 30 15:19:56 CEST 2000
meillo@1 376 <br>
meillo@1 377 This page was created using <a href="http://www.freddyfrog.com/hacks/genpage/">Genpage</a> - Version: 1.0.6
meillo@1 378 </p>
meillo@1 379
meillo@1 380 </table>
meillo@1 381 </center>
meillo@1 382
meillo@1 383 </BODY>
meillo@1 384 </HEAD>
meillo@1 385