Mercurial > 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 wrap: on
line diff
--- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/docs/old-manual/README Sat May 29 21:51:13 2010 +0200 @@ -0,0 +1,10 @@ +This is the old manual by oku, dated May/July 2000. At this time the +development must just have started with the 0.1 versions. + +Many things are still the same as then, but there are things that +changed. Please keep this in mind when you read the manual. + +Start reading at manual.html. + + +meillo
--- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/docs/old-manual/alias.html Sat May 29 21:51:13 2010 +0200 @@ -0,0 +1,84 @@ + + + + + + + + +<HTML> +<HEAD> +<TITLE>MasqMail - Manual +</TITLE> +</HEAD> + <BODY TEXT="#000000" LINK="#0000ff" BGCOLOR="#ffffff"> + + <center> + <table width="80%"> + <tr><td> + <table width="100%" bgcolor="#0000aa" cellspacing=0 cellpadding=0> +<tr> + <td> + <a href="manual.html"> + <img width="20" src = "../images/u_arrow.gif" alt = "manual"> + </a> + </td> +<td align=center width="100%"><font size="6" color = "#ffffff">Alias Format</font></td> +<td> + <a href="./options.html"> + <img width="20" src = "../images/l_arrow.gif" alt = "Options"> + </a> +</td> +<td> + <a href="./config.html"> + <img width="20" src = "../images/r_arrow.gif" alt = "Configuration"> + </a> +</td> +</tr> +</table> + + +<p>The alias file consists of lines of the form:</p> +<pre> +local_part: item1, item2, ... +</pre> + +<p>Items can be surrounded by quotes '"'. If within the quotes other +quotes are needed for an address they can be escaped with a leading +backslash '\'.</p> + +<p>A leading '\' indicates that this address shall not be further +expanded.</p> + +<p>A leading pipe symbol '|' indicates that the item shall be treated +as a pipe command. The content of the message will then be sent to the +standard input of a command. The command will run under the user id +and group id masqmail is running as. If quotes are needed, the pipe +symbol must appear <i>within</i> the quotes.</p> + +<p>Loops will be detected, the offending address will be ignored.</p> + +<p>Aliases will be expanded at <i>delivery</i> time. This means that +if there is a message still in the queue and you change any alias +which matches one of the recipient addresses, the change will have +effect next time a delivery is attemped.</p> + +<p>There is no need to restart masqmail or run any command when the +alias file has been changed.</p> + </td></tr> + + <tr><td> + <p> + <hr> + <address><a href = "mailto:kurth@innominate.de">Oliver Kurth</a></address> + Last modified: Tue May 30 15:19:57 CEST 2000 + <br> + This page was created using <a href="http://www.freddyfrog.com/hacks/genpage/">Genpage</a> - Version: 1.0.6 + </p> + + </table> + </center> + + </BODY> +</HEAD> +
--- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/docs/old-manual/config.html Sat May 29 21:51:13 2010 +0200 @@ -0,0 +1,385 @@ + + + + + + + + +<HTML> +<HEAD> +<TITLE>MasqMail - Manual +</TITLE> +</HEAD> + <BODY TEXT="#000000" LINK="#0000ff" BGCOLOR="#ffffff"> + + <center> + <table width="80%"> + <tr><td> + <table width="100%" bgcolor="#0000aa" cellspacing=0 cellpadding=0> +<tr> + <td> + <a href="manual.html"> + <img width="20" src = "../images/u_arrow.gif" alt = "manual"> + </a> + </td> +<td align=center width="100%"><font size="6" color = "#ffffff">Configuration</font></td> +<td> + <a href="./alias.html"> + <img width="20" src = "../images/l_arrow.gif" alt = "Alias Format"> + </a> +</td> +<td> + <a href="./faq.html"> + <img width="20" src = "../images/r_arrow.gif" alt = "Frequently Asked Questions"> + </a> +</td> +</tr> +</table> + + +<p>The configuration consists of lines of the form</p> + +<i>val</i> = <i>expression</i> + +<p>Where <i>val</i> is a variable name and <i>expression</i> a string, +which can be quoted with '"'. If the expression is on multiple lines +or contains characters other than letters, digits or the charcaters +'.', '-', '_', '/', it <em>must</em> be quoted. Unfortunately, you +cannot use quotes inside quotes. (Will be implemented in a later +version.)</p> + +<p>Each val has a <i>type</i>, which can be boolean, numeric, string +or list. A boolean variable can be set with one of the values 'on', +'yes', and 'true' or 'off', 'no' and 'false'. List items are separated +with ';'. For some values patterns (like '*','?') can be used. The +spaces before and after the '=' are optional.</p> + +<p>Most lists (exceptions: local_hosts, local_nets and +listen_addresses) accept files. These will be recognized by a leading +slash '/'. The contents of these files will be included at the +position of the file name, there can be items or other files before +and after the file entry. The format of the files is different +though, within these files each entry is on another line. (And not +separated by semicolons). This makes it easy to include large lists +which are common in different configuration files, so they do not have +to appear in every configuration file.</p> + +<p>Blank lines and lines starting with '#' are ignored.</p> + +<h4><font color = "#ff0000">Main Configuration</font></h4> + +<b>run_as_user</b>, Type: <i>boolean</i>, default: <i>false</i> + +<p>If this is set, masqmail runs with the user id of the user who +invoked it and never changes it. This is for debugging purposes +<em>only</em>. If the user is not root, masqmail will not be able to +listen on a port < 1000 and will not be able to deliver local mail +to others than the user.</p> + +<b>use_syslog</b>, Type: <i>boolean</i>, default: <i>false</i> + +<p>If this is set, masqmail uses syslogd for logging. It uses facility +<i>MAIL</i>. You still have to set <b>log_dir</b> for debug files.</p> + +<b>debug_level</b>, Type: <i>numeric</i>, default: <i>0</i> + +<p>Set the debug level. Valid values are 0 to 6, increasing it further +makes no difference. Be careful if you set this as high as 5 or higher, +the logs may very soon fill your hard drive.</p> + +<b>mail_dir</b>, Type: <i>string</i>, default: <i>none</i> + +<p>The directory where local mail is stored, usually /var/spool/mail.</p> + +<b>spool_dir</b>, Type: <i>string</i>, default: <i>none</i> + +<p>The directory where masqmail stores its spool files (and later also +other stuff). It <em>must</em> have a subdirectory +<i>input</i>. Masqmail needs read and write permissions for this +directory. I suggest to use /var/spool/masqmail.</p> + +<b>log_dir</b>, Type: <i>string</i>, default: <i>none</i> + +<p>The directory where masqmail puts its log files, these are +<i>masqmail.log</i> and <i>debug.log</i>. Masqmail needs write +permission.</p> + +<b>host_name</b>, Type: <i>string</i>, default: <i>none</i> + +<p>This is used in different places: Masqmail identifies itself in the +greeting banner on incoming connections and in the HELO/EHLO command +for outgoing connections with this name, it is used in the Received: +header and to qualify the sender of a locally originating message.</p> + +<p>It is <em>not</em> used to find whether an address is local. Use +<b>local_hosts</b> for that.</p> + +<b>local_hosts</b>, Type: <i>list</i>, default: <i>none</i> + +<p>A semicolon ';' separated list of hostnames which are considered +local. Normally you set it to "localhost;foo;foo.bar.com" if your host +has the fully qualified domain name 'foo.bar.com'.</p> + +<b>local_nets</b>, Type: <i>list</i>, default: <i>none</i> + +<p>A semicolon ';' separated list of hostnames which are on the +'local' net. Delivery to these hosts is attempted immediately. You can +use patterns with '*', eg. "*.bar.com".</p> + +<b>listen_addresses</b>, Type: <i>list</i>, default: <i>none</i> + +<p>A semicolon ';' separated list of interfaces on which connections +will be accepted. An interface ist defined by a hostname, optionally +followed by a colon ':' and a number for the port. If this is left out, +port 25 will be used.</p> + +<p>You can set this to "localhost:25;foo:25" if your hostname is 'foo'.</p> + +<b>do_queue</b>, Type: <i>boolean</i>, default: <i>false</i> + +<p>If this is set, mail will not be delivered immediately when +accepted. Same as calling masqmail with the -odq option.</p> + +<b>connect_route.<name></b>, Type: <i>string</i>, default: <i>none</i> + +<p>Replace <name> with a name to identify a connection. Set this +to a filename for the special <i>route</i> configuration for that +connection. You will use that name to call masqmail with the -qo option +every time a connection to your ISP is set up.</p> + +<p>Example: Your ISP has the name <i>FastNet</i>. Then you write the +following line in the main configuration:</p> + +<p><pre>connect_route.FastNet = "/etc/masqmail/fastnet.route"</pre></p> + +<p>/etc/masqmail/fastnet.route is the route configuration file, see +below. As soon as a link to FastNet has been set up, you call masqmail +-qoFastNet. Masqmail will then read the specified file and send the +mails.</p> + +<b>local_net_route</b>, Type: <i>string</i>, default: <i>none</i> + +<p>This is similar to <b>connect_route.<name></b> but for the +local net. Recipient addresses that are in <b>local_nets</b> will be +routed using this route configuration. Main purpose is to define a +mail server with <b>mail_host</b> in your local network. In simple +environments this can be left unset. If unset, a default route +configuration will be used.</p> + +<b>alias_file</b> + +<p>Set this to the location of your alias file. If unset, no aliasing +will be done.</p> + +<b>online_detect</b>, Type: <i>string</i>, default: <i>none</i> + +<p>Defines the method MasqMail uses to detect whether there is +currently an online connection. It can have the values <em>file</em> +or <em>mserver</em>.</p> + +<p>When it is set to <em>file</em>, MasqMail first checks for the +existence of <b>online_file</b> (see below) and if it exists, it reads +it. The content of the file should be the name of the current +connection as defined with <b>connect_route.<name></b> (without +a trailing newline character).</p> + +<p>When it is set to <em>mserver</em>, MasqMail connects to the +masqdialer server using the value of <b>mserver_iface</b> and asks it +whether a connection exists and for the name, which should be the name +of the current connection as defined with +<b>connect_route.<name></b>.</p> + +<p>The online status is checked either when masqmail receives a mail +with an address outside your LAN or when called with the -qo option +(without arguments).</p> + +<b>online_file</b>, Type: <i>string</i>, default: <i>none</i> + +<p>This is the name of the file checked for when MasqMail determines +whether it is online. The file should only exist when there is +currently a connection. Create it in your ip-up script with eg.</p> + +<p><pre> +echo -n <name> > /tmp/connect_route +chmod 0644 /tmp/connect_route +</pre></p> + +<p>Do not forget to delete it in your ip-down script.</p> + +<b>mserver_iface</b>, Type: <i>string</i>, default: <i>none</i> + +<p>The interface the masqdialer server is listening to. Usually this +will be "localhost:224" if mserver is running on the same host as +masqmail. But using this option, you can also let masqmail run on +another host by setting mserver_iface to another hostname, +eg. "foo:224".</p> + +<b>get.<name></b>, Type: <i>string</i>, default: <i>none</i> + +<p>Replace <name> with a name to identify a <i>get</i> +configuration. Set this to a filename for the <i>get</i> +configuration. These files will be used to retrieve mail when called +with the -g option.</p> + +<h4><font color = "#ff0000">Route Configuration</font></h4> + +<b>mail_host</b>, Type: <i>string</i>, default: <i>none</i> + +<p>This is preferably the mail server of your ISP. All outgoing +messages will be sent to this host which will distribute them to their +destinations. If you do not set this mails will be sent +directly. Because the mail server is probably 'near' to you, mail +transfer will be much faster if you use it.</p> + +<b>do_correct_helo</b>, Type: <i>boolean</i>, default: <i>false</i> + +<p>If this is set, masqmail tries to look up your host name as it +appears on the internet and sends this in the HELO/EHLO command. Some +servers are so picky that they want this. <em>Which is really +crazy. It just does not make any sense to lie about ones own identity, +because it can always be looked up by the server. Nobody should +believe in the name given by HELO/EHLO anyway.</em> If this is not +set, <b>host_name</b> will be used.</p> + +<b>allowed_mail_locals</b>, Type: <i>list</i>, default: <i>none(all)</i> + +<p>This is a semicolon ';' separated list of local parts which will be +allowed to send mail through this connection. If unset and +<b>not_allowed_mail_locals</b> is also unset, all users are +allowed.</p> + +<b>not_allowed_mail_locals</b>, Type: <i>list</i>, default: <i>none</i> + +<p>This is a semicolon ';' separated list of local parts which will be +<em>not</em> allowed to send mail through this connection. <em>Local +parts in this list will not be allowed to use this route even if they +are part of <b>allowed_mail_locals</b> (see above).</em></p> + +<b>allowed_rcpt_domains</b>, Type: <i>list</i>, default: <i>none(all)</i> + +<p>A list of recipient domains where mail will be sent to. This is for +example useful if you use this route configuration when connected to +another LAN via ppp. Patterns containing '?' and '*' can be used.</p> + +<b>not_allowed_rcpt_domains</b>, Type: <i>list</i>, default: <i>none</i> + +<p>A list of recipient domains where mail will <em>not</em> be sent +to. This is for example useful if you send mail directly (mail_host +ist not set) and you know of hosts that will not accept mail from you +because they use a dialup list (eg. <a +href="http://maps.vix.com/dul/"> maps.vix.com/dul/</a>). If any domain +matches <em>both</em> <b>allowed_rcpt_domains</b> and +<b>not_allowed_rcpt_domains</b>, mail will <em>not</em> be sent to +this domain. Patterns containing '?' and '*' can be used.</p> + +<b>set_h_from_domain</b>, Type: <i>string</i>, default: <i>none</i> + +<p>Replace the domain part in 'From:' headers with this value. This +may be useful if you use a private, outside unknown address on your +local LAN and want this to be replaced by the domain of the address of +your email addrsss on the internet. <em>Note that this is different to +<b>set_return_path_domain</b>, see below.</em></p> + +<b>set_h_reply_to_domain</b>, Type: <i>string</i>, default: <i>none</i> + +<p>Same as <b>set_h_from_domain</b>, but for the 'Reply-To' header.</p> + +<b>set_return_path_domain</b>, Type: <i>string</i>, default: <i>none</i> + +<p>Sets the domain part of the envelope from address. Some hosts check +whether this is the same as the net the connection is coming from. If +not, they reject the mail because they suspect spamming. It should be +a <em>valid</em> address, because some mail servers also check +that. You can also use this to set it to your usual address on the +internet and put a local address only known on your LAN in the +configuration of your mailer. <em>Only the <em>domain</em> part will +be changed, the local part remains unchanged. Use +<b>map_return_path_addresses</b> for rewriting local parts</em>.</p> + +<b>map_h_from_addresses</b>, Type: <i>list</i>, default: <i>none</i> + +<p>This is similar to <b>set_h_from_domain</b>, but more flexible. Set +this to a list which maps local parts to a full RFC 822 compliant +email address, the local parts (the <em>keys</em>) are separated from +the addresses (the <em>values</em>) by colons (':').</p> + +<p>Example:</p> + +<p><pre> +map_h_from_addresses = +"john: John Smith <jsmith@mail.academic.edu>; +charlie: Charlie Miller <cmiller@mx.commercial.com>" +</pre></p> + +<b>map_h_reply_to_addresses</b>, Type: <i>list</i>, default: <i>none</i> + +<p>Same as <b>map_h_from_addresses</b>, but for the 'Reply-To:' header.</p> + +<b>map_return_path_addresses</b>, Type: <i>list</i>, default: <i>none</i> + +<p>This is similar to <b>set_return_path_domain</b>, but more +flexible. Set this to a list which maps local parts to a full RFC 821 +compliant email address, the local parts (the <em>keys</em>) are +separated from the addresses (the <em>values</em>) by colons +(':'). Note that this option takes <em>RFC 821</em> addresses +while <b>map_h_from_addresses</b> takes <em>RFC 822</em> addresses. The +most important difference is that RFC 821 addresses have no full +name.</p> + +<p>Example:</p> +<p><pre> +map_return_path_addresses = +"john: <jsmith@mail.academic.edu>; +charlie: <cmiller@mx.commercial.com>" +</pre></p> + +<b>expand_h_sender_domain</b>, Type: <i>boolean</i>, default: <i>true</i> + +<p>This sets the domain of the sender address as given by the Sender: +header to the same domain as in the envelope return path address +(which can be set by either <b>set_return_path_domain</b> or +<b>map_return_path_addresses</b>). This is for mail clients +(eg. Microsoft Outlook) which use this address as the sender +address. <em>Though they should use the From: address, see RFC +821. </em>If <i>fetchmail</i> encounters an unqualified Sender: +address, it will be expanded to the domain of the pop server, which is +almost never correct. </p> + +<b>auth_name</b>, Type: <i>string</i>, default: <i>none</i> + +<p>Set the authentication type for ESMTP AUTH authentification. +Currently only 'cram-md5' is supported.</p> + +<b>auth_login</b>, Type: <i>string</i>, default: <i>none</i> + +<p>Your account name for ESMTP AUTH authentification.</p> + +<b>auth_secret</b>, Type: <i>string</i>, default: <i>none</i> + +<p>Your secret for ESMTP AUTH authentification.</p> + +<b>pop_login</b>, Type: <i>string</i>, default: <i>none</i> + +<p>If your Mail server requires SMTP-after-POP, set this to a +<i>get</i> configuration. If you login to the POP server +<em>before</em> you send, this is not necessary. See the <a href = +"get.html"</a>get configuration</a> for more information.</p> + + </td></tr> + + <tr><td> + <p> + <hr> + <address><a href = "mailto:kurth@innominate.de">Oliver Kurth</a></address> + Last modified: Tue May 30 15:19:56 CEST 2000 + <br> + This page was created using <a href="http://www.freddyfrog.com/hacks/genpage/">Genpage</a> - Version: 1.0.6 + </p> + + </table> + </center> + + </BODY> +</HEAD> +
--- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/docs/old-manual/docs/masqmail.8.html Sat May 29 21:51:13 2010 +0200 @@ -0,0 +1,327 @@ +<body text="#000000" link="#0000ff" bgcolor="#ffffff"><center><table width="80%"> +<tr><td><h1>masqmail</h1> +<h2>An offline Mail Transfer Agent</h2> + + +<h2>Synopsis</h2> +<b> +/usr/sbin/masqmail [-C <em>file</em>] [-odq] [-bd] [-q<em>interval</em>]<br> + +/usr/sbin/masqmail [-odq] [-bs]<br> + +/usr/sbin/masqmail [-bp]<br> + +/usr/sbin/masqmail [-q]<br> + +/usr/sbin/masqmail [-qo [<em>name</em>]]<br> + +/usr/sbin/masqmail [-odq] [-g [<em>name</em>]]<br> + +/usr/sbin/masqmail [-odq] [-go [<em>name</em>]]<br> + +/usr/sbin/masqmail [-t] [-oi] [-f <em>address</em>] [--] <em>address...</em><br> + +/usr/sbin/mailq<br> + +</b> + + +<h2>Description</h2> + +<p>MasqMail is a mail server designed for hosts that do +not have a permanent internet connection eg. a home network or a +single host at home. It has special support for connections to +different ISPs. It replaces sendmail or other MTAs such as qmail or +exim. It can also act as a pop3 client.</p> + + + +<h2>Options</h2> + +<p>Since masqmail is intended to replace sendmail, it uses the same +command line options, but not all are implemented. There are also two +additional options, which are unique to masqmail (-qo <em>connection</em> and -g) +</p> + + +<p><b>--</b></p> +<p>Not a 'real' option, it means that all following arguments are to +be understood as arguments and not as options even if they begin with a +leading dash '-'. Mutt is known to call sendmail with this option.</p> + + + +<p><b>-bd</b></p> +<p>Run as daemon, accepting connections, usually on port 25 if not +configured differently. This is usually used in the startup script at system boot and +together with the -q option (see below).</p> + + + +<p><b>-bi</b></p> +<p>Old sendmail rebuilds its alias database when invoked with this +option. Masqmail ignores it. Masqmail reads directly from the file +given with alias_file in the config file.</p> + + + +<p><b>-bp</b></p> +<p>Show the messages in the queue. Same as calling masqmail as +'mailq'.</p> + + + +<p><b>-bs</b></p> +<p>Accept SMTP commands from stdin. Some mailers (eg pine) use this +option as an interface. It can also be used to call masqmail from +inetd.</p> + + + +<p><b>-B <em>arg</em></b></p> +<p><em>arg</em> is usually 8BITMIME. Some mailers use this +to indicate that the message contains characters > 127. Masqmail is +8-bit clean and ignores this, so you do not have to recompile elm, +which is very painful ;-). Note though that this violates some +conventions: masqmail does not convert 8 bit messages to any +MIME format if it encounters a mail server which does not advertise +its 8BITMIME capability, masqmail does not advertise this itself. This +is the same practice as that of exim (but different to +sendmail).</p> + + +<p><b>-bV </b></p> +<p>Show version information.</p> + + + + +<p><b>-C </b><em>filename</em></p> +<p>Use another configuration than <em>/etc/masqmail/masqmail.conf</em>. Useful for +debugging purposes. If not invoked by a privileged user, masqmail will drop all privileges. +</p> + + + +<p><b>-d <em>number</em></b></p> + +<p>Set the debug level. This takes precedence before the value of +debug_level in the configuration file. Read the warning in the +description of the latter. +</p> + + + + +<p><b>-f [<em>address</em>]</b></p> + +<p>Set the return path address to <em>address</em>. Only root, the +user mail and anyoune in group trusted is allowed to do that.</p> + + + + +<p><b>-F [<em>string</em>]</b></p> + +<p>Set the full sender name (in the From: header) +to <em>string</em>.</p> + + + + +<p><b>-g [<em>name</em>]</b></p> + +<p>Get mail (using pop3 or apop), using the configurations given +with get.<em>name</em> in the main configuration. Without <em>name</em>, +all get configurations will be used. See also <a href="masqmail.get.5.html">masqmail.get</a></p> + + + + +<p><b>-go [<em>interval</em>] [<em>name</em>]</b></p> + +<p>Can be followed by a connection name. Use this option in your +script which starts as soon as a link to the internet has been set up +(usually ip-up). When masqmail is called with this option, the +specified get configuration(s) is(are) read and mail will be +retrieved from servers on the internet. +The <em>name</em> is defined +in the configuration (see <b>online_gets.<em>name</em></b>). +</p><p> +If called with an interval option (recognized by a digit +as the first characater), masqmail starts as a daemon and tries to +get mail in these intervals. It checks for the online status first. +Example: masqmail -go 5m will retrieve mail +all five minutes. +</p><p> +If called without <em>name</em> the online status is determined with +the configured method (see <b>online_detect</b> in config.html). +</p> + + + + +<p><b>-i</b></p> +<p>Same as -oi, see below.</p> + + + +<p><b>-Mrm <em>list</em></b></p> +<p>Remove given messages from the queue. Only allowed for privileged users.</p> + + + +<p><b>-oem</b></p> +<p>If the -oi ist not also given, always return with a non zero +return code. Maybe someone tells me what this is good for...</p> + + + +<p><b>-odb</b></p> +<p>Deliver in background. Masqmail always does this, which +makes this option pretty much useless.</p> + + + +<p><b>-odq</b></p> +<p>Do not attempt to deliver immediately. Any messages will be queued +until the next queue running process picks them up and delivers +them. You get the same effect by setting the do_queue option in +/etc/masqmail/masqmail.conf.</p> + + + +<p><b>-oi</b></p> +<p>A dot as a single character in a line does not terminate +the message.</p> + + + +<p><b>-q [<em>interval</em>]</b></p> +<p>If not given with an argument, run a queue process, ie. try to +deliver all messages in the queue. Masqmail sends only to those +addresses that are on the local net, not to those that are +outside. Use -qo for those.</p> +<p> +If you have configured inetd to start masqmail, you can use this +option in a cron job which starts in regular time intervals, to mimic +the same effect as starting masqmail with -bd -q30m. +</p><p> +An argument may be a time interval ie. a numerical value followed +by one of the letters. s,m,h,d,w which are interpreted as seconds, +minutes, hours, days or weeks respectively. Example: -q30m. Masqmail +starts as a daemon and a queue runner process will be started +automatically once in this time interval. This is usually used +together with -bd (see above). +</p> + + + + +<p><b>-qo [<em>name</em>]</b></p> + +<p>Can be followed by a connection name. Use this option in your +script which starts as soon as a link to the internet has been set up +(usually ip-up). When masqmail is called with this option, the +specified route configuration is read and the queued mail with +destinations on the internet will be sent. The <em>name</em> is defined +in the configuration (see <b>online_routes.<em>name</em></b>). +</p><p> +If called without <em>name</em> the online status is determined with +the configured method (see <b>online_detect</b> in config.html) +</p> + + + + +<p><b>-t</b></p> +<p>Read recipients from headers. Delete 'Bcc:' headers. If any +arguments are given, these are interpreted as recipient addresses and +the message will not be sent to these.</p> + + + +<p><b>-v</b></p> +<p>Log also to stdout. Currently, some log messages are +marked as 'write to stdout' and additionally, all messages with +priority 'LOG_ALERT' and 'LOG_WARNING' will be written to stdout +if this option is given. It is disabled in daemon mode. +</p> + + + + +<h2>Environment for pipes and mdas</h2> + + +<p>For security reasons, before any pipe command from an alias +expansion or an mda is called, the environment variables will be +completely discarded and newly set up. These are:</p> +<p>SENDER, RETURN_PATH - the return path.</p> +<p>SENDER_DOMAIN - the domain part of the return path.</p> +<p>SENDER_LOCAL - the local part of the return path.</p> +<p>RECEIVED_HOST - the host the message was received from (unless local).</p> +<p>LOCAL_PART, USER, LOGNAME - the local part of the (original) recipient.</p> +<p>MESSAGE_ID - the unique message id. This is not necessarily identical with the Message ID as given in the Message ID: header.</p> +<p>QUALIFY_DOMAIN - the domain which will be appended to unqualified addresses.</p> + + + + +<h2>Files</h2> + +<p><em>/etc/masqmail/masqmail.conf</em> is the main configuration +for masqmail. Depending on the settings in this file, you will also +have other configuration files in <em>/etc/masqmail/</em>.</p> +<p><em>/etc/aliases</em> is the alias file, if not set differently +in <em>/etc/masqmail/masqmail.conf</em>.</p> +<p><em>/var/spool/masqmail/</em> is the spool directory where masqmail +stores its spooled messages and the uniq pop ids.</p> +<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> +<p><em>/var/log/masqmail/</em> is the directory where masqmail stores +its log mesages. This can also be somewhere else if configured +differently by your sysadmin or the package mantainer.</p> + + + +<h2>Conforming to</h2> + +<p>RFC 821, 822, 1869, 1870, 2197, 2554 (SMTP)</p> +<p>RFC 1725, 1939 (POP3)</p> +<p>RFC 1321 (MD5)</p> +<p>RFC 2195 (CRAM-MD5)</p> + + + +<h2>Author</h2> + +<p>masqmail was written by Oliver Kurth +<oku@masqmail.cx></p><p>You will find the newest version of +masqmail at <a href = "http://masqmail.cx/masqmail/">http://masqmail.cx/masqmail/</a> or search for it +in freshmeat (<a href = "http://www.freshmeat.net">http://www.freshmeat.net</a>). There is also a mailing list, +you will find information about it at masqmails main site.</p> + + + +<h2>Bugs</h2> + +<p>You should report them to the mailing list.</p> + + + +<h2>See also</h2> + +<p> +<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> +</p> + + + +<h2>Comments</h2> + +<p>This man page was written using <a href="http://masqmail.cx/xml2man/">xml2man</a> by the same author.</p> + + + +</td></tr></table></center> +</body>
--- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/docs/old-manual/docs/masqmail.aliases.5.html Sat May 29 21:51:13 2010 +0200 @@ -0,0 +1,75 @@ +<body text="#000000" link="#0000ff" bgcolor="#ffffff"><center><table width="80%"> +<tr><td><h1>masqmail.aliases</h1> +<h2>masqmail alias file format</h2> + + +<h2>Description</h2> + +<p>This man page describes the format of the masqmail alias file. Its usual location is <em>/etc/aliases</em>.</p> + + + +<h2>File Format</h2> + +<p>The alias file consists of lines of the form:</p> + +local_part: item1, item2, ... + + +<p>Items can be surrounded by quotes '"'. If within the quotes other +quotes are needed for an address they can be escaped with a leading +backslash '\'.</p> + +<p>A leading '\' indicates that this address shall not be further +expanded.</p> + +<p>A leading pipe symbol '|' indicates that the item shall be treated +as a pipe command. The content of the message will then be sent to the +standard input of a command. The command will run under the user id +and group id masqmail is running as. If quotes are needed, the pipe +symbol must appear within the quotes.</p> + +<p>Loops will be detected, the offending address will be ignored.</p> + +<p>Aliases will be expanded at delivery time. This means that +if there is a message still in the queue and you change any alias +which matches one of the recipient addresses, the change will have +effect next time a delivery is attemped.</p> + +<p>There is no need to restart masqmail or run any command when the +alias file has been changed.</p> + + + +<h2>Author</h2> + +<p>masqmail was written by Oliver Kurth +<oku@masqmail.cx></p><p>You will find the newest version of +masqmail at <a href = "http://masqmail.cx/masqmail/">http://masqmail.cx/masqmail/</a> or search for it +in freshmeat (<a href = "http://www.freshmeat.net">http://www.freshmeat.net</a>). There is also a mailing list, +you will find information about it at masqmails main site.</p> + + + +<h2>Bugs</h2> + +<p>You should report them to the mailing list.</p> + + + +<h2>See also</h2> + +<p> +<a href="masqmail.conf.5.html">masqmail.conf</a>, <a href="masqmail.8.html">masqmail</a>, +</p> + + + +<h2>Comments</h2> + +<p>This man page was written using <a href="http://masqmail.cx/xml2man/">xml2man</a> by the same author.</p> + + + +</td></tr></table></center> +</body>
--- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/docs/old-manual/docs/masqmail.conf.5.html Sat May 29 21:51:13 2010 +0200 @@ -0,0 +1,569 @@ +<body text="#000000" link="#0000ff" bgcolor="#ffffff"><center><table width="80%"> +<tr><td><h1>masqmail.conf</h1> +<h2>masqmail configuration file</h2> + + +<h2>Description</h2> + +<p>This man page describes the syntax of the main configuration file +of masqmail. Its usual location is <em>/etc/masqmail/masqmail.conf</em></p> + +<p>The configuration consists of lines of the form</p> + +<p><b>val</b> = <em>expression</em></p> + +<p>Where <b>val</b> is a variable name and <em>expression</em> a string, +which can be quoted with '"'. If the expression is on multiple lines +or contains characters other than letters, digits or the characters +'.', '-', '_', '/', it must be quoted. You can use quotes inside quotes +by escaping them with a backslash.</p> + +<p>Each val has a type, which can be boolean, numeric, string +or list. A boolean variable can be set with one of the values 'on', +'yes', and 'true' or 'off', 'no' and 'false'. List items are separated +with ';'. For some values patterns (like '*','?') can be used. The +spaces before and after the '=' are optional.</p> + +<p>Most lists (exceptions: <b>local_hosts</b>, +<b>local_nets</b>, <b>listen_addresses</b>, <b>online_routes</b> and <b>online_gets</b>) accept +files. These will be recognized by a leading slash '/'. The contents +of these files will be included at the position of the file name, +there can be items or other files before and after the file entry. The +format of the files is different though, within these files each entry +is on another line. (And not separated by semicolons). This makes it +easy to include large lists which are common in different +configuration files, so they do not have to appear in every +configuration file.</p> + +<p>Blank lines and lines starting with '#' are ignored.</p> + + + + +<h2>Options</h2> + + +<p><b>run_as_user = <em>boolean</em></b></p> + +<p>If this is set, masqmail runs with the user id of the user who +invoked it and never changes it. This is for debugging purposes +only. If the user is not root, masqmail will not be able to +listen on a port < 1024 and will not be able to deliver local mail +to others than the user.</p> + + + + +<p><b>use_syslog = <em>boolean</em></b></p> + +<p>If this is set, masqmail uses syslogd for logging. It uses facility +MAIL. You still have to set <b>log_dir</b> for debug files.</p> + + + + +<p><b>debug_level = <em>n</em></b></p> + +<p>Set the debug level. Valid values are 0 to 6, increasing it further +makes no difference. Be careful if you set this as high as 5 or higher, +the logs may very soon fill your hard drive.</p> + + + + +<p><b>mail_dir = <em>file</em></b></p> + +<p>The directory where local mail is stored, +usually <em>/var/spool/mail</em> or <em>/var/mail</em>.</p> + + + + +<p><b>spool_dir = <em>file</em></b></p> + +<p>The directory where masqmail stores its spool files (and later also +other stuff). It must have a subdirectory <em>input</em>. +Masqmail needs read and write permissions for this +directory. I suggest to use <em>/var/spool/masqmail</em>.</p> + + + + +<p><b>host_name = <em>string</em></b></p> + +<p>This is used in different places: Masqmail identifies itself in the +greeting banner on incoming connections and in the HELO/EHLO command +for outgoing connections with this name, it is used in the Received: +header and to qualify the sender of a locally originating message.</p> + +<p>If the string begins with a slash '/', it it assumed that it is a +filename, and the first line of this file will be used. Usually this will +be '/etc/mailname' to make masqmail conform to Debian policies.</p> + +<p>It is not used to find whether an address is local. +Use <b>local_hosts</b> for that.</p> + + + + +<p><b>remote_port = <em>n</em></b></p> + +<p>The remote port number to be used. This defaults to port 25.</p> +<p>This option is deprecated. Use <b>host_name</b> in the route +configuration instead. See <a href="masqmail.route.5.html">masqmail.route</a>.</p> + + + + +<p><b>local_hosts = <em>list</em></b></p> + +<p>A semicolon ';' separated list of hostnames which are considered +local. Normally you set it to "localhost;foo;foo.bar.com" if your host +has the fully qualified domain name 'foo.bar.com'.</p> + + + + +<p><b>local_nets = <em>list</em></b></p> + +<p>A semicolon ';' separated list of hostnames which are on the +'local' net. Delivery to these hosts is attempted immediately. You can +use patterns with '*', eg. "*.bar.com".</p> + + + + +<p><b>local_addresses = <em>list</em></b></p> + +<p>A semicolon ';' separated list of fully qualified email-addresses +which are considered local although their domain name part is not in +the list of <b>local_hosts</b>. </p> +<p>For example: There are two people working at your +LAN: person1@yourdomain and person2@yourdomain. But there are +other persons @yourdomain which are NOT local. So you can not put +yourdomain to the list of local_hosts. If person1 now wants +to write to person2@yourdomain and this mail should not leave the LAN +then you can put</p> +<p>local_addresses = "person1@yourdomain;person2@yourdomain"</p> +<p>to your masqmail.conf.</p> + + + + +<p><b>not_local_addresses = <em>list</em></b></p> + +<p>A semicolon ';' separated list of fully qualified email-addresses +which are considered not local although their domain name part is in +the list of <b>local_hosts</b>. </p> +<p>This ist the opposite of the previous case. The majority of addresses +of a specific domain are local. But some users are not. With this +option you can easily exclude these users.</p> +<p>Example:</p> +<p>local_hosts = "localhost;myhost;mydomain.net"</p> +<p>not_local_addresses = "eric@mydomain.net"</p> + + + + +<p><b>listen_addresses = <em>list</em></b></p> + +<p>A semicolon ';' separated list of interfaces on which connections +will be accepted. An interface ist defined by a hostname, optionally +followed by a colon ':' and a number for the port. If this is left out, +port 25 will be used.</p> +<p>You can set this to "localhost:25;foo:25" if your hostname is 'foo'.</p> +<p>Note that the names are resolved to IP addreses. If your host has +different names which resolve to the same IP, use only one of them, +otherwise you will get an error message. +</p> + + + + +<p><b>do_save_envelope_to = <em>boolean</em></b></p> + +<p>If this is set to true, a possibly existing Envelope-to: header in an +incoming mail which is received via either pop3 or smtp will be saved as +an X-Orig-Envelope-to: header.</p> +<p>This is useful if you retrieve mail from a pop3 server with either masqmail +or fetchmail, and the server supports Envelope-to: headers, and you want to make use +of those with a mail filtering tool, eg. procmail. It cannot be preserved because +masqmail sets such a header by itself.</p> +<p>Default is false.</p> + + + + +<p><b>do_relay = <em>boolean</em></b></p> + +<p>If this is set to false, mail with a return path that is not local and a +destination that is also not local will not be accepted via smtp and a 550 +reply will be given. Default is true.</p> +<p>Note that this will not protect you from spammers using open relays, but from +users unable to set their address in their mail clients.</p> + + + + +<p><b>do_queue = <em>boolean</em></b></p> + +<p>If this is set, mail will not be delivered immediately when +accepted. Same as calling masqmail with the <b>-odq</b> option.</p> + + + + +<p><b>online_routes.<em>name</em> = <em>list</em></b></p> + + +<p>Replace <em>name</em> with a name to identify a connection. Set this +to a filename (or a list of filenames) for the special route configuration for that +connection. You will use that name to call masqmail with the + <b>-qo</b> option every time a connection to your ISP is set +up.</p> + +<p>Example: Your ISP has the name FastNet. Then you write the +following line in the main configuration:</p> + +<p><b>online_routes.FastNet</b> = <em>"/etc/masqmail/fastnet.route"</em></p> + +<p><em>/etc/masqmail/fastnet.route</em> is the route configuration +file, see <a href="masqmail.route.5.html">masqmail.route</a>. As soon as a link to FastNet has been set up, you +call masqmail <b>-qo</b> <em>FastNet</em>. Masqmail will then +read the specified file and send the mails.</p> + + + + + +<p><b>connect_route.<em>name</em> = <em>list</em></b></p> + +<p>Old name for <b>online_routes</b>.</p> + + + + + +<p><b>local_net_route = <em>file</em></b></p> + +<p>This is similar to <b>online_routes.<em>name</em></b> but for the +local net. Recipient addresses that are in local_nets will be +routed using this route configuration. Main purpose is to define a +mail server with mail_host in your local network. In simple +environments this can be left unset. If unset, a default route +configuration will be used.</p> + + + + +<p><b>alias_file = <em>file</em></b></p> + +<p>Set this to the location of your alias file. If unset, no aliasing +will be done.</p> + + + + +<p><b>alias_local_caseless = <em>boolean</em></b></p> + +<p>If this is set, local parts in the alias file will be matched +disregarding upper/lower case.</p> + + + + +<p><b>pipe_fromline = <em>boolean</em></b></p> + +<p>If this is set, a from line will be prepended to the output stream whenever +a pipe command is called after an alias expansion. Default is false.</p> + + + + +<p><b>pipe_fromhack = <em>boolean</em></b></p> + +<p>If this is set, each line beginning with 'From ' is replaced with '>From ' whenever +a pipe command is called after an alias expansion. You probably want this if you have +set <b>pipe_fromline</b> above. Default is false.</p> + + + + +<p><b>mbox_default = <em>string</em></b></p> + +<p>The default local delivery method. Can be one of mbox, mda or +maildir (the latter only if maildir support is enabled at compile +time). Default is mbox. You can override this for each user by using +the <b>mbox_users</b>, <b>mda_users</b> or <b>maildir_users</b> options +(see below). +</p> + + + + +<p><b>mbox_users = <em>list</em></b></p> + +<p>A list of users which wish delivery to an mbox style mail folder.</p> + + + + +<p><b>mda_users = <em>list</em></b></p> + +<p>A list of users which wish local delivery to an mda. You have to +set <b>mda</b> (see below) as well.</p> + + + + +<p><b>maildir_users = <em>list</em></b></p> + +<p>A list of users which wish delivery to a qmail style maildir. The +path to maildir is ~/Maildir/. The maildir will be created if it +does not exist.</p> + + + + +<p><b>mda = <em>expand string</em></b></p> + +<p>If you want local delivery to be transferred to an mda (Mail +Delivery Agent), set this to a command. The argument will be expanded +on delivery time, you can use variables beginning with a '$' sign, +optionally enclosed in curly braces. Variables you can use are:</p> +<p>uid - the unique message id. This is not necessarily identical with +the Message ID as given in the Message ID: header.</p> +<p>received_host - the host the mail was received from</p> +<p>ident - the ident, this is either the ident delivered by the ident +protocol or the user id of the sender if the message was received locally.</p> +<p>return_path_local - the local part of the return path (sender).</p> +<p>return_path_domain - the domain part of the return path (sender).</p> +<p>return_path - the complete return path (sender).</p> +<p>rcpt_local - the local part of the recipient.</p> +<p>rcpt_domain - the domain part of the recipient.</p> +<p>rcpt - the complete recipient address.</p> +<p>Example:</p><p>mda="/usr/bin/procmail -Y -d ${rcpt_local}"</p> +<p>For the mda, as for pipe commands, a few environment variables will +be set as well. See <a href="masqmail.8.html">masqmail</a>. To use environment variables for the mda, +the '$' sign has to be escaped with a backslash, otherwise they will +be tried to be expanded with the internal variables.</p> + + + + + +<p><b>mda_fromline = <em>boolean</em></b></p> + +<p>If this is set, a from line will be prepended to the output stream whenever +a message is delivered to an mda. Default is false.</p> + + + + +<p><b>mda_fromhack = <em>boolean</em></b></p> + +<p>If this is set, each line beginning with 'From ' is replaced with '>From ' whenever +a message is delivered to an mda. You probably want this if you have +set <b>mda_fromline</b> above. Default is false.</p> + + + + +<p><b>online_detect = <em>string</em></b></p> + +<p>Defines the method MasqMail uses to detect whether there is +currently an online connection. It can have the +values <b>file</b>, <b>pipe</b> or <b>mserver</b>.</p> + +<p>When it is set to <b>file</b>, MasqMail first checks for the +existence of <b>online_file</b> (see below) and if it exists, it reads +it. The content of the file should be the name of the current +connection as defined with <b>connect_route.<em>name</em></b> (without +a trailing newline character).</p> + +<p>When it is set to <b>pipe</b>, MasqMail calls the executable given by +the <b>online_pipe</b> option (see below) and reads the current online +status from its standard output.</p> + +<p>When it is set to <b>mserver</b>, MasqMail connects to the +masqdialer server using the value of <b>mserver_iface</b> and asks it +whether a connection exists and for the name, which should be the name +of the current connection as defined with <b>connect_route.<em>name</em></b>.</p> + +<p>No matter how MasqMail detects the online status, only messages +that are accepted at online time will be delivered using the +connection. The spool still has to be emptied with masqmail <b>-qo</b> +<em>connection</em>.</p> + + + + +<p><b>online_file = <em>file</em></b></p> + +<p>This is the name of the file checked for when MasqMail determines +whether it is online. The file should only exist when there is +currently a connection. Create it in your ip-up script with eg.</p> + +<p>echo -n <name> > /tmp/connect_route</p> +<p>chmod 0644 /tmp/connect_route</p> + +<p>Do not forget to delete it in your ip-down script.</p> + + + + +<p><b>online_pipe = <em>file</em></b></p> + +<p>This is the name of the executable which will be called to determine +the online status. This executable should just print the name oif the current +connection to the standard output and return a zero status code. masqmail assumes +it is offline if the script returns with a non zero status. Simple example:</p> + +<p>#!/bin/sh</p> +<p></p> +<p>[ -e /tmp/connect_route ] || exit 1</p> +<p>cat /tmp/connect_route</p> +<p>exit 0</p> + +<p>Of course, instead of the example above you could as well use <b>file</b> as +the online detection method, but you can do something more sophisticated.</p> + + + + +<p><b>mserver_iface = <em>interface</em></b></p> + +<p>The interface the masqdialer server is listening to. Usually this +will be "localhost:224" if mserver is running on the same host as +masqmail. But using this option, you can also let masqmail run on +another host by setting <b>mserver_iface</b> to another hostname, +eg. "foo:224".</p> + + + + +<p><b>get.<em>name</em> = <em>file</em></b></p> + +<p>Replace <em>name</em> with a name to identify a get +configuration. Set this to a filename for the get configuration. These +files will be used to retrieve mail when called with the -g option.</p> + + + + +<p><b>online_gets.<em>name</em> = <em>list</em></b></p> + +<p>Replace <em>name</em> with a name to identify an online +configuration. Set this to a filename (or a list of filenames) for the get configuration. These +files will be used to retrieve mail when called with the -go option.</p> + + + + +<p><b>ident_trusted_nets = <em>list</em></b></p> + +<p><em>list</em> is a list of networks of the form a.b.c.d/e +(eg. 192.168.1.0/24), from which the ident given by the ident protocol +will be trusted, so a user can delete his mail from the queue if the +ident is identical to his login name.</p> + + + + +<p><b>errmsg_file = <em>file</em></b></p> + +<p>Set this to a template which will be used to generate delivery failure +reports. Variable parts within the template begin with a dollar sign and +are identical to those which can be used as arguments for the mda command, +see <b>mda</b> above. Additional information can be included with +@failed_rcpts, @msg_headers and @msg_body, these must be at the +beginning of a line and will be replaced with the list of the failed recipients, +the message headers and the message body of the failed message.</p> +<p>Default is /usr/share/masqmail/tpl/failmsg.tpl.</p> + + + + +<p><b>warnmsg_file = <em>file</em></b></p> + +<p>Set this to a template which will be used to generate delivery warning +reports. It uses the same mechanisms for variables as <b>errmsg_file</b>, +see above. +</p> +<p>Default is /usr/share/masqmail/tpl/warnmsg.tpl.</p> + + + + +<p><b>warn_intervals</b> = <em>list</em></p> + +<p>Set this to a list of time intervals, at which delivery warnings (starting +with the receiving time of the message) shall be generated.</p> +<p>A warning will only be generated just after an attempt to deliver the +mail and if that attempt failed temporarily. So a warning may be generated after +a longer time, if there was no attempt before.</p> +<p>Default is "1h;4h;8h;1d;2d;3d"</p> + + + + +<p><b>max_defer_time</b> = <em>time</em></p> + +<p>This is the maximum time, in which a temporarily failed mail will be kept +in the spool. When this time is exceeded, it will be handled as a delivery failure, +and the message will be bounced.</p> +<p>The excedence of this time will only be noticed if the message was actually +tried to be delivered. If, for example, the message can only be delivered when +online, but you have not been online for that time, no bounce will be generated.</p> +<p>Default is 4d (4 days)</p> + + + + +<p><b>log_user = <em>name</em></b></p> + +<p>Replace <em>name</em> with a valid local or remote mail address.</p> +<p>If this option is not empty, then a copy of every mail, +that passes trough the masqmail system will also be sent to the +given mail address.</p> +<p>For example you can feed your mails into a program like hypermail for +archiving purpose by placing an appropriate pipe command in masqmail.alias</p> + + + + + +<h2>Author</h2> + +<p>masqmail was written by Oliver Kurth +<oku@masqmail.cx></p><p>You will find the newest version of +masqmail at <a href = "http://masqmail.cx/masqmail/">http://masqmail.cx/masqmail/</a> or search for it +in freshmeat (<a href = "http://www.freshmeat.net">http://www.freshmeat.net</a>). There is also a mailing list, +you will find information about it at masqmails main site.</p> + + + +<h2>Bugs</h2> + +<p>You should report them to the mailing list.</p> + + + +<h2>See also</h2> + +<p> +<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> +</p> + + + + +<h2>Comments</h2> + +<p>This man page was written using <a href="http://masqmail.cx/xml2man/">xml2man</a> by the same +author.</p> + + + +</td></tr></table></center> +</body>
--- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/docs/old-manual/docs/masqmail.get.5.html Sat May 29 21:51:13 2010 +0200 @@ -0,0 +1,175 @@ +<body text="#000000" link="#0000ff" bgcolor="#ffffff"><center><table width="80%"> +<tr><td><h1>masqmail.get</h1> +<h2>masqmail get configuration file</h2> + + +<h2>Description</h2> + <p>This man page describes the options available for the +masqmail get configuration.</p> + + + + +<h2>Options</h2> + + + +<p><b>protocol</b> = <em>string</em></p> + +<p>The protocol with which you retrieve your mail. Currently only +'pop3' and 'apop' are supported. There is no default.</p> + + + + +<p><b>server</b> = <em>string</em></p> + +<p>The server you get your mail from.</p> + + + + +<p><b>resolve_list</b> = <em>list</em></p> + +<p>Specify the method how the domain of the server is resolved. Possible values are +dns_mx, dns_a, byname. For 'dns_mx', the domain is assumed to be an MX +pointer to a list of host names, these will be tried each in order +(lowest preference value first, equal preference values in random +order). For 'dns_a', the domain is assumed to be an A pointer. For +'byname', the library function <b>gethostbyname (3)</b> will be used.</p> +<p>The default is "dns_a;byname". It does not make much sense here to use 'dns_mx'.</p> + + + + +<p><b>user</b> = <em>string</em></p> + +<p>Your login name.</p> + + + + +<p><b>pass</b> = <em>string</em></p> + +<p>Your password.</p> + + + + +<p><b>address</b> = <em>address</em></p> + +<p>The address where the retrieved mail should be sent to. It can be +any address, but you probably want to set this to a local address on +your LAN.</p> + + + + +<p><b>return_path</b> = <em>address</em></p> + +<p>If set, masqmail sets the return path to this address. Bounces +generated during further delivery will be sent to this address. If +unset, masqmail looks for the Return-Path: header in the mail, if +this does not exist it uses the From: address and if this fails, +postmaster will be used. +</p><p> +It is in most cases not useful to set this to the same address as +the 'address' option as this may generate multiple bounces. +postmaster is recommended.</p> + + + + +<p><b>do_keep</b> = <em>boolean</em></p> + +<p>If you want to keep your mail on the server after you retrieved it, +set this to true. It is recommended that you also set do_uidl, +otherwise you will get the mail again each time you connect to the +server. Masqmail does not check any headers before it retrieves mail, +which may mark it as already fetched. Note that this behaviour is +different to that of fetchmail. The default is false.</p> + + + + +<p><b>do_uidl</b> = <em>boolean</em></p> + +<p>If set, MasqMail keeps a list of unique IDs of mails already +fetched, so that they will not be retrieved again. Default is false.</p> + + + + +<p><b>do_uidl_dele</b> = <em>boolean</em></p> + +<p>If set, and <b>do_uidl</b> is also set, MasqMail sends a delete (DELE) +command to the server for each message uid in the uid listing at the +beginning of the session. This prevents mail to be left on the server if +masqmail gets interrupted during a session before it can send the QUIT +command to the server. Default is false. +</p> + + + + +<p><b>max_size</b> = <em>numeric</em></p> + +<p>If set to a value > 0, only messages smaller than this in bytes will be +retrieved. The default is 0.</p> + + + + +<p><b>max_count</b> = <em>numeric</em></p> + +<p>If set to a value > 0, only <b>max_count</b> messages will be retrieved. +The default is 0.</p> + + + + +<p><b>wrapper</b> = <em>command</em></p> + +<p>If set, instead of opening a connection to a remote server, <em>command</em> will +be called and all traffic will be piped to its +stdin and from its stdout. Purpose is to tunnel ip traffic, eg. for ssl.</p> +<p>Example for ssl tunneling:</p> +<p>wrapper="/usr/bin/openssl s_client -quiet -connect pop.gmx.net:995 2>/dev/null"</p> + + + + + +<h2>Author</h2> + +<p>masqmail was written by Oliver Kurth +<oku@masqmail.cx></p><p>You will find the newest version of +masqmail at <a href = "http://masqmail.cx/masqmail/">http://masqmail.cx/masqmail/</a> or search for it +in freshmeat (<a href = "http://www.freshmeat.net">http://www.freshmeat.net</a>). There is also a mailing list, +you will find information about it at masqmails main site.</p> + + + +<h2>Bugs</h2> + +<p>You should report them to the mailing list.</p> + + + +<h2>See also</h2> + +<p> +<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> +</p> + + + +<h2>Comments</h2> + +<p>This man page was written using <a href="http://masqmail.cx/xml2man/">xml2man</a> by the same +author.</p> + + + +</td></tr></table></center> +</body>
--- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/docs/old-manual/docs/masqmail.route.5.html Sat May 29 21:51:13 2010 +0200 @@ -0,0 +1,385 @@ +<body text="#000000" link="#0000ff" bgcolor="#ffffff"><center><table width="80%"> +<tr><td><h1>masqmail.route</h1> +<h2>masqmail route configuration file</h2> + + +<h2>Description</h2> + +<p>This man page describes the syntax of the route configuration files +of <a href="masqmail.8.html">masqmail</a>. Their usual locations are in <em>/etc/masqmail/</em>.</p> + + + +<h2>Options</h2> + + + +<p><b>protocol</b> = <em>string</em></p> + +<p><em>string</em> can be one of 'smtp' or 'pipe', default is +'smtp'. If set to 'smtp', mail will be sent with the SMTP protocol to +its destination. If set to 'pipe', you also have to set 'pipe' +to a command, the message will then be piped to a program. See option 'pipe' below.</p> + + + + +<p><b>mail_host</b> = <em>string</em></p> + +<p>This is preferably the mail server of your ISP. All outgoing +messages will be sent to this host which will distribute them to their +destinations. If you do not set this mails will be sent +directly. Because the mail server is probably 'near' to you, mail +transfer will be much faster if you use it.</p> +<p>You can optionally give a port number following the host name +and a colon, eg mail_host="mail.foo.com:25".</p> + + + + +<p><b>resolve_list</b> = <em>list</em></p> + +<p>Specify the method how the domain of the server is resolved. Possible values are +dns_mx, dns_a, byname. For 'dns_mx', the domain is assumed to be an MX +pointer to a list of host names, these will be tried each in order +(lowest preference value first, equal preference values in random +order). For 'dns_a', the domain is assumed to be an A pointer. For +'byname', the library function <b>gethostbyname (3)</b> will be used.</p> +<p>The default is "dns_mx;dns_a;byname".</p> + + + + +<p><b>connect_error_fail</b> = <em>boolean</em></p> + +<p>If this is set, a connection error will cause a mail delivery to +fail, ie. it will be bounced. If it is unset, it will just be defered.</p> +<p>Default is false. The reason for this is that masqmail is designed +for non permanent internet connections, where such errors may occur +quite often, and a bounce would be annoying.</p> +<p>For the default local_net route is is set to true.</p> + + + + +<p><b>helo_name</b> = <em>string</em></p> + +<p>Set the name given with the HELO/EHLO command. If this is not +set, <b>host_name</b> from <em>masqmail.conf</em> will be used, if +the <b>do_correct_helo</b> option (see below) is unset.</p> + + + + +<p><b>do_correct_helo</b> = <em>boolean</em></p> + +<p>If this is set, masqmail tries to look up your host name as it +appears on the internet and sends this in the HELO/EHLO command. Some +servers are so picky that they want this. Which is really +crazy. It just does not make any sense to lie about ones own identity, +because it can always be looked up by the server. Nobody should +believe in the name given by HELO/EHLO anyway. If this is not +set, <b>host_name</b> from <em>masqmail.conf</em> or as given with +the <b>helo_name</b> (see above) will be used.</p> + + + + +<p><b>do_pipelining</b> = <em>boolean</em></p> + +<p>If this is set to false, masqmail will not use ESMTP PIPELINING, even +if the server announces that it is able to cope with it. Default is true.</p> +<p>You do not want to set this to false unless the mail setup on the +remote server side is really broken. Keywords: wingate.</p> + + + + +<p><b>allowed_mail_locals</b> = <em>list</em></p> + +<p>This is a semicolon ';' separated list of local parts which will be +allowed to send mail through this connection. If unset +and <b>not_allowed_mail_locals</b> is also unset, all users are +allowed.</p> + + + + +<p><b>not_allowed_mail_locals</b> = <em>list</em></p> + +<p>This is a semicolon ';' separated list of local parts which will be +not allowed to send mail through this connection. Local +parts in this list will not be allowed to use this route even if they +are part of <b>allowed_mail_locals</b> (see above).</p> + + + + +<p><b>allowed_return_paths</b> = <em>list</em></p> + +<p>This is a semicolon ';' separated list of addresses. Messages which +have one one of these addresses as the return path will be used using +this route (if not also in <b>not_allowed_return_paths</b> or an item +in <b>not_allowed_mail_locals</b> matches).</p> +<p>Patterns containing '?' and '*' can be used. The special item "<>" matches +the null sender address (eg. failure notices or delivery notifications).</p> + + + + +<p><b>not_allowed_return_paths</b> = <em>list</em></p> + +<p>This is a semicolon ';' separated list of addresses. Messages which +have one one of these addresses as the return path will not be used using +this route (even if also in <b>allowed_return_paths</b> or an item +in <b>allowed_mail_locals</b> matches).</p> +<p>Patterns containing '?' and '*' can be used. The special item "<>" matches +the null sender address (eg. failure notices or delivery notifications).</p> + + + + +<p><b>allowed_rcpt_domains</b> = <em>list</em></p> + +<p>A list of recipient domains where mail will be sent to. This is for +example useful if you use this route configuration when connected to +another LAN via ppp. Patterns containing '?' and '*' can be used.</p> + + + + +<p><b>not_allowed_rcpt_domains</b> = <em>list</em></p> + +<p>A list of recipient domains where mail will not be sent +to. This is for example useful if you send mail directly (<b>mail_host</b> is +not set) and you know of hosts that will not accept mail from you +because they use a dialup list (eg. <a href = "http://maps.vix.com/dul/">http://maps.vix.com/dul/</a>. If any domain +matches both <b>allowed_rcpt_domains</b> and <b>not_allowed_rcpt_domains</b>, +mail will not be sent to this domain. Patterns containing '?' and '*' can be used.</p> + + + + +<p><b>set_h_from_domain</b> = <em>string</em></p> + +<p>Replace the domain part in 'From:' headers with this value. This +may be useful if you use a private, outside unknown address on your +local LAN and want this to be replaced by the domain of the address of +your email addrsss on the internet. Note that this is different to <b> +set_return_path_domain</b>, see below.</p> + + + + +<p><b>set_return_path_domain</b> = <em>string</em></p> + +<p>Sets the domain part of the envelope from address. Some hosts check +whether this is the same as the net the connection is coming from. If +not, they reject the mail because they suspect spamming. It should be +a valid address, because some mail servers also check +that. You can also use this to set it to your usual address on the +internet and put a local address only known on your LAN in the +configuration of your mailer. Only the domain part will +be changed, the local part remains unchanged. Use <b> +map_return_path_addresses</b> for rewriting local parts.</p> + + + + +<p><b>map_h_from_addresses</b> = <em>list</em></p> + +<p>This is similar to <b>set_h_from_domain</b>, but more flexible. Set +this to a list which maps local parts to a full RFC 822 compliant +email address, the local parts (the keys) are separated from +the addresses (the values) by colons (':').</p> + +<p>Example:</p> + +<p>map_h_from_addresses = "john: John Smith <jsmith@mail.academic.edu>; +charlie: Charlie Miller <cmiller@mx.commercial.com>"</p> +<p>You can use patterns, eg. * as keys.</p> + + + + +<p><b>map_h_reply_to_addresses</b> = <em>list</em></p> + +<p>Same as <b>map_h_from_addresses</b>, but for the 'Reply-To:' header.</p> + + + + +<p><b>map_h_mail_followup_to_addresses</b> = <em>list</em></p> + +<p>Same as <b>map_h_from_addresses</b>, but for the 'Mail-Followup-To:' +header. Useful when replying to mailing lists.</p> + + + + +<p><b>map_return_path_addresses</b> = <em>list</em></p> + +<p>This is similar to <b>set_return_path_domain</b>, but more +flexible. Set this to a list which maps local parts to a full RFC 821 +compliant email address, the local parts (the keys) are +separated from the addresses (the values) by colons +(':'). Note that this option takes RFC 821 addresses +while <b>map_h_from_addresses</b> takes RFC 822 addresses. The +most important difference is that RFC 821 addresses have no full +name.</p> + +<p>Example:</p> +<p> +map_return_path_addresses = +"john: <jsmith@mail.academic.edu>; +charlie: <cmiller@mx.commercial.com>" +</p> +<p>You can use patterns, eg. * as keys.</p> + + + + +<p><b>expand_h_sender_address</b> = <em>boolean</em></p> + +<p>This sets the domain of the sender address as given by the Sender: +header to the same address as in the envelope return path address +(which can be set by either <b>set_return_path_domain</b> or <b>map_return_path_addresses</b>). +This is for mail clients (eg. Microsoft Outlook) which use this address as the sender +address. Though they should use the From: address, see RFC +821. If <a href="http://www.fetchmail.org">fetchmail</a> encounters an unqualified Sender: +address, it will be expanded to the domain of the pop server, which is +almost never correct. Default is true.</p> + + + + +<p><b>expand_h_sender_domain</b> = <em>boolean</em></p> + +<p>Like <b>expand_h_sender_address</b>, but sets the domain only. +Deprecated, will be removed in a later version.</p> + + + + +<p><b>last_route</b> = <em>boolean</em></p> + +<p>If this is set, a mail which would have been delivered using this +route, but has failed temporarily, will not be tried to be delivered +using the next route.</p> +<p>If you have set up a special route with filters using the lists +'allowed_rcpt_domains', 'allowed_return_paths', and +'allowed_mail_locals' or their complements (not_), and the mail +passing these rules should be delivered using this route only, you +should set this to 'true'. Otherwise the mail would be passed to the +next route (if any), unless that route has rules which prevent +that.</p> +<p>Default is false.</p> + + + + +<p><b>auth_name</b> = <em>string</em></p> + +<p>Set the authentication type for ESMTP AUTH authentification. +Currently only 'cram-md5' and 'login' are supported.</p> + + + + +<p><b>auth_login</b> = <em>string</em></p> + +<p>Your account name for ESMTP AUTH authentification.</p> + + + + +<p><b>auth_secret</b> = <em>string</em></p> + +<p>Your secret for ESMTP AUTH authentification.</p> + + + + +<p><b>pop3_login</b> = <em>file</em></p> + +<p>If your Mail server requires SMTP-after-POP, set this to a +get configuration (see <a href="masqmail.get.5.html">masqmail.get</a>). +If you login to the POP server +before you send, this is not necessary.</p> + + + + +<p><b>wrapper</b> = <em>command</em></p> + +<p>If set, instead of opening a connection to a remote server, <em>command</em> will +be called and all traffic will be piped to its +stdin and from its stdout. Purpose is to tunnel ip traffic, eg. for ssl.</p> +<p>Example for ssl tunneling:</p> +<p>wrapper="/usr/bin/openssl s_client -quiet -connect pop.gmx.net:995 2>/dev/null"</p> + + + + +<p><b>pipe</b> = <em>command</em></p> + +<p>If set, and protocol is set to 'pipe', <em>command</em> will be +called and the message will be piped to its stdin. Purpose is to use +gateways to uucp, fax, sms or whatever else.</p> +<p>You can use variables to give as arguments to the command, these +are the same as for the mda in the main configuration, see <a href="masqmail.conf.5.html">masqmail.conf</a>.</p> + + + + +<p><b>pipe_fromline = <em>boolean</em></b></p> + +<p>If this is set, and protocol is set to 'pipe', a from line will be prepended to the output stream whenever +a pipe command is called. Default is false.</p> + + + + +<p><b>pipe_fromhack = <em>boolean</em></b></p> + +<p>If this is set, and protocol is set to 'pipe', each line beginning with 'From ' +is replaced with '>From ' whenever a pipe command is called. You probably want this if you have +set <b>pipe_fromline</b> above. Default is false.</p> + + + + + +<h2>Author</h2> + +<p>masqmail was written by Oliver Kurth +<oku@masqmail.cx></p><p>You will find the newest version of +masqmail at <a href = "http://masqmail.cx/masqmail/">http://masqmail.cx/masqmail/</a> or search for it +in freshmeat (<a href = "http://www.freshmeat.net">http://www.freshmeat.net</a>). There is also a mailing list, +you will find information about it at masqmails main site.</p> + + + +<h2>Bugs</h2> + +<p>You should report them to the mailing list.</p> + + + +<h2>See also</h2> + +<p> +<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> +</p> + + + +<h2>Comments</h2> + +<p>This man page was written using <a href="http://masqmail.cx/xml2man/">xml2man</a> by the same +author.</p> + + + +</td></tr></table></center> +</body>
--- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/docs/old-manual/faq.html Sat May 29 21:51:13 2010 +0200 @@ -0,0 +1,189 @@ +<HTML> +<HEAD> +<TITLE>MasqMail - Manual +</TITLE> +</HEAD> + <BODY TEXT="#000000" LINK="#0000ff" BGCOLOR="#ffffff"> + + <center> + <table width="80%"> + <tr><td> + <table width="100%" bgcolor="#0000aa" cellspacing=0 cellpadding=0> + <tr> + <td> + <a href="manual.html"> + <img width="20" src = "../images/u_arrow.gif" alt = "manual"> + </a> + </td> + <td align=center width="100%"><font size="6" color = "#ffffff">Frequently Asked Questions</font></td> + <td> + <a href="./config.html"> + <img width="20" src = "../images/l_arrow.gif" alt = "Configuration"> + </a> + </td> + </tr> + </table> + + + Some of these questions were never asked, but I thought they will be + some time. Some <em>were</em> asked. + + <h4>General Questions</h4> + <ul> + <li><a href="#1_0">1.0: When do I need MasqMail?</a></li> + <li><a href="#1_1">1.1: When do I <em>not</em> need MasqMail?</a></li> + <li><a href="#1_2">1.2: Can I retrieve mail with MasqMail?</a></li> + <li><a href="#1_3">1.3: Is there a mailing list for MasqMail?</a></li> + </ul> + + <h4>Setup</h4> + <ul> + <li><a href="#2_0">2.0: After starting masmail, I get the following + message: "could not gain root privileges. Is the setuid bit set?"</a></li> + <li><a href="#2_1">2.1: After starting masmail, I get the following + message: "bind: (terminating): Address already in use"</a></li> + </ul> + + <h4>Header Rewriting</h4> + <ul> + <li><a href="#3_0">3.0: My friends told me that they do not see my + full name in their inbox, although it is configured in my mail + client.</a></li> + </ul> + + <h4>Delivering Online</h4> + <ul> + <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> + <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> + </ul> + + <h4>Bugs</h4> + <ul> + <li><a href="#5_0">5.0: I found a bug.</a></li> + <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> + </ul> + + <a name="1_0"> <h4>1.0: When do I need MasqMail?</h4></a> + + <p> You do not <em>need</em> it. But it makes sending mails via a + dialup connection a lot easier.</p> + + <p>It is useful if you dial to the internet from time to time via a + modem and connect to different providers, each one with a different + configuration. Other MTAs are not flexible enough if you have to send + mails via different mail servers for each provider. With MasqMail you + can configure a different one for each provider and even set your + return addresses differently.</p> + + <p>It is also useful if you have a LAN with a gateway which is + connected to the internet via a modem because you can rewrite your + address depending on whether the recipients are <em>inside</em> or + <em>outside</em> your LAN. So responses and delivery failures on your + LAN will be sent to you without leaving it, while those outside will + be delivered to your address outside. (But it does not yet send + delivery failures itself yet.)</p> + + <p>MasqMail is also often used on notebooks.</p> + + <a name="1_1"><h4>1.1: When do I <em>not</em> need MasqMail?</h4></a> + + <p>The use of MasqMail is <em>strongly</em> discouraged if you have a + permanent connection to the internet without a firewall. First because + it does not have the ability to block relaying (it relays every mail) + and second because there are no capabilities to protect against + SPAM. You will not take advantages of its features anyway.</p> + + <a name="1_2"><h4>1.2: Can I retrieve mail with MasqMail?</h4></a> + + <p>Yes, for version >= 0.1.0 you can retrieve mail via the POP3 and + APOP protocol from single drop mailboxes (in case you do not know + about single/mutidrop, you probaby use single drop mailboxes).</p> + + <p>You can also use fetchmail or other pop/imap clients to feed + it.</p> + + <a name="1_3"><h4>1.3: Is there a mailing list for MasqMail?</h4></a> + + <p>Yes, there is! See <a href="http://www.innominate.org/mailman/listinfo/masqmail">here</a>.</p> + + <a name="2_0"><h4>2.0: After starting masmail, I get the following + message: "could not gain root privileges. Is the setuid bit set?"</h4></a> + + <p>Set the set-user-id-bit with chmod u+s /usr/sbin/masqmail.</p> + + <a name="2_1"><h4>2.1: After starting masmail, I get the following + message: "bind: (terminating): Address already in use"</h4></a> + + <p>This means that there is already a process listening on a port, + usually 25. You either have another MTA running in background + (sendmail, exim, etc...) or another instance of masqmail.</p> + + <p>It may also mean that the ports you configured MM to listen to + (with 'listen_addresses') are on the same IP address, eg. you may have + set your hostname to 127.0.0.1 and try to listen on localhost and your + host name. In this case either set your hostname to another IP address + or delete one of the conflicting entries.</p> + + <a name="3_0"><h4>3.0: My friends told me that they do not see my full + name in their inbox, although it is configured in my mail + client.</h4></a> + + <p>You probably used the <b>map_h_from_addresses</b> feature in the + route configuration and forgot to set your real name. The syntax + is:</p> + + <pre> +map_h_from_addresses = "charlie:Charlie Miller <cmiller@foo.com>"; + </pre> + + <p>Do not forget the <em>Charlie Miller</em>.</p> + + <a name="4_0"><h4>4.0: With connection method <em>file</em>, I get the + following message in the log file: "Could not open /tmp/connect_route: + Permission denied".</h4></a> + + <p>In your ip-up script, you have to set read permission to the user + masqmail runs as. After you write the file with the connection name, + set read permission to all with chmod ugo+r <em>file</em>. + + <a name="4_1"><h4>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.".</h4></a> + + <p>Check whether the name in the file is really identical to name you + gave to the route configuration (case sensitive!). Maybe there is a + linefeed after the name in the file. Write it with echo -n.</p> + + <a name="5_0"><h4>5.0: I found a bug.</h4></a> + + <p>Make sure you are using the newest version, in case of doubt search + it in <a href="http://www.freshmeat.net">freshmeat</a>. If you do, tell + <a href = "mailto:Oliver Kurth <kurth@innominate.de>">me</a>. See + also the section <a href="index.html#bugs">bugs</a> on the <a + href="index.html">main</a> page.</p> + + <a name="5_1"><h4>5.1: I think I found a bug, but I am not sure + whether I configured MasqMail incorrectly.</h4></a> + + <p>Don't care. Tell <a href = "mailto:Oliver Kurth + <kurth@innominate.de>">me</a>. Or write to the <a + href="http://www.innominate.org/mailman/listinfo/masqmail">mailing + list</a>.</p> + + </td></tr> + + <tr><td> + <p> + <hr> + <address><a href = "mailto:kurth@innominate.de">Oliver Kurth</a></address> + Last modified: Tue May 30 15:19:56 CEST 2000 + <br> + This page was created using <a href="http://www.freddyfrog.com/hacks/genpage/">Genpage</a> - Version: 1.0.6 + </p> + + </table> + </center> + + </BODY> +</HEAD> +
--- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/docs/old-manual/install.html Sat May 29 21:51:13 2010 +0200 @@ -0,0 +1,219 @@ + + + + + + + + +<HTML> +<HEAD> +<TITLE>MasqMail - Manual +</TITLE> +</HEAD> + <BODY TEXT="#000000" LINK="#0000ff" BGCOLOR="#ffffff"> + + <center> + <table width="80%"> + <tr><td> + <table width="100%" bgcolor="#0000aa" cellspacing=0 cellpadding=0> +<tr> + <td> + <a href="manual.html"> + <img width="20" src = "../images/u_arrow.gif" alt = "manual"> + </a> + </td> +<td align=center width="100%"><font size="6" color = "#ffffff">Installation</font></td> +<td> + <a href="./options.html"> + <img width="20" src = "../images/r_arrow.gif" alt = "Options"> + </a> +</td> +</tr> +</table> + + +<p>You need a user and a group for masqmail to run, I suggest user +'mail' and group 'trusted'. Say:</p> + +<pre> +groupadd -g 42 trusted +useradd -u 42 -g 42 -d / -s /bin/sh -c "Mail Transfer Agent" mail +</pre> + +<p>If you use other names than <i>mail</i> and <i>trusted</i> use the options +described below for configure. The 42 is just a suggestion, you can +use any number you like, but preferably one < 100. It does not have +to be the same for the user 'mail' and the group 'trusted'.</p> + +<p>Compliling is a matter of the usual procedure:</p> + +In the source directory, after unpacking do:<br> + +<pre> +./configure +make +make install +</pre> + +<p>Optionally, after you have called make, you can make some tests in +the tests directory. Read the README in that directory for +instructions.</p> + +<h4>Additional options for configure:</h4> + +<p> +<b>--with-user=USER</b> sets the user as which MasqMail will run. Default is +<i>mail</i>. USER has to exist before you 'make install'. +</p><p> +<b>--with-group=GROUP</b> sets the group as which MasqMail will run. Default +is <i>trusted</i>. GROUP has to exist before you 'make install'. +</p><p> +<b>--with-logdir=LOGDIR</b> sets the directory where MasqMail stores its log +files. It will be created if it does not exist. Default is /var/masqmail/. +</p><p> +<b>--with-spooldir=SPOOLDIR</b> sets the directory where MasqMail stores its +spool files. It will be created if it does not exist. Default is +/var/spool/masqmail/. +</p><p> +<b>--enable-auth</b> enables ESMTP AUTH support (disabled by default) +</p><p> +<b>--disable-pop3</b> disables pop3 support (enabled by default) +</p> + +<h4>After make install</h4> + +<p> +You can also use these instructions to omit 'make install' if you do +not want to use it. +</p><p> +Check that 'make install' worked correctly. The following command: +</p><p><pre> +ls -ld /usr/sbin/masqmail /var/masqmail/ /var/spool/masqmail /var/spool/masqmail/input +</pre></p><p> +should give output similar to +</p><p> +<pre> +-rwsr-xr-x 1 root root 86955 Oct 14 14:27 /usr/sbin/masqmail +drwxr-xr-x 2 mail trusted 1024 Oct 14 14:29 /var/masqmail/ +drwxr-xr-x 3 mail trusted 1024 Oct 14 14:27 /var/spool/masqmail +drwxr-xr-x 2 mail trusted 1024 Oct 14 18:32 /var/spool/masqmail/input +drwxr-xr-x 2 mail trusted 1024 Oct 14 18:32 /var/spool/masqmail/popuidl +</pre> +</p> +<p> +(important is the set-user-id bit for /usr/sbin/masqmail and the +ownership of all items). +</p> + +<p>Edit the configuration files. You can use the files from the +examples directory as a template. Copy masqmail.conf to +/etc/maqmail.conf, the others to the location given in +masqmail.conf.</p> + +<p>If you already have an MTA (eg. sendmail) installed, move that to +another location:</p> + +mv /usr/sbin/sendmail /usr/sbin/sendmail.orig<br> + +<p>Then make a link to the new MTA:</p> + +<pre> +ln -s /usr/sbin/masqmail /usr/sbin/sendmail +</pre> + +<p>Now every mailer that used to call sendmail will now call +masqmail. You can now kill your old sendmail if it is running and +start masqmail. Usually this is done with the startup scripts. For +SuSE this would be (as root):</p> + +<pre> +/sbin/init.d/sendmail stop +/sbin/init.d/sendmail start +</pre> + +<p>or shorter:</p> + +<pre> +/sbin/init.d/sendmail restart<br> +</pre> + +<p>You can also start it with:</p> + +<pre> +/usr/sbin/sendmail -bd -q30m<br> +</pre> + +<p>You can also let it be called from inetd (with the -bs option), but +this is untested.</p> + +<h4>Configuring for online delivery</h4> + +<p>Now you have to set up the online configuration. The trick is to +tell your ip-up script the connection name. You could use the IP +number of the far side of the ppp link, but this is a pain and may +change each time. But you can give it an additional argument via pppd +with ipparam. Somewhere in your dial up script you have a line similar +to:</p> + +<pre> +/usr/sbin/pppd /dev/ttyS1 connect "/usr/sbin/chat -t 90 -f +${CHATFILE}" -d -d -d user user@somewhere file ${OPTIONS} +</pre> + +<p>Just add 'ipparam FastNet' in the command line for pppd if your ISP +has the name FastNet. The ip-up script will then get 'FastNet' as a +sixth parameter. In your ip-up script you can then call masqmail with</p> + +<pre> +/usr/sbin/masqmail -qo $6 +</pre> + +<p>instead of 'sendmail -q', if you had that in the script +before. Masqmail will then read the route configuration specified for +the connection name 'FastNet' and deliver the mail destined to the +internet. See the <a href="config.html">configuration manual</a> on how +to write a route configuration or use one of the examples as a +template. <em>I do not know how do configure that for an ISDN adapter, +but I am sure you will find something similar in the man +pages.</em></p> + +<p>If you want mail that is received by masqmail from your local +net to be delivered immediately using the route configuration, you +have two possibilities:<p> + +<p> +<ul> + +<li>if you are using the masqdialer system, you just have to set the +variables <b>online_detect</b> to <i>mserver</i> and +<b>mserver_iface</b> to the interface mserver is listening to.</li> + +<li>otherwise you have to add two commands in your ip-up script:<br> +echo -n $6 > /tmp/connect_route<br> chmod 644 /tmp/connect_route<br> +and you have to remove the file <i>/tmp/connect_route</i> in your +ip-down script:<br> rm /tmp/connect_route.<br> Then you have to set +<b>online_detect</b> to <i>file</i> and <b>online_file</b> to +<i>/tmp/connect_route</i>. </li> + +</ul> +</p> + +<p>See the route documentation for more.</p> + </td></tr> + + <tr><td> + <p> + <hr> + <address><a href = "mailto:kurth@innominate.de">Oliver Kurth</a></address> + Last modified: Tue May 30 15:19:56 CEST 2000 + <br> + This page was created using <a href="http://www.freddyfrog.com/hacks/genpage/">Genpage</a> - Version: 1.0.6 + </p> + + </table> + </center> + + </BODY> +</HEAD> +
--- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/docs/old-manual/manual.html Sat May 29 21:51:13 2010 +0200 @@ -0,0 +1,45 @@ +<HTML> + <HEAD> + <TITLE>MasqMail - Manual + </TITLE> + </HEAD> + <BODY TEXT="#000000" LINK="#0000ff" BGCOLOR="#ffffff"> + + <center> + <table width="80%"> + <tr><td> + <table width="100%" bgcolor="#0000aa" cellspacing=0 cellpadding=0> + <tr> + <td> + <a href="index.html"> + <img width="20" src = "../images/u_arrow.gif" alt = "index"> + </a> + </td> + <td align=center width="100%"><font size="6" color = "#ffffff">Manual</font></td> + </tr> + </table> + + + <a href = "install.html">Installation</a><br> + <a href = "faq.html">Frequently Asked Questions</a><br> + <br> + <a href = "docs/masqmail.8.html">Command line options</a><br> + <a href = "docs/masqmail.conf.5.html">Configuration</a><br> + <a href = "docs/masqmail.route.5.html">Routes</a><br> + <a href = "docs/masqmail.aliases.5.html">Alias File Format</a><br> + <a href = "docs/masqmail.get.5.html">Mail Get Configuration</a><br> + </td></tr> + + <tr><td> + <p> + <hr> + <address><a href = "mailto:oku@masqmail.cx">Oliver Kurth</a></address> + Last modified: Fri, 28 Jul 2000 09:13:20 +0200 + </p> + + </table> + </center> + + </BODY> +</HEAD> +
--- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/docs/old-manual/options.html Sat May 29 21:51:13 2010 +0200 @@ -0,0 +1,181 @@ + + + + + + + + +<HTML> +<HEAD> +<TITLE>MasqMail - Manual +</TITLE> +</HEAD> + <BODY TEXT="#000000" LINK="#0000ff" BGCOLOR="#ffffff"> + + <center> + <table width="80%"> + <tr><td> + <table width="100%" bgcolor="#0000aa" cellspacing=0 cellpadding=0> +<tr> + <td> + <a href="manual.html"> + <img width="20" src = "../images/u_arrow.gif" alt = "manual"> + </a> + </td> +<td align=center width="100%"><font size="6" color = "#ffffff">Options</font></td> +<td> + <a href="./install.html"> + <img width="20" src = "../images/l_arrow.gif" alt = "Installation"> + </a> +</td> +<td> + <a href="./alias.html"> + <img width="20" src = "../images/r_arrow.gif" alt = "Alias Format"> + </a> +</td> +</tr> +</table> + + +<p>Since masqmail is intended to replace sendmail, it uses the same +command line options, but not all are implemented. There are also two +additional options, which are unique to masqmail (-qo +<connection> and -g) </p> + +<b>-- </b>option:<br> + +<p>Not a 'real' option, it means that all following arguments are to +be understood as arguments and not as options even if they begin with a +leading dash '-'. Mutt is known to call sendmail with this option.</p> + +<b>-bd </b>option (daemon):<br> + +<p>Run as daemon, accepting connections, usually on port 25 if not +configured differently. This is usually used in the startup script and +together with the -q option (see below).</p> + +<b>-bi </b>option:<br> + +<p>Old sendmail rebuilds its alias database when invoked with this +option. Masqmail ignores it. Masqmail reads directly from the file +given with <b>alias_file</b> in the config file.</p> + +<b>-bp </b>option:<br> + +<p>Show the messages in the queue. Same as calling masqmail as +'mailq'.</p> + +<b>-bs </b>option:<br> + +<p>Accept SMTP commands from stdin. Some mailers (eg pine) use this +option as an interface. It can also be used to call masqmail from +inetd, according to Tomislav Filipcic this works.</p> + +<b>-B<arg></b>option:<br> + +<p>arg is usually 8BITMIME. Some mailers use this to indicate that the +message contains characters > 127. Masqmail is 8-bit clean and +ignores this, so you do not have to recompile elm, which is very +painful ;-). Note though that this violates some conventions: masqmail +<em>does not</em> convert 8 bit messages to any MIME format if it +encounters a mail server which does not advertise its 8BITMIME capability, +masqmail does not advertise this itself. This is the same practice as +that of exim (but different to sendmail).</p> + +<p>This <em>may</em> change in the future, but do not rely on it.</p> + +<b>-C<filename></b>option:<br> + +<p>Use another configuration than /etc/masqmail.conf. Useful for +debugging purposes.</p> + +<b>-d <number> </b>option:<br> + +<p>Set the debug level. This takes precedence before the value of +<b>debug_level</b> in the configuration file. Read the warning in the +description of the latter.</p> + +<b>-g </b>option:<br> + +<p>Get mail, using the configurations given with +<b>get.<name></b> in the main configuration.</p> + +<b>-i </b>option:<br> + +<p>Same as <b>-oi</b>, see below.</p> + +<b>-oem </b>option:<br> + +<p>If the <b>-oi</b> ist not also given, always return with a non zero +return code. Maybe someone tells me what this is good for... </p> + +<b>-odb </b>option:<br> + +<p>Deliver in background. Masqmail always does this.</p> + +<b>-odq </b>option:<br> + +<p>Do not attempt to deliver immediately. Any messages will be queued +until the next queue running process picks them up and delivers +them. You get the same effect by setting the <i>do_queue</i> option in +/etc/masqmail.conf.</p> + +<b>-oi </b>option:<br> + +<p>A dot as a single character in a line does <em>not</em> terminate +the message.</p> + +<b>-q </b>option:<br> + +<p>If not given with an argument, run a queue process, ie. try to +deliver all messages in the queue. Masqmail sends only to those +addresses that are on the <em>local</em> net, not to those that are +outside. Use -qo <connection> for those.</p> + +<p>If you have configured inetd to start masqmail, you can use this +option in a cron job which starts in regular time intervals, to mimic +the same effect as starting masqmail with -bd -q30m.</p> + +<p>An argument may be a time interval ie. a numerical value followed +by one of the letters. s,m,h,d,w which are interpreted as seconds, +minutes, hours, days or weeks respectively. Example: -q30m. Masqmail +starts as a daemon and a queue runner process will be started +automatically once in this time interval. This is usually used +together with -bd (see above).</p> + +<b>-qo<name> </b>option:<br> + +<p>Can be followed by a connection name. Use this option in your +script which starts as soon as a link to the internet has been set up +(usually ip-up). When masqmail is called with this option, the +specified route configuration is read and the queued mail with +destinations on the internet will be sent. The <b>name</b> is defined +in the configuration (see <b>connect_route.<name></b>).</p> + +<p>If called without <name>, the online status is determined with +the configured method (see <b>online_detect</b> in <a +href="config.html">config.html</a>)</p> + +<b>-t </b>option:<br> + +<p>Read recipients from headers. Delete 'Bcc:' headers. If any +arguments are given, these are interpreted as recipient addresses and +the message will <em>not</em> be sent to these.</p> + </td></tr> + + <tr><td> + <p> + <hr> + <address><a href = "mailto:kurth@innominate.de">Oliver Kurth</a></address> + Last modified: Tue May 30 15:19:56 CEST 2000 + <br> + This page was created using <a href="http://www.freddyfrog.com/hacks/genpage/">Genpage</a> - Version: 1.0.6 + </p> + + </table> + </center> + + </BODY> +</HEAD> +