]> diplodocus.org Git - nmh/blob - man/send.man
Only get a write lock on the sequences file if we're performing a pack
[nmh] / man / send.man
1 .\"
2 .\" %nmhwarning%
3 .\"
4 .TH SEND %manext1% "August 14, 2016" "%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 [ \-sendmail
36 .IR program ]
37 .RB [ \-server
38 .IR servername ]
39 .RB [ \-port
40 .IR port-name/number ]
41 .RB [ \-sasl ]
42 .RB [ \-nosasl ]
43 .RB [ \-saslmaxssf
44 .IR ssf ]
45 .RB [ \-saslmech
46 .IR mechanism ]
47 .RB [ \-authservice
48 .IR service ]
49 .RB [ \-snoop ]
50 .RB [ \-user
51 .IR username ]
52 .RB [ \-tls ]
53 .RB [ \-initialtls ]
54 .RB [ \-notls ]
55 .RB [ \-width
56 .IR columns ]
57 .RB [ file
58 \&...]
59 .RB [ \-version ]
60 .RB [ \-help ]
61 .ad
62 .SH DESCRIPTION
63 .B Send
64 will cause each of the specified files to be delivered
65 to each of the destinations in the \*(lqTo:\*(rq, \*(lqcc:\*(rq,
66 \*(lqBcc:\*(rq, \*(lqDcc:\*(rq, and \*(lqFcc:\*(rq fields of the message. If
67 .B send
68 is re\-distributing a message, as invoked from
69 .BR dist ,
70 then the
71 corresponding \*(lqResent\-xxx\*(rq fields are examined instead.
72 .PP
73 By default,
74 .B send
75 uses the program
76 .B post
77 to do the actual
78 delivery of the messages, although this can be changed by defining the
79 .I postproc
80 profile component. Most of the features attributed to
81 .B send
82 are actually performed by
83 .BR post .
84 .PP
85 Before
86 .B send
87 gives the message to
88 .B post
89 for delivery, the message is processed by
90 .B mhbuild
91 to perform any necessary MIME encoding of the outgoing message. This
92 can be changed by the
93 .I buildmimeproc
94 profile component.
95 .B mhbuild
96 is invoked with the
97 .B \-auto
98 switch, so
99 .B mhbuild
100 directives are not processed by default. See
101 .IR mhbuild (1)
102 for more information.
103 .PP
104 .B mhbuild
105 will scan the message draft for a header named
106 .IR Attach .
107 The draft is converted to a MIME message if one or more matches are found.
108 This conversion occurs before all other processing. The
109 .IR whatnow (1)
110 man page describes the user interface for managing MIME attachments via
111 this mechanism.
112 .PP
113 The first part of the MIME message is the draft body if that body contains
114 any non-blank characters.
115 The body of each
116 .I Attach
117 header field is interpreted as a file name, and each file named is included as a separate
118 part in the MIME message.
119 .PP
120 Determination of the content MIME type inserted into the Content-Type
121 header for each part depends on how the
122 .B nmh
123 installation was configured. If a program, such as
124 .B file
125 with a
126 .B \-\-mime
127 or
128 .B \-i
129 option, was found that can specify the type of a file as a MIME type
130 string, then that will be used. To determine if your
131 .B nmh
132 was so configured, run
133 .B mhparam mimetypeproc
134 and see if a non-empty string is displayed.
135 .PP
136 If your
137 .B nmh
138 was not configured with a program to specify a file type as a MIME
139 string, then a different method is used to determine the content-type
140 string. For file names with dot suffixes, the profile is scanned for a
141 .I mhshow-suffix-
142 entry for that suffix.
143 The content-type for the part is taken from that profile entry if a match is
144 found. If a match is not found in the user profile, the mhn.defaults
145 profile is scanned next.
146 If no match is found or the file does not have a dot suffix, the content-type
147 is text/plain if the file contains only ASCII characters or application/octet-stream
148 if it contains characters outside of the ASCII range. See
149 .IR mhshow (1)
150 for more details and example syntax.
151 .PP
152 Each attached MIME part contains a
153 \*(lqContent-Description\*(rq header that includes the filename, and
154 adds a \*(lqContent-Disposition\*(rq header.
155 Here is an example of MIME part headers for an attachment:
156 .PP
157 .nf
158 Content-Type: text/plain; name="VERSION"; charset="us-ascii"
159 Content-Description: VERSION
160 Content-Disposition: attachment; filename="VERSION"
161 .fi
162 .PP
163 See
164 .IR mhbuild (1)
165 for explanation of how the Content-Disposition value is selected.
166 .PP
167 If
168 .B \-push
169 is specified,
170 .B send
171 will detach itself from the user's
172 terminal and perform its actions in the background. If
173 .BR push 'd
174 and the draft can't be sent, then an error message will be sent (using
175 the mailproc) back to the user. If
176 .B \-forward
177 is given, then a copy
178 of the draft will be attached to this failure notice. Using
179 .B \-push
180 differs from putting
181 .B send
182 in the background because the output is
183 trapped and analyzed by
184 .BR nmh .
185 .PP
186 If
187 .B \-verbose
188 is specified,
189 .B send
190 will indicate the interactions
191 occurring with the transport system, prior to actual delivery.
192 If
193 .B \-watch
194 is specified
195 .B send
196 will monitor the delivery of local
197 and network mail. Hence, by specifying both switches, a large detail
198 of information can be gathered about each step of the message's entry
199 into the transport system.
200 .PP
201 The
202 .B \-draftfolder
203 .I +folder
204 and
205 .B \-draftmessage
206 .I msg
207 switches invoke
208 the
209 .B nmh
210 draft folder facility. This is an advanced (and highly
211 useful) feature. Consult the
212 .IR mh-draft (5)
213 man page for more
214 information.
215 .PP
216 If
217 .B \-split
218 is specified,
219 .B send
220 will split the draft into one
221 or more partial messages prior to sending. This makes use of the
222 MIME features in
223 .BR nmh .
224 Note however that if
225 .B send
226 is
227 invoked under
228 .BR dist ,
229 then this switch is ignored\0--\0it makes
230 no sense to redistribute a message in this fashion. Sometimes you want
231 .B send
232 to pause after posting a partial message. This is usually
233 the case when you are running
234 .B sendmail
235 and expect to generate a
236 lot of partial messages. The argument to
237 .B \-split
238 tells it how long
239 to pause between postings.
240 .PP
241 .B Send
242 with no
243 .I file
244 argument will query whether the draft
245 is the intended file, whereas
246 .B \-draft
247 will suppress this question.
248 Once the transport system has successfully accepted custody of the
249 message, the file will be renamed with a site-dependent prefix
250 (usually a comma), which allows
251 it to be retrieved until the next draft message is sent. If there are
252 errors in the formatting of the message,
253 .B send
254 will abort with a
255 (hopefully) helpful error message.
256 .PP
257 If a \*(lqBcc:\*(rq field is encountered, its addresses will be used for
258 delivery, and the \*(lqBcc:\*(rq field will be removed from the message
259 sent to sighted recipients. The blind recipients will receive an entirely
260 new message with a minimal set of headers. Included in the body of the
261 message will be a copy of the message sent to the sighted recipients.
262 .PP
263 If a \*(lqDcc:\*(rq field is encountered and the
264 .B sendmail/pipe
265 mail transport method is not in use, its addresses will be used for
266 delivery, and the \*(lqDcc:\*(rq field will be removed from the message. The
267 blind recipients will receive the same message sent to the sighted
268 recipients. *WARNING* Recipients listed in the \*(lqDcc:\*(rq field receive no
269 explicit indication that they have received a \*(lqblind copy\*(rq.
270 This can cause blind recipients to
271 inadvertently reply to all of the sighted recipients of the
272 original message, revealing that they received a blind copy.
273 On the other hand, since a normal reply to a message sent
274 via a \*(lqBcc:\*(rq field
275 will generate a reply only to the sender of the original message,
276 it takes extra effort in most mailers to reply to the included
277 message, and so would usually only be done deliberately, rather
278 than by accident.
279 .PP
280 If
281 .B \-filter
282 .I filterfile
283 is specified, then this copy is filtered
284 (re\-formatted) by
285 .B mhl
286 prior to being sent to the blind recipients.
287 Alternately, if you specify the
288 .B -mime
289 switch, then
290 .B send
291 will
292 use the MIME rules for encapsulation.
293 .PP
294 Prior to sending the message, the \*(lqDate:\ now\*(rq field will be appended to the headers in the message.
295 If
296 .B \-msgid
297 is specified, then a \*(lqMessage\-ID:\*(rq field will also
298 be added to the message.
299 .PP
300 The
301 .B \-messageid
302 switch selects the style used for the part appearing after the @
303 in \*(lqMessage\-ID:\*(rq, \*(lqResent\-Message\-ID:\*(rq, and
304 \*(lqContent\-ID:\*(rq header fields. The two acceptable options are
305 .B localname
306 (which is the default),
307 and
308 .BR random .
309 With
310 .BR localname ,
311 the local hostname is used. With
312 .BR random ,
313 a random sequence of characters is used instead. Note that the
314 .B \-msgid
315 switch must be enabled for this switch to have any effect.
316 .PP
317 If
318 .B send
319 is re\-distributing a message (when invoked by
320 .BR dist ),
321 then \*(lqResent\-\*(rq will be prepended to each of these
322 fields: \*(lqFrom:\*(rq, \*(lqDate:\*(rq, and \*(lqMessage\-ID:\*(rq.
323 .PP
324 A \*(lqFrom:\*(rq field is required for all outgoing messages. Multiple
325 addresses are permitted in the \*(lqFrom:\*(rq field, but a \*(lqSender:\*(rq
326 field is required in this case. Otherwise a \*(lqSender:\*(rq field
327 is optional.
328 .PP
329 If a message with multiple \*(lqFrom:\*(rq
330 addresses does
331 .B NOT
332 include a \*(lqSender:\*(rq field but does include an \*(lqEnvelope\-From:\*(rq
333 field, the \*(lqEnvelope\-From:\*(rq field will be used to construct
334 a \*(lqSender:\*(rq field.
335 .PP
336 When using SMTP for mail submission, the envelope\-from used for the SMTP
337 transaction is derived from the \*(lqEnvelope\-From:\*(rq field.
338 If no \*(lqEnvelope\-From:\*(rq field is present, the \*(lqSender:\*(rq
339 field is used. If neither the \*(lqEnvelope\-From:\*(rq nor the
340 \*(lqSender:\*(rq field is present, the \*(lqFrom:\*(rq field is used.
341 When \*(lqEnvelope\-From:\*(rq appears in a message
342 it will be removed from the final outgoing message.
343 .PP
344 By using the
345 .B \-format
346 switch, each of the entries in the \*(lqTo:\*(rq
347 and \*(lqcc:\*(rq fields will be replaced with \*(lqstandard\*(rq
348 format entries. This standard format is designed to be usable by all
349 of the message handlers on the various systems around the Internet.
350 If
351 .B \-noformat
352 is given, then headers are output exactly as they appear
353 in the message draft.
354 .PP
355 If an \*(lqFcc:\ folder\*(rq is encountered, the message will be copied
356 to the specified folder for the sender in the format in which it will
357 appear to any non\-Bcc receivers of the message. That is, it will have
358 the appended fields and field reformatting. The \*(lqFcc:\*(rq fields
359 will be removed from all outgoing copies of the message.
360 .PP
361 By using the
362 .B \-width
363 .I columns
364 switch, the user can direct
365 .B send
366 as to how long it should make header lines containing addresses.
367 .PP
368 The mail transport system default is provided in
369 .I %nmhetcdir%/mts.conf
370 but can be overriiden here with the
371 .B \-mts
372 switch.
373 .PP
374 If nmh is using as its mail transport system
375 .BR sendmail/pipe ,
376 the
377 .B \-sendmail
378 switch can be used to override the default
379 .B sendmail
380 program.
381 .PP
382 If nmh is using the SMTP MTA, the
383 .B \-server
384 and the
385 .B \-port
386 switches can be used to override the default mail server (defined by the
387 .I %nmhetcdir%/mts.conf
388 .RI servers
389 entry). The
390 .B \-snoop
391 switch can be used to view the SMTP transaction. (Beware that the
392 SMTP transaction may contain authentication information either in
393 plaintext or easily decoded base64.) If
394 .B \-saslmech xoauth2
395 is used, the HTTP transaction is also shown.
396 .PP
397 If
398 .B nmh
399 has been compiled with SASL support, the
400 .B \-sasl
401 and
402 .B \-nosasl
403 switches will enable and disable
404 the use of SASL authentication with the SMTP MTA. Depending on the
405 SASL mechanism used, this may require an additional password prompt from the
406 user (but the
407 .I netrc
408 file can be used to store this password, as described in the
409 mh-profile(5) man page). The
410 .B \-saslmech
411 switch can be used to select a particular SASL mechanism,
412 and the
413 .B \-user
414 switch can be used to select a authorization userid to provide to SASL
415 other than the default. The credentials profile entry in the
416 mh\-profile(5) man page describes the ways to supply a username and
417 password.
418 .PP
419 If SASL authentication is successful,
420 .BR nmh
421 will attempt to negotiate a security layer for session encryption.
422 Encrypted data is labelled with `(encrypted)' and `(decrypted)' when
423 viewing the SMTP transaction with the
424 .B \-snoop
425 switch; see the
426 .B post
427 man page description of
428 .B \-snoop
429 for its other features.
430 The
431 .B \-saslmaxssf
432 switch can be used to select the maximum value of the Security Strength Factor.
433 This is an integer value and the exact meaning of this value depends on the
434 underlying SASL mechanism. A value of 0 disables encryption.
435 .PP
436 If
437 .B nmh
438 has been compiled with OAuth support, the
439 .B \-saslmech xoauth2
440 switch will enable OAuth authentication. The
441 .B \-user
442 switch must be used, and the
443 .I user-name
444 must be an email address the user has for the service, which must
445 be specified with the
446 .B \-authservice
447 .I service
448 switch. Before using this, the user must authorize nmh by running
449 .B mhlogin
450 and grant authorization to that account. See the
451 .B mhlogin
452 man page for more details.
453 .PP
454 If
455 .B nmh
456 has been compiled with TLS support, the
457 .B \-tls
458 and
459 .B \-initialtls
460 switches will require the negotiation of TLS when
461 connecting to the SMTP MTA. The
462 .B \-tls
463 switch will negotiate TLS as part of the normal SMTP protocol
464 using the STARTTLS command. The
465 .B \-initialtls
466 will negotiate TLS immediately after the connection has
467 taken place, before any SMTP commands are sent or received. Encrypted data
468 is labelled with `(tls-encrypted)' and
469 `(tls-decrypted)' when viewing the SMTP transction with the
470 .B \-snoop
471 switch; see the
472 .B post
473 man page description of
474 .B \-snoop
475 for its other features.
476 The
477 .B \-notls
478 switch will disable all attempts to negotiate TLS.
479 .PP
480 If port 465 is specified and none of the TLS switches were enabled,
481 .B \-initialtls
482 will be implied if TLS support was compiled in. Though port 465 for
483 SMTPS (SMTP over SSL) was deregistered by IANA in 1998, it is still
484 used for that service.
485 .PP
486 The files specified by the profile entry \*(lqAliasfile:\*(rq and any
487 additional alias files given by the
488 .B \-alias
489 .I aliasfile
490 switch will be
491 read (more than one file, each preceded by
492 .BR \-alias ,
493 can be named).
494 See
495 .IR mh\-alias (5)
496 for more information.
497 .SS Selection based on sender address: sendfrom
498 One or more
499 .I sendfrom
500 profile components can be used to select a mail server address, mail server
501 port, or any other switch that can be supplied to
502 .BR post .
503 It works by first looking at the sender address and domain name in the
504 message draft, as described below.
505 It then looks for a corresponding profile entry, which contains the
506 .B post
507 switches.
508 To enable, add profile entries of the form:
509 .PP
510 .RS 5
511 .RI sendfrom- "address/domain name" : " post switches"
512 .RE
513 .PP
514 The email address is extracted from the Envelope-From: header, if not blank,
515 the Sender: header, or the From: header line in the message draft.
516 Multiple profile entries, with different email addresses or domain names, are
517 supported.
518 This allows different switches to
519 .BR post ,
520 such as -user, to be associated with different email addresses.
521 If a domain name is used, it matches all users in that domain.
522 .PP
523 Here is an example profile entry using OAuth for an account hosted by gmail:
524 .PP
525 .nf
526 .RS 5
527 sendfrom-gmail_address@example.com: -saslmech xoauth2
528 .RS 5
529 -authservice gmail -tls -server smtp.gmail.com
530 -user gmail_login@example.com
531 .RE
532 .RE
533 .fi
534 .PP
535 (Indentation indicates a continued line, as supported in MH profiles.)
536 The username need not be the same as the sender address, which was extracted
537 from the appropriate header line as noted above.
538 .PP
539 Here are example profile entries that use an nmh credentials file:
540 .PP
541 .nf
542 .RS 5
543 credentials: file:nmhcreds
544 sendfrom-sendgrid_address@example.com: -sasl -tls
545 .RS 5
546 -server smtp.sendgrid.net
547 .RE
548 sendfrom-outbound.att.net: -sasl -initialtls
549 .RS 5
550 -server outbound.att.net -port 465
551 .RE
552 sendfrom-fastmail.com: -initialtls -sasl -saslmech LOGIN
553 .RS 5
554 -server smtps-proxy.messagingengine.com -port 80
555 .RE
556 .RE
557 .fi
558 .PP
559 where nmhcreds is in the user's nmh directory (from the Path profile component)
560 and contains:
561 .PP
562 .nf
563 .RS 5
564 machine smtp.sendgrid.net
565 .RS 5
566 login sendgrid_login@example.com
567 password ********
568 .RE
569 machine outbound.att.net
570 .RS 5
571 login att_login@example.com
572 password ********
573 .RE
574 machine smtps-proxy.messagingengine.com
575 .RS 5
576 login fastmail_login@example.com
577 password ********
578 .RE
579 .RE
580 .fi
581 .PP
582 For more information on authentication to mail servers, see the
583 .IR mhlogin (1)
584 man page for OAuth services, and
585 .IR mh-profile (5)
586 man page for login credentials.
587 .PP
588 .SH FILES
589 .fc ^ ~
590 .nf
591 .ta \w'%nmhetcdir%/ExtraBigFileName 'u
592 ^$HOME/\&.mh\(ruprofile~^The user profile
593 .fi
594 .SH "PROFILE COMPONENTS"
595 .fc ^ ~
596 .nf
597 .ta 2.4i
598 .ta \w'ExtraBigProfileName 'u
599 ^Path:~^To determine the user's nmh directory
600 ^Draft\-Folder:~^To find the default draft\-folder
601 ^Aliasfile:~^For a default alias file
602 ^Signature:~^To determine the user's mail signature
603 ^mailproc:~^Program to post failure notices
604 ^postproc:~^Program to post the message
605 ^sendfrom-address:~^Switches to post for sender address
606 ^sendfrom-domain:~^Switches to post for sender domain name
607 .fi
608 .SH "SEE ALSO"
609 .IR comp (1),
610 .IR dist (1),
611 .IR file (1),
612 .IR forw (1),
613 .IR mhbuild (1),
614 .IR mhparam (1),
615 .IR mhlogin (1),
616 .IR repl (1),
617 .IR whatnow (1),
618 .IR mh\-alias (5),
619 .IR mh\-profile (5),
620 .IR mh\-tailor (5),
621 .IR post (8)
622 .SH DEFAULTS
623 .nf
624 .RB ` file "' defaults to <mh\-dir>/draft"
625 .RB ` \-alias "' defaults to %nmhetcdir%/MailAliases"
626 .RB ` \-nodraftfolder '
627 .RB ` \-nofilter '
628 .RB ` \-format '
629 .RB ` \-forward '
630 .RB ` \-nomime '
631 .RB ` \-nomsgid '
632 .RB ` "\-messageid\ localname" '
633 .RB ` \-nopush '
634 .RB ` \-noverbose '
635 .RB ` \-nowatch '
636 .RB ` "\-width\ 72" '
637 .fi
638 .SH CONTEXT
639 None
640 .SH BUGS
641 Under some configurations, it is not possible to monitor the mail delivery
642 transaction;
643 .B \-watch
644 is a no-op on those systems.
645 .PP
646 Using
647 .B \-split
648 .I 0
649 doesn't work correctly.