5 .\" include the -mh macro file
8 .TH MH-TAILOR %manext5% MH.6.8 [%nmhversion%]
10 mh-tailor, mts.conf \- mail transport customization for nmh message handler
15 \fI%etcdir%/mts.conf\fP
18 The file %etcdir%/mts.conf defines run-time options for those \fInmh\fR
19 programs which interact (in some form) with the message transport system.
20 At present, these (user) programs are: \fIap\fR, \fIconflict\fR,
21 \fIinc\fR, \fImsgchk\fR, \fImsh\fR, \fIpost\fR, \fIrcvdist\fR, and
24 Each option should be given on a single line. Blank lines and lines
25 which begin with `#' are ignored. The options available along with
26 default values and a description of their meanings are listed below:
32 The hostname \fInmh\fR considers local. It should typically be a fully
33 qualified hostname. If this is not set, depending on the version of
34 UNIX you're running, \fInmh\fR will query the system for this value
35 (e.g., uname, gethostname, etc.), and attempt to fully qualify this
38 If you are using POP to retrieve new messages, you may want to set this
39 value to the name of the POP server, so that outgoing message appear to
40 have originated on the POP server.
45 If this is set, a `.' followed by this string will be appended to your
48 This should only be needed, if for some reason \fInmh\fR is not able to
49 fully qualify the hostname returned by the system (e.g., uname,
55 This option specifies the host name that \fInmh\fP will give in the
56 SMTP \fBHELO\fP (and \fBEHLO\fP) command, when posting mail. If not
57 set, the default is to use the host name that \fInmh\fR considers local
58 (see \*(lqlocalname\*(rq above). If this option is set, but empty, no
59 \fBHELO\fP command will be given.
62 Although the \fBHELO\fP command is required by RFC\-821, many SMTP servers
63 do not require it. Early versions of SendMail will fail if the hostname
64 given in the \fBHELO\fP command is the local host. Later versions of
65 SendMail will complain if you omit the \fBHELO\fP command. If you run
66 SendMail, find out what your system expects and set this field if needed.
71 This option is only used for UUCP mail. It specifies the name of the
72 local host in the \fIUUCP\fR \*(lqdomain\*(rq. If not set, depending
73 on the version of UNIX you're running, \fInmh\fR will query the system
74 for this value. This has no equivalent in the \fInmh\fR configuration
80 The directory where maildrops are kept. If this option is set, but empty,
81 the user's home directory is used. This overrides the default value
82 chosen at the time of compilation.
87 The name of the maildrop file in the directory where maildrops are kept.
88 If this is empty, the user's login name is used. This overrides the default
89 value (which is empty).
92 mmdelim1: \\001\\001\\001\\001\\n
94 The beginning-of-message delimiter for maildrops.
97 mmdelim2: \\001\\001\\001\\001\\n
99 The end-of-message delimiter for maildrops.
104 This directive controls three different types of email address masquerading.
105 The three possible values, which may be specified in any combination on the
106 line, separated by spaces, are "draft_from", "mmailid", and
107 "username_extension".
109 "mmailid" was the only type of masquerading in the original MH package, and
110 apparently stands for "masquerade mail identification". This type of
111 masquerading keys off of the GECOS field of the passwd file. When enabled,
112 \fInmh\fR will check if the user's pw_gecos field in the passwd file is of the
116 Full Name <fakeusername>
118 If it is, the internal \fInmh\fR routines that find the username and full name
119 of that user will return "fakeusername" and "Full Name" respectively. This is
120 useful if you want the messages you send to always appear to come from the name
121 of an MTA alias rather than your actual account name. For instance, many
122 organizations set up "First.Last" sendmail aliases for all users. If this is
123 the case, the GECOS field for each user should look like:
126 First [Middle] Last <First.Last>
128 "username_extension", when specified on the "masquerade:" line, allows a second
129 type of username masquerading. If the user sets the \fB$USERNAME_EXTENSION\fR
130 environment variable, its value will be appended to the actual login name. For
131 instance, if I am dan@company.com, and I set \fB$USERNAME_EXTENSION\fR to
132 "\-www", my mail will appear to come from "dan\-www@company.com". This is meant
133 to interact with qmail's "user\-extension" feature, where mail sent to
134 \fIuser\fR\-\fIstring\fR will be delivered to \fIuser\fR. Likewise, those using
135 versions of sendmail for which "plussed user" processing is active can set
136 \fB$USERNAME_EXTENSION\fR to "+\fIstring\fR". These MTA features are useful
137 because they allow one to use different email addresses in different situations
138 (to aid in automatic mail filtering or in determining where spammers got one's
139 address) while only actually having a single account. Note that
140 \fB$USERNAME_EXTENSION\fR is only appended to the username when \fIpost\fR is
141 generating "[Resent\-]From:" lines and the SMTP envelope "From:". \fIinc\fR,
142 for instance, will not try to read from a maildrop file called "dan\-www" (to
143 recall the earlier example).
145 "draft_from" controls the most powerful type of address masquerading. Normally,
146 when a user explicitly specifies a "From:" header in a draft, \fInmh\fR uses it
147 rather than constructing its own. However, to discourage email forgery, the
148 SMTP envelope "From:" and a "Sender:" header are set to the user's real address.
149 When "draft_from" is turned on, though, the envelope "From:" will use the
150 address specified in the draft, and there will be no "Sender:" header. This is
151 useful when a user wants to pretend to be sending mail "directly" from a remote
152 POP3 account, or when remote mail robots incorrectly use the envelope "From:" in
153 preference to the body "From:" (or refuse to take action when the two don't
154 match). Note that the MTA may still reveal the user's real identity (e.g.
155 sendmail's "X\-Authentication\-Warning:" header).
158 maildelivery: %libdir%/maildelivery
160 The name of the system-wide default \fI\&.maildelivery\fR file.
161 See \fIslocal\fR\0(1) for the details.
166 The highest user-id which should NOT receive mail addressed to
172 If set, then each user-id greater than \*(lqeveryone\*(rq that has a
173 login shell equivalent to the given value (e.g., \*(lq/bin/csh\*(rq)
174 indicates that mail for \*(lqeveryone\*(rq should not be sent to them.
175 This is useful for handling admin, dummy, and guest logins.
179 These options are only available if you compiled \fInmh\fP with the
180 \*(lq/smtp\*(rq support.
184 hostable: %etcdir%/hosts
186 The exceptions file for /etc/hosts used by \fIpost\fR to try to find
187 official names. The format of this file is quite simple:
190 1. Comments are surrounded by sharp (`#') and newline.
192 2. Words are surrounded by white space.
194 3. The first word on the line is the official name of a host.
196 4. All words following the official names are aliases for that host.
200 servers: localhost \\01localnet
202 A lists of hosts and networks which to look for SMTP servers when
203 posting local mail. It turns out this is a major win for hosts which
204 don't run an message transport system. The value of \*(lqservers\*(rq
205 should be one or more items. Each item is the name of either a host
206 or a net (in the latter case, precede the name of the net by a \\01).
207 This list is searched when looking for a smtp server to post mail.
208 If a host is present, the SMTP port on that host is tried. If a net
209 is present, the SMTP port on each host in that net is tried. Note that
210 if you are running with the BIND code, then any networks specified are
211 ignored (sorry, the interface went away under BIND).
215 This option is only available if you compiled \fInmh\fP to use
216 \fISendMail\fP as your delivery agent.
220 sendmail: %sendmailpath%
222 The pathname to the \fIsendmail\fR program.
225 .Uh "Post Office Protocol"
226 This option is only available if you have compiled \fInmh\fP with POP
227 support enabled (i.e., \*(lq--enable-pop\*(rq).
233 The name of the default POP service host. If this is not set, then
234 \fInmh\fR looks in the standard maildrop areas for waiting mail, otherwise
235 the named POP service host is consulted.
238 .Uh "BBoards Delivery"
239 This option is only available if you compiled \fInmh\fP with
240 \*(lqbbdelivery:\ on\*(rq.
246 The local BBoards domain (a UCI hack).
249 .Uh "BBoards & The POP"
250 These options are only available if you compiled \fInmh\fP with
251 \*(lqbboards:\ pop\*(rq and \*(lqpop:\ on\*(rq.
257 The POP service host which also acts as a BBoard server. This variable
258 should be set on the POP BBoards client host.
263 The guest account on the POP/BB service host. This should be a different
264 login ID than either the POP user or the BBoards user. (The user-id
265 \*(lqftp\*(rq is highly recommended.) This variable should be set on
266 both the POP BBoards client and service hosts.
269 popbblist: %etcdir%/hosts.popbb
271 A file containing of lists of hosts that are allowed to use the POP
272 facility to access BBoards using the guest account. If this file is not
273 present, then no check is made. This variable should be set on the POP
274 BBoards service host.
278 .Uh "BBoards & The NNTP"
279 This option is only available if you compiled \fInmh\fP with
280 \*(lqbboards:\ nntp\*(rq and \*(lqpop:\ on\*(rq.
286 The host which provides the NNTP service. This variable should be set
287 on the NNTP BBoards client host.
291 A few words on locking: \fInmh\fR has several methods for creating locks
292 on files. When configuring \fInmh\fR, you will need to decide on the
293 locking style and locking directory (if any). The first controls the
294 method of locking, the second says where lock files should be created.
296 To configure \fInmh\fR for kernel locking, define \fBFLOCK_LOCKING\fP if
297 you want to use the \fIflock\fP system call; define \fBLOCKF_LOCKING\fP if
298 you want to use the \fIlockf\fP system call; or define \fBFCNTL_LOCKING\fP
299 if you want to use the \fIfcntl\fP system call for kernel-level locking.
301 Instead of kernel locking, you can configure \fInmh\fR to use dot
302 locking by defining \fBDOT_LOCKING\fP. Dot locking specifies that
303 a file should be created whose existence means \*(lqlocked\*(rq and
304 whose non-existence means \*(lqunlocked\*(rq. The name of this file is
305 constructed by appending \*(lq.lock\*(rq to the name of the file being
306 locked. If \fBLOCKDIR\fP is not specified, lock files will be created
307 in the directory where the file being locked resides. Otherwise, lock
308 files will be created in the directory specified by \fBLOCKDIR\fP.
310 Prior to installing \fInmh\fR, you should see how locking is done at
311 your site, and set the appropriate values.
314 ^%etcdir%/mts.conf~^nmh mts configuration file