masqmail-0.2
diff docs/old-manual/config.html @ 56:f6a6f55b7b9e
added old manual from the old website
it is dated May/July 2000
| author | meillo@marmaro.de |
|---|---|
| date | Sat, 29 May 2010 21:51:13 +0200 |
| parents | |
| children |
line diff
1.1 --- /dev/null Thu Jan 01 00:00:00 1970 +0000 1.2 +++ b/docs/old-manual/config.html Sat May 29 21:51:13 2010 +0200 1.3 @@ -0,0 +1,385 @@ 1.4 + 1.5 + 1.6 + 1.7 + 1.8 + 1.9 + 1.10 + 1.11 + 1.12 +<HTML> 1.13 +<HEAD> 1.14 +<TITLE>MasqMail - Manual 1.15 +</TITLE> 1.16 +</HEAD> 1.17 + <BODY TEXT="#000000" LINK="#0000ff" BGCOLOR="#ffffff"> 1.18 + 1.19 + <center> 1.20 + <table width="80%"> 1.21 + <tr><td> 1.22 + <table width="100%" bgcolor="#0000aa" cellspacing=0 cellpadding=0> 1.23 +<tr> 1.24 + <td> 1.25 + <a href="manual.html"> 1.26 + <img width="20" src = "../images/u_arrow.gif" alt = "manual"> 1.27 + </a> 1.28 + </td> 1.29 +<td align=center width="100%"><font size="6" color = "#ffffff">Configuration</font></td> 1.30 +<td> 1.31 + <a href="./alias.html"> 1.32 + <img width="20" src = "../images/l_arrow.gif" alt = "Alias Format"> 1.33 + </a> 1.34 +</td> 1.35 +<td> 1.36 + <a href="./faq.html"> 1.37 + <img width="20" src = "../images/r_arrow.gif" alt = "Frequently Asked Questions"> 1.38 + </a> 1.39 +</td> 1.40 +</tr> 1.41 +</table> 1.42 + 1.43 + 1.44 +<p>The configuration consists of lines of the form</p> 1.45 + 1.46 +<i>val</i> = <i>expression</i> 1.47 + 1.48 +<p>Where <i>val</i> is a variable name and <i>expression</i> a string, 1.49 +which can be quoted with '"'. If the expression is on multiple lines 1.50 +or contains characters other than letters, digits or the charcaters 1.51 +'.', '-', '_', '/', it <em>must</em> be quoted. Unfortunately, you 1.52 +cannot use quotes inside quotes. (Will be implemented in a later 1.53 +version.)</p> 1.54 + 1.55 +<p>Each val has a <i>type</i>, which can be boolean, numeric, string 1.56 +or list. A boolean variable can be set with one of the values 'on', 1.57 +'yes', and 'true' or 'off', 'no' and 'false'. List items are separated 1.58 +with ';'. For some values patterns (like '*','?') can be used. The 1.59 +spaces before and after the '=' are optional.</p> 1.60 + 1.61 +<p>Most lists (exceptions: local_hosts, local_nets and 1.62 +listen_addresses) accept files. These will be recognized by a leading 1.63 +slash '/'. The contents of these files will be included at the 1.64 +position of the file name, there can be items or other files before 1.65 +and after the file entry. The format of the files is different 1.66 +though, within these files each entry is on another line. (And not 1.67 +separated by semicolons). This makes it easy to include large lists 1.68 +which are common in different configuration files, so they do not have 1.69 +to appear in every configuration file.</p> 1.70 + 1.71 +<p>Blank lines and lines starting with '#' are ignored.</p> 1.72 + 1.73 +<h4><font color = "#ff0000">Main Configuration</font></h4> 1.74 + 1.75 +<b>run_as_user</b>, Type: <i>boolean</i>, default: <i>false</i> 1.76 + 1.77 +<p>If this is set, masqmail runs with the user id of the user who 1.78 +invoked it and never changes it. This is for debugging purposes 1.79 +<em>only</em>. If the user is not root, masqmail will not be able to 1.80 +listen on a port < 1000 and will not be able to deliver local mail 1.81 +to others than the user.</p> 1.82 + 1.83 +<b>use_syslog</b>, Type: <i>boolean</i>, default: <i>false</i> 1.84 + 1.85 +<p>If this is set, masqmail uses syslogd for logging. It uses facility 1.86 +<i>MAIL</i>. You still have to set <b>log_dir</b> for debug files.</p> 1.87 + 1.88 +<b>debug_level</b>, Type: <i>numeric</i>, default: <i>0</i> 1.89 + 1.90 +<p>Set the debug level. Valid values are 0 to 6, increasing it further 1.91 +makes no difference. Be careful if you set this as high as 5 or higher, 1.92 +the logs may very soon fill your hard drive.</p> 1.93 + 1.94 +<b>mail_dir</b>, Type: <i>string</i>, default: <i>none</i> 1.95 + 1.96 +<p>The directory where local mail is stored, usually /var/spool/mail.</p> 1.97 + 1.98 +<b>spool_dir</b>, Type: <i>string</i>, default: <i>none</i> 1.99 + 1.100 +<p>The directory where masqmail stores its spool files (and later also 1.101 +other stuff). It <em>must</em> have a subdirectory 1.102 +<i>input</i>. Masqmail needs read and write permissions for this 1.103 +directory. I suggest to use /var/spool/masqmail.</p> 1.104 + 1.105 +<b>log_dir</b>, Type: <i>string</i>, default: <i>none</i> 1.106 + 1.107 +<p>The directory where masqmail puts its log files, these are 1.108 +<i>masqmail.log</i> and <i>debug.log</i>. Masqmail needs write 1.109 +permission.</p> 1.110 + 1.111 +<b>host_name</b>, Type: <i>string</i>, default: <i>none</i> 1.112 + 1.113 +<p>This is used in different places: Masqmail identifies itself in the 1.114 +greeting banner on incoming connections and in the HELO/EHLO command 1.115 +for outgoing connections with this name, it is used in the Received: 1.116 +header and to qualify the sender of a locally originating message.</p> 1.117 + 1.118 +<p>It is <em>not</em> used to find whether an address is local. Use 1.119 +<b>local_hosts</b> for that.</p> 1.120 + 1.121 +<b>local_hosts</b>, Type: <i>list</i>, default: <i>none</i> 1.122 + 1.123 +<p>A semicolon ';' separated list of hostnames which are considered 1.124 +local. Normally you set it to "localhost;foo;foo.bar.com" if your host 1.125 +has the fully qualified domain name 'foo.bar.com'.</p> 1.126 + 1.127 +<b>local_nets</b>, Type: <i>list</i>, default: <i>none</i> 1.128 + 1.129 +<p>A semicolon ';' separated list of hostnames which are on the 1.130 +'local' net. Delivery to these hosts is attempted immediately. You can 1.131 +use patterns with '*', eg. "*.bar.com".</p> 1.132 + 1.133 +<b>listen_addresses</b>, Type: <i>list</i>, default: <i>none</i> 1.134 + 1.135 +<p>A semicolon ';' separated list of interfaces on which connections 1.136 +will be accepted. An interface ist defined by a hostname, optionally 1.137 +followed by a colon ':' and a number for the port. If this is left out, 1.138 +port 25 will be used.</p> 1.139 + 1.140 +<p>You can set this to "localhost:25;foo:25" if your hostname is 'foo'.</p> 1.141 + 1.142 +<b>do_queue</b>, Type: <i>boolean</i>, default: <i>false</i> 1.143 + 1.144 +<p>If this is set, mail will not be delivered immediately when 1.145 +accepted. Same as calling masqmail with the -odq option.</p> 1.146 + 1.147 +<b>connect_route.<name></b>, Type: <i>string</i>, default: <i>none</i> 1.148 + 1.149 +<p>Replace <name> with a name to identify a connection. Set this 1.150 +to a filename for the special <i>route</i> configuration for that 1.151 +connection. You will use that name to call masqmail with the -qo option 1.152 +every time a connection to your ISP is set up.</p> 1.153 + 1.154 +<p>Example: Your ISP has the name <i>FastNet</i>. Then you write the 1.155 +following line in the main configuration:</p> 1.156 + 1.157 +<p><pre>connect_route.FastNet = "/etc/masqmail/fastnet.route"</pre></p> 1.158 + 1.159 +<p>/etc/masqmail/fastnet.route is the route configuration file, see 1.160 +below. As soon as a link to FastNet has been set up, you call masqmail 1.161 +-qoFastNet. Masqmail will then read the specified file and send the 1.162 +mails.</p> 1.163 + 1.164 +<b>local_net_route</b>, Type: <i>string</i>, default: <i>none</i> 1.165 + 1.166 +<p>This is similar to <b>connect_route.<name></b> but for the 1.167 +local net. Recipient addresses that are in <b>local_nets</b> will be 1.168 +routed using this route configuration. Main purpose is to define a 1.169 +mail server with <b>mail_host</b> in your local network. In simple 1.170 +environments this can be left unset. If unset, a default route 1.171 +configuration will be used.</p> 1.172 + 1.173 +<b>alias_file</b> 1.174 + 1.175 +<p>Set this to the location of your alias file. If unset, no aliasing 1.176 +will be done.</p> 1.177 + 1.178 +<b>online_detect</b>, Type: <i>string</i>, default: <i>none</i> 1.179 + 1.180 +<p>Defines the method MasqMail uses to detect whether there is 1.181 +currently an online connection. It can have the values <em>file</em> 1.182 +or <em>mserver</em>.</p> 1.183 + 1.184 +<p>When it is set to <em>file</em>, MasqMail first checks for the 1.185 +existence of <b>online_file</b> (see below) and if it exists, it reads 1.186 +it. The content of the file should be the name of the current 1.187 +connection as defined with <b>connect_route.<name></b> (without 1.188 +a trailing newline character).</p> 1.189 + 1.190 +<p>When it is set to <em>mserver</em>, MasqMail connects to the 1.191 +masqdialer server using the value of <b>mserver_iface</b> and asks it 1.192 +whether a connection exists and for the name, which should be the name 1.193 +of the current connection as defined with 1.194 +<b>connect_route.<name></b>.</p> 1.195 + 1.196 +<p>The online status is checked either when masqmail receives a mail 1.197 +with an address outside your LAN or when called with the -qo option 1.198 +(without arguments).</p> 1.199 + 1.200 +<b>online_file</b>, Type: <i>string</i>, default: <i>none</i> 1.201 + 1.202 +<p>This is the name of the file checked for when MasqMail determines 1.203 +whether it is online. The file should only exist when there is 1.204 +currently a connection. Create it in your ip-up script with eg.</p> 1.205 + 1.206 +<p><pre> 1.207 +echo -n <name> > /tmp/connect_route 1.208 +chmod 0644 /tmp/connect_route 1.209 +</pre></p> 1.210 + 1.211 +<p>Do not forget to delete it in your ip-down script.</p> 1.212 + 1.213 +<b>mserver_iface</b>, Type: <i>string</i>, default: <i>none</i> 1.214 + 1.215 +<p>The interface the masqdialer server is listening to. Usually this 1.216 +will be "localhost:224" if mserver is running on the same host as 1.217 +masqmail. But using this option, you can also let masqmail run on 1.218 +another host by setting mserver_iface to another hostname, 1.219 +eg. "foo:224".</p> 1.220 + 1.221 +<b>get.<name></b>, Type: <i>string</i>, default: <i>none</i> 1.222 + 1.223 +<p>Replace <name> with a name to identify a <i>get</i> 1.224 +configuration. Set this to a filename for the <i>get</i> 1.225 +configuration. These files will be used to retrieve mail when called 1.226 +with the -g option.</p> 1.227 + 1.228 +<h4><font color = "#ff0000">Route Configuration</font></h4> 1.229 + 1.230 +<b>mail_host</b>, Type: <i>string</i>, default: <i>none</i> 1.231 + 1.232 +<p>This is preferably the mail server of your ISP. All outgoing 1.233 +messages will be sent to this host which will distribute them to their 1.234 +destinations. If you do not set this mails will be sent 1.235 +directly. Because the mail server is probably 'near' to you, mail 1.236 +transfer will be much faster if you use it.</p> 1.237 + 1.238 +<b>do_correct_helo</b>, Type: <i>boolean</i>, default: <i>false</i> 1.239 + 1.240 +<p>If this is set, masqmail tries to look up your host name as it 1.241 +appears on the internet and sends this in the HELO/EHLO command. Some 1.242 +servers are so picky that they want this. <em>Which is really 1.243 +crazy. It just does not make any sense to lie about ones own identity, 1.244 +because it can always be looked up by the server. Nobody should 1.245 +believe in the name given by HELO/EHLO anyway.</em> If this is not 1.246 +set, <b>host_name</b> will be used.</p> 1.247 + 1.248 +<b>allowed_mail_locals</b>, Type: <i>list</i>, default: <i>none(all)</i> 1.249 + 1.250 +<p>This is a semicolon ';' separated list of local parts which will be 1.251 +allowed to send mail through this connection. If unset and 1.252 +<b>not_allowed_mail_locals</b> is also unset, all users are 1.253 +allowed.</p> 1.254 + 1.255 +<b>not_allowed_mail_locals</b>, Type: <i>list</i>, default: <i>none</i> 1.256 + 1.257 +<p>This is a semicolon ';' separated list of local parts which will be 1.258 +<em>not</em> allowed to send mail through this connection. <em>Local 1.259 +parts in this list will not be allowed to use this route even if they 1.260 +are part of <b>allowed_mail_locals</b> (see above).</em></p> 1.261 + 1.262 +<b>allowed_rcpt_domains</b>, Type: <i>list</i>, default: <i>none(all)</i> 1.263 + 1.264 +<p>A list of recipient domains where mail will be sent to. This is for 1.265 +example useful if you use this route configuration when connected to 1.266 +another LAN via ppp. Patterns containing '?' and '*' can be used.</p> 1.267 + 1.268 +<b>not_allowed_rcpt_domains</b>, Type: <i>list</i>, default: <i>none</i> 1.269 + 1.270 +<p>A list of recipient domains where mail will <em>not</em> be sent 1.271 +to. This is for example useful if you send mail directly (mail_host 1.272 +ist not set) and you know of hosts that will not accept mail from you 1.273 +because they use a dialup list (eg. <a 1.274 +href="http://maps.vix.com/dul/"> maps.vix.com/dul/</a>). If any domain 1.275 +matches <em>both</em> <b>allowed_rcpt_domains</b> and 1.276 +<b>not_allowed_rcpt_domains</b>, mail will <em>not</em> be sent to 1.277 +this domain. Patterns containing '?' and '*' can be used.</p> 1.278 + 1.279 +<b>set_h_from_domain</b>, Type: <i>string</i>, default: <i>none</i> 1.280 + 1.281 +<p>Replace the domain part in 'From:' headers with this value. This 1.282 +may be useful if you use a private, outside unknown address on your 1.283 +local LAN and want this to be replaced by the domain of the address of 1.284 +your email addrsss on the internet. <em>Note that this is different to 1.285 +<b>set_return_path_domain</b>, see below.</em></p> 1.286 + 1.287 +<b>set_h_reply_to_domain</b>, Type: <i>string</i>, default: <i>none</i> 1.288 + 1.289 +<p>Same as <b>set_h_from_domain</b>, but for the 'Reply-To' header.</p> 1.290 + 1.291 +<b>set_return_path_domain</b>, Type: <i>string</i>, default: <i>none</i> 1.292 + 1.293 +<p>Sets the domain part of the envelope from address. Some hosts check 1.294 +whether this is the same as the net the connection is coming from. If 1.295 +not, they reject the mail because they suspect spamming. It should be 1.296 +a <em>valid</em> address, because some mail servers also check 1.297 +that. You can also use this to set it to your usual address on the 1.298 +internet and put a local address only known on your LAN in the 1.299 +configuration of your mailer. <em>Only the <em>domain</em> part will 1.300 +be changed, the local part remains unchanged. Use 1.301 +<b>map_return_path_addresses</b> for rewriting local parts</em>.</p> 1.302 + 1.303 +<b>map_h_from_addresses</b>, Type: <i>list</i>, default: <i>none</i> 1.304 + 1.305 +<p>This is similar to <b>set_h_from_domain</b>, but more flexible. Set 1.306 +this to a list which maps local parts to a full RFC 822 compliant 1.307 +email address, the local parts (the <em>keys</em>) are separated from 1.308 +the addresses (the <em>values</em>) by colons (':').</p> 1.309 + 1.310 +<p>Example:</p> 1.311 + 1.312 +<p><pre> 1.313 +map_h_from_addresses = 1.314 +"john: John Smith <jsmith@mail.academic.edu>; 1.315 +charlie: Charlie Miller <cmiller@mx.commercial.com>" 1.316 +</pre></p> 1.317 + 1.318 +<b>map_h_reply_to_addresses</b>, Type: <i>list</i>, default: <i>none</i> 1.319 + 1.320 +<p>Same as <b>map_h_from_addresses</b>, but for the 'Reply-To:' header.</p> 1.321 + 1.322 +<b>map_return_path_addresses</b>, Type: <i>list</i>, default: <i>none</i> 1.323 + 1.324 +<p>This is similar to <b>set_return_path_domain</b>, but more 1.325 +flexible. Set this to a list which maps local parts to a full RFC 821 1.326 +compliant email address, the local parts (the <em>keys</em>) are 1.327 +separated from the addresses (the <em>values</em>) by colons 1.328 +(':'). Note that this option takes <em>RFC 821</em> addresses 1.329 +while <b>map_h_from_addresses</b> takes <em>RFC 822</em> addresses. The 1.330 +most important difference is that RFC 821 addresses have no full 1.331 +name.</p> 1.332 + 1.333 +<p>Example:</p> 1.334 +<p><pre> 1.335 +map_return_path_addresses = 1.336 +"john: <jsmith@mail.academic.edu>; 1.337 +charlie: <cmiller@mx.commercial.com>" 1.338 +</pre></p> 1.339 + 1.340 +<b>expand_h_sender_domain</b>, Type: <i>boolean</i>, default: <i>true</i> 1.341 + 1.342 +<p>This sets the domain of the sender address as given by the Sender: 1.343 +header to the same domain as in the envelope return path address 1.344 +(which can be set by either <b>set_return_path_domain</b> or 1.345 +<b>map_return_path_addresses</b>). This is for mail clients 1.346 +(eg. Microsoft Outlook) which use this address as the sender 1.347 +address. <em>Though they should use the From: address, see RFC 1.348 +821. </em>If <i>fetchmail</i> encounters an unqualified Sender: 1.349 +address, it will be expanded to the domain of the pop server, which is 1.350 +almost never correct. </p> 1.351 + 1.352 +<b>auth_name</b>, Type: <i>string</i>, default: <i>none</i> 1.353 + 1.354 +<p>Set the authentication type for ESMTP AUTH authentification. 1.355 +Currently only 'cram-md5' is supported.</p> 1.356 + 1.357 +<b>auth_login</b>, Type: <i>string</i>, default: <i>none</i> 1.358 + 1.359 +<p>Your account name for ESMTP AUTH authentification.</p> 1.360 + 1.361 +<b>auth_secret</b>, Type: <i>string</i>, default: <i>none</i> 1.362 + 1.363 +<p>Your secret for ESMTP AUTH authentification.</p> 1.364 + 1.365 +<b>pop_login</b>, Type: <i>string</i>, default: <i>none</i> 1.366 + 1.367 +<p>If your Mail server requires SMTP-after-POP, set this to a 1.368 +<i>get</i> configuration. If you login to the POP server 1.369 +<em>before</em> you send, this is not necessary. See the <a href = 1.370 +"get.html"</a>get configuration</a> for more information.</p> 1.371 + 1.372 + </td></tr> 1.373 + 1.374 + <tr><td> 1.375 + <p> 1.376 + <hr> 1.377 + <address><a href = "mailto:kurth@innominate.de">Oliver Kurth</a></address> 1.378 + Last modified: Tue May 30 15:19:56 CEST 2000 1.379 + <br> 1.380 + This page was created using <a href="http://www.freddyfrog.com/hacks/genpage/">Genpage</a> - Version: 1.0.6 1.381 + </p> 1.382 + 1.383 + </table> 1.384 + </center> 1.385 + 1.386 + </BODY> 1.387 +</HEAD> 1.388 +