]> diplodocus.org Git - nmh/blob - man/send.man
Added note that suffixes were removed from filenames of temporary files.
[nmh] / man / send.man
1 .\"
2 .\" %nmhwarning%
3 .\"
4 .TH SEND %manext1% "January 23, 2014" "%nmhversion%"
5 .SH NAME
6 send \- send a message
7 .SH SYNOPSIS
8 .HP 5
9 .na
10 .B send
11 .RB [ \-alias
12 .IR aliasfile ]
13 .RB [ \-draft ]
14 .RB [ \-draftfolder
15 .IR +folder ]
16 .RB [ \-draftmessage
17 .IR msg ]
18 .RB [ \-nodraftfolder ]
19 .RB [ \-filter
20 .IR filterfile ]
21 .RB [ \-nofilter ]
22 .RB [ \-format " | " \-noformat ]
23 .RB [ \-forward " | " \-noforward ]
24 .RB [ \-mime " | " \-nomime ]
25 .RB [ \-msgid " | " \-nomsgid ]
26 .RB [ \-messageid
27 .IR localname " | " random ]
28 .RB [ \-push " | " \-nopush ]
29 .RB [ \-split
30 .IR seconds ]
31 .RB [ \-verbose " | " \-noverbose ]
32 .RB [ \-watch " | " \-nowatch ]
33 .RB [ \-mts
34 .IR smtp " | " sendmail/smtp " | " sendmail/pipe ]
35 .RB [ \-server
36 .IR servername ]
37 .RB [ \-port
38 .IR port-name/number ]
39 .RB [ \-sasl ]
40 .RB [ \-nosasl ]
41 .RB [ \-saslmaxssf
42 .IR ssf ]
43 .RB [ \-saslmech
44 .IR mechanism ]
45 .RB [ \-snoop ]
46 .RB [ \-user
47 .IR username ]
48 .RB [ \-tls ]
49 .RB [ \-initialtls ]
50 .RB [ \-notls ]
51 .RB [ \-width
52 .IR columns ]
53 .RB [ file
54 \&...]
55 .RB [ \-version ]
56 .RB [ \-help ]
57 .ad
58 .SH DESCRIPTION
59 .B Send
60 will cause each of the specified files to be delivered
61 to each of the destinations in the \*(lqTo:\*(rq, \*(lqcc:\*(rq,
62 \*(lqBcc:\*(rq, \*(lqDcc:\*(rq, and \*(lqFcc:\*(rq fields of the message. If
63 .B send
64 is re\-distributing a message, as invoked from
65 .BR dist ,
66 then the
67 corresponding \*(lqResent\-xxx\*(rq fields are examined instead.
68 .PP
69 By default,
70 .B send
71 uses the program
72 .B post
73 to do the actual
74 delivery of the messages, although this can be changed by defining the
75 .I postproc
76 profile component. Most of the features attributed to
77 .B send
78 are actually performed by
79 .BR post .
80 .PP
81 Before
82 .B send
83 gives the message to
84 .B post
85 for delivery, the message is processed by
86 .B mhbuild
87 to perform any necessary MIME encoding of the outgoing message. This
88 can be changed by the
89 .I buildmimeproc
90 profile component.
91 .B mhbuild
92 is invoked with the
93 .B \-auto
94 switch, so
95 .B mhbuild
96 directives are not processed by default. See
97 .IR mhbuild (1)
98 for more information.
99 .PP
100 .B mhbuild
101 will scan the message draft for a header named
102 .IR Attach .
103 The draft is converted to a MIME message if one or more matches are found.
104 This conversion occurs before all other processing. The
105 .IR whatnow (1)
106 man page describes the user interface for managing MIME attachments via
107 this mechanism.
108 .PP
109 The first part of the MIME message is the draft body if that body contains
110 any non-blank characters.
111 The body of each
112 .I Attach
113 header field is interpreted as a file name, and each file named is included as a separate
114 part in the MIME message.
115 .PP
116 Determination of the content MIME type inserted into the Content-Type
117 header for each part depends on how the
118 .B nmh
119 installation was configured. If a program, such as
120 .B file
121 with a
122 .B \-\-mime
123 or
124 .B \-i
125 option, was found that can specify the type of a file as a MIME type
126 string, then that will be used. To determine if your
127 .B nmh
128 was so configured, run
129 .B mhparam mimetypeproc
130 and see if a non-empty string is displayed.
131 .PP
132 If your
133 .B nmh
134 was not configured with a program to specify a file type as a MIME
135 string, then a different method is used to determine the content-type
136 string. For file names with dot suffixes, the profile is scanned for a
137 .I mhshow-suffix-
138 entry for that suffix.
139 The content-type for the part is taken from that profile entry if a match is
140 found. If a match is not found in the user profile, the mhn.defaults
141 profile is scanned next.
142 If no match is found or the file does not have a dot suffix, the content-type
143 is text/plain if the file contains only ASCII characters or application/octet-stream
144 if it contains characters outside of the ASCII range. See
145 .IR mhshow (1)
146 for more details and example syntax.
147 .PP
148 Each attached MIME part contains a
149 \*(lqContent-Description\*(rq header that includes the filename, and
150 adds a \*(lqContent-Disposition\*(rq header.
151 Here is an example of MIME part headers for an attachment:
152 .PP
153 .nf
154 Content-Type: text/plain; name="VERSION"; charset="us-ascii"
155 Content-Description: VERSION
156 Content-Disposition: attachment; filename="VERSION"
157 .fi
158 .PP
159 If
160 .B \-push
161 is specified,
162 .B send
163 will detach itself from the user's
164 terminal and perform its actions in the background. If
165 .BR push 'd
166 and the draft can't be sent, then an error message will be sent (using
167 the mailproc) back to the user. If
168 .B \-forward
169 is given, then a copy
170 of the draft will be attached to this failure notice. Using
171 .B \-push
172 differs from putting
173 .B send
174 in the background because the output is
175 trapped and analyzed by
176 .BR nmh .
177 .PP
178 If
179 .B \-verbose
180 is specified,
181 .B send
182 will indicate the interactions
183 occurring with the transport system, prior to actual delivery.
184 If
185 .B \-watch
186 is specified
187 .B send
188 will monitor the delivery of local
189 and network mail. Hence, by specifying both switches, a large detail
190 of information can be gathered about each step of the message's entry
191 into the transport system.
192 .PP
193 The
194 .B \-draftfolder
195 .I +folder
196 and
197 .B \-draftmessage
198 .I msg
199 switches invoke
200 the
201 .B nmh
202 draft folder facility. This is an advanced (and highly
203 useful) feature. Consult the
204 .IR mh-draft (5)
205 man page for more
206 information.
207 .PP
208 If
209 .B \-split
210 is specified,
211 .B send
212 will split the draft into one
213 or more partial messages prior to sending. This makes use of the
214 MIME features in
215 .BR nmh .
216 Note however that if
217 .B send
218 is
219 invoked under
220 .BR dist ,
221 then this switch is ignored\0--\0it makes
222 no sense to redistribute a message in this fashion. Sometimes you want
223 .B send
224 to pause after posting a partial message. This is usually
225 the case when you are running
226 .B sendmail
227 and expect to generate a
228 lot of partial messages. The argument to
229 .B \-split
230 tells it how long
231 to pause between postings.
232 .PP
233 .B Send
234 with no
235 .I file
236 argument will query whether the draft
237 is the intended file, whereas
238 .B \-draft
239 will suppress this question.
240 Once the transport system has successfully accepted custody of the
241 message, the file will be renamed with a site-dependent prefix
242 (usually a comma), which allows
243 it to be retrieved until the next draft message is sent. If there are
244 errors in the formatting of the message,
245 .B send
246 will abort with a
247 (hopefully) helpful error message.
248 .PP
249 If a \*(lqBcc:\*(rq field is encountered, its addresses will be used for
250 delivery, and the \*(lqBcc:\*(rq field will be removed from the message
251 sent to sighted recipients. The blind recipients will receive an entirely
252 new message with a minimal set of headers. Included in the body of the
253 message will be a copy of the message sent to the sighted recipients.
254 .PP
255 If a \*(lqDcc:\*(rq field is encountered and the
256 .B sendmail/pipe
257 mail transport method is not in use, its addresses will be used for
258 delivery, and the \*(lqDcc:\*(rq field will be removed from the message. The
259 blind recipients will receive the same message sent to the sighted
260 recipients. *WARNING* Recipients listed in the \*(lqDcc:\*(rq field receive no
261 explicit indication that they have received a \*(lqblind copy\*(rq.
262 This can cause blind recipients to
263 inadvertently reply to all of the sighted recipients of the
264 original message, revealing that they received a blind copy.
265 On the other hand, since a normal reply to a message sent
266 via a \*(lqBcc:\*(rq field
267 will generate a reply only to the sender of the original message,
268 it takes extra effort in most mailers to reply to the included
269 message, and so would usually only be done deliberately, rather
270 than by accident.
271 .PP
272 If
273 .B \-filter
274 .I filterfile
275 is specified, then this copy is filtered
276 (re\-formatted) by
277 .B mhl
278 prior to being sent to the blind recipients.
279 Alternately, if you specify the
280 .B -mime
281 switch, then
282 .B send
283 will
284 use the MIME rules for encapsulation.
285 .PP
286 Prior to sending the message, the \*(lqDate:\ now\*(rq field will be appended to the headers in the message.
287 If
288 .B \-msgid
289 is specified, then a \*(lqMessage\-ID:\*(rq field will also
290 be added to the message.
291 .PP
292 The
293 .B \-messageid
294 switch selects the style used for the part appearing after the @
295 in \*(lqMessage\-ID:\*(rq, \*(lqResent\-Message\-ID:\*(rq, and
296 \*(lqContent\-ID:\*(rq header fields. The two acceptable options are
297 .B localname
298 (which is the default),
299 and
300 .BR random .
301 With
302 .BR localname ,
303 the local hostname is used. With
304 .BR random ,
305 a random sequence of characters is used instead. Note that the
306 .B \-msgid
307 switch must be enabled for this switch to have any effect.
308 .PP
309 If
310 .B send
311 is re\-distributing a message (when invoked by
312 .BR dist ),
313 then \*(lqResent\-\*(rq will be prepended to each of these
314 fields: \*(lqFrom:\*(rq, \*(lqDate:\*(rq, and \*(lqMessage\-ID:\*(rq.
315 .PP
316 A \*(lqFrom:\*(rq field is required for all outgoing messages. Multiple
317 addresses are permitted in the \*(lqFrom:\*(rq field, but a \*(lqSender:\*(rq
318 field is required in this case. Otherwise a \*(lqSender:\*(rq field
319 is optional.
320 .PP
321 If a message with multiple \*(lqFrom:\*(rq
322 addresses does
323 .B NOT
324 include a \*(lqSender:\*(rq field but does include an \*(lqEnvelope\-From:\*(rq
325 field, the \*(lqEnvelope\-From:\*(rq field will be used to construct
326 a \*(lqSender:\*(rq field.
327 .PP
328 When using SMTP for mail submission, the envelope\-from used for the SMTP
329 transaction is derived from the \*(lqEnvelope\-From:\*(rq field.
330 If no \*(lqEnvelope\-From:\*(rq field is present, the \*(lqSender:\*(rq
331 field is used. If neither the \*(lqEnvelope\-From:\*(rq nor the
332 \*(lqSender:\*(rq field is present, the \*(lqFrom:\*(rq field is used.
333 When \*(lqEnvelope\-From:\*(rq appears in a message
334 it will be removed from the final outgoing message.
335 .PP
336 By using the
337 .B \-format
338 switch, each of the entries in the \*(lqTo:\*(rq
339 and \*(lqcc:\*(rq fields will be replaced with \*(lqstandard\*(rq
340 format entries. This standard format is designed to be usable by all
341 of the message handlers on the various systems around the Internet.
342 If
343 .B \-noformat
344 is given, then headers are output exactly as they appear
345 in the message draft.
346 .PP
347 If an \*(lqFcc:\ folder\*(rq is encountered, the message will be copied
348 to the specified folder for the sender in the format in which it will
349 appear to any non\-Bcc receivers of the message. That is, it will have
350 the appended fields and field reformatting. The \*(lqFcc:\*(rq fields
351 will be removed from all outgoing copies of the message.
352 .PP
353 By using the
354 .B \-width
355 .I columns
356 switch, the user can direct
357 .B send
358 as to how long it should make header lines containing addresses.
359 .PP
360 The mail transport system default is provided in
361 .I %etcdir%/mts.conf
362 but can be overriiden here with the
363 .B \-mts
364 switch.
365 .PP
366 If nmh is using the SMTP MTA, the
367 .B \-server
368 and the
369 .B \-port
370 switches can be used to override the default mail server (defined by the
371 .I %etcdir%/mts.conf
372 .RI servers
373 entry). The
374 .B \-snoop
375 switch can be used to view the SMTP transaction. (Beware that the
376 SMTP transaction may contain authentication information either in
377 plaintext or easily decoded base64.)
378 .PP
379 If
380 .B nmh
381 has been compiled with SASL support, the
382 .B \-sasl
383 and
384 .B \-nosasl
385 switches will enable and disable
386 the use of SASL authentication with the SMTP MTA. Depending on the
387 SASL mechanism used, this may require an additional password prompt from the
388 user (but the
389 .I netrc
390 file can be used to store this password, as described in the
391 mh-profile(5) man page). The
392 .B \-saslmech
393 switch can be used to select a particular SASL mechanism,
394 and the
395 .B \-user
396 switch can be used to select a authorization userid to provide to SASL
397 other than the default. The credentials profile entry in the
398 mh_profile(5) man page describes the ways to supply a username and
399 password.
400 .PP
401 If SASL authentication is successful,
402 .BR nmh
403 will attempt to negotiate a security layer for session encryption.
404 Encrypted data is labelled with `(encrypted)' and `(decrypted)' when
405 viewing the SMTP transaction with the
406 .B \-snoop
407 switch. The
408 .B \-saslmaxssf
409 switch can be used to select the maximum value of the Security Strength Factor.
410 This is an integer value and the exact meaning of this value depends on the
411 underlying SASL mechanism. A value of 0 disables encryption.
412 .PP
413 If
414 .B nmh
415 has been compiled with TLS support, the
416 .B \-tls
417 and
418 .B \-initialtls
419 switches will require the negotiation of TLS when
420 connecting to the SMTP MTA. The
421 .B \-tls
422 switch will negotiate TLS as part of the normal SMTP protocol
423 using the STARTTLS command. The
424 .B \-initialtls
425 will negotiate TLS immediately after the connection has
426 taken place, before any SMTP commands are sent or received. Encrypted data
427 is labelled with `(tls-encrypted)' and
428 `(tls-decrypted)' when viewing the SMTP transction with the
429 .B \-snoop
430 switch.
431 The
432 .B \-notls
433 switch will disable all attempts to negotiate TLS.
434 .PP
435 The files specified by the profile entry \*(lqAliasfile:\*(rq and any
436 additional alias files given by the
437 .B \-alias
438 .I aliasfile
439 switch will be
440 read (more than one file, each preceded by
441 .BR \-alias ,
442 can be named).
443 See
444 .IR mh\-alias (5)
445 for more information.
446 .SH FILES
447 .fc ^ ~
448 .nf
449 .ta \w'%etcdir%/ExtraBigFileName 'u
450 ^$HOME/\&.mh\(ruprofile~^The user profile
451 .fi
452 .SH "PROFILE COMPONENTS"
453 .fc ^ ~
454 .nf
455 .ta 2.4i
456 .ta \w'ExtraBigProfileName 'u
457 ^Path:~^To determine the user's nmh directory
458 ^Draft\-Folder:~^To find the default draft\-folder
459 ^Aliasfile:~^For a default alias file
460 ^Signature:~^To determine the user's mail signature
461 ^mailproc:~^Program to post failure notices
462 ^postproc:~^Program to post the message
463 .fi
464 .SH "SEE ALSO"
465 .IR comp (1),
466 .IR dist (1),
467 .IR file (1),
468 .IR forw (1),
469 .IR mhparam (1),
470 .IR repl (1),
471 .IR whatnow (1),
472 .IR mh\-alias (5),
473 .IR mh\-profile (5),
474 .IR mh\-tailor (5),
475 .IR post (8)
476 .SH DEFAULTS
477 .nf
478 .RB ` file "' defaults to <mh\-dir>/draft"
479 .RB ` \-alias "' defaults to %etcdir%/MailAliases"
480 .RB ` \-nodraftfolder '
481 .RB ` \-nofilter '
482 .RB ` \-format '
483 .RB ` \-forward '
484 .RB ` \-nomime '
485 .RB ` \-nomsgid '
486 .RB ` "\-messageid\ localname" '
487 .RB ` \-nopush '
488 .RB ` \-noverbose '
489 .RB ` \-nowatch '
490 .RB ` "\-width\ 72" '
491 .fi
492 .SH CONTEXT
493 None
494 .SH BUGS
495 Under some configurations, it is not possible to monitor the mail delivery
496 transaction;
497 .B \-watch
498 is a no-op on those systems.
499 .PP
500 Using
501 .B \-split
502 .I 0
503 doesn't work correctly.