|
56
|
1 <body text="#000000" link="#0000ff" bgcolor="#ffffff"><center><table width="80%">
|
|
|
2 <tr><td><h1>masqmail</h1>
|
|
|
3 <h2>An offline Mail Transfer Agent</h2>
|
|
|
4
|
|
|
5
|
|
|
6 <h2>Synopsis</h2>
|
|
|
7 <b>
|
|
|
8 /usr/sbin/masqmail [-C <em>file</em>] [-odq] [-bd] [-q<em>interval</em>]<br>
|
|
|
9
|
|
|
10 /usr/sbin/masqmail [-odq] [-bs]<br>
|
|
|
11
|
|
|
12 /usr/sbin/masqmail [-bp]<br>
|
|
|
13
|
|
|
14 /usr/sbin/masqmail [-q]<br>
|
|
|
15
|
|
|
16 /usr/sbin/masqmail [-qo [<em>name</em>]]<br>
|
|
|
17
|
|
|
18 /usr/sbin/masqmail [-odq] [-g [<em>name</em>]]<br>
|
|
|
19
|
|
|
20 /usr/sbin/masqmail [-odq] [-go [<em>name</em>]]<br>
|
|
|
21
|
|
|
22 /usr/sbin/masqmail [-t] [-oi] [-f <em>address</em>] [--] <em>address...</em><br>
|
|
|
23
|
|
|
24 /usr/sbin/mailq<br>
|
|
|
25
|
|
|
26 </b>
|
|
|
27
|
|
|
28
|
|
|
29 <h2>Description</h2>
|
|
|
30
|
|
|
31 <p>MasqMail is a mail server designed for hosts that do
|
|
|
32 not have a permanent internet connection eg. a home network or a
|
|
|
33 single host at home. It has special support for connections to
|
|
|
34 different ISPs. It replaces sendmail or other MTAs such as qmail or
|
|
|
35 exim. It can also act as a pop3 client.</p>
|
|
|
36
|
|
|
37
|
|
|
38
|
|
|
39 <h2>Options</h2>
|
|
|
40
|
|
|
41 <p>Since masqmail is intended to replace sendmail, it uses the same
|
|
|
42 command line options, but not all are implemented. There are also two
|
|
|
43 additional options, which are unique to masqmail (-qo <em>connection</em> and -g)
|
|
|
44 </p>
|
|
|
45
|
|
|
46
|
|
|
47 <p><b>--</b></p>
|
|
|
48 <p>Not a 'real' option, it means that all following arguments are to
|
|
|
49 be understood as arguments and not as options even if they begin with a
|
|
|
50 leading dash '-'. Mutt is known to call sendmail with this option.</p>
|
|
|
51
|
|
|
52
|
|
|
53
|
|
|
54 <p><b>-bd</b></p>
|
|
|
55 <p>Run as daemon, accepting connections, usually on port 25 if not
|
|
|
56 configured differently. This is usually used in the startup script at system boot and
|
|
|
57 together with the -q option (see below).</p>
|
|
|
58
|
|
|
59
|
|
|
60
|
|
|
61 <p><b>-bi</b></p>
|
|
|
62 <p>Old sendmail rebuilds its alias database when invoked with this
|
|
|
63 option. Masqmail ignores it. Masqmail reads directly from the file
|
|
|
64 given with alias_file in the config file.</p>
|
|
|
65
|
|
|
66
|
|
|
67
|
|
|
68 <p><b>-bp</b></p>
|
|
|
69 <p>Show the messages in the queue. Same as calling masqmail as
|
|
|
70 'mailq'.</p>
|
|
|
71
|
|
|
72
|
|
|
73
|
|
|
74 <p><b>-bs</b></p>
|
|
|
75 <p>Accept SMTP commands from stdin. Some mailers (eg pine) use this
|
|
|
76 option as an interface. It can also be used to call masqmail from
|
|
|
77 inetd.</p>
|
|
|
78
|
|
|
79
|
|
|
80
|
|
|
81 <p><b>-B <em>arg</em></b></p>
|
|
|
82 <p><em>arg</em> is usually 8BITMIME. Some mailers use this
|
|
|
83 to indicate that the message contains characters > 127. Masqmail is
|
|
|
84 8-bit clean and ignores this, so you do not have to recompile elm,
|
|
|
85 which is very painful ;-). Note though that this violates some
|
|
|
86 conventions: masqmail does not convert 8 bit messages to any
|
|
|
87 MIME format if it encounters a mail server which does not advertise
|
|
|
88 its 8BITMIME capability, masqmail does not advertise this itself. This
|
|
|
89 is the same practice as that of exim (but different to
|
|
|
90 sendmail).</p>
|
|
|
91
|
|
|
92
|
|
|
93 <p><b>-bV </b></p>
|
|
|
94 <p>Show version information.</p>
|
|
|
95
|
|
|
96
|
|
|
97
|
|
|
98
|
|
|
99 <p><b>-C </b><em>filename</em></p>
|
|
|
100 <p>Use another configuration than <em>/etc/masqmail/masqmail.conf</em>. Useful for
|
|
|
101 debugging purposes. If not invoked by a privileged user, masqmail will drop all privileges.
|
|
|
102 </p>
|
|
|
103
|
|
|
104
|
|
|
105
|
|
|
106 <p><b>-d <em>number</em></b></p>
|
|
|
107
|
|
|
108 <p>Set the debug level. This takes precedence before the value of
|
|
|
109 debug_level in the configuration file. Read the warning in the
|
|
|
110 description of the latter.
|
|
|
111 </p>
|
|
|
112
|
|
|
113
|
|
|
114
|
|
|
115
|
|
|
116 <p><b>-f [<em>address</em>]</b></p>
|
|
|
117
|
|
|
118 <p>Set the return path address to <em>address</em>. Only root, the
|
|
|
119 user mail and anyoune in group trusted is allowed to do that.</p>
|
|
|
120
|
|
|
121
|
|
|
122
|
|
|
123
|
|
|
124 <p><b>-F [<em>string</em>]</b></p>
|
|
|
125
|
|
|
126 <p>Set the full sender name (in the From: header)
|
|
|
127 to <em>string</em>.</p>
|
|
|
128
|
|
|
129
|
|
|
130
|
|
|
131
|
|
|
132 <p><b>-g [<em>name</em>]</b></p>
|
|
|
133
|
|
|
134 <p>Get mail (using pop3 or apop), using the configurations given
|
|
|
135 with get.<em>name</em> in the main configuration. Without <em>name</em>,
|
|
|
136 all get configurations will be used. See also <a href="masqmail.get.5.html">masqmail.get</a></p>
|
|
|
137
|
|
|
138
|
|
|
139
|
|
|
140
|
|
|
141 <p><b>-go [<em>interval</em>] [<em>name</em>]</b></p>
|
|
|
142
|
|
|
143 <p>Can be followed by a connection name. Use this option in your
|
|
|
144 script which starts as soon as a link to the internet has been set up
|
|
|
145 (usually ip-up). When masqmail is called with this option, the
|
|
|
146 specified get configuration(s) is(are) read and mail will be
|
|
|
147 retrieved from servers on the internet.
|
|
|
148 The <em>name</em> is defined
|
|
|
149 in the configuration (see <b>online_gets.<em>name</em></b>).
|
|
|
150 </p><p>
|
|
|
151 If called with an interval option (recognized by a digit
|
|
|
152 as the first characater), masqmail starts as a daemon and tries to
|
|
|
153 get mail in these intervals. It checks for the online status first.
|
|
|
154 Example: masqmail -go 5m will retrieve mail
|
|
|
155 all five minutes.
|
|
|
156 </p><p>
|
|
|
157 If called without <em>name</em> the online status is determined with
|
|
|
158 the configured method (see <b>online_detect</b> in config.html).
|
|
|
159 </p>
|
|
|
160
|
|
|
161
|
|
|
162
|
|
|
163
|
|
|
164 <p><b>-i</b></p>
|
|
|
165 <p>Same as -oi, see below.</p>
|
|
|
166
|
|
|
167
|
|
|
168
|
|
|
169 <p><b>-Mrm <em>list</em></b></p>
|
|
|
170 <p>Remove given messages from the queue. Only allowed for privileged users.</p>
|
|
|
171
|
|
|
172
|
|
|
173
|
|
|
174 <p><b>-oem</b></p>
|
|
|
175 <p>If the -oi ist not also given, always return with a non zero
|
|
|
176 return code. Maybe someone tells me what this is good for...</p>
|
|
|
177
|
|
|
178
|
|
|
179
|
|
|
180 <p><b>-odb</b></p>
|
|
|
181 <p>Deliver in background. Masqmail always does this, which
|
|
|
182 makes this option pretty much useless.</p>
|
|
|
183
|
|
|
184
|
|
|
185
|
|
|
186 <p><b>-odq</b></p>
|
|
|
187 <p>Do not attempt to deliver immediately. Any messages will be queued
|
|
|
188 until the next queue running process picks them up and delivers
|
|
|
189 them. You get the same effect by setting the do_queue option in
|
|
|
190 /etc/masqmail/masqmail.conf.</p>
|
|
|
191
|
|
|
192
|
|
|
193
|
|
|
194 <p><b>-oi</b></p>
|
|
|
195 <p>A dot as a single character in a line does not terminate
|
|
|
196 the message.</p>
|
|
|
197
|
|
|
198
|
|
|
199
|
|
|
200 <p><b>-q [<em>interval</em>]</b></p>
|
|
|
201 <p>If not given with an argument, run a queue process, ie. try to
|
|
|
202 deliver all messages in the queue. Masqmail sends only to those
|
|
|
203 addresses that are on the local net, not to those that are
|
|
|
204 outside. Use -qo for those.</p>
|
|
|
205 <p>
|
|
|
206 If you have configured inetd to start masqmail, you can use this
|
|
|
207 option in a cron job which starts in regular time intervals, to mimic
|
|
|
208 the same effect as starting masqmail with -bd -q30m.
|
|
|
209 </p><p>
|
|
|
210 An argument may be a time interval ie. a numerical value followed
|
|
|
211 by one of the letters. s,m,h,d,w which are interpreted as seconds,
|
|
|
212 minutes, hours, days or weeks respectively. Example: -q30m. Masqmail
|
|
|
213 starts as a daemon and a queue runner process will be started
|
|
|
214 automatically once in this time interval. This is usually used
|
|
|
215 together with -bd (see above).
|
|
|
216 </p>
|
|
|
217
|
|
|
218
|
|
|
219
|
|
|
220
|
|
|
221 <p><b>-qo [<em>name</em>]</b></p>
|
|
|
222
|
|
|
223 <p>Can be followed by a connection name. Use this option in your
|
|
|
224 script which starts as soon as a link to the internet has been set up
|
|
|
225 (usually ip-up). When masqmail is called with this option, the
|
|
|
226 specified route configuration is read and the queued mail with
|
|
|
227 destinations on the internet will be sent. The <em>name</em> is defined
|
|
|
228 in the configuration (see <b>online_routes.<em>name</em></b>).
|
|
|
229 </p><p>
|
|
|
230 If called without <em>name</em> the online status is determined with
|
|
|
231 the configured method (see <b>online_detect</b> in config.html)
|
|
|
232 </p>
|
|
|
233
|
|
|
234
|
|
|
235
|
|
|
236
|
|
|
237 <p><b>-t</b></p>
|
|
|
238 <p>Read recipients from headers. Delete 'Bcc:' headers. If any
|
|
|
239 arguments are given, these are interpreted as recipient addresses and
|
|
|
240 the message will not be sent to these.</p>
|
|
|
241
|
|
|
242
|
|
|
243
|
|
|
244 <p><b>-v</b></p>
|
|
|
245 <p>Log also to stdout. Currently, some log messages are
|
|
|
246 marked as 'write to stdout' and additionally, all messages with
|
|
|
247 priority 'LOG_ALERT' and 'LOG_WARNING' will be written to stdout
|
|
|
248 if this option is given. It is disabled in daemon mode.
|
|
|
249 </p>
|
|
|
250
|
|
|
251
|
|
|
252
|
|
|
253
|
|
|
254 <h2>Environment for pipes and mdas</h2>
|
|
|
255
|
|
|
256
|
|
|
257 <p>For security reasons, before any pipe command from an alias
|
|
|
258 expansion or an mda is called, the environment variables will be
|
|
|
259 completely discarded and newly set up. These are:</p>
|
|
|
260 <p>SENDER, RETURN_PATH - the return path.</p>
|
|
|
261 <p>SENDER_DOMAIN - the domain part of the return path.</p>
|
|
|
262 <p>SENDER_LOCAL - the local part of the return path.</p>
|
|
|
263 <p>RECEIVED_HOST - the host the message was received from (unless local).</p>
|
|
|
264 <p>LOCAL_PART, USER, LOGNAME - the local part of the (original) recipient.</p>
|
|
|
265 <p>MESSAGE_ID - the unique message id. This is not necessarily identical with the Message ID as given in the Message ID: header.</p>
|
|
|
266 <p>QUALIFY_DOMAIN - the domain which will be appended to unqualified addresses.</p>
|
|
|
267
|
|
|
268
|
|
|
269
|
|
|
270
|
|
|
271 <h2>Files</h2>
|
|
|
272
|
|
|
273 <p><em>/etc/masqmail/masqmail.conf</em> is the main configuration
|
|
|
274 for masqmail. Depending on the settings in this file, you will also
|
|
|
275 have other configuration files in <em>/etc/masqmail/</em>.</p>
|
|
|
276 <p><em>/etc/aliases</em> is the alias file, if not set differently
|
|
|
277 in <em>/etc/masqmail/masqmail.conf</em>.</p>
|
|
|
278 <p><em>/var/spool/masqmail/</em> is the spool directory where masqmail
|
|
|
279 stores its spooled messages and the uniq pop ids.</p>
|
|
|
280 <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>
|
|
|
281 <p><em>/var/log/masqmail/</em> is the directory where masqmail stores
|
|
|
282 its log mesages. This can also be somewhere else if configured
|
|
|
283 differently by your sysadmin or the package mantainer.</p>
|
|
|
284
|
|
|
285
|
|
|
286
|
|
|
287 <h2>Conforming to</h2>
|
|
|
288
|
|
|
289 <p>RFC 821, 822, 1869, 1870, 2197, 2554 (SMTP)</p>
|
|
|
290 <p>RFC 1725, 1939 (POP3)</p>
|
|
|
291 <p>RFC 1321 (MD5)</p>
|
|
|
292 <p>RFC 2195 (CRAM-MD5)</p>
|
|
|
293
|
|
|
294
|
|
|
295
|
|
|
296 <h2>Author</h2>
|
|
|
297
|
|
|
298 <p>masqmail was written by Oliver Kurth
|
|
|
299 <oku@masqmail.cx></p><p>You will find the newest version of
|
|
|
300 masqmail at <a href = "http://masqmail.cx/masqmail/">http://masqmail.cx/masqmail/</a> or search for it
|
|
|
301 in freshmeat (<a href = "http://www.freshmeat.net">http://www.freshmeat.net</a>). There is also a mailing list,
|
|
|
302 you will find information about it at masqmails main site.</p>
|
|
|
303
|
|
|
304
|
|
|
305
|
|
|
306 <h2>Bugs</h2>
|
|
|
307
|
|
|
308 <p>You should report them to the mailing list.</p>
|
|
|
309
|
|
|
310
|
|
|
311
|
|
|
312 <h2>See also</h2>
|
|
|
313
|
|
|
314 <p>
|
|
|
315 <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>
|
|
|
316 </p>
|
|
|
317
|
|
|
318
|
|
|
319
|
|
|
320 <h2>Comments</h2>
|
|
|
321
|
|
|
322 <p>This man page was written using <a href="http://masqmail.cx/xml2man/">xml2man</a> by the same author.</p>
|
|
|
323
|
|
|
324
|
|
|
325
|
|
|
326 </td></tr></table></center>
|
|
|
327 </body>
|
