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