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