masqmail
changeset 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 | 185ba6c0e6f0 |
children | ed34413652fc |
files | docs/old-manual/README docs/old-manual/alias.html docs/old-manual/config.html docs/old-manual/docs/masqmail.8.html docs/old-manual/docs/masqmail.aliases.5.html docs/old-manual/docs/masqmail.conf.5.html docs/old-manual/docs/masqmail.get.5.html docs/old-manual/docs/masqmail.route.5.html docs/old-manual/faq.html docs/old-manual/install.html docs/old-manual/manual.html docs/old-manual/options.html |
diffstat | 12 files changed, 2644 insertions(+), 0 deletions(-) [+] |
line diff
1.1 --- /dev/null Thu Jan 01 00:00:00 1970 +0000 1.2 +++ b/docs/old-manual/README Sat May 29 21:51:13 2010 +0200 1.3 @@ -0,0 +1,10 @@ 1.4 +This is the old manual by oku, dated May/July 2000. At this time the 1.5 +development must just have started with the 0.1 versions. 1.6 + 1.7 +Many things are still the same as then, but there are things that 1.8 +changed. Please keep this in mind when you read the manual. 1.9 + 1.10 +Start reading at manual.html. 1.11 + 1.12 + 1.13 +meillo
2.1 --- /dev/null Thu Jan 01 00:00:00 1970 +0000 2.2 +++ b/docs/old-manual/alias.html Sat May 29 21:51:13 2010 +0200 2.3 @@ -0,0 +1,84 @@ 2.4 + 2.5 + 2.6 + 2.7 + 2.8 + 2.9 + 2.10 + 2.11 + 2.12 +<HTML> 2.13 +<HEAD> 2.14 +<TITLE>MasqMail - Manual 2.15 +</TITLE> 2.16 +</HEAD> 2.17 + <BODY TEXT="#000000" LINK="#0000ff" BGCOLOR="#ffffff"> 2.18 + 2.19 + <center> 2.20 + <table width="80%"> 2.21 + <tr><td> 2.22 + <table width="100%" bgcolor="#0000aa" cellspacing=0 cellpadding=0> 2.23 +<tr> 2.24 + <td> 2.25 + <a href="manual.html"> 2.26 + <img width="20" src = "../images/u_arrow.gif" alt = "manual"> 2.27 + </a> 2.28 + </td> 2.29 +<td align=center width="100%"><font size="6" color = "#ffffff">Alias Format</font></td> 2.30 +<td> 2.31 + <a href="./options.html"> 2.32 + <img width="20" src = "../images/l_arrow.gif" alt = "Options"> 2.33 + </a> 2.34 +</td> 2.35 +<td> 2.36 + <a href="./config.html"> 2.37 + <img width="20" src = "../images/r_arrow.gif" alt = "Configuration"> 2.38 + </a> 2.39 +</td> 2.40 +</tr> 2.41 +</table> 2.42 + 2.43 + 2.44 +<p>The alias file consists of lines of the form:</p> 2.45 +<pre> 2.46 +local_part: item1, item2, ... 2.47 +</pre> 2.48 + 2.49 +<p>Items can be surrounded by quotes '"'. If within the quotes other 2.50 +quotes are needed for an address they can be escaped with a leading 2.51 +backslash '\'.</p> 2.52 + 2.53 +<p>A leading '\' indicates that this address shall not be further 2.54 +expanded.</p> 2.55 + 2.56 +<p>A leading pipe symbol '|' indicates that the item shall be treated 2.57 +as a pipe command. The content of the message will then be sent to the 2.58 +standard input of a command. The command will run under the user id 2.59 +and group id masqmail is running as. If quotes are needed, the pipe 2.60 +symbol must appear <i>within</i> the quotes.</p> 2.61 + 2.62 +<p>Loops will be detected, the offending address will be ignored.</p> 2.63 + 2.64 +<p>Aliases will be expanded at <i>delivery</i> time. This means that 2.65 +if there is a message still in the queue and you change any alias 2.66 +which matches one of the recipient addresses, the change will have 2.67 +effect next time a delivery is attemped.</p> 2.68 + 2.69 +<p>There is no need to restart masqmail or run any command when the 2.70 +alias file has been changed.</p> 2.71 + </td></tr> 2.72 + 2.73 + <tr><td> 2.74 + <p> 2.75 + <hr> 2.76 + <address><a href = "mailto:kurth@innominate.de">Oliver Kurth</a></address> 2.77 + Last modified: Tue May 30 15:19:57 CEST 2000 2.78 + <br> 2.79 + This page was created using <a href="http://www.freddyfrog.com/hacks/genpage/">Genpage</a> - Version: 1.0.6 2.80 + </p> 2.81 + 2.82 + </table> 2.83 + </center> 2.84 + 2.85 + </BODY> 2.86 +</HEAD> 2.87 +
3.1 --- /dev/null Thu Jan 01 00:00:00 1970 +0000 3.2 +++ b/docs/old-manual/config.html Sat May 29 21:51:13 2010 +0200 3.3 @@ -0,0 +1,385 @@ 3.4 + 3.5 + 3.6 + 3.7 + 3.8 + 3.9 + 3.10 + 3.11 + 3.12 +<HTML> 3.13 +<HEAD> 3.14 +<TITLE>MasqMail - Manual 3.15 +</TITLE> 3.16 +</HEAD> 3.17 + <BODY TEXT="#000000" LINK="#0000ff" BGCOLOR="#ffffff"> 3.18 + 3.19 + <center> 3.20 + <table width="80%"> 3.21 + <tr><td> 3.22 + <table width="100%" bgcolor="#0000aa" cellspacing=0 cellpadding=0> 3.23 +<tr> 3.24 + <td> 3.25 + <a href="manual.html"> 3.26 + <img width="20" src = "../images/u_arrow.gif" alt = "manual"> 3.27 + </a> 3.28 + </td> 3.29 +<td align=center width="100%"><font size="6" color = "#ffffff">Configuration</font></td> 3.30 +<td> 3.31 + <a href="./alias.html"> 3.32 + <img width="20" src = "../images/l_arrow.gif" alt = "Alias Format"> 3.33 + </a> 3.34 +</td> 3.35 +<td> 3.36 + <a href="./faq.html"> 3.37 + <img width="20" src = "../images/r_arrow.gif" alt = "Frequently Asked Questions"> 3.38 + </a> 3.39 +</td> 3.40 +</tr> 3.41 +</table> 3.42 + 3.43 + 3.44 +<p>The configuration consists of lines of the form</p> 3.45 + 3.46 +<i>val</i> = <i>expression</i> 3.47 + 3.48 +<p>Where <i>val</i> is a variable name and <i>expression</i> a string, 3.49 +which can be quoted with '"'. If the expression is on multiple lines 3.50 +or contains characters other than letters, digits or the charcaters 3.51 +'.', '-', '_', '/', it <em>must</em> be quoted. Unfortunately, you 3.52 +cannot use quotes inside quotes. (Will be implemented in a later 3.53 +version.)</p> 3.54 + 3.55 +<p>Each val has a <i>type</i>, which can be boolean, numeric, string 3.56 +or list. A boolean variable can be set with one of the values 'on', 3.57 +'yes', and 'true' or 'off', 'no' and 'false'. List items are separated 3.58 +with ';'. For some values patterns (like '*','?') can be used. The 3.59 +spaces before and after the '=' are optional.</p> 3.60 + 3.61 +<p>Most lists (exceptions: local_hosts, local_nets and 3.62 +listen_addresses) accept files. These will be recognized by a leading 3.63 +slash '/'. The contents of these files will be included at the 3.64 +position of the file name, there can be items or other files before 3.65 +and after the file entry. The format of the files is different 3.66 +though, within these files each entry is on another line. (And not 3.67 +separated by semicolons). This makes it easy to include large lists 3.68 +which are common in different configuration files, so they do not have 3.69 +to appear in every configuration file.</p> 3.70 + 3.71 +<p>Blank lines and lines starting with '#' are ignored.</p> 3.72 + 3.73 +<h4><font color = "#ff0000">Main Configuration</font></h4> 3.74 + 3.75 +<b>run_as_user</b>, Type: <i>boolean</i>, default: <i>false</i> 3.76 + 3.77 +<p>If this is set, masqmail runs with the user id of the user who 3.78 +invoked it and never changes it. This is for debugging purposes 3.79 +<em>only</em>. If the user is not root, masqmail will not be able to 3.80 +listen on a port < 1000 and will not be able to deliver local mail 3.81 +to others than the user.</p> 3.82 + 3.83 +<b>use_syslog</b>, Type: <i>boolean</i>, default: <i>false</i> 3.84 + 3.85 +<p>If this is set, masqmail uses syslogd for logging. It uses facility 3.86 +<i>MAIL</i>. You still have to set <b>log_dir</b> for debug files.</p> 3.87 + 3.88 +<b>debug_level</b>, Type: <i>numeric</i>, default: <i>0</i> 3.89 + 3.90 +<p>Set the debug level. Valid values are 0 to 6, increasing it further 3.91 +makes no difference. Be careful if you set this as high as 5 or higher, 3.92 +the logs may very soon fill your hard drive.</p> 3.93 + 3.94 +<b>mail_dir</b>, Type: <i>string</i>, default: <i>none</i> 3.95 + 3.96 +<p>The directory where local mail is stored, usually /var/spool/mail.</p> 3.97 + 3.98 +<b>spool_dir</b>, Type: <i>string</i>, default: <i>none</i> 3.99 + 3.100 +<p>The directory where masqmail stores its spool files (and later also 3.101 +other stuff). It <em>must</em> have a subdirectory 3.102 +<i>input</i>. Masqmail needs read and write permissions for this 3.103 +directory. I suggest to use /var/spool/masqmail.</p> 3.104 + 3.105 +<b>log_dir</b>, Type: <i>string</i>, default: <i>none</i> 3.106 + 3.107 +<p>The directory where masqmail puts its log files, these are 3.108 +<i>masqmail.log</i> and <i>debug.log</i>. Masqmail needs write 3.109 +permission.</p> 3.110 + 3.111 +<b>host_name</b>, Type: <i>string</i>, default: <i>none</i> 3.112 + 3.113 +<p>This is used in different places: Masqmail identifies itself in the 3.114 +greeting banner on incoming connections and in the HELO/EHLO command 3.115 +for outgoing connections with this name, it is used in the Received: 3.116 +header and to qualify the sender of a locally originating message.</p> 3.117 + 3.118 +<p>It is <em>not</em> used to find whether an address is local. Use 3.119 +<b>local_hosts</b> for that.</p> 3.120 + 3.121 +<b>local_hosts</b>, Type: <i>list</i>, default: <i>none</i> 3.122 + 3.123 +<p>A semicolon ';' separated list of hostnames which are considered 3.124 +local. Normally you set it to "localhost;foo;foo.bar.com" if your host 3.125 +has the fully qualified domain name 'foo.bar.com'.</p> 3.126 + 3.127 +<b>local_nets</b>, Type: <i>list</i>, default: <i>none</i> 3.128 + 3.129 +<p>A semicolon ';' separated list of hostnames which are on the 3.130 +'local' net. Delivery to these hosts is attempted immediately. You can 3.131 +use patterns with '*', eg. "*.bar.com".</p> 3.132 + 3.133 +<b>listen_addresses</b>, Type: <i>list</i>, default: <i>none</i> 3.134 + 3.135 +<p>A semicolon ';' separated list of interfaces on which connections 3.136 +will be accepted. An interface ist defined by a hostname, optionally 3.137 +followed by a colon ':' and a number for the port. If this is left out, 3.138 +port 25 will be used.</p> 3.139 + 3.140 +<p>You can set this to "localhost:25;foo:25" if your hostname is 'foo'.</p> 3.141 + 3.142 +<b>do_queue</b>, Type: <i>boolean</i>, default: <i>false</i> 3.143 + 3.144 +<p>If this is set, mail will not be delivered immediately when 3.145 +accepted. Same as calling masqmail with the -odq option.</p> 3.146 + 3.147 +<b>connect_route.<name></b>, Type: <i>string</i>, default: <i>none</i> 3.148 + 3.149 +<p>Replace <name> with a name to identify a connection. Set this 3.150 +to a filename for the special <i>route</i> configuration for that 3.151 +connection. You will use that name to call masqmail with the -qo option 3.152 +every time a connection to your ISP is set up.</p> 3.153 + 3.154 +<p>Example: Your ISP has the name <i>FastNet</i>. Then you write the 3.155 +following line in the main configuration:</p> 3.156 + 3.157 +<p><pre>connect_route.FastNet = "/etc/masqmail/fastnet.route"</pre></p> 3.158 + 3.159 +<p>/etc/masqmail/fastnet.route is the route configuration file, see 3.160 +below. As soon as a link to FastNet has been set up, you call masqmail 3.161 +-qoFastNet. Masqmail will then read the specified file and send the 3.162 +mails.</p> 3.163 + 3.164 +<b>local_net_route</b>, Type: <i>string</i>, default: <i>none</i> 3.165 + 3.166 +<p>This is similar to <b>connect_route.<name></b> but for the 3.167 +local net. Recipient addresses that are in <b>local_nets</b> will be 3.168 +routed using this route configuration. Main purpose is to define a 3.169 +mail server with <b>mail_host</b> in your local network. In simple 3.170 +environments this can be left unset. If unset, a default route 3.171 +configuration will be used.</p> 3.172 + 3.173 +<b>alias_file</b> 3.174 + 3.175 +<p>Set this to the location of your alias file. If unset, no aliasing 3.176 +will be done.</p> 3.177 + 3.178 +<b>online_detect</b>, Type: <i>string</i>, default: <i>none</i> 3.179 + 3.180 +<p>Defines the method MasqMail uses to detect whether there is 3.181 +currently an online connection. It can have the values <em>file</em> 3.182 +or <em>mserver</em>.</p> 3.183 + 3.184 +<p>When it is set to <em>file</em>, MasqMail first checks for the 3.185 +existence of <b>online_file</b> (see below) and if it exists, it reads 3.186 +it. The content of the file should be the name of the current 3.187 +connection as defined with <b>connect_route.<name></b> (without 3.188 +a trailing newline character).</p> 3.189 + 3.190 +<p>When it is set to <em>mserver</em>, MasqMail connects to the 3.191 +masqdialer server using the value of <b>mserver_iface</b> and asks it 3.192 +whether a connection exists and for the name, which should be the name 3.193 +of the current connection as defined with 3.194 +<b>connect_route.<name></b>.</p> 3.195 + 3.196 +<p>The online status is checked either when masqmail receives a mail 3.197 +with an address outside your LAN or when called with the -qo option 3.198 +(without arguments).</p> 3.199 + 3.200 +<b>online_file</b>, Type: <i>string</i>, default: <i>none</i> 3.201 + 3.202 +<p>This is the name of the file checked for when MasqMail determines 3.203 +whether it is online. The file should only exist when there is 3.204 +currently a connection. Create it in your ip-up script with eg.</p> 3.205 + 3.206 +<p><pre> 3.207 +echo -n <name> > /tmp/connect_route 3.208 +chmod 0644 /tmp/connect_route 3.209 +</pre></p> 3.210 + 3.211 +<p>Do not forget to delete it in your ip-down script.</p> 3.212 + 3.213 +<b>mserver_iface</b>, Type: <i>string</i>, default: <i>none</i> 3.214 + 3.215 +<p>The interface the masqdialer server is listening to. Usually this 3.216 +will be "localhost:224" if mserver is running on the same host as 3.217 +masqmail. But using this option, you can also let masqmail run on 3.218 +another host by setting mserver_iface to another hostname, 3.219 +eg. "foo:224".</p> 3.220 + 3.221 +<b>get.<name></b>, Type: <i>string</i>, default: <i>none</i> 3.222 + 3.223 +<p>Replace <name> with a name to identify a <i>get</i> 3.224 +configuration. Set this to a filename for the <i>get</i> 3.225 +configuration. These files will be used to retrieve mail when called 3.226 +with the -g option.</p> 3.227 + 3.228 +<h4><font color = "#ff0000">Route Configuration</font></h4> 3.229 + 3.230 +<b>mail_host</b>, Type: <i>string</i>, default: <i>none</i> 3.231 + 3.232 +<p>This is preferably the mail server of your ISP. All outgoing 3.233 +messages will be sent to this host which will distribute them to their 3.234 +destinations. If you do not set this mails will be sent 3.235 +directly. Because the mail server is probably 'near' to you, mail 3.236 +transfer will be much faster if you use it.</p> 3.237 + 3.238 +<b>do_correct_helo</b>, Type: <i>boolean</i>, default: <i>false</i> 3.239 + 3.240 +<p>If this is set, masqmail tries to look up your host name as it 3.241 +appears on the internet and sends this in the HELO/EHLO command. Some 3.242 +servers are so picky that they want this. <em>Which is really 3.243 +crazy. It just does not make any sense to lie about ones own identity, 3.244 +because it can always be looked up by the server. Nobody should 3.245 +believe in the name given by HELO/EHLO anyway.</em> If this is not 3.246 +set, <b>host_name</b> will be used.</p> 3.247 + 3.248 +<b>allowed_mail_locals</b>, Type: <i>list</i>, default: <i>none(all)</i> 3.249 + 3.250 +<p>This is a semicolon ';' separated list of local parts which will be 3.251 +allowed to send mail through this connection. If unset and 3.252 +<b>not_allowed_mail_locals</b> is also unset, all users are 3.253 +allowed.</p> 3.254 + 3.255 +<b>not_allowed_mail_locals</b>, Type: <i>list</i>, default: <i>none</i> 3.256 + 3.257 +<p>This is a semicolon ';' separated list of local parts which will be 3.258 +<em>not</em> allowed to send mail through this connection. <em>Local 3.259 +parts in this list will not be allowed to use this route even if they 3.260 +are part of <b>allowed_mail_locals</b> (see above).</em></p> 3.261 + 3.262 +<b>allowed_rcpt_domains</b>, Type: <i>list</i>, default: <i>none(all)</i> 3.263 + 3.264 +<p>A list of recipient domains where mail will be sent to. This is for 3.265 +example useful if you use this route configuration when connected to 3.266 +another LAN via ppp. Patterns containing '?' and '*' can be used.</p> 3.267 + 3.268 +<b>not_allowed_rcpt_domains</b>, Type: <i>list</i>, default: <i>none</i> 3.269 + 3.270 +<p>A list of recipient domains where mail will <em>not</em> be sent 3.271 +to. This is for example useful if you send mail directly (mail_host 3.272 +ist not set) and you know of hosts that will not accept mail from you 3.273 +because they use a dialup list (eg. <a 3.274 +href="http://maps.vix.com/dul/"> maps.vix.com/dul/</a>). If any domain 3.275 +matches <em>both</em> <b>allowed_rcpt_domains</b> and 3.276 +<b>not_allowed_rcpt_domains</b>, mail will <em>not</em> be sent to 3.277 +this domain. Patterns containing '?' and '*' can be used.</p> 3.278 + 3.279 +<b>set_h_from_domain</b>, Type: <i>string</i>, default: <i>none</i> 3.280 + 3.281 +<p>Replace the domain part in 'From:' headers with this value. This 3.282 +may be useful if you use a private, outside unknown address on your 3.283 +local LAN and want this to be replaced by the domain of the address of 3.284 +your email addrsss on the internet. <em>Note that this is different to 3.285 +<b>set_return_path_domain</b>, see below.</em></p> 3.286 + 3.287 +<b>set_h_reply_to_domain</b>, Type: <i>string</i>, default: <i>none</i> 3.288 + 3.289 +<p>Same as <b>set_h_from_domain</b>, but for the 'Reply-To' header.</p> 3.290 + 3.291 +<b>set_return_path_domain</b>, Type: <i>string</i>, default: <i>none</i> 3.292 + 3.293 +<p>Sets the domain part of the envelope from address. Some hosts check 3.294 +whether this is the same as the net the connection is coming from. If 3.295 +not, they reject the mail because they suspect spamming. It should be 3.296 +a <em>valid</em> address, because some mail servers also check 3.297 +that. You can also use this to set it to your usual address on the 3.298 +internet and put a local address only known on your LAN in the 3.299 +configuration of your mailer. <em>Only the <em>domain</em> part will 3.300 +be changed, the local part remains unchanged. Use 3.301 +<b>map_return_path_addresses</b> for rewriting local parts</em>.</p> 3.302 + 3.303 +<b>map_h_from_addresses</b>, Type: <i>list</i>, default: <i>none</i> 3.304 + 3.305 +<p>This is similar to <b>set_h_from_domain</b>, but more flexible. Set 3.306 +this to a list which maps local parts to a full RFC 822 compliant 3.307 +email address, the local parts (the <em>keys</em>) are separated from 3.308 +the addresses (the <em>values</em>) by colons (':').</p> 3.309 + 3.310 +<p>Example:</p> 3.311 + 3.312 +<p><pre> 3.313 +map_h_from_addresses = 3.314 +"john: John Smith <jsmith@mail.academic.edu>; 3.315 +charlie: Charlie Miller <cmiller@mx.commercial.com>" 3.316 +</pre></p> 3.317 + 3.318 +<b>map_h_reply_to_addresses</b>, Type: <i>list</i>, default: <i>none</i> 3.319 + 3.320 +<p>Same as <b>map_h_from_addresses</b>, but for the 'Reply-To:' header.</p> 3.321 + 3.322 +<b>map_return_path_addresses</b>, Type: <i>list</i>, default: <i>none</i> 3.323 + 3.324 +<p>This is similar to <b>set_return_path_domain</b>, but more 3.325 +flexible. Set this to a list which maps local parts to a full RFC 821 3.326 +compliant email address, the local parts (the <em>keys</em>) are 3.327 +separated from the addresses (the <em>values</em>) by colons 3.328 +(':'). Note that this option takes <em>RFC 821</em> addresses 3.329 +while <b>map_h_from_addresses</b> takes <em>RFC 822</em> addresses. The 3.330 +most important difference is that RFC 821 addresses have no full 3.331 +name.</p> 3.332 + 3.333 +<p>Example:</p> 3.334 +<p><pre> 3.335 +map_return_path_addresses = 3.336 +"john: <jsmith@mail.academic.edu>; 3.337 +charlie: <cmiller@mx.commercial.com>" 3.338 +</pre></p> 3.339 + 3.340 +<b>expand_h_sender_domain</b>, Type: <i>boolean</i>, default: <i>true</i> 3.341 + 3.342 +<p>This sets the domain of the sender address as given by the Sender: 3.343 +header to the same domain as in the envelope return path address 3.344 +(which can be set by either <b>set_return_path_domain</b> or 3.345 +<b>map_return_path_addresses</b>). This is for mail clients 3.346 +(eg. Microsoft Outlook) which use this address as the sender 3.347 +address. <em>Though they should use the From: address, see RFC 3.348 +821. </em>If <i>fetchmail</i> encounters an unqualified Sender: 3.349 +address, it will be expanded to the domain of the pop server, which is 3.350 +almost never correct. </p> 3.351 + 3.352 +<b>auth_name</b>, Type: <i>string</i>, default: <i>none</i> 3.353 + 3.354 +<p>Set the authentication type for ESMTP AUTH authentification. 3.355 +Currently only 'cram-md5' is supported.</p> 3.356 + 3.357 +<b>auth_login</b>, Type: <i>string</i>, default: <i>none</i> 3.358 + 3.359 +<p>Your account name for ESMTP AUTH authentification.</p> 3.360 + 3.361 +<b>auth_secret</b>, Type: <i>string</i>, default: <i>none</i> 3.362 + 3.363 +<p>Your secret for ESMTP AUTH authentification.</p> 3.364 + 3.365 +<b>pop_login</b>, Type: <i>string</i>, default: <i>none</i> 3.366 + 3.367 +<p>If your Mail server requires SMTP-after-POP, set this to a 3.368 +<i>get</i> configuration. If you login to the POP server 3.369 +<em>before</em> you send, this is not necessary. See the <a href = 3.370 +"get.html"</a>get configuration</a> for more information.</p> 3.371 + 3.372 + </td></tr> 3.373 + 3.374 + <tr><td> 3.375 + <p> 3.376 + <hr> 3.377 + <address><a href = "mailto:kurth@innominate.de">Oliver Kurth</a></address> 3.378 + Last modified: Tue May 30 15:19:56 CEST 2000 3.379 + <br> 3.380 + This page was created using <a href="http://www.freddyfrog.com/hacks/genpage/">Genpage</a> - Version: 1.0.6 3.381 + </p> 3.382 + 3.383 + </table> 3.384 + </center> 3.385 + 3.386 + </BODY> 3.387 +</HEAD> 3.388 +
4.1 --- /dev/null Thu Jan 01 00:00:00 1970 +0000 4.2 +++ b/docs/old-manual/docs/masqmail.8.html Sat May 29 21:51:13 2010 +0200 4.3 @@ -0,0 +1,327 @@ 4.4 +<body text="#000000" link="#0000ff" bgcolor="#ffffff"><center><table width="80%"> 4.5 +<tr><td><h1>masqmail</h1> 4.6 +<h2>An offline Mail Transfer Agent</h2> 4.7 + 4.8 + 4.9 +<h2>Synopsis</h2> 4.10 +<b> 4.11 +/usr/sbin/masqmail [-C <em>file</em>] [-odq] [-bd] [-q<em>interval</em>]<br> 4.12 + 4.13 +/usr/sbin/masqmail [-odq] [-bs]<br> 4.14 + 4.15 +/usr/sbin/masqmail [-bp]<br> 4.16 + 4.17 +/usr/sbin/masqmail [-q]<br> 4.18 + 4.19 +/usr/sbin/masqmail [-qo [<em>name</em>]]<br> 4.20 + 4.21 +/usr/sbin/masqmail [-odq] [-g [<em>name</em>]]<br> 4.22 + 4.23 +/usr/sbin/masqmail [-odq] [-go [<em>name</em>]]<br> 4.24 + 4.25 +/usr/sbin/masqmail [-t] [-oi] [-f <em>address</em>] [--] <em>address...</em><br> 4.26 + 4.27 +/usr/sbin/mailq<br> 4.28 + 4.29 +</b> 4.30 + 4.31 + 4.32 +<h2>Description</h2> 4.33 + 4.34 +<p>MasqMail is a mail server designed for hosts that do 4.35 +not have a permanent internet connection eg. a home network or a 4.36 +single host at home. It has special support for connections to 4.37 +different ISPs. It replaces sendmail or other MTAs such as qmail or 4.38 +exim. It can also act as a pop3 client.</p> 4.39 + 4.40 + 4.41 + 4.42 +<h2>Options</h2> 4.43 + 4.44 +<p>Since masqmail is intended to replace sendmail, it uses the same 4.45 +command line options, but not all are implemented. There are also two 4.46 +additional options, which are unique to masqmail (-qo <em>connection</em> and -g) 4.47 +</p> 4.48 + 4.49 + 4.50 +<p><b>--</b></p> 4.51 +<p>Not a 'real' option, it means that all following arguments are to 4.52 +be understood as arguments and not as options even if they begin with a 4.53 +leading dash '-'. Mutt is known to call sendmail with this option.</p> 4.54 + 4.55 + 4.56 + 4.57 +<p><b>-bd</b></p> 4.58 +<p>Run as daemon, accepting connections, usually on port 25 if not 4.59 +configured differently. This is usually used in the startup script at system boot and 4.60 +together with the -q option (see below).</p> 4.61 + 4.62 + 4.63 + 4.64 +<p><b>-bi</b></p> 4.65 +<p>Old sendmail rebuilds its alias database when invoked with this 4.66 +option. Masqmail ignores it. Masqmail reads directly from the file 4.67 +given with alias_file in the config file.</p> 4.68 + 4.69 + 4.70 + 4.71 +<p><b>-bp</b></p> 4.72 +<p>Show the messages in the queue. Same as calling masqmail as 4.73 +'mailq'.</p> 4.74 + 4.75 + 4.76 + 4.77 +<p><b>-bs</b></p> 4.78 +<p>Accept SMTP commands from stdin. Some mailers (eg pine) use this 4.79 +option as an interface. It can also be used to call masqmail from 4.80 +inetd.</p> 4.81 + 4.82 + 4.83 + 4.84 +<p><b>-B <em>arg</em></b></p> 4.85 +<p><em>arg</em> is usually 8BITMIME. Some mailers use this 4.86 +to indicate that the message contains characters > 127. Masqmail is 4.87 +8-bit clean and ignores this, so you do not have to recompile elm, 4.88 +which is very painful ;-). Note though that this violates some 4.89 +conventions: masqmail does not convert 8 bit messages to any 4.90 +MIME format if it encounters a mail server which does not advertise 4.91 +its 8BITMIME capability, masqmail does not advertise this itself. This 4.92 +is the same practice as that of exim (but different to 4.93 +sendmail).</p> 4.94 + 4.95 + 4.96 +<p><b>-bV </b></p> 4.97 +<p>Show version information.</p> 4.98 + 4.99 + 4.100 + 4.101 + 4.102 +<p><b>-C </b><em>filename</em></p> 4.103 +<p>Use another configuration than <em>/etc/masqmail/masqmail.conf</em>. Useful for 4.104 +debugging purposes. If not invoked by a privileged user, masqmail will drop all privileges. 4.105 +</p> 4.106 + 4.107 + 4.108 + 4.109 +<p><b>-d <em>number</em></b></p> 4.110 + 4.111 +<p>Set the debug level. This takes precedence before the value of 4.112 +debug_level in the configuration file. Read the warning in the 4.113 +description of the latter. 4.114 +</p> 4.115 + 4.116 + 4.117 + 4.118 + 4.119 +<p><b>-f [<em>address</em>]</b></p> 4.120 + 4.121 +<p>Set the return path address to <em>address</em>. Only root, the 4.122 +user mail and anyoune in group trusted is allowed to do that.</p> 4.123 + 4.124 + 4.125 + 4.126 + 4.127 +<p><b>-F [<em>string</em>]</b></p> 4.128 + 4.129 +<p>Set the full sender name (in the From: header) 4.130 +to <em>string</em>.</p> 4.131 + 4.132 + 4.133 + 4.134 + 4.135 +<p><b>-g [<em>name</em>]</b></p> 4.136 + 4.137 +<p>Get mail (using pop3 or apop), using the configurations given 4.138 +with get.<em>name</em> in the main configuration. Without <em>name</em>, 4.139 +all get configurations will be used. See also <a href="masqmail.get.5.html">masqmail.get</a></p> 4.140 + 4.141 + 4.142 + 4.143 + 4.144 +<p><b>-go [<em>interval</em>] [<em>name</em>]</b></p> 4.145 + 4.146 +<p>Can be followed by a connection name. Use this option in your 4.147 +script which starts as soon as a link to the internet has been set up 4.148 +(usually ip-up). When masqmail is called with this option, the 4.149 +specified get configuration(s) is(are) read and mail will be 4.150 +retrieved from servers on the internet. 4.151 +The <em>name</em> is defined 4.152 +in the configuration (see <b>online_gets.<em>name</em></b>). 4.153 +</p><p> 4.154 +If called with an interval option (recognized by a digit 4.155 +as the first characater), masqmail starts as a daemon and tries to 4.156 +get mail in these intervals. It checks for the online status first. 4.157 +Example: masqmail -go 5m will retrieve mail 4.158 +all five minutes. 4.159 +</p><p> 4.160 +If called without <em>name</em> the online status is determined with 4.161 +the configured method (see <b>online_detect</b> in config.html). 4.162 +</p> 4.163 + 4.164 + 4.165 + 4.166 + 4.167 +<p><b>-i</b></p> 4.168 +<p>Same as -oi, see below.</p> 4.169 + 4.170 + 4.171 + 4.172 +<p><b>-Mrm <em>list</em></b></p> 4.173 +<p>Remove given messages from the queue. Only allowed for privileged users.</p> 4.174 + 4.175 + 4.176 + 4.177 +<p><b>-oem</b></p> 4.178 +<p>If the -oi ist not also given, always return with a non zero 4.179 +return code. Maybe someone tells me what this is good for...</p> 4.180 + 4.181 + 4.182 + 4.183 +<p><b>-odb</b></p> 4.184 +<p>Deliver in background. Masqmail always does this, which 4.185 +makes this option pretty much useless.</p> 4.186 + 4.187 + 4.188 + 4.189 +<p><b>-odq</b></p> 4.190 +<p>Do not attempt to deliver immediately. Any messages will be queued 4.191 +until the next queue running process picks them up and delivers 4.192 +them. You get the same effect by setting the do_queue option in 4.193 +/etc/masqmail/masqmail.conf.</p> 4.194 + 4.195 + 4.196 + 4.197 +<p><b>-oi</b></p> 4.198 +<p>A dot as a single character in a line does not terminate 4.199 +the message.</p> 4.200 + 4.201 + 4.202 + 4.203 +<p><b>-q [<em>interval</em>]</b></p> 4.204 +<p>If not given with an argument, run a queue process, ie. try to 4.205 +deliver all messages in the queue. Masqmail sends only to those 4.206 +addresses that are on the local net, not to those that are 4.207 +outside. Use -qo for those.</p> 4.208 +<p> 4.209 +If you have configured inetd to start masqmail, you can use this 4.210 +option in a cron job which starts in regular time intervals, to mimic 4.211 +the same effect as starting masqmail with -bd -q30m. 4.212 +</p><p> 4.213 +An argument may be a time interval ie. a numerical value followed 4.214 +by one of the letters. s,m,h,d,w which are interpreted as seconds, 4.215 +minutes, hours, days or weeks respectively. Example: -q30m. Masqmail 4.216 +starts as a daemon and a queue runner process will be started 4.217 +automatically once in this time interval. This is usually used 4.218 +together with -bd (see above). 4.219 +</p> 4.220 + 4.221 + 4.222 + 4.223 + 4.224 +<p><b>-qo [<em>name</em>]</b></p> 4.225 + 4.226 +<p>Can be followed by a connection name. Use this option in your 4.227 +script which starts as soon as a link to the internet has been set up 4.228 +(usually ip-up). When masqmail is called with this option, the 4.229 +specified route configuration is read and the queued mail with 4.230 +destinations on the internet will be sent. The <em>name</em> is defined 4.231 +in the configuration (see <b>online_routes.<em>name</em></b>). 4.232 +</p><p> 4.233 +If called without <em>name</em> the online status is determined with 4.234 +the configured method (see <b>online_detect</b> in config.html) 4.235 +</p> 4.236 + 4.237 + 4.238 + 4.239 + 4.240 +<p><b>-t</b></p> 4.241 +<p>Read recipients from headers. Delete 'Bcc:' headers. If any 4.242 +arguments are given, these are interpreted as recipient addresses and 4.243 +the message will not be sent to these.</p> 4.244 + 4.245 + 4.246 + 4.247 +<p><b>-v</b></p> 4.248 +<p>Log also to stdout. Currently, some log messages are 4.249 +marked as 'write to stdout' and additionally, all messages with 4.250 +priority 'LOG_ALERT' and 'LOG_WARNING' will be written to stdout 4.251 +if this option is given. It is disabled in daemon mode. 4.252 +</p> 4.253 + 4.254 + 4.255 + 4.256 + 4.257 +<h2>Environment for pipes and mdas</h2> 4.258 + 4.259 + 4.260 +<p>For security reasons, before any pipe command from an alias 4.261 +expansion or an mda is called, the environment variables will be 4.262 +completely discarded and newly set up. These are:</p> 4.263 +<p>SENDER, RETURN_PATH - the return path.</p> 4.264 +<p>SENDER_DOMAIN - the domain part of the return path.</p> 4.265 +<p>SENDER_LOCAL - the local part of the return path.</p> 4.266 +<p>RECEIVED_HOST - the host the message was received from (unless local).</p> 4.267 +<p>LOCAL_PART, USER, LOGNAME - the local part of the (original) recipient.</p> 4.268 +<p>MESSAGE_ID - the unique message id. This is not necessarily identical with the Message ID as given in the Message ID: header.</p> 4.269 +<p>QUALIFY_DOMAIN - the domain which will be appended to unqualified addresses.</p> 4.270 + 4.271 + 4.272 + 4.273 + 4.274 +<h2>Files</h2> 4.275 + 4.276 +<p><em>/etc/masqmail/masqmail.conf</em> is the main configuration 4.277 +for masqmail. Depending on the settings in this file, you will also 4.278 +have other configuration files in <em>/etc/masqmail/</em>.</p> 4.279 +<p><em>/etc/aliases</em> is the alias file, if not set differently 4.280 +in <em>/etc/masqmail/masqmail.conf</em>.</p> 4.281 +<p><em>/var/spool/masqmail/</em> is the spool directory where masqmail 4.282 +stores its spooled messages and the uniq pop ids.</p> 4.283 +<p><em>/var/spool/mail/</em> is the directory where locally delivered mail will be put, if not configured differently in <em>masqmail.conf</em>.</p> 4.284 +<p><em>/var/log/masqmail/</em> is the directory where masqmail stores 4.285 +its log mesages. This can also be somewhere else if configured 4.286 +differently by your sysadmin or the package mantainer.</p> 4.287 + 4.288 + 4.289 + 4.290 +<h2>Conforming to</h2> 4.291 + 4.292 +<p>RFC 821, 822, 1869, 1870, 2197, 2554 (SMTP)</p> 4.293 +<p>RFC 1725, 1939 (POP3)</p> 4.294 +<p>RFC 1321 (MD5)</p> 4.295 +<p>RFC 2195 (CRAM-MD5)</p> 4.296 + 4.297 + 4.298 + 4.299 +<h2>Author</h2> 4.300 + 4.301 +<p>masqmail was written by Oliver Kurth 4.302 +<oku@masqmail.cx></p><p>You will find the newest version of 4.303 +masqmail at <a href = "http://masqmail.cx/masqmail/">http://masqmail.cx/masqmail/</a> or search for it 4.304 +in freshmeat (<a href = "http://www.freshmeat.net">http://www.freshmeat.net</a>). There is also a mailing list, 4.305 +you will find information about it at masqmails main site.</p> 4.306 + 4.307 + 4.308 + 4.309 +<h2>Bugs</h2> 4.310 + 4.311 +<p>You should report them to the mailing list.</p> 4.312 + 4.313 + 4.314 + 4.315 +<h2>See also</h2> 4.316 + 4.317 +<p> 4.318 +<a href="masqmail.conf.5.html">masqmail.conf</a>, <a href="masqmail.route.5.html">masqmail.route</a>, <a href="masqmail.get.5.html">masqmail.get</a>, <a href="masqmail.aliases.5.html">masqmail.aliases</a> 4.319 +</p> 4.320 + 4.321 + 4.322 + 4.323 +<h2>Comments</h2> 4.324 + 4.325 +<p>This man page was written using <a href="http://masqmail.cx/xml2man/">xml2man</a> by the same author.</p> 4.326 + 4.327 + 4.328 + 4.329 +</td></tr></table></center> 4.330 +</body>
5.1 --- /dev/null Thu Jan 01 00:00:00 1970 +0000 5.2 +++ b/docs/old-manual/docs/masqmail.aliases.5.html Sat May 29 21:51:13 2010 +0200 5.3 @@ -0,0 +1,75 @@ 5.4 +<body text="#000000" link="#0000ff" bgcolor="#ffffff"><center><table width="80%"> 5.5 +<tr><td><h1>masqmail.aliases</h1> 5.6 +<h2>masqmail alias file format</h2> 5.7 + 5.8 + 5.9 +<h2>Description</h2> 5.10 + 5.11 +<p>This man page describes the format of the masqmail alias file. Its usual location is <em>/etc/aliases</em>.</p> 5.12 + 5.13 + 5.14 + 5.15 +<h2>File Format</h2> 5.16 + 5.17 +<p>The alias file consists of lines of the form:</p> 5.18 + 5.19 +local_part: item1, item2, ... 5.20 + 5.21 + 5.22 +<p>Items can be surrounded by quotes '"'. If within the quotes other 5.23 +quotes are needed for an address they can be escaped with a leading 5.24 +backslash '\'.</p> 5.25 + 5.26 +<p>A leading '\' indicates that this address shall not be further 5.27 +expanded.</p> 5.28 + 5.29 +<p>A leading pipe symbol '|' indicates that the item shall be treated 5.30 +as a pipe command. The content of the message will then be sent to the 5.31 +standard input of a command. The command will run under the user id 5.32 +and group id masqmail is running as. If quotes are needed, the pipe 5.33 +symbol must appear within the quotes.</p> 5.34 + 5.35 +<p>Loops will be detected, the offending address will be ignored.</p> 5.36 + 5.37 +<p>Aliases will be expanded at delivery time. This means that 5.38 +if there is a message still in the queue and you change any alias 5.39 +which matches one of the recipient addresses, the change will have 5.40 +effect next time a delivery is attemped.</p> 5.41 + 5.42 +<p>There is no need to restart masqmail or run any command when the 5.43 +alias file has been changed.</p> 5.44 + 5.45 + 5.46 + 5.47 +<h2>Author</h2> 5.48 + 5.49 +<p>masqmail was written by Oliver Kurth 5.50 +<oku@masqmail.cx></p><p>You will find the newest version of 5.51 +masqmail at <a href = "http://masqmail.cx/masqmail/">http://masqmail.cx/masqmail/</a> or search for it 5.52 +in freshmeat (<a href = "http://www.freshmeat.net">http://www.freshmeat.net</a>). There is also a mailing list, 5.53 +you will find information about it at masqmails main site.</p> 5.54 + 5.55 + 5.56 + 5.57 +<h2>Bugs</h2> 5.58 + 5.59 +<p>You should report them to the mailing list.</p> 5.60 + 5.61 + 5.62 + 5.63 +<h2>See also</h2> 5.64 + 5.65 +<p> 5.66 +<a href="masqmail.conf.5.html">masqmail.conf</a>, <a href="masqmail.8.html">masqmail</a>, 5.67 +</p> 5.68 + 5.69 + 5.70 + 5.71 +<h2>Comments</h2> 5.72 + 5.73 +<p>This man page was written using <a href="http://masqmail.cx/xml2man/">xml2man</a> by the same author.</p> 5.74 + 5.75 + 5.76 + 5.77 +</td></tr></table></center> 5.78 +</body>
6.1 --- /dev/null Thu Jan 01 00:00:00 1970 +0000 6.2 +++ b/docs/old-manual/docs/masqmail.conf.5.html Sat May 29 21:51:13 2010 +0200 6.3 @@ -0,0 +1,569 @@ 6.4 +<body text="#000000" link="#0000ff" bgcolor="#ffffff"><center><table width="80%"> 6.5 +<tr><td><h1>masqmail.conf</h1> 6.6 +<h2>masqmail configuration file</h2> 6.7 + 6.8 + 6.9 +<h2>Description</h2> 6.10 + 6.11 +<p>This man page describes the syntax of the main configuration file 6.12 +of masqmail. Its usual location is <em>/etc/masqmail/masqmail.conf</em></p> 6.13 + 6.14 +<p>The configuration consists of lines of the form</p> 6.15 + 6.16 +<p><b>val</b> = <em>expression</em></p> 6.17 + 6.18 +<p>Where <b>val</b> is a variable name and <em>expression</em> a string, 6.19 +which can be quoted with '"'. If the expression is on multiple lines 6.20 +or contains characters other than letters, digits or the characters 6.21 +'.', '-', '_', '/', it must be quoted. You can use quotes inside quotes 6.22 +by escaping them with a backslash.</p> 6.23 + 6.24 +<p>Each val has a type, which can be boolean, numeric, string 6.25 +or list. A boolean variable can be set with one of the values 'on', 6.26 +'yes', and 'true' or 'off', 'no' and 'false'. List items are separated 6.27 +with ';'. For some values patterns (like '*','?') can be used. The 6.28 +spaces before and after the '=' are optional.</p> 6.29 + 6.30 +<p>Most lists (exceptions: <b>local_hosts</b>, 6.31 +<b>local_nets</b>, <b>listen_addresses</b>, <b>online_routes</b> and <b>online_gets</b>) accept 6.32 +files. These will be recognized by a leading slash '/'. The contents 6.33 +of these files will be included at the position of the file name, 6.34 +there can be items or other files before and after the file entry. The 6.35 +format of the files is different though, within these files each entry 6.36 +is on another line. (And not separated by semicolons). This makes it 6.37 +easy to include large lists which are common in different 6.38 +configuration files, so they do not have to appear in every 6.39 +configuration file.</p> 6.40 + 6.41 +<p>Blank lines and lines starting with '#' are ignored.</p> 6.42 + 6.43 + 6.44 + 6.45 + 6.46 +<h2>Options</h2> 6.47 + 6.48 + 6.49 +<p><b>run_as_user = <em>boolean</em></b></p> 6.50 + 6.51 +<p>If this is set, masqmail runs with the user id of the user who 6.52 +invoked it and never changes it. This is for debugging purposes 6.53 +only. If the user is not root, masqmail will not be able to 6.54 +listen on a port < 1024 and will not be able to deliver local mail 6.55 +to others than the user.</p> 6.56 + 6.57 + 6.58 + 6.59 + 6.60 +<p><b>use_syslog = <em>boolean</em></b></p> 6.61 + 6.62 +<p>If this is set, masqmail uses syslogd for logging. It uses facility 6.63 +MAIL. You still have to set <b>log_dir</b> for debug files.</p> 6.64 + 6.65 + 6.66 + 6.67 + 6.68 +<p><b>debug_level = <em>n</em></b></p> 6.69 + 6.70 +<p>Set the debug level. Valid values are 0 to 6, increasing it further 6.71 +makes no difference. Be careful if you set this as high as 5 or higher, 6.72 +the logs may very soon fill your hard drive.</p> 6.73 + 6.74 + 6.75 + 6.76 + 6.77 +<p><b>mail_dir = <em>file</em></b></p> 6.78 + 6.79 +<p>The directory where local mail is stored, 6.80 +usually <em>/var/spool/mail</em> or <em>/var/mail</em>.</p> 6.81 + 6.82 + 6.83 + 6.84 + 6.85 +<p><b>spool_dir = <em>file</em></b></p> 6.86 + 6.87 +<p>The directory where masqmail stores its spool files (and later also 6.88 +other stuff). It must have a subdirectory <em>input</em>. 6.89 +Masqmail needs read and write permissions for this 6.90 +directory. I suggest to use <em>/var/spool/masqmail</em>.</p> 6.91 + 6.92 + 6.93 + 6.94 + 6.95 +<p><b>host_name = <em>string</em></b></p> 6.96 + 6.97 +<p>This is used in different places: Masqmail identifies itself in the 6.98 +greeting banner on incoming connections and in the HELO/EHLO command 6.99 +for outgoing connections with this name, it is used in the Received: 6.100 +header and to qualify the sender of a locally originating message.</p> 6.101 + 6.102 +<p>If the string begins with a slash '/', it it assumed that it is a 6.103 +filename, and the first line of this file will be used. Usually this will 6.104 +be '/etc/mailname' to make masqmail conform to Debian policies.</p> 6.105 + 6.106 +<p>It is not used to find whether an address is local. 6.107 +Use <b>local_hosts</b> for that.</p> 6.108 + 6.109 + 6.110 + 6.111 + 6.112 +<p><b>remote_port = <em>n</em></b></p> 6.113 + 6.114 +<p>The remote port number to be used. This defaults to port 25.</p> 6.115 +<p>This option is deprecated. Use <b>host_name</b> in the route 6.116 +configuration instead. See <a href="masqmail.route.5.html">masqmail.route</a>.</p> 6.117 + 6.118 + 6.119 + 6.120 + 6.121 +<p><b>local_hosts = <em>list</em></b></p> 6.122 + 6.123 +<p>A semicolon ';' separated list of hostnames which are considered 6.124 +local. Normally you set it to "localhost;foo;foo.bar.com" if your host 6.125 +has the fully qualified domain name 'foo.bar.com'.</p> 6.126 + 6.127 + 6.128 + 6.129 + 6.130 +<p><b>local_nets = <em>list</em></b></p> 6.131 + 6.132 +<p>A semicolon ';' separated list of hostnames which are on the 6.133 +'local' net. Delivery to these hosts is attempted immediately. You can 6.134 +use patterns with '*', eg. "*.bar.com".</p> 6.135 + 6.136 + 6.137 + 6.138 + 6.139 +<p><b>local_addresses = <em>list</em></b></p> 6.140 + 6.141 +<p>A semicolon ';' separated list of fully qualified email-addresses 6.142 +which are considered local although their domain name part is not in 6.143 +the list of <b>local_hosts</b>. </p> 6.144 +<p>For example: There are two people working at your 6.145 +LAN: person1@yourdomain and person2@yourdomain. But there are 6.146 +other persons @yourdomain which are NOT local. So you can not put 6.147 +yourdomain to the list of local_hosts. If person1 now wants 6.148 +to write to person2@yourdomain and this mail should not leave the LAN 6.149 +then you can put</p> 6.150 +<p>local_addresses = "person1@yourdomain;person2@yourdomain"</p> 6.151 +<p>to your masqmail.conf.</p> 6.152 + 6.153 + 6.154 + 6.155 + 6.156 +<p><b>not_local_addresses = <em>list</em></b></p> 6.157 + 6.158 +<p>A semicolon ';' separated list of fully qualified email-addresses 6.159 +which are considered not local although their domain name part is in 6.160 +the list of <b>local_hosts</b>. </p> 6.161 +<p>This ist the opposite of the previous case. The majority of addresses 6.162 +of a specific domain are local. But some users are not. With this 6.163 +option you can easily exclude these users.</p> 6.164 +<p>Example:</p> 6.165 +<p>local_hosts = "localhost;myhost;mydomain.net"</p> 6.166 +<p>not_local_addresses = "eric@mydomain.net"</p> 6.167 + 6.168 + 6.169 + 6.170 + 6.171 +<p><b>listen_addresses = <em>list</em></b></p> 6.172 + 6.173 +<p>A semicolon ';' separated list of interfaces on which connections 6.174 +will be accepted. An interface ist defined by a hostname, optionally 6.175 +followed by a colon ':' and a number for the port. If this is left out, 6.176 +port 25 will be used.</p> 6.177 +<p>You can set this to "localhost:25;foo:25" if your hostname is 'foo'.</p> 6.178 +<p>Note that the names are resolved to IP addreses. If your host has 6.179 +different names which resolve to the same IP, use only one of them, 6.180 +otherwise you will get an error message. 6.181 +</p> 6.182 + 6.183 + 6.184 + 6.185 + 6.186 +<p><b>do_save_envelope_to = <em>boolean</em></b></p> 6.187 + 6.188 +<p>If this is set to true, a possibly existing Envelope-to: header in an 6.189 +incoming mail which is received via either pop3 or smtp will be saved as 6.190 +an X-Orig-Envelope-to: header.</p> 6.191 +<p>This is useful if you retrieve mail from a pop3 server with either masqmail 6.192 +or fetchmail, and the server supports Envelope-to: headers, and you want to make use 6.193 +of those with a mail filtering tool, eg. procmail. It cannot be preserved because 6.194 +masqmail sets such a header by itself.</p> 6.195 +<p>Default is false.</p> 6.196 + 6.197 + 6.198 + 6.199 + 6.200 +<p><b>do_relay = <em>boolean</em></b></p> 6.201 + 6.202 +<p>If this is set to false, mail with a return path that is not local and a 6.203 +destination that is also not local will not be accepted via smtp and a 550 6.204 +reply will be given. Default is true.</p> 6.205 +<p>Note that this will not protect you from spammers using open relays, but from 6.206 +users unable to set their address in their mail clients.</p> 6.207 + 6.208 + 6.209 + 6.210 + 6.211 +<p><b>do_queue = <em>boolean</em></b></p> 6.212 + 6.213 +<p>If this is set, mail will not be delivered immediately when 6.214 +accepted. Same as calling masqmail with the <b>-odq</b> option.</p> 6.215 + 6.216 + 6.217 + 6.218 + 6.219 +<p><b>online_routes.<em>name</em> = <em>list</em></b></p> 6.220 + 6.221 + 6.222 +<p>Replace <em>name</em> with a name to identify a connection. Set this 6.223 +to a filename (or a list of filenames) for the special route configuration for that 6.224 +connection. You will use that name to call masqmail with the 6.225 + <b>-qo</b> option every time a connection to your ISP is set 6.226 +up.</p> 6.227 + 6.228 +<p>Example: Your ISP has the name FastNet. Then you write the 6.229 +following line in the main configuration:</p> 6.230 + 6.231 +<p><b>online_routes.FastNet</b> = <em>"/etc/masqmail/fastnet.route"</em></p> 6.232 + 6.233 +<p><em>/etc/masqmail/fastnet.route</em> is the route configuration 6.234 +file, see <a href="masqmail.route.5.html">masqmail.route</a>. As soon as a link to FastNet has been set up, you 6.235 +call masqmail <b>-qo</b> <em>FastNet</em>. Masqmail will then 6.236 +read the specified file and send the mails.</p> 6.237 + 6.238 + 6.239 + 6.240 + 6.241 + 6.242 +<p><b>connect_route.<em>name</em> = <em>list</em></b></p> 6.243 + 6.244 +<p>Old name for <b>online_routes</b>.</p> 6.245 + 6.246 + 6.247 + 6.248 + 6.249 + 6.250 +<p><b>local_net_route = <em>file</em></b></p> 6.251 + 6.252 +<p>This is similar to <b>online_routes.<em>name</em></b> but for the 6.253 +local net. Recipient addresses that are in local_nets will be 6.254 +routed using this route configuration. Main purpose is to define a 6.255 +mail server with mail_host in your local network. In simple 6.256 +environments this can be left unset. If unset, a default route 6.257 +configuration will be used.</p> 6.258 + 6.259 + 6.260 + 6.261 + 6.262 +<p><b>alias_file = <em>file</em></b></p> 6.263 + 6.264 +<p>Set this to the location of your alias file. If unset, no aliasing 6.265 +will be done.</p> 6.266 + 6.267 + 6.268 + 6.269 + 6.270 +<p><b>alias_local_caseless = <em>boolean</em></b></p> 6.271 + 6.272 +<p>If this is set, local parts in the alias file will be matched 6.273 +disregarding upper/lower case.</p> 6.274 + 6.275 + 6.276 + 6.277 + 6.278 +<p><b>pipe_fromline = <em>boolean</em></b></p> 6.279 + 6.280 +<p>If this is set, a from line will be prepended to the output stream whenever 6.281 +a pipe command is called after an alias expansion. Default is false.</p> 6.282 + 6.283 + 6.284 + 6.285 + 6.286 +<p><b>pipe_fromhack = <em>boolean</em></b></p> 6.287 + 6.288 +<p>If this is set, each line beginning with 'From ' is replaced with '>From ' whenever 6.289 +a pipe command is called after an alias expansion. You probably want this if you have 6.290 +set <b>pipe_fromline</b> above. Default is false.</p> 6.291 + 6.292 + 6.293 + 6.294 + 6.295 +<p><b>mbox_default = <em>string</em></b></p> 6.296 + 6.297 +<p>The default local delivery method. Can be one of mbox, mda or 6.298 +maildir (the latter only if maildir support is enabled at compile 6.299 +time). Default is mbox. You can override this for each user by using 6.300 +the <b>mbox_users</b>, <b>mda_users</b> or <b>maildir_users</b> options 6.301 +(see below). 6.302 +</p> 6.303 + 6.304 + 6.305 + 6.306 + 6.307 +<p><b>mbox_users = <em>list</em></b></p> 6.308 + 6.309 +<p>A list of users which wish delivery to an mbox style mail folder.</p> 6.310 + 6.311 + 6.312 + 6.313 + 6.314 +<p><b>mda_users = <em>list</em></b></p> 6.315 + 6.316 +<p>A list of users which wish local delivery to an mda. You have to 6.317 +set <b>mda</b> (see below) as well.</p> 6.318 + 6.319 + 6.320 + 6.321 + 6.322 +<p><b>maildir_users = <em>list</em></b></p> 6.323 + 6.324 +<p>A list of users which wish delivery to a qmail style maildir. The 6.325 +path to maildir is ~/Maildir/. The maildir will be created if it 6.326 +does not exist.</p> 6.327 + 6.328 + 6.329 + 6.330 + 6.331 +<p><b>mda = <em>expand string</em></b></p> 6.332 + 6.333 +<p>If you want local delivery to be transferred to an mda (Mail 6.334 +Delivery Agent), set this to a command. The argument will be expanded 6.335 +on delivery time, you can use variables beginning with a '$' sign, 6.336 +optionally enclosed in curly braces. Variables you can use are:</p> 6.337 +<p>uid - the unique message id. This is not necessarily identical with 6.338 +the Message ID as given in the Message ID: header.</p> 6.339 +<p>received_host - the host the mail was received from</p> 6.340 +<p>ident - the ident, this is either the ident delivered by the ident 6.341 +protocol or the user id of the sender if the message was received locally.</p> 6.342 +<p>return_path_local - the local part of the return path (sender).</p> 6.343 +<p>return_path_domain - the domain part of the return path (sender).</p> 6.344 +<p>return_path - the complete return path (sender).</p> 6.345 +<p>rcpt_local - the local part of the recipient.</p> 6.346 +<p>rcpt_domain - the domain part of the recipient.</p> 6.347 +<p>rcpt - the complete recipient address.</p> 6.348 +<p>Example:</p><p>mda="/usr/bin/procmail -Y -d ${rcpt_local}"</p> 6.349 +<p>For the mda, as for pipe commands, a few environment variables will 6.350 +be set as well. See <a href="masqmail.8.html">masqmail</a>. To use environment variables for the mda, 6.351 +the '$' sign has to be escaped with a backslash, otherwise they will 6.352 +be tried to be expanded with the internal variables.</p> 6.353 + 6.354 + 6.355 + 6.356 + 6.357 + 6.358 +<p><b>mda_fromline = <em>boolean</em></b></p> 6.359 + 6.360 +<p>If this is set, a from line will be prepended to the output stream whenever 6.361 +a message is delivered to an mda. Default is false.</p> 6.362 + 6.363 + 6.364 + 6.365 + 6.366 +<p><b>mda_fromhack = <em>boolean</em></b></p> 6.367 + 6.368 +<p>If this is set, each line beginning with 'From ' is replaced with '>From ' whenever 6.369 +a message is delivered to an mda. You probably want this if you have 6.370 +set <b>mda_fromline</b> above. Default is false.</p> 6.371 + 6.372 + 6.373 + 6.374 + 6.375 +<p><b>online_detect = <em>string</em></b></p> 6.376 + 6.377 +<p>Defines the method MasqMail uses to detect whether there is 6.378 +currently an online connection. It can have the 6.379 +values <b>file</b>, <b>pipe</b> or <b>mserver</b>.</p> 6.380 + 6.381 +<p>When it is set to <b>file</b>, MasqMail first checks for the 6.382 +existence of <b>online_file</b> (see below) and if it exists, it reads 6.383 +it. The content of the file should be the name of the current 6.384 +connection as defined with <b>connect_route.<em>name</em></b> (without 6.385 +a trailing newline character).</p> 6.386 + 6.387 +<p>When it is set to <b>pipe</b>, MasqMail calls the executable given by 6.388 +the <b>online_pipe</b> option (see below) and reads the current online 6.389 +status from its standard output.</p> 6.390 + 6.391 +<p>When it is set to <b>mserver</b>, MasqMail connects to the 6.392 +masqdialer server using the value of <b>mserver_iface</b> and asks it 6.393 +whether a connection exists and for the name, which should be the name 6.394 +of the current connection as defined with <b>connect_route.<em>name</em></b>.</p> 6.395 + 6.396 +<p>No matter how MasqMail detects the online status, only messages 6.397 +that are accepted at online time will be delivered using the 6.398 +connection. The spool still has to be emptied with masqmail <b>-qo</b> 6.399 +<em>connection</em>.</p> 6.400 + 6.401 + 6.402 + 6.403 + 6.404 +<p><b>online_file = <em>file</em></b></p> 6.405 + 6.406 +<p>This is the name of the file checked for when MasqMail determines 6.407 +whether it is online. The file should only exist when there is 6.408 +currently a connection. Create it in your ip-up script with eg.</p> 6.409 + 6.410 +<p>echo -n <name> > /tmp/connect_route</p> 6.411 +<p>chmod 0644 /tmp/connect_route</p> 6.412 + 6.413 +<p>Do not forget to delete it in your ip-down script.</p> 6.414 + 6.415 + 6.416 + 6.417 + 6.418 +<p><b>online_pipe = <em>file</em></b></p> 6.419 + 6.420 +<p>This is the name of the executable which will be called to determine 6.421 +the online status. This executable should just print the name oif the current 6.422 +connection to the standard output and return a zero status code. masqmail assumes 6.423 +it is offline if the script returns with a non zero status. Simple example:</p> 6.424 + 6.425 +<p>#!/bin/sh</p> 6.426 +<p></p> 6.427 +<p>[ -e /tmp/connect_route ] || exit 1</p> 6.428 +<p>cat /tmp/connect_route</p> 6.429 +<p>exit 0</p> 6.430 + 6.431 +<p>Of course, instead of the example above you could as well use <b>file</b> as 6.432 +the online detection method, but you can do something more sophisticated.</p> 6.433 + 6.434 + 6.435 + 6.436 + 6.437 +<p><b>mserver_iface = <em>interface</em></b></p> 6.438 + 6.439 +<p>The interface the masqdialer server is listening to. Usually this 6.440 +will be "localhost:224" if mserver is running on the same host as 6.441 +masqmail. But using this option, you can also let masqmail run on 6.442 +another host by setting <b>mserver_iface</b> to another hostname, 6.443 +eg. "foo:224".</p> 6.444 + 6.445 + 6.446 + 6.447 + 6.448 +<p><b>get.<em>name</em> = <em>file</em></b></p> 6.449 + 6.450 +<p>Replace <em>name</em> with a name to identify a get 6.451 +configuration. Set this to a filename for the get configuration. These 6.452 +files will be used to retrieve mail when called with the -g option.</p> 6.453 + 6.454 + 6.455 + 6.456 + 6.457 +<p><b>online_gets.<em>name</em> = <em>list</em></b></p> 6.458 + 6.459 +<p>Replace <em>name</em> with a name to identify an online 6.460 +configuration. Set this to a filename (or a list of filenames) for the get configuration. These 6.461 +files will be used to retrieve mail when called with the -go option.</p> 6.462 + 6.463 + 6.464 + 6.465 + 6.466 +<p><b>ident_trusted_nets = <em>list</em></b></p> 6.467 + 6.468 +<p><em>list</em> is a list of networks of the form a.b.c.d/e 6.469 +(eg. 192.168.1.0/24), from which the ident given by the ident protocol 6.470 +will be trusted, so a user can delete his mail from the queue if the 6.471 +ident is identical to his login name.</p> 6.472 + 6.473 + 6.474 + 6.475 + 6.476 +<p><b>errmsg_file = <em>file</em></b></p> 6.477 + 6.478 +<p>Set this to a template which will be used to generate delivery failure 6.479 +reports. Variable parts within the template begin with a dollar sign and 6.480 +are identical to those which can be used as arguments for the mda command, 6.481 +see <b>mda</b> above. Additional information can be included with 6.482 +@failed_rcpts, @msg_headers and @msg_body, these must be at the 6.483 +beginning of a line and will be replaced with the list of the failed recipients, 6.484 +the message headers and the message body of the failed message.</p> 6.485 +<p>Default is /usr/share/masqmail/tpl/failmsg.tpl.</p> 6.486 + 6.487 + 6.488 + 6.489 + 6.490 +<p><b>warnmsg_file = <em>file</em></b></p> 6.491 + 6.492 +<p>Set this to a template which will be used to generate delivery warning 6.493 +reports. It uses the same mechanisms for variables as <b>errmsg_file</b>, 6.494 +see above. 6.495 +</p> 6.496 +<p>Default is /usr/share/masqmail/tpl/warnmsg.tpl.</p> 6.497 + 6.498 + 6.499 + 6.500 + 6.501 +<p><b>warn_intervals</b> = <em>list</em></p> 6.502 + 6.503 +<p>Set this to a list of time intervals, at which delivery warnings (starting 6.504 +with the receiving time of the message) shall be generated.</p> 6.505 +<p>A warning will only be generated just after an attempt to deliver the 6.506 +mail and if that attempt failed temporarily. So a warning may be generated after 6.507 +a longer time, if there was no attempt before.</p> 6.508 +<p>Default is "1h;4h;8h;1d;2d;3d"</p> 6.509 + 6.510 + 6.511 + 6.512 + 6.513 +<p><b>max_defer_time</b> = <em>time</em></p> 6.514 + 6.515 +<p>This is the maximum time, in which a temporarily failed mail will be kept 6.516 +in the spool. When this time is exceeded, it will be handled as a delivery failure, 6.517 +and the message will be bounced.</p> 6.518 +<p>The excedence of this time will only be noticed if the message was actually 6.519 +tried to be delivered. If, for example, the message can only be delivered when 6.520 +online, but you have not been online for that time, no bounce will be generated.</p> 6.521 +<p>Default is 4d (4 days)</p> 6.522 + 6.523 + 6.524 + 6.525 + 6.526 +<p><b>log_user = <em>name</em></b></p> 6.527 + 6.528 +<p>Replace <em>name</em> with a valid local or remote mail address.</p> 6.529 +<p>If this option is not empty, then a copy of every mail, 6.530 +that passes trough the masqmail system will also be sent to the 6.531 +given mail address.</p> 6.532 +<p>For example you can feed your mails into a program like hypermail for 6.533 +archiving purpose by placing an appropriate pipe command in masqmail.alias</p> 6.534 + 6.535 + 6.536 + 6.537 + 6.538 + 6.539 +<h2>Author</h2> 6.540 + 6.541 +<p>masqmail was written by Oliver Kurth 6.542 +<oku@masqmail.cx></p><p>You will find the newest version of 6.543 +masqmail at <a href = "http://masqmail.cx/masqmail/">http://masqmail.cx/masqmail/</a> or search for it 6.544 +in freshmeat (<a href = "http://www.freshmeat.net">http://www.freshmeat.net</a>). There is also a mailing list, 6.545 +you will find information about it at masqmails main site.</p> 6.546 + 6.547 + 6.548 + 6.549 +<h2>Bugs</h2> 6.550 + 6.551 +<p>You should report them to the mailing list.</p> 6.552 + 6.553 + 6.554 + 6.555 +<h2>See also</h2> 6.556 + 6.557 +<p> 6.558 +<a href="masqmail.8.html">masqmail</a>, <a href="masqmail.route.5.html">masqmail.route</a>, <a href="masqmail.get.5.html">masqmail.get</a> 6.559 +</p> 6.560 + 6.561 + 6.562 + 6.563 + 6.564 +<h2>Comments</h2> 6.565 + 6.566 +<p>This man page was written using <a href="http://masqmail.cx/xml2man/">xml2man</a> by the same 6.567 +author.</p> 6.568 + 6.569 + 6.570 + 6.571 +</td></tr></table></center> 6.572 +</body>
7.1 --- /dev/null Thu Jan 01 00:00:00 1970 +0000 7.2 +++ b/docs/old-manual/docs/masqmail.get.5.html Sat May 29 21:51:13 2010 +0200 7.3 @@ -0,0 +1,175 @@ 7.4 +<body text="#000000" link="#0000ff" bgcolor="#ffffff"><center><table width="80%"> 7.5 +<tr><td><h1>masqmail.get</h1> 7.6 +<h2>masqmail get configuration file</h2> 7.7 + 7.8 + 7.9 +<h2>Description</h2> 7.10 + <p>This man page describes the options available for the 7.11 +masqmail get configuration.</p> 7.12 + 7.13 + 7.14 + 7.15 + 7.16 +<h2>Options</h2> 7.17 + 7.18 + 7.19 + 7.20 +<p><b>protocol</b> = <em>string</em></p> 7.21 + 7.22 +<p>The protocol with which you retrieve your mail. Currently only 7.23 +'pop3' and 'apop' are supported. There is no default.</p> 7.24 + 7.25 + 7.26 + 7.27 + 7.28 +<p><b>server</b> = <em>string</em></p> 7.29 + 7.30 +<p>The server you get your mail from.</p> 7.31 + 7.32 + 7.33 + 7.34 + 7.35 +<p><b>resolve_list</b> = <em>list</em></p> 7.36 + 7.37 +<p>Specify the method how the domain of the server is resolved. Possible values are 7.38 +dns_mx, dns_a, byname. For 'dns_mx', the domain is assumed to be an MX 7.39 +pointer to a list of host names, these will be tried each in order 7.40 +(lowest preference value first, equal preference values in random 7.41 +order). For 'dns_a', the domain is assumed to be an A pointer. For 7.42 +'byname', the library function <b>gethostbyname (3)</b> will be used.</p> 7.43 +<p>The default is "dns_a;byname". It does not make much sense here to use 'dns_mx'.</p> 7.44 + 7.45 + 7.46 + 7.47 + 7.48 +<p><b>user</b> = <em>string</em></p> 7.49 + 7.50 +<p>Your login name.</p> 7.51 + 7.52 + 7.53 + 7.54 + 7.55 +<p><b>pass</b> = <em>string</em></p> 7.56 + 7.57 +<p>Your password.</p> 7.58 + 7.59 + 7.60 + 7.61 + 7.62 +<p><b>address</b> = <em>address</em></p> 7.63 + 7.64 +<p>The address where the retrieved mail should be sent to. It can be 7.65 +any address, but you probably want to set this to a local address on 7.66 +your LAN.</p> 7.67 + 7.68 + 7.69 + 7.70 + 7.71 +<p><b>return_path</b> = <em>address</em></p> 7.72 + 7.73 +<p>If set, masqmail sets the return path to this address. Bounces 7.74 +generated during further delivery will be sent to this address. If 7.75 +unset, masqmail looks for the Return-Path: header in the mail, if 7.76 +this does not exist it uses the From: address and if this fails, 7.77 +postmaster will be used. 7.78 +</p><p> 7.79 +It is in most cases not useful to set this to the same address as 7.80 +the 'address' option as this may generate multiple bounces. 7.81 +postmaster is recommended.</p> 7.82 + 7.83 + 7.84 + 7.85 + 7.86 +<p><b>do_keep</b> = <em>boolean</em></p> 7.87 + 7.88 +<p>If you want to keep your mail on the server after you retrieved it, 7.89 +set this to true. It is recommended that you also set do_uidl, 7.90 +otherwise you will get the mail again each time you connect to the 7.91 +server. Masqmail does not check any headers before it retrieves mail, 7.92 +which may mark it as already fetched. Note that this behaviour is 7.93 +different to that of fetchmail. The default is false.</p> 7.94 + 7.95 + 7.96 + 7.97 + 7.98 +<p><b>do_uidl</b> = <em>boolean</em></p> 7.99 + 7.100 +<p>If set, MasqMail keeps a list of unique IDs of mails already 7.101 +fetched, so that they will not be retrieved again. Default is false.</p> 7.102 + 7.103 + 7.104 + 7.105 + 7.106 +<p><b>do_uidl_dele</b> = <em>boolean</em></p> 7.107 + 7.108 +<p>If set, and <b>do_uidl</b> is also set, MasqMail sends a delete (DELE) 7.109 +command to the server for each message uid in the uid listing at the 7.110 +beginning of the session. This prevents mail to be left on the server if 7.111 +masqmail gets interrupted during a session before it can send the QUIT 7.112 +command to the server. Default is false. 7.113 +</p> 7.114 + 7.115 + 7.116 + 7.117 + 7.118 +<p><b>max_size</b> = <em>numeric</em></p> 7.119 + 7.120 +<p>If set to a value > 0, only messages smaller than this in bytes will be 7.121 +retrieved. The default is 0.</p> 7.122 + 7.123 + 7.124 + 7.125 + 7.126 +<p><b>max_count</b> = <em>numeric</em></p> 7.127 + 7.128 +<p>If set to a value > 0, only <b>max_count</b> messages will be retrieved. 7.129 +The default is 0.</p> 7.130 + 7.131 + 7.132 + 7.133 + 7.134 +<p><b>wrapper</b> = <em>command</em></p> 7.135 + 7.136 +<p>If set, instead of opening a connection to a remote server, <em>command</em> will 7.137 +be called and all traffic will be piped to its 7.138 +stdin and from its stdout. Purpose is to tunnel ip traffic, eg. for ssl.</p> 7.139 +<p>Example for ssl tunneling:</p> 7.140 +<p>wrapper="/usr/bin/openssl s_client -quiet -connect pop.gmx.net:995 2>/dev/null"</p> 7.141 + 7.142 + 7.143 + 7.144 + 7.145 + 7.146 +<h2>Author</h2> 7.147 + 7.148 +<p>masqmail was written by Oliver Kurth 7.149 +<oku@masqmail.cx></p><p>You will find the newest version of 7.150 +masqmail at <a href = "http://masqmail.cx/masqmail/">http://masqmail.cx/masqmail/</a> or search for it 7.151 +in freshmeat (<a href = "http://www.freshmeat.net">http://www.freshmeat.net</a>). There is also a mailing list, 7.152 +you will find information about it at masqmails main site.</p> 7.153 + 7.154 + 7.155 + 7.156 +<h2>Bugs</h2> 7.157 + 7.158 +<p>You should report them to the mailing list.</p> 7.159 + 7.160 + 7.161 + 7.162 +<h2>See also</h2> 7.163 + 7.164 +<p> 7.165 +<a href="masqmail.8.html">masqmail</a>, <a href="masqmail.route.5.html">masqmail.route</a>, <a href="masqmail.conf.5.html">masqmail.conf</a> 7.166 +</p> 7.167 + 7.168 + 7.169 + 7.170 +<h2>Comments</h2> 7.171 + 7.172 +<p>This man page was written using <a href="http://masqmail.cx/xml2man/">xml2man</a> by the same 7.173 +author.</p> 7.174 + 7.175 + 7.176 + 7.177 +</td></tr></table></center> 7.178 +</body>
8.1 --- /dev/null Thu Jan 01 00:00:00 1970 +0000 8.2 +++ b/docs/old-manual/docs/masqmail.route.5.html Sat May 29 21:51:13 2010 +0200 8.3 @@ -0,0 +1,385 @@ 8.4 +<body text="#000000" link="#0000ff" bgcolor="#ffffff"><center><table width="80%"> 8.5 +<tr><td><h1>masqmail.route</h1> 8.6 +<h2>masqmail route configuration file</h2> 8.7 + 8.8 + 8.9 +<h2>Description</h2> 8.10 + 8.11 +<p>This man page describes the syntax of the route configuration files 8.12 +of <a href="masqmail.8.html">masqmail</a>. Their usual locations are in <em>/etc/masqmail/</em>.</p> 8.13 + 8.14 + 8.15 + 8.16 +<h2>Options</h2> 8.17 + 8.18 + 8.19 + 8.20 +<p><b>protocol</b> = <em>string</em></p> 8.21 + 8.22 +<p><em>string</em> can be one of 'smtp' or 'pipe', default is 8.23 +'smtp'. If set to 'smtp', mail will be sent with the SMTP protocol to 8.24 +its destination. If set to 'pipe', you also have to set 'pipe' 8.25 +to a command, the message will then be piped to a program. See option 'pipe' below.</p> 8.26 + 8.27 + 8.28 + 8.29 + 8.30 +<p><b>mail_host</b> = <em>string</em></p> 8.31 + 8.32 +<p>This is preferably the mail server of your ISP. All outgoing 8.33 +messages will be sent to this host which will distribute them to their 8.34 +destinations. If you do not set this mails will be sent 8.35 +directly. Because the mail server is probably 'near' to you, mail 8.36 +transfer will be much faster if you use it.</p> 8.37 +<p>You can optionally give a port number following the host name 8.38 +and a colon, eg mail_host="mail.foo.com:25".</p> 8.39 + 8.40 + 8.41 + 8.42 + 8.43 +<p><b>resolve_list</b> = <em>list</em></p> 8.44 + 8.45 +<p>Specify the method how the domain of the server is resolved. Possible values are 8.46 +dns_mx, dns_a, byname. For 'dns_mx', the domain is assumed to be an MX 8.47 +pointer to a list of host names, these will be tried each in order 8.48 +(lowest preference value first, equal preference values in random 8.49 +order). For 'dns_a', the domain is assumed to be an A pointer. For 8.50 +'byname', the library function <b>gethostbyname (3)</b> will be used.</p> 8.51 +<p>The default is "dns_mx;dns_a;byname".</p> 8.52 + 8.53 + 8.54 + 8.55 + 8.56 +<p><b>connect_error_fail</b> = <em>boolean</em></p> 8.57 + 8.58 +<p>If this is set, a connection error will cause a mail delivery to 8.59 +fail, ie. it will be bounced. If it is unset, it will just be defered.</p> 8.60 +<p>Default is false. The reason for this is that masqmail is designed 8.61 +for non permanent internet connections, where such errors may occur 8.62 +quite often, and a bounce would be annoying.</p> 8.63 +<p>For the default local_net route is is set to true.</p> 8.64 + 8.65 + 8.66 + 8.67 + 8.68 +<p><b>helo_name</b> = <em>string</em></p> 8.69 + 8.70 +<p>Set the name given with the HELO/EHLO command. If this is not 8.71 +set, <b>host_name</b> from <em>masqmail.conf</em> will be used, if 8.72 +the <b>do_correct_helo</b> option (see below) is unset.</p> 8.73 + 8.74 + 8.75 + 8.76 + 8.77 +<p><b>do_correct_helo</b> = <em>boolean</em></p> 8.78 + 8.79 +<p>If this is set, masqmail tries to look up your host name as it 8.80 +appears on the internet and sends this in the HELO/EHLO command. Some 8.81 +servers are so picky that they want this. Which is really 8.82 +crazy. It just does not make any sense to lie about ones own identity, 8.83 +because it can always be looked up by the server. Nobody should 8.84 +believe in the name given by HELO/EHLO anyway. If this is not 8.85 +set, <b>host_name</b> from <em>masqmail.conf</em> or as given with 8.86 +the <b>helo_name</b> (see above) will be used.</p> 8.87 + 8.88 + 8.89 + 8.90 + 8.91 +<p><b>do_pipelining</b> = <em>boolean</em></p> 8.92 + 8.93 +<p>If this is set to false, masqmail will not use ESMTP PIPELINING, even 8.94 +if the server announces that it is able to cope with it. Default is true.</p> 8.95 +<p>You do not want to set this to false unless the mail setup on the 8.96 +remote server side is really broken. Keywords: wingate.</p> 8.97 + 8.98 + 8.99 + 8.100 + 8.101 +<p><b>allowed_mail_locals</b> = <em>list</em></p> 8.102 + 8.103 +<p>This is a semicolon ';' separated list of local parts which will be 8.104 +allowed to send mail through this connection. If unset 8.105 +and <b>not_allowed_mail_locals</b> is also unset, all users are 8.106 +allowed.</p> 8.107 + 8.108 + 8.109 + 8.110 + 8.111 +<p><b>not_allowed_mail_locals</b> = <em>list</em></p> 8.112 + 8.113 +<p>This is a semicolon ';' separated list of local parts which will be 8.114 +not allowed to send mail through this connection. Local 8.115 +parts in this list will not be allowed to use this route even if they 8.116 +are part of <b>allowed_mail_locals</b> (see above).</p> 8.117 + 8.118 + 8.119 + 8.120 + 8.121 +<p><b>allowed_return_paths</b> = <em>list</em></p> 8.122 + 8.123 +<p>This is a semicolon ';' separated list of addresses. Messages which 8.124 +have one one of these addresses as the return path will be used using 8.125 +this route (if not also in <b>not_allowed_return_paths</b> or an item 8.126 +in <b>not_allowed_mail_locals</b> matches).</p> 8.127 +<p>Patterns containing '?' and '*' can be used. The special item "<>" matches 8.128 +the null sender address (eg. failure notices or delivery notifications).</p> 8.129 + 8.130 + 8.131 + 8.132 + 8.133 +<p><b>not_allowed_return_paths</b> = <em>list</em></p> 8.134 + 8.135 +<p>This is a semicolon ';' separated list of addresses. Messages which 8.136 +have one one of these addresses as the return path will not be used using 8.137 +this route (even if also in <b>allowed_return_paths</b> or an item 8.138 +in <b>allowed_mail_locals</b> matches).</p> 8.139 +<p>Patterns containing '?' and '*' can be used. The special item "<>" matches 8.140 +the null sender address (eg. failure notices or delivery notifications).</p> 8.141 + 8.142 + 8.143 + 8.144 + 8.145 +<p><b>allowed_rcpt_domains</b> = <em>list</em></p> 8.146 + 8.147 +<p>A list of recipient domains where mail will be sent to. This is for 8.148 +example useful if you use this route configuration when connected to 8.149 +another LAN via ppp. Patterns containing '?' and '*' can be used.</p> 8.150 + 8.151 + 8.152 + 8.153 + 8.154 +<p><b>not_allowed_rcpt_domains</b> = <em>list</em></p> 8.155 + 8.156 +<p>A list of recipient domains where mail will not be sent 8.157 +to. This is for example useful if you send mail directly (<b>mail_host</b> is 8.158 +not set) and you know of hosts that will not accept mail from you 8.159 +because they use a dialup list (eg. <a href = "http://maps.vix.com/dul/">http://maps.vix.com/dul/</a>. If any domain 8.160 +matches both <b>allowed_rcpt_domains</b> and <b>not_allowed_rcpt_domains</b>, 8.161 +mail will not be sent to this domain. Patterns containing '?' and '*' can be used.</p> 8.162 + 8.163 + 8.164 + 8.165 + 8.166 +<p><b>set_h_from_domain</b> = <em>string</em></p> 8.167 + 8.168 +<p>Replace the domain part in 'From:' headers with this value. This 8.169 +may be useful if you use a private, outside unknown address on your 8.170 +local LAN and want this to be replaced by the domain of the address of 8.171 +your email addrsss on the internet. Note that this is different to <b> 8.172 +set_return_path_domain</b>, see below.</p> 8.173 + 8.174 + 8.175 + 8.176 + 8.177 +<p><b>set_return_path_domain</b> = <em>string</em></p> 8.178 + 8.179 +<p>Sets the domain part of the envelope from address. Some hosts check 8.180 +whether this is the same as the net the connection is coming from. If 8.181 +not, they reject the mail because they suspect spamming. It should be 8.182 +a valid address, because some mail servers also check 8.183 +that. You can also use this to set it to your usual address on the 8.184 +internet and put a local address only known on your LAN in the 8.185 +configuration of your mailer. Only the domain part will 8.186 +be changed, the local part remains unchanged. Use <b> 8.187 +map_return_path_addresses</b> for rewriting local parts.</p> 8.188 + 8.189 + 8.190 + 8.191 + 8.192 +<p><b>map_h_from_addresses</b> = <em>list</em></p> 8.193 + 8.194 +<p>This is similar to <b>set_h_from_domain</b>, but more flexible. Set 8.195 +this to a list which maps local parts to a full RFC 822 compliant 8.196 +email address, the local parts (the keys) are separated from 8.197 +the addresses (the values) by colons (':').</p> 8.198 + 8.199 +<p>Example:</p> 8.200 + 8.201 +<p>map_h_from_addresses = "john: John Smith <jsmith@mail.academic.edu>; 8.202 +charlie: Charlie Miller <cmiller@mx.commercial.com>"</p> 8.203 +<p>You can use patterns, eg. * as keys.</p> 8.204 + 8.205 + 8.206 + 8.207 + 8.208 +<p><b>map_h_reply_to_addresses</b> = <em>list</em></p> 8.209 + 8.210 +<p>Same as <b>map_h_from_addresses</b>, but for the 'Reply-To:' header.</p> 8.211 + 8.212 + 8.213 + 8.214 + 8.215 +<p><b>map_h_mail_followup_to_addresses</b> = <em>list</em></p> 8.216 + 8.217 +<p>Same as <b>map_h_from_addresses</b>, but for the 'Mail-Followup-To:' 8.218 +header. Useful when replying to mailing lists.</p> 8.219 + 8.220 + 8.221 + 8.222 + 8.223 +<p><b>map_return_path_addresses</b> = <em>list</em></p> 8.224 + 8.225 +<p>This is similar to <b>set_return_path_domain</b>, but more 8.226 +flexible. Set this to a list which maps local parts to a full RFC 821 8.227 +compliant email address, the local parts (the keys) are 8.228 +separated from the addresses (the values) by colons 8.229 +(':'). Note that this option takes RFC 821 addresses 8.230 +while <b>map_h_from_addresses</b> takes RFC 822 addresses. The 8.231 +most important difference is that RFC 821 addresses have no full 8.232 +name.</p> 8.233 + 8.234 +<p>Example:</p> 8.235 +<p> 8.236 +map_return_path_addresses = 8.237 +"john: <jsmith@mail.academic.edu>; 8.238 +charlie: <cmiller@mx.commercial.com>" 8.239 +</p> 8.240 +<p>You can use patterns, eg. * as keys.</p> 8.241 + 8.242 + 8.243 + 8.244 + 8.245 +<p><b>expand_h_sender_address</b> = <em>boolean</em></p> 8.246 + 8.247 +<p>This sets the domain of the sender address as given by the Sender: 8.248 +header to the same address as in the envelope return path address 8.249 +(which can be set by either <b>set_return_path_domain</b> or <b>map_return_path_addresses</b>). 8.250 +This is for mail clients (eg. Microsoft Outlook) which use this address as the sender 8.251 +address. Though they should use the From: address, see RFC 8.252 +821. If <a href="http://www.fetchmail.org">fetchmail</a> encounters an unqualified Sender: 8.253 +address, it will be expanded to the domain of the pop server, which is 8.254 +almost never correct. Default is true.</p> 8.255 + 8.256 + 8.257 + 8.258 + 8.259 +<p><b>expand_h_sender_domain</b> = <em>boolean</em></p> 8.260 + 8.261 +<p>Like <b>expand_h_sender_address</b>, but sets the domain only. 8.262 +Deprecated, will be removed in a later version.</p> 8.263 + 8.264 + 8.265 + 8.266 + 8.267 +<p><b>last_route</b> = <em>boolean</em></p> 8.268 + 8.269 +<p>If this is set, a mail which would have been delivered using this 8.270 +route, but has failed temporarily, will not be tried to be delivered 8.271 +using the next route.</p> 8.272 +<p>If you have set up a special route with filters using the lists 8.273 +'allowed_rcpt_domains', 'allowed_return_paths', and 8.274 +'allowed_mail_locals' or their complements (not_), and the mail 8.275 +passing these rules should be delivered using this route only, you 8.276 +should set this to 'true'. Otherwise the mail would be passed to the 8.277 +next route (if any), unless that route has rules which prevent 8.278 +that.</p> 8.279 +<p>Default is false.</p> 8.280 + 8.281 + 8.282 + 8.283 + 8.284 +<p><b>auth_name</b> = <em>string</em></p> 8.285 + 8.286 +<p>Set the authentication type for ESMTP AUTH authentification. 8.287 +Currently only 'cram-md5' and 'login' are supported.</p> 8.288 + 8.289 + 8.290 + 8.291 + 8.292 +<p><b>auth_login</b> = <em>string</em></p> 8.293 + 8.294 +<p>Your account name for ESMTP AUTH authentification.</p> 8.295 + 8.296 + 8.297 + 8.298 + 8.299 +<p><b>auth_secret</b> = <em>string</em></p> 8.300 + 8.301 +<p>Your secret for ESMTP AUTH authentification.</p> 8.302 + 8.303 + 8.304 + 8.305 + 8.306 +<p><b>pop3_login</b> = <em>file</em></p> 8.307 + 8.308 +<p>If your Mail server requires SMTP-after-POP, set this to a 8.309 +get configuration (see <a href="masqmail.get.5.html">masqmail.get</a>). 8.310 +If you login to the POP server 8.311 +before you send, this is not necessary.</p> 8.312 + 8.313 + 8.314 + 8.315 + 8.316 +<p><b>wrapper</b> = <em>command</em></p> 8.317 + 8.318 +<p>If set, instead of opening a connection to a remote server, <em>command</em> will 8.319 +be called and all traffic will be piped to its 8.320 +stdin and from its stdout. Purpose is to tunnel ip traffic, eg. for ssl.</p> 8.321 +<p>Example for ssl tunneling:</p> 8.322 +<p>wrapper="/usr/bin/openssl s_client -quiet -connect pop.gmx.net:995 2>/dev/null"</p> 8.323 + 8.324 + 8.325 + 8.326 + 8.327 +<p><b>pipe</b> = <em>command</em></p> 8.328 + 8.329 +<p>If set, and protocol is set to 'pipe', <em>command</em> will be 8.330 +called and the message will be piped to its stdin. Purpose is to use 8.331 +gateways to uucp, fax, sms or whatever else.</p> 8.332 +<p>You can use variables to give as arguments to the command, these 8.333 +are the same as for the mda in the main configuration, see <a href="masqmail.conf.5.html">masqmail.conf</a>.</p> 8.334 + 8.335 + 8.336 + 8.337 + 8.338 +<p><b>pipe_fromline = <em>boolean</em></b></p> 8.339 + 8.340 +<p>If this is set, and protocol is set to 'pipe', a from line will be prepended to the output stream whenever 8.341 +a pipe command is called. Default is false.</p> 8.342 + 8.343 + 8.344 + 8.345 + 8.346 +<p><b>pipe_fromhack = <em>boolean</em></b></p> 8.347 + 8.348 +<p>If this is set, and protocol is set to 'pipe', each line beginning with 'From ' 8.349 +is replaced with '>From ' whenever a pipe command is called. You probably want this if you have 8.350 +set <b>pipe_fromline</b> above. Default is false.</p> 8.351 + 8.352 + 8.353 + 8.354 + 8.355 + 8.356 +<h2>Author</h2> 8.357 + 8.358 +<p>masqmail was written by Oliver Kurth 8.359 +<oku@masqmail.cx></p><p>You will find the newest version of 8.360 +masqmail at <a href = "http://masqmail.cx/masqmail/">http://masqmail.cx/masqmail/</a> or search for it 8.361 +in freshmeat (<a href = "http://www.freshmeat.net">http://www.freshmeat.net</a>). There is also a mailing list, 8.362 +you will find information about it at masqmails main site.</p> 8.363 + 8.364 + 8.365 + 8.366 +<h2>Bugs</h2> 8.367 + 8.368 +<p>You should report them to the mailing list.</p> 8.369 + 8.370 + 8.371 + 8.372 +<h2>See also</h2> 8.373 + 8.374 +<p> 8.375 +<a href="masqmail.8.html">masqmail</a>, <a href="masqmail.conf.5.html">masqmail.conf</a>, <a href="masqmail.get.5.html">masqmail.get</a> 8.376 +</p> 8.377 + 8.378 + 8.379 + 8.380 +<h2>Comments</h2> 8.381 + 8.382 +<p>This man page was written using <a href="http://masqmail.cx/xml2man/">xml2man</a> by the same 8.383 +author.</p> 8.384 + 8.385 + 8.386 + 8.387 +</td></tr></table></center> 8.388 +</body>
9.1 --- /dev/null Thu Jan 01 00:00:00 1970 +0000 9.2 +++ b/docs/old-manual/faq.html Sat May 29 21:51:13 2010 +0200 9.3 @@ -0,0 +1,189 @@ 9.4 +<HTML> 9.5 +<HEAD> 9.6 +<TITLE>MasqMail - Manual 9.7 +</TITLE> 9.8 +</HEAD> 9.9 + <BODY TEXT="#000000" LINK="#0000ff" BGCOLOR="#ffffff"> 9.10 + 9.11 + <center> 9.12 + <table width="80%"> 9.13 + <tr><td> 9.14 + <table width="100%" bgcolor="#0000aa" cellspacing=0 cellpadding=0> 9.15 + <tr> 9.16 + <td> 9.17 + <a href="manual.html"> 9.18 + <img width="20" src = "../images/u_arrow.gif" alt = "manual"> 9.19 + </a> 9.20 + </td> 9.21 + <td align=center width="100%"><font size="6" color = "#ffffff">Frequently Asked Questions</font></td> 9.22 + <td> 9.23 + <a href="./config.html"> 9.24 + <img width="20" src = "../images/l_arrow.gif" alt = "Configuration"> 9.25 + </a> 9.26 + </td> 9.27 + </tr> 9.28 + </table> 9.29 + 9.30 + 9.31 + Some of these questions were never asked, but I thought they will be 9.32 + some time. Some <em>were</em> asked. 9.33 + 9.34 + <h4>General Questions</h4> 9.35 + <ul> 9.36 + <li><a href="#1_0">1.0: When do I need MasqMail?</a></li> 9.37 + <li><a href="#1_1">1.1: When do I <em>not</em> need MasqMail?</a></li> 9.38 + <li><a href="#1_2">1.2: Can I retrieve mail with MasqMail?</a></li> 9.39 + <li><a href="#1_3">1.3: Is there a mailing list for MasqMail?</a></li> 9.40 + </ul> 9.41 + 9.42 + <h4>Setup</h4> 9.43 + <ul> 9.44 + <li><a href="#2_0">2.0: After starting masmail, I get the following 9.45 + message: "could not gain root privileges. Is the setuid bit set?"</a></li> 9.46 + <li><a href="#2_1">2.1: After starting masmail, I get the following 9.47 + message: "bind: (terminating): Address already in use"</a></li> 9.48 + </ul> 9.49 + 9.50 + <h4>Header Rewriting</h4> 9.51 + <ul> 9.52 + <li><a href="#3_0">3.0: My friends told me that they do not see my 9.53 + full name in their inbox, although it is configured in my mail 9.54 + client.</a></li> 9.55 + </ul> 9.56 + 9.57 + <h4>Delivering Online</h4> 9.58 + <ul> 9.59 + <li><a href="#4_0">4.0: With connection methed <em>file</em>, I get the following message in the log file: "Could not open /tmp/connect_route: Permission denied".</a></li> 9.60 + <li><a href="#4_1">4.1: With connection methed <em>file</em>, I get the following message in the log file: "route with name <em>name</em> not found.".</a></li> 9.61 + </ul> 9.62 + 9.63 + <h4>Bugs</h4> 9.64 + <ul> 9.65 + <li><a href="#5_0">5.0: I found a bug.</a></li> 9.66 + <li><a href="#5_1">5.1: I think I found a bug, but I am not sure whether I configured MasqMail incorrectly.</a></li> 9.67 + </ul> 9.68 + 9.69 + <a name="1_0"> <h4>1.0: When do I need MasqMail?</h4></a> 9.70 + 9.71 + <p> You do not <em>need</em> it. But it makes sending mails via a 9.72 + dialup connection a lot easier.</p> 9.73 + 9.74 + <p>It is useful if you dial to the internet from time to time via a 9.75 + modem and connect to different providers, each one with a different 9.76 + configuration. Other MTAs are not flexible enough if you have to send 9.77 + mails via different mail servers for each provider. With MasqMail you 9.78 + can configure a different one for each provider and even set your 9.79 + return addresses differently.</p> 9.80 + 9.81 + <p>It is also useful if you have a LAN with a gateway which is 9.82 + connected to the internet via a modem because you can rewrite your 9.83 + address depending on whether the recipients are <em>inside</em> or 9.84 + <em>outside</em> your LAN. So responses and delivery failures on your 9.85 + LAN will be sent to you without leaving it, while those outside will 9.86 + be delivered to your address outside. (But it does not yet send 9.87 + delivery failures itself yet.)</p> 9.88 + 9.89 + <p>MasqMail is also often used on notebooks.</p> 9.90 + 9.91 + <a name="1_1"><h4>1.1: When do I <em>not</em> need MasqMail?</h4></a> 9.92 + 9.93 + <p>The use of MasqMail is <em>strongly</em> discouraged if you have a 9.94 + permanent connection to the internet without a firewall. First because 9.95 + it does not have the ability to block relaying (it relays every mail) 9.96 + and second because there are no capabilities to protect against 9.97 + SPAM. You will not take advantages of its features anyway.</p> 9.98 + 9.99 + <a name="1_2"><h4>1.2: Can I retrieve mail with MasqMail?</h4></a> 9.100 + 9.101 + <p>Yes, for version >= 0.1.0 you can retrieve mail via the POP3 and 9.102 + APOP protocol from single drop mailboxes (in case you do not know 9.103 + about single/mutidrop, you probaby use single drop mailboxes).</p> 9.104 + 9.105 + <p>You can also use fetchmail or other pop/imap clients to feed 9.106 + it.</p> 9.107 + 9.108 + <a name="1_3"><h4>1.3: Is there a mailing list for MasqMail?</h4></a> 9.109 + 9.110 + <p>Yes, there is! See <a href="http://www.innominate.org/mailman/listinfo/masqmail">here</a>.</p> 9.111 + 9.112 + <a name="2_0"><h4>2.0: After starting masmail, I get the following 9.113 + message: "could not gain root privileges. Is the setuid bit set?"</h4></a> 9.114 + 9.115 + <p>Set the set-user-id-bit with chmod u+s /usr/sbin/masqmail.</p> 9.116 + 9.117 + <a name="2_1"><h4>2.1: After starting masmail, I get the following 9.118 + message: "bind: (terminating): Address already in use"</h4></a> 9.119 + 9.120 + <p>This means that there is already a process listening on a port, 9.121 + usually 25. You either have another MTA running in background 9.122 + (sendmail, exim, etc...) or another instance of masqmail.</p> 9.123 + 9.124 + <p>It may also mean that the ports you configured MM to listen to 9.125 + (with 'listen_addresses') are on the same IP address, eg. you may have 9.126 + set your hostname to 127.0.0.1 and try to listen on localhost and your 9.127 + host name. In this case either set your hostname to another IP address 9.128 + or delete one of the conflicting entries.</p> 9.129 + 9.130 + <a name="3_0"><h4>3.0: My friends told me that they do not see my full 9.131 + name in their inbox, although it is configured in my mail 9.132 + client.</h4></a> 9.133 + 9.134 + <p>You probably used the <b>map_h_from_addresses</b> feature in the 9.135 + route configuration and forgot to set your real name. The syntax 9.136 + is:</p> 9.137 + 9.138 + <pre> 9.139 +map_h_from_addresses = "charlie:Charlie Miller <cmiller@foo.com>"; 9.140 + </pre> 9.141 + 9.142 + <p>Do not forget the <em>Charlie Miller</em>.</p> 9.143 + 9.144 + <a name="4_0"><h4>4.0: With connection method <em>file</em>, I get the 9.145 + following message in the log file: "Could not open /tmp/connect_route: 9.146 + Permission denied".</h4></a> 9.147 + 9.148 + <p>In your ip-up script, you have to set read permission to the user 9.149 + masqmail runs as. After you write the file with the connection name, 9.150 + set read permission to all with chmod ugo+r <em>file</em>. 9.151 + 9.152 + <a name="4_1"><h4>4.1: With connection methed <em>file</em>, I get the 9.153 + following message in the log file: "route with name <em>name</em> not 9.154 + found.".</h4></a> 9.155 + 9.156 + <p>Check whether the name in the file is really identical to name you 9.157 + gave to the route configuration (case sensitive!). Maybe there is a 9.158 + linefeed after the name in the file. Write it with echo -n.</p> 9.159 + 9.160 + <a name="5_0"><h4>5.0: I found a bug.</h4></a> 9.161 + 9.162 + <p>Make sure you are using the newest version, in case of doubt search 9.163 + it in <a href="http://www.freshmeat.net">freshmeat</a>. If you do, tell 9.164 + <a href = "mailto:Oliver Kurth <kurth@innominate.de>">me</a>. See 9.165 + also the section <a href="index.html#bugs">bugs</a> on the <a 9.166 + href="index.html">main</a> page.</p> 9.167 + 9.168 + <a name="5_1"><h4>5.1: I think I found a bug, but I am not sure 9.169 + whether I configured MasqMail incorrectly.</h4></a> 9.170 + 9.171 + <p>Don't care. Tell <a href = "mailto:Oliver Kurth 9.172 + <kurth@innominate.de>">me</a>. Or write to the <a 9.173 + href="http://www.innominate.org/mailman/listinfo/masqmail">mailing 9.174 + list</a>.</p> 9.175 + 9.176 + </td></tr> 9.177 + 9.178 + <tr><td> 9.179 + <p> 9.180 + <hr> 9.181 + <address><a href = "mailto:kurth@innominate.de">Oliver Kurth</a></address> 9.182 + Last modified: Tue May 30 15:19:56 CEST 2000 9.183 + <br> 9.184 + This page was created using <a href="http://www.freddyfrog.com/hacks/genpage/">Genpage</a> - Version: 1.0.6 9.185 + </p> 9.186 + 9.187 + </table> 9.188 + </center> 9.189 + 9.190 + </BODY> 9.191 +</HEAD> 9.192 +
10.1 --- /dev/null Thu Jan 01 00:00:00 1970 +0000 10.2 +++ b/docs/old-manual/install.html Sat May 29 21:51:13 2010 +0200 10.3 @@ -0,0 +1,219 @@ 10.4 + 10.5 + 10.6 + 10.7 + 10.8 + 10.9 + 10.10 + 10.11 + 10.12 +<HTML> 10.13 +<HEAD> 10.14 +<TITLE>MasqMail - Manual 10.15 +</TITLE> 10.16 +</HEAD> 10.17 + <BODY TEXT="#000000" LINK="#0000ff" BGCOLOR="#ffffff"> 10.18 + 10.19 + <center> 10.20 + <table width="80%"> 10.21 + <tr><td> 10.22 + <table width="100%" bgcolor="#0000aa" cellspacing=0 cellpadding=0> 10.23 +<tr> 10.24 + <td> 10.25 + <a href="manual.html"> 10.26 + <img width="20" src = "../images/u_arrow.gif" alt = "manual"> 10.27 + </a> 10.28 + </td> 10.29 +<td align=center width="100%"><font size="6" color = "#ffffff">Installation</font></td> 10.30 +<td> 10.31 + <a href="./options.html"> 10.32 + <img width="20" src = "../images/r_arrow.gif" alt = "Options"> 10.33 + </a> 10.34 +</td> 10.35 +</tr> 10.36 +</table> 10.37 + 10.38 + 10.39 +<p>You need a user and a group for masqmail to run, I suggest user 10.40 +'mail' and group 'trusted'. Say:</p> 10.41 + 10.42 +<pre> 10.43 +groupadd -g 42 trusted 10.44 +useradd -u 42 -g 42 -d / -s /bin/sh -c "Mail Transfer Agent" mail 10.45 +</pre> 10.46 + 10.47 +<p>If you use other names than <i>mail</i> and <i>trusted</i> use the options 10.48 +described below for configure. The 42 is just a suggestion, you can 10.49 +use any number you like, but preferably one < 100. It does not have 10.50 +to be the same for the user 'mail' and the group 'trusted'.</p> 10.51 + 10.52 +<p>Compliling is a matter of the usual procedure:</p> 10.53 + 10.54 +In the source directory, after unpacking do:<br> 10.55 + 10.56 +<pre> 10.57 +./configure 10.58 +make 10.59 +make install 10.60 +</pre> 10.61 + 10.62 +<p>Optionally, after you have called make, you can make some tests in 10.63 +the tests directory. Read the README in that directory for 10.64 +instructions.</p> 10.65 + 10.66 +<h4>Additional options for configure:</h4> 10.67 + 10.68 +<p> 10.69 +<b>--with-user=USER</b> sets the user as which MasqMail will run. Default is 10.70 +<i>mail</i>. USER has to exist before you 'make install'. 10.71 +</p><p> 10.72 +<b>--with-group=GROUP</b> sets the group as which MasqMail will run. Default 10.73 +is <i>trusted</i>. GROUP has to exist before you 'make install'. 10.74 +</p><p> 10.75 +<b>--with-logdir=LOGDIR</b> sets the directory where MasqMail stores its log 10.76 +files. It will be created if it does not exist. Default is /var/masqmail/. 10.77 +</p><p> 10.78 +<b>--with-spooldir=SPOOLDIR</b> sets the directory where MasqMail stores its 10.79 +spool files. It will be created if it does not exist. Default is 10.80 +/var/spool/masqmail/. 10.81 +</p><p> 10.82 +<b>--enable-auth</b> enables ESMTP AUTH support (disabled by default) 10.83 +</p><p> 10.84 +<b>--disable-pop3</b> disables pop3 support (enabled by default) 10.85 +</p> 10.86 + 10.87 +<h4>After make install</h4> 10.88 + 10.89 +<p> 10.90 +You can also use these instructions to omit 'make install' if you do 10.91 +not want to use it. 10.92 +</p><p> 10.93 +Check that 'make install' worked correctly. The following command: 10.94 +</p><p><pre> 10.95 +ls -ld /usr/sbin/masqmail /var/masqmail/ /var/spool/masqmail /var/spool/masqmail/input 10.96 +</pre></p><p> 10.97 +should give output similar to 10.98 +</p><p> 10.99 +<pre> 10.100 +-rwsr-xr-x 1 root root 86955 Oct 14 14:27 /usr/sbin/masqmail 10.101 +drwxr-xr-x 2 mail trusted 1024 Oct 14 14:29 /var/masqmail/ 10.102 +drwxr-xr-x 3 mail trusted 1024 Oct 14 14:27 /var/spool/masqmail 10.103 +drwxr-xr-x 2 mail trusted 1024 Oct 14 18:32 /var/spool/masqmail/input 10.104 +drwxr-xr-x 2 mail trusted 1024 Oct 14 18:32 /var/spool/masqmail/popuidl 10.105 +</pre> 10.106 +</p> 10.107 +<p> 10.108 +(important is the set-user-id bit for /usr/sbin/masqmail and the 10.109 +ownership of all items). 10.110 +</p> 10.111 + 10.112 +<p>Edit the configuration files. You can use the files from the 10.113 +examples directory as a template. Copy masqmail.conf to 10.114 +/etc/maqmail.conf, the others to the location given in 10.115 +masqmail.conf.</p> 10.116 + 10.117 +<p>If you already have an MTA (eg. sendmail) installed, move that to 10.118 +another location:</p> 10.119 + 10.120 +mv /usr/sbin/sendmail /usr/sbin/sendmail.orig<br> 10.121 + 10.122 +<p>Then make a link to the new MTA:</p> 10.123 + 10.124 +<pre> 10.125 +ln -s /usr/sbin/masqmail /usr/sbin/sendmail 10.126 +</pre> 10.127 + 10.128 +<p>Now every mailer that used to call sendmail will now call 10.129 +masqmail. You can now kill your old sendmail if it is running and 10.130 +start masqmail. Usually this is done with the startup scripts. For 10.131 +SuSE this would be (as root):</p> 10.132 + 10.133 +<pre> 10.134 +/sbin/init.d/sendmail stop 10.135 +/sbin/init.d/sendmail start 10.136 +</pre> 10.137 + 10.138 +<p>or shorter:</p> 10.139 + 10.140 +<pre> 10.141 +/sbin/init.d/sendmail restart<br> 10.142 +</pre> 10.143 + 10.144 +<p>You can also start it with:</p> 10.145 + 10.146 +<pre> 10.147 +/usr/sbin/sendmail -bd -q30m<br> 10.148 +</pre> 10.149 + 10.150 +<p>You can also let it be called from inetd (with the -bs option), but 10.151 +this is untested.</p> 10.152 + 10.153 +<h4>Configuring for online delivery</h4> 10.154 + 10.155 +<p>Now you have to set up the online configuration. The trick is to 10.156 +tell your ip-up script the connection name. You could use the IP 10.157 +number of the far side of the ppp link, but this is a pain and may 10.158 +change each time. But you can give it an additional argument via pppd 10.159 +with ipparam. Somewhere in your dial up script you have a line similar 10.160 +to:</p> 10.161 + 10.162 +<pre> 10.163 +/usr/sbin/pppd /dev/ttyS1 connect "/usr/sbin/chat -t 90 -f 10.164 +${CHATFILE}" -d -d -d user user@somewhere file ${OPTIONS} 10.165 +</pre> 10.166 + 10.167 +<p>Just add 'ipparam FastNet' in the command line for pppd if your ISP 10.168 +has the name FastNet. The ip-up script will then get 'FastNet' as a 10.169 +sixth parameter. In your ip-up script you can then call masqmail with</p> 10.170 + 10.171 +<pre> 10.172 +/usr/sbin/masqmail -qo $6 10.173 +</pre> 10.174 + 10.175 +<p>instead of 'sendmail -q', if you had that in the script 10.176 +before. Masqmail will then read the route configuration specified for 10.177 +the connection name 'FastNet' and deliver the mail destined to the 10.178 +internet. See the <a href="config.html">configuration manual</a> on how 10.179 +to write a route configuration or use one of the examples as a 10.180 +template. <em>I do not know how do configure that for an ISDN adapter, 10.181 +but I am sure you will find something similar in the man 10.182 +pages.</em></p> 10.183 + 10.184 +<p>If you want mail that is received by masqmail from your local 10.185 +net to be delivered immediately using the route configuration, you 10.186 +have two possibilities:<p> 10.187 + 10.188 +<p> 10.189 +<ul> 10.190 + 10.191 +<li>if you are using the masqdialer system, you just have to set the 10.192 +variables <b>online_detect</b> to <i>mserver</i> and 10.193 +<b>mserver_iface</b> to the interface mserver is listening to.</li> 10.194 + 10.195 +<li>otherwise you have to add two commands in your ip-up script:<br> 10.196 +echo -n $6 > /tmp/connect_route<br> chmod 644 /tmp/connect_route<br> 10.197 +and you have to remove the file <i>/tmp/connect_route</i> in your 10.198 +ip-down script:<br> rm /tmp/connect_route.<br> Then you have to set 10.199 +<b>online_detect</b> to <i>file</i> and <b>online_file</b> to 10.200 +<i>/tmp/connect_route</i>. </li> 10.201 + 10.202 +</ul> 10.203 +</p> 10.204 + 10.205 +<p>See the route documentation for more.</p> 10.206 + </td></tr> 10.207 + 10.208 + <tr><td> 10.209 + <p> 10.210 + <hr> 10.211 + <address><a href = "mailto:kurth@innominate.de">Oliver Kurth</a></address> 10.212 + Last modified: Tue May 30 15:19:56 CEST 2000 10.213 + <br> 10.214 + This page was created using <a href="http://www.freddyfrog.com/hacks/genpage/">Genpage</a> - Version: 1.0.6 10.215 + </p> 10.216 + 10.217 + </table> 10.218 + </center> 10.219 + 10.220 + </BODY> 10.221 +</HEAD> 10.222 +
11.1 --- /dev/null Thu Jan 01 00:00:00 1970 +0000 11.2 +++ b/docs/old-manual/manual.html Sat May 29 21:51:13 2010 +0200 11.3 @@ -0,0 +1,45 @@ 11.4 +<HTML> 11.5 + <HEAD> 11.6 + <TITLE>MasqMail - Manual 11.7 + </TITLE> 11.8 + </HEAD> 11.9 + <BODY TEXT="#000000" LINK="#0000ff" BGCOLOR="#ffffff"> 11.10 + 11.11 + <center> 11.12 + <table width="80%"> 11.13 + <tr><td> 11.14 + <table width="100%" bgcolor="#0000aa" cellspacing=0 cellpadding=0> 11.15 + <tr> 11.16 + <td> 11.17 + <a href="index.html"> 11.18 + <img width="20" src = "../images/u_arrow.gif" alt = "index"> 11.19 + </a> 11.20 + </td> 11.21 + <td align=center width="100%"><font size="6" color = "#ffffff">Manual</font></td> 11.22 + </tr> 11.23 + </table> 11.24 + 11.25 + 11.26 + <a href = "install.html">Installation</a><br> 11.27 + <a href = "faq.html">Frequently Asked Questions</a><br> 11.28 + <br> 11.29 + <a href = "docs/masqmail.8.html">Command line options</a><br> 11.30 + <a href = "docs/masqmail.conf.5.html">Configuration</a><br> 11.31 + <a href = "docs/masqmail.route.5.html">Routes</a><br> 11.32 + <a href = "docs/masqmail.aliases.5.html">Alias File Format</a><br> 11.33 + <a href = "docs/masqmail.get.5.html">Mail Get Configuration</a><br> 11.34 + </td></tr> 11.35 + 11.36 + <tr><td> 11.37 + <p> 11.38 + <hr> 11.39 + <address><a href = "mailto:oku@masqmail.cx">Oliver Kurth</a></address> 11.40 + Last modified: Fri, 28 Jul 2000 09:13:20 +0200 11.41 + </p> 11.42 + 11.43 + </table> 11.44 + </center> 11.45 + 11.46 + </BODY> 11.47 +</HEAD> 11.48 +
12.1 --- /dev/null Thu Jan 01 00:00:00 1970 +0000 12.2 +++ b/docs/old-manual/options.html Sat May 29 21:51:13 2010 +0200 12.3 @@ -0,0 +1,181 @@ 12.4 + 12.5 + 12.6 + 12.7 + 12.8 + 12.9 + 12.10 + 12.11 + 12.12 +<HTML> 12.13 +<HEAD> 12.14 +<TITLE>MasqMail - Manual 12.15 +</TITLE> 12.16 +</HEAD> 12.17 + <BODY TEXT="#000000" LINK="#0000ff" BGCOLOR="#ffffff"> 12.18 + 12.19 + <center> 12.20 + <table width="80%"> 12.21 + <tr><td> 12.22 + <table width="100%" bgcolor="#0000aa" cellspacing=0 cellpadding=0> 12.23 +<tr> 12.24 + <td> 12.25 + <a href="manual.html"> 12.26 + <img width="20" src = "../images/u_arrow.gif" alt = "manual"> 12.27 + </a> 12.28 + </td> 12.29 +<td align=center width="100%"><font size="6" color = "#ffffff">Options</font></td> 12.30 +<td> 12.31 + <a href="./install.html"> 12.32 + <img width="20" src = "../images/l_arrow.gif" alt = "Installation"> 12.33 + </a> 12.34 +</td> 12.35 +<td> 12.36 + <a href="./alias.html"> 12.37 + <img width="20" src = "../images/r_arrow.gif" alt = "Alias Format"> 12.38 + </a> 12.39 +</td> 12.40 +</tr> 12.41 +</table> 12.42 + 12.43 + 12.44 +<p>Since masqmail is intended to replace sendmail, it uses the same 12.45 +command line options, but not all are implemented. There are also two 12.46 +additional options, which are unique to masqmail (-qo 12.47 +<connection> and -g) </p> 12.48 + 12.49 +<b>-- </b>option:<br> 12.50 + 12.51 +<p>Not a 'real' option, it means that all following arguments are to 12.52 +be understood as arguments and not as options even if they begin with a 12.53 +leading dash '-'. Mutt is known to call sendmail with this option.</p> 12.54 + 12.55 +<b>-bd </b>option (daemon):<br> 12.56 + 12.57 +<p>Run as daemon, accepting connections, usually on port 25 if not 12.58 +configured differently. This is usually used in the startup script and 12.59 +together with the -q option (see below).</p> 12.60 + 12.61 +<b>-bi </b>option:<br> 12.62 + 12.63 +<p>Old sendmail rebuilds its alias database when invoked with this 12.64 +option. Masqmail ignores it. Masqmail reads directly from the file 12.65 +given with <b>alias_file</b> in the config file.</p> 12.66 + 12.67 +<b>-bp </b>option:<br> 12.68 + 12.69 +<p>Show the messages in the queue. Same as calling masqmail as 12.70 +'mailq'.</p> 12.71 + 12.72 +<b>-bs </b>option:<br> 12.73 + 12.74 +<p>Accept SMTP commands from stdin. Some mailers (eg pine) use this 12.75 +option as an interface. It can also be used to call masqmail from 12.76 +inetd, according to Tomislav Filipcic this works.</p> 12.77 + 12.78 +<b>-B<arg></b>option:<br> 12.79 + 12.80 +<p>arg is usually 8BITMIME. Some mailers use this to indicate that the 12.81 +message contains characters > 127. Masqmail is 8-bit clean and 12.82 +ignores this, so you do not have to recompile elm, which is very 12.83 +painful ;-). Note though that this violates some conventions: masqmail 12.84 +<em>does not</em> convert 8 bit messages to any MIME format if it 12.85 +encounters a mail server which does not advertise its 8BITMIME capability, 12.86 +masqmail does not advertise this itself. This is the same practice as 12.87 +that of exim (but different to sendmail).</p> 12.88 + 12.89 +<p>This <em>may</em> change in the future, but do not rely on it.</p> 12.90 + 12.91 +<b>-C<filename></b>option:<br> 12.92 + 12.93 +<p>Use another configuration than /etc/masqmail.conf. Useful for 12.94 +debugging purposes.</p> 12.95 + 12.96 +<b>-d <number> </b>option:<br> 12.97 + 12.98 +<p>Set the debug level. This takes precedence before the value of 12.99 +<b>debug_level</b> in the configuration file. Read the warning in the 12.100 +description of the latter.</p> 12.101 + 12.102 +<b>-g </b>option:<br> 12.103 + 12.104 +<p>Get mail, using the configurations given with 12.105 +<b>get.<name></b> in the main configuration.</p> 12.106 + 12.107 +<b>-i </b>option:<br> 12.108 + 12.109 +<p>Same as <b>-oi</b>, see below.</p> 12.110 + 12.111 +<b>-oem </b>option:<br> 12.112 + 12.113 +<p>If the <b>-oi</b> ist not also given, always return with a non zero 12.114 +return code. Maybe someone tells me what this is good for... </p> 12.115 + 12.116 +<b>-odb </b>option:<br> 12.117 + 12.118 +<p>Deliver in background. Masqmail always does this.</p> 12.119 + 12.120 +<b>-odq </b>option:<br> 12.121 + 12.122 +<p>Do not attempt to deliver immediately. Any messages will be queued 12.123 +until the next queue running process picks them up and delivers 12.124 +them. You get the same effect by setting the <i>do_queue</i> option in 12.125 +/etc/masqmail.conf.</p> 12.126 + 12.127 +<b>-oi </b>option:<br> 12.128 + 12.129 +<p>A dot as a single character in a line does <em>not</em> terminate 12.130 +the message.</p> 12.131 + 12.132 +<b>-q </b>option:<br> 12.133 + 12.134 +<p>If not given with an argument, run a queue process, ie. try to 12.135 +deliver all messages in the queue. Masqmail sends only to those 12.136 +addresses that are on the <em>local</em> net, not to those that are 12.137 +outside. Use -qo <connection> for those.</p> 12.138 + 12.139 +<p>If you have configured inetd to start masqmail, you can use this 12.140 +option in a cron job which starts in regular time intervals, to mimic 12.141 +the same effect as starting masqmail with -bd -q30m.</p> 12.142 + 12.143 +<p>An argument may be a time interval ie. a numerical value followed 12.144 +by one of the letters. s,m,h,d,w which are interpreted as seconds, 12.145 +minutes, hours, days or weeks respectively. Example: -q30m. Masqmail 12.146 +starts as a daemon and a queue runner process will be started 12.147 +automatically once in this time interval. This is usually used 12.148 +together with -bd (see above).</p> 12.149 + 12.150 +<b>-qo<name> </b>option:<br> 12.151 + 12.152 +<p>Can be followed by a connection name. Use this option in your 12.153 +script which starts as soon as a link to the internet has been set up 12.154 +(usually ip-up). When masqmail is called with this option, the 12.155 +specified route configuration is read and the queued mail with 12.156 +destinations on the internet will be sent. The <b>name</b> is defined 12.157 +in the configuration (see <b>connect_route.<name></b>).</p> 12.158 + 12.159 +<p>If called without <name>, the online status is determined with 12.160 +the configured method (see <b>online_detect</b> in <a 12.161 +href="config.html">config.html</a>)</p> 12.162 + 12.163 +<b>-t </b>option:<br> 12.164 + 12.165 +<p>Read recipients from headers. Delete 'Bcc:' headers. If any 12.166 +arguments are given, these are interpreted as recipient addresses and 12.167 +the message will <em>not</em> be sent to these.</p> 12.168 + </td></tr> 12.169 + 12.170 + <tr><td> 12.171 + <p> 12.172 + <hr> 12.173 + <address><a href = "mailto:kurth@innominate.de">Oliver Kurth</a></address> 12.174 + Last modified: Tue May 30 15:19:56 CEST 2000 12.175 + <br> 12.176 + This page was created using <a href="http://www.freddyfrog.com/hacks/genpage/">Genpage</a> - Version: 1.0.6 12.177 + </p> 12.178 + 12.179 + </table> 12.180 + </center> 12.181 + 12.182 + </BODY> 12.183 +</HEAD> 12.184 +