masqmail: 0241aaccfcdb docs/old-manual/docs/masqmail.8.html

masqmail

view docs/old-manual/docs/masqmail.8.html @ 206:0241aaccfcdb

default listen_addresses: use 127.0.0.1 instead of `localhost' because `localhost' could be bound to some other IP address. This is unlikely but could be. Using 127.0.0.1 is more safe. See mailing list for details

author	meillo@marmaro.de
date	Sat, 17 Jul 2010 00:34:40 +0200
parents
children

line source

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>

6 <h2>Synopsis</h2>

7

8 /usr/sbin/masqmail [-C file] [-odq] [-bd] [-qinterval]

10 /usr/sbin/masqmail [-odq] [-bs]

12 /usr/sbin/masqmail [-bp]

14 /usr/sbin/masqmail [-q]

16 /usr/sbin/masqmail [-qo [name]]

18 /usr/sbin/masqmail [-odq] [-g [name]]

20 /usr/sbin/masqmail [-odq] [-go [name]]

22 /usr/sbin/masqmail [-t] [-oi] [-f address] [--] address...

24 /usr/sbin/mailq

26

29 <h2>Description</h2>

31 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.

39 <h2>Options</h2>

41 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 connection and -g)

44

47 --

48 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.

54 -bd

55 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).

61 -bi

62 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.

68 -bp

69 Show the messages in the queue. Same as calling masqmail as

70 'mailq'.

74 -bs

75 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.

81 -B arg

82 arg 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).

93 -bV

94 Show version information.

99 -C filename

100 Use another configuration than /etc/masqmail/masqmail.conf. Useful for

101 debugging purposes. If not invoked by a privileged user, masqmail will drop all privileges.

102

103

104

105

106 -d number

107

108 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

112

113

114

115

116 -f [address]

117

118 Set the return path address to address. Only root, the

119 user mail and anyoune in group trusted is allowed to do that.

120

121

122

123

124 -F [string]

125

126 Set the full sender name (in the From: header)

127 to string.

128

129

130

131

132 -g [name]

133

134 Get mail (using pop3 or apop), using the configurations given

135 with get.name in the main configuration. Without name,

136 all get configurations will be used. See also <a href="masqmail.get.5.html">masqmail.get</a>

137

138

139

140

141 -go [interval] [name]

142

143 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 name is defined

149 in the configuration (see online_gets.name).

150

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

157 If called without name the online status is determined with

158 the configured method (see online_detect in config.html).

159

160

161

162

163

164 -i

165 Same as -oi, see below.

166

167

168

169 -Mrm list

170 Remove given messages from the queue. Only allowed for privileged users.

171

172

173

174 -oem

175 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...

177

178

179

180 -odb

181 Deliver in background. Masqmail always does this, which

182 makes this option pretty much useless.

183

184

185

186 -odq

187 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.

191

192

193

194 -oi

195 A dot as a single character in a line does not terminate

196 the message.

197

198

199

200 -q [interval]

201 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.

205

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

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

217

218

219

220

221 -qo [name]

222

223 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 name is defined

228 in the configuration (see online_routes.name).

229

230 If called without name the online status is determined with

231 the configured method (see online_detect in config.html)

232

233

234

235

236

237 -t

238 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.

241

242

243

244 -v

245 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

250

251

252

253

254 <h2>Environment for pipes and mdas</h2>

255

256

257 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:

260 SENDER, RETURN_PATH - the return path.

261 SENDER_DOMAIN - the domain part of the return path.

262 SENDER_LOCAL - the local part of the return path.

263 RECEIVED_HOST - the host the message was received from (unless local).

264 LOCAL_PART, USER, LOGNAME - the local part of the (original) recipient.

265 MESSAGE_ID - the unique message id. This is not necessarily identical with the Message ID as given in the Message ID: header.

266 QUALIFY_DOMAIN - the domain which will be appended to unqualified addresses.

267

268

269

270

271 <h2>Files</h2>

272

273 /etc/masqmail/masqmail.conf is the main configuration

274 for masqmail. Depending on the settings in this file, you will also

275 have other configuration files in /etc/masqmail/.

276 /etc/aliases is the alias file, if not set differently

277 in /etc/masqmail/masqmail.conf.

278 /var/spool/masqmail/ is the spool directory where masqmail

279 stores its spooled messages and the uniq pop ids.

280 /var/spool/mail/ is the directory where locally delivered mail will be put, if not configured differently in masqmail.conf.

281 /var/log/masqmail/ 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.

284

285

286

287 <h2>Conforming to</h2>

288

289 RFC 821, 822, 1869, 1870, 2197, 2554 (SMTP)

290 RFC 1725, 1939 (POP3)

291 RFC 1321 (MD5)

292 RFC 2195 (CRAM-MD5)

293

294

295

296 <h2>Author</h2>

297

298 masqmail was written by Oliver Kurth

299 <oku@masqmail.cx>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.

303

304

305

306 <h2>Bugs</h2>

307

308 You should report them to the mailing list.

309

310

311

312 <h2>See also</h2>

313

314

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

317

318

319

320 <h2>Comments</h2>

321

322 This man page was written using <a href="http://masqmail.cx/xml2man/">xml2man</a> by the same author.

323

324

325

326 </td></tr></table></center>

327 </body>