]> diplodocus.org Git - nmh/blob - man/post.man
Reorder configure options to be before variables
[nmh] / man / post.man
1 .TH POST %manext8% 2016-10-17 "%nmhversion%"
2 .
3 .\" %nmhwarning%
4 .
5 .SH NAME
6 post \- deliver an nmh message
7 .SH SYNOPSIS
8 .HP 5
9 .na
10 .B %nmhlibexecdir%/post
11 .RB [ \-help ]
12 .RB [ \-version ]
13 .RB [ \-alias
14 .IR aliasfile ]
15 .RB [ \-filter
16 .IR filterfile ]
17 .RB [ \-nofilter ]
18 .RB [ \-format " | " \-noformat ]
19 .RB [ \-mime " | " \-nomime ]
20 .RB [ \-msgid " | " \-nomsgid ]
21 .RB [ \-messageid
22 .IR localname " | " random ]
23 .RB [ \-verbose " | " \-noverbose ]
24 .RB [ \-watch " | " \-nowatch ]
25 .RB [ \-width
26 .IR columns ]
27 .RB [ \-mts
28 .IR smtp " | " sendmail/smtp " | " sendmail/pipe ]
29 .RB [ \-sendmail
30 .IR program ]
31 .RB [ \-server
32 .IR servername ]
33 .RB [ \-port
34 .IR portname/number ]
35 .RB [ \-sasl ]
36 .RB [ \-nosasl ]
37 .RB [ \-saslmech
38 .IR mechanism ]
39 .RB [ \-user
40 .IR username ]
41 .RB [ \-tls ]
42 .RB [ \-initialtls ]
43 .RB [ \-notls ]
44 .I file
45 .ad
46 .SH DESCRIPTION
47 .B post
48 is the default program called by
49 .B send
50 to deliver the message in
51 .I file
52 to local and remote users.
53 In fact, most of the features attributed to
54 .B send
55 in its manual page are performed by
56 .BR post ,
57 with
58 .B send
59 acting as a relatively simple preprocessor.
60 Thus, it is
61 .B post
62 which parses the various header fields, appends a
63 \*(lqDate:\*(rq line, and interacts with the mail transport system.
64 .B post
65 will not normally be called directly by the user, but can be replaced
66 by the user with a
67 .I postproc
68 profile component that will have
69 .I file
70 as its final argument.
71 See
72 .IR mh-profile (5)
73 for more information on postproc.
74 .PP
75 .B post
76 searches the \*(lqTo:\*(rq, \*(lqcc:\*(rq, \*(lqBcc:\*(rq,
77 \*(lqFcc:\*(rq, and \*(lqResent\-xxx:\*(rq header lines of the specified
78 message for destination addresses, checks these addresses for validity,
79 and formats them so as to conform to ARPAnet Internet Message Format
80 protocol, unless the
81 .B \-noformat
82 flag is set. This will normally cause
83 \*(lq@\fIlocal\-site\fR\*(rq to be appended to each local destination
84 address, as well as any local return addresses. The
85 .B \-width
86 .I columns
87 switch can be used to indicate the preferred length of the header
88 components that contain addresses.
89 .PP
90 If a \*(lqBcc:\*(rq field is encountered, its addresses will be used for
91 delivery, and the \*(lqBcc:\*(rq field will be removed from the message
92 sent to sighted recipients. The blind recipients will receive an entirely
93 new message with a minimal set of headers. The body of this new message
94 will contain a copy of the message sent to the sighted recipients, either
95 marked up with the indicator text "Blind-Carbon-Copy" or encapsulated
96 as a MIME digest.
97 .PP
98 If
99 .B \-filter
100 .I filterfile
101 is specified, then this copy is filtered (re-formatted) by
102 .B mhl
103 prior to being sent to the blind recipients.
104 Alternately, if the
105 .B \-mime
106 switch is given, then
107 .B post
108 will use the MIME rules for encapsulation.
109 .PP
110 If a \*(lqDcc:\*(rq field is encountered and the
111 .B sendmail/pipe
112 mail transport method is not in use, its addresses will be used for
113 delivery, and the \*(lqDcc:\*(rq field will be removed from the message. The
114 blind recipients will receive exactly the same message as the sighted
115 recipients. *WARNING* Recipients listed in the \*(lqDcc:\*(rq field receive no
116 explicit indication that they have received a \*(lqblind copy\*(rq.
117 This can cause blind recipients to
118 inadvertently reply to all of the sighted recipients of the
119 original message, revealing that they received a blind copy.
120 On the other hand, since a normal reply to a message sent
121 via a \*(lqBcc:\*(rq field
122 will generate a reply only to the sender of the original message,
123 it takes extra effort in most mailers to reply to the included
124 message, and so would usually only be done deliberately, rather
125 than by accident.
126 .PP
127 .B post
128 rejects any message that contains a \*(lqDcc:\*(rq field if the
129 .B sendmail/pipe
130 mail transport method is used.
131 .PP
132 The
133 .B \-alias
134 .I aliasfile
135 switch can be used to specify a file that post should read aliases from.
136 More than one file can be specified, with each being preceded by
137 .BR \-alias .
138 In any event, the primary alias file is read first.
139 .PP
140 The
141 .B \-msgid
142 switch indicates that a \*(lqMessage\-ID:\*(rq or
143 \*(lqResent\-Message\-ID:\*(rq field should be added to the header.
144 .PP
145 The
146 .B \-messageid
147 switch selects the style used for the part appearing after the @
148 in \*(lqMessage\-ID:\*(rq, \*(lqResent\-Message\-ID:\*(rq, and
149 \*(lqContent\-ID:\*(rq header fields. The two acceptable options are
150 .B localname
151 (which is the default),
152 and
153 .BR random .
154 With
155 .BR localname ,
156 the local hostname is used. With
157 .BR random ,
158 a random sequence of characters is used instead. Note that the
159 .B \-msgid
160 switch must be enabled for this switch to have any effect.
161 .PP
162 The
163 .B \-verbose
164 switch indicates that the user should be informed of
165 each step of the posting/filing process.
166 .PP
167 The
168 .B \-watch
169 switch indicates that the user would like to watch the
170 transport system's handling of the message (e.g., local and \*(lqfast\*(rq
171 delivery).
172 .PP
173 Under normal circumstances,
174 .B post
175 uses the \*(lqFrom:\*(rq line in the message draft as the identity of
176 the originating mailbox. A \*(lqFrom:\*(rq line is required in
177 all message drafts. By default the message composition utilities such
178 as
179 .BR comp ,
180 .B repl
181 and
182 .B mhmail
183 will automatically place a \*(lqFrom:\*(rq line in the message draft.
184 There are two ways to override this behavior, however.
185 Note that they apply equally to \*(lqResent\-From:\*(rq lines in messages sent
186 with
187 .BR dist .
188 .PP
189 The first way is to supply a \*(lqSender:\*(rq line. The value of this
190 field will be used as the originating mailbox identity when submitting the
191 message to the mail transport system. If multiple addresses are
192 given in the \*(lqFrom:\*(rq line, a \*(lqSender:\*(rq line is
193 .BR required .
194 If an \*(lqEnvelope-From:\*(rq line is supplied when multiple addresses
195 are given in the \*(lqFrom:\*(rq line, a \*(lqSender:\*(rq header will
196 be generated using the value of the \*(lqEnvelope-From:\*(rq line,
197 .B if
198 the \*(lqEnvelope-From:\*(rq line is not blank.
199 .PP
200 The second way is to supply a \*(lqEnvelope-From:\*(rq line. The value
201 of this field will be used as the originating mailbox identity when
202 submitting the message to the mail transport system. This will override
203 both the value of the \*(lqFrom:\*(rq line and a \*(lqSender:\*(rq line
204 (if one is supplied). The \*(lqEnvelope-From:\*(rq line is allowed to
205 have a blank value; if the value is blank, then the mail transport system
206 will be instructed to not send any bounces in response to the message.
207 Not all mail transport systems support this feature.
208 .PP
209 The mail transport system default is defined in
210 .I %nmhetcdir%/mts.conf
211 but can be overridden here with the
212 .B \-mts
213 switch.
214 .PP
215 If nmh is using
216 .B sendmail/pipe
217 or
218 .B sendmail/smtp
219 as its mail transport system, the
220 .B \-sendmail
221 switch can be used to override the default
222 .B sendmail
223 program.
224 .PP
225 If nmh is using the SMTP MTA, the
226 .B \-server
227 and
228 .B \-port
229 switches can be used to override the default mail server and port.
230 The default server is set with
231 .I servers
232 in
233 .IR %nmhetcdir%/mts.conf ,
234 and the default port is
235 .IR submission ,
236 587.
237 .PP
238 If
239 .B nmh
240 has been compiled with SASL support, the
241 .B \-sasl
242 and
243 .B \-nosasl
244 switches will enable and disable
245 the use of SASL authentication with the SMTP MTA. Depending on the
246 SASL mechanism used, this may require an additional password prompt from the
247 user (but the
248 .I netrc
249 file can be used to store this password, as described in
250 .IR mh-profile (5).
251 The
252 .B \-saslmech
253 switch can be used to select a particular SASL mechanism,
254 and the
255 .B \-user
256 switch can be used to select an authorization userid to provide to SASL,
257 other than the default. The credentials profile entry in
258 .IR mh-profile (5)
259 describes the ways to supply a username and password.
260 .PP
261 If SASL authentication is successful,
262 nmh
263 will attempt to negotiate a security layer for session encryption.
264 Encrypted data is labelled with `(sasl-encrypted)' and `(sasl-decrypted)' when
265 viewing the SMTP transaction with the
266 .B \-snoop
267 switch.
268 Base64-encoded data is wrapped with `b64<>'.
269 (Beware that the SMTP transaction may contain authentication information either
270 in plaintext or easily decoded base64.)
271 .PP
272 If
273 .B nmh
274 has been compiled with TLS support, the
275 .B \-tls
276 and
277 .B \-initialtls
278 switches will require the negotiation of TLS when connecting to the SMTP MTA.
279 The
280 .B \-tls
281 switch will negotiate TLS as part of the normal SMTP protocol
282 using the STARTTLS command. The
283 .B \-initialtls
284 will negotiate TLS immediately after the connection has
285 taken place, before any SMTP commands are sent or received. Encrypted data
286 is labelled with `(tls-encrypted)' and
287 `(tls-decrypted)' when viewing the SMTP transaction with the
288 .B \-snoop
289 switch.
290 Base64-encoded data is wrapped with `b64<>'.
291 (Beware that the SMTP transaction may contain authentication information either
292 in plaintext or easily decoded base64.)
293 The
294 .B \-notls
295 switch will disable all attempts to negotiate TLS.
296 .PP
297 If port 465 is specified and none of the TLS switches were enabled,
298 .B \-initialtls
299 will be implied if TLS support was compiled in. Though port 465 for
300 SMTPS (SMTP over SSL) was deregistered by IANA in 1998, it is still
301 used for that service.
302 .PP
303 .B post
304 filters out header lines with names beginning with \*(lqNmh-\*(rq
305 (case insensitive) from the message draft.
306 Those lines are reserved for internal
307 .B nmh
308 use.
309 .SH FILES
310 .fc ^ ~
311 .nf
312 .ta \w'%nmhetcdir%/ExtraBigFileName 'u
313 ^%nmhetcdir%/mts.conf~^nmh mts configuration file
314 ^%nmhetcdir%/MailAliases~^global nmh alias file
315 ^%bindir%/refile~^Program to process Fcc:s
316 ^%nmhlibexecdir%/mhl~^Program to process Bcc:s
317 .fi
318 .SH "PROFILE COMPONENTS"
319 .B post
320 does
321 .I not
322 consult the user's
323 .I \&.mh_profile
324 .SH "SEE ALSO"
325 .IR mhmail (1),
326 .IR send (1),
327 .IR mh\-mail (5),
328 .IR mh\-alias (5),
329 .IR mh\-profile (5),
330 .IR mh\-tailor (5)
331 .PP
332 .I "Standard for the Format of ARPA Internet Text Messages"
333 (RFC 822)
334 .SH DEFAULTS
335 .nf
336 .RB ` \-alias "' defaults to %nmhetcdir%/MailAliases"
337 .RB ` \-format '
338 .RB ` \-nomime '
339 .RB ` \-nomsgid '
340 .RB ` "\-messageid\ localname" '
341 .RB ` \-noverbose '
342 .RB ` \-nowatch '
343 .RB ` "\-width\ 72" '
344 .RB ` \-nofilter '
345 .fi
346 .SH CONTEXT
347 None
348 .SH BUGS
349 \*(lqReply\-To:\*(rq fields are allowed to have groups in them according
350 to the RFC 822 specification, but
351 .B post
352 won't let you use them.