Removed mmailid masquerading.
[mmh] / man / mh-tailor.man5
1 .\"
2 .\" %nmhwarning%
3 .\"
4 .TH MH-TAILOR %manext5% "%nmhdate%" MH.6.8 [%nmhversion%]
5 .SH NAME
6 mh-tailor, mts.conf \- mail transport customization for nmh message handler
7 .SH SYNOPSIS
8 .I %etcdir%/mts.conf
9 .SH DESCRIPTION
10 The file
11 .I %etcdir%/mts.conf
12 defines run-time options for those
13 .B nmh
14 programs which interact (in some form) with the message transport system.
15 At present, these (user) programs are:
16 .BR ap ,
17 .BR conflict ,
18 .BR inc ,
19 .BR msgchk ,
20 .BR post ,
21 .BR rcvdist ,
22 and
23 .BR rcvpack .
24 .PP
25 Each option should be given on a single line.  Blank lines and lines
26 which begin with `#' are ignored.  The options available along with
27 default values and a description of their meanings are listed below:
28 .PP
29 .B spost
30 will send messages by forking a
31 local copy of
32 .BR sendmail .
33 .PP
34 .BR masquerade:
35 .RS 5
36 This directive controls two different types of email address masquerading.
37 The two possible values, which may be specified in any combination on the
38 line, separated by spaces, are \*(lqdraft_from\*(rq and
39 \*(lqusername_extension\*(rq.
40 .PP
41 \*(lqusername_extension\*(rq, when specified on the \*(lqmasquerade:\*(rq line, allows a second
42 type of username masquerading.  If the user sets the
43 .B $USERNAME_EXTENSION
44 environment variable, its value will be appended to the actual login name.  For
45 instance, if I am \*(lqdan@company.com\*(rq, and I set
46 .B $USERNAME_EXTENSION
47 to \*(lq\-www\*(rq, my mail will appear to come from \*(lqdan\-www@company.com\*(rq.  This is meant
48 to interact with qmail's \*(lquser\-extension\*(rq feature, where mail sent to
49 .IR user \- string
50 will be delivered to
51 .IR user .
52 Likewise, those using
53 versions of sendmail for which \*(lqplussed user\*(rq processing is active can set
54 .B $USERNAME_EXTENSION
55 to \*(lq+\fIstring\fR\*(rq.  These MTA features are useful
56 because they allow one to use different email addresses in different situations
57 (to aid in automatic mail filtering or in determining where spammers got one's
58 address) while only actually having a single account.  Note that
59 .B $USERNAME_EXTENSION
60 is only appended to the username when \fIpost\fR is
61 generating \*(lq[Resent\-]From:\*(rq lines and the SMTP envelope
62 \*(lqFrom:\*(rq.
63 .BR inc ,
64 for instance, will not try to read from a maildrop file called \*(lqdan\-www\*(rq (to
65 recall the earlier example).
66 .PP
67 \*(lqdraft_from\*(rq controls the most powerful type of address masquerading.  Normally,
68 when a user explicitly specifies a \*(lqFrom:\*(rq header in a draft,
69 .B nmh
70 uses it
71 rather than constructing its own.  However, to discourage email forgery, the
72 SMTP envelope \*(lqFrom:\*(rq and a \*(lqSender:\*(rq header are set to the user's real address.
73 When \*(lqdraft_from\*(rq is turned on, though, the envelope \*(lqFrom:\*(rq will use the
74 address specified in the draft, and there will be no \*(lqSender:\*(rq header.  This is
75 useful when a user wants to pretend to be sending mail \*(lqdirectly\*(rq from a remote
76 POP3 account, or when remote mail robots incorrectly use the envelope \*(lqFrom:\*(rq in
77 preference to the body \*(lqFrom:\*(rq (or refuse to take action when the two don't
78 match).  Note that the MTA may still reveal the user's real identity (e.g.
79 .BR sendmail 's
80 \*(lqX\-Authentication\-Warning:\*(rq header).
81 .RE
82 .PP
83 .BR maildelivery :
84 %libdir%/maildelivery
85 .RS 5
86 The name of the system-wide default
87 .I maildelivery
88 file.
89 See
90 .BR slocal (1)
91 for the details.
92 .SS "File Locking"
93 A few words on locking:
94 .B nmh
95 has several methods for creating locks
96 on files.  When configuring
97 .BR nmh ,
98 you will need to decide on the
99 locking style and locking directory (if any).  The first controls the
100 method of locking, the second says where lock files should be created.
101 .PP
102 To configure
103 .B nmh
104 for kernel locking, use the \*(lq--with-locking=flock\*(rq configure option if
105 you want to use the
106 .B flock
107 system call; use \*(lq--with-locking=lockf\*(rq if
108 you want to use the
109 .B lockf
110 system call; or use \*(lq--with-locking=fcntl\*(rq
111 if you want to use the
112 .B fcntl
113 system call for kernel-level locking.
114 .PP
115 Instead of kernel locking, you can configure
116 .B nmh
117 to use dot locking by using \*(lq--with-locking=dot\*(rq.  Dot locking
118 specifies that
119 a file should be created whose existence means \*(lqlocked\*(rq and
120 whose non-existence means \*(lqunlocked\*(rq.  The name of this file is
121 constructed by appending \*(lq.lock\*(rq to the name of the file being
122 locked.  If
123 .B LOCKDIR
124 is not specified, lock files will be created
125 in the directory where the file being locked resides.  Otherwise, lock
126 files will be created in the directory specified by
127 .BR LOCKDIR .
128 .PP
129 Prior to installing
130 .BR nmh ,
131 you should see how locking is done at
132 your site, and set the appropriate values.
133
134 .SH FILES
135 .fc ^ ~
136 .nf
137 .ta \w'%etcdir%/ExtraBigFileName  'u
138 ^%etcdir%/mts.conf~^nmh mts configuration file
139 .fi
140
141 .SH "PROFILE COMPONENTS"
142 None
143
144 .SH "SEE ALSO"
145 mh\-mts(8), post(8)
146
147 .SH DEFAULTS
148 As listed above