SYNOPSIS formating to prevent filling
[mmh] / man / send.man
1 .\"
2 .\" %nmhwarning%
3 .\" $Id$
4 .\"
5 .TH SEND %manext1% "%nmhdate%" MH.6.8 [%nmhversion%]
6 .SH NAME
7 send \- send a message
8 .SH SYNOPSIS
9 .HP 5
10 .na
11 .B send
12 .RB [ \-alias
13 .IR aliasfile ]
14 .RB [ \-draft ]
15 .RB [ \-draftfolder
16 .IR +folder ]
17 .RB [ \-draftmessage
18 .IR msg ]
19 .RB [ \-nodraftfolder ]
20 .RB [ \-filter
21 .IR filterfile ]
22 .RB [ \-nofilter ]
23 .RB [ \-format " | " \-noformat ]
24 .RB [ \-forward " | " \-noforward ]
25 .RB [ \-mime " | " \-nomime ]
26 .RB [ \-msgid " | " \-nomsgid ]
27 .RB [ \-push " | " \-nopush ]
28 .RB [ \-split
29 .IR seconds ]
30 .RB [ \-verbose " | " \-noverbose ]
31 .RB [ \-watch " | " \-nowatch ]
32 .RB [ \-sasl ]
33 .RB [ \-saslmech
34 .IR mechanism ]
35 .RB [ \-user
36 .IR username ]
37 .RB [ \-width
38 .IR columns ]
39 .RB [ file
40 \&...] 
41 .RB [ \-version ]
42 .RB [ \-help ]
43 .ad
44 .SH DESCRIPTION
45 .B Send
46 will cause each of the specified files to be delivered
47 to each of the destinations in the \*(lqTo:\*(rq, \*(lqcc:\*(rq,
48 \*(lqBcc:\*(rq, and \*(lqFcc:\*(rq fields of the message.  If
49 .B send
50 is re\-distributing a message, as invoked from
51 .BR dist ,
52 then the
53 corresponding \*(lqResent\-xxx\*(rq fields are examined instead.
54 .PP
55 By default,
56 .B send
57 uses the program
58 .B post
59 to do the actual
60 delivery of the messages, although this can be changed by defining the
61 .I postproc
62 profile component.  Most of the features attributed to
63 .B send
64 are actually performed by
65 .BR post .
66 .PP
67 If
68 .B \-push
69 is specified,
70 .B send
71 will detach itself from the user's
72 terminal and perform its actions in the background.  If
73 .BR push 'd
74 and the draft can't be sent, then an error message will be sent (using
75 the mailproc) back to the user.  If
76 .B \-forward
77 is given, then a copy
78 of the draft will be attached to this failure notice.  Using
79 .B \-push
80 differs from putting
81 .B send
82 in the background because the output is
83 trapped and analyzed by
84 .BR nmh .
85 .PP
86 If
87 .B \-verbose
88 is specified,
89 .B send
90 will indicate the interactions
91 occurring with the transport system, prior to actual delivery.
92 If
93 .B \-watch
94 is specified
95 .B send
96 will monitor the delivery of local
97 and network mail.  Hence, by specifying both switches, a large detail
98 of information can be gathered about each step of the message's entry
99 into the transport system.
100 .PP
101 The
102 .B \-draftfolder
103 .I +folder
104 and
105 .B \-draftmessage
106 .I msg
107 switches invoke
108 the
109 .B nmh
110 draft folder facility.  This is an advanced (and highly
111 useful) feature.  Consult the
112 .BR mh-draft (5)
113 man page for more
114 information.
115 .PP
116 If
117 .B \-split
118 is specified,
119 .B send
120 will split the draft into one
121 or more partial messages prior to sending.  This makes use of the
122 MIME features in
123 .BR nmh .
124 Note however that if
125 .B send
126 is
127 invoked under
128 .BR dist ,
129 then this switch is ignored\0--\0it makes
130 no sense to redistribute a message in this fashion.  Sometimes you want
131 .B send
132 to pause after posting a partial message.  This is usually
133 the case when you are running
134 .B sendmail
135 and expect to generate a
136 lot of partial messages.  The argument to
137 .B \-split
138 tells it how long
139 to pause between postings.
140 .PP
141 .B Send
142 with no
143 .I file
144 argument will query whether the draft
145 is the intended file, whereas
146 .B \-draft
147 will suppress this question.
148 Once the transport system has successfully accepted custody of the
149 message, the file will be renamed with a leading comma, which allows
150 it to be retrieved until the next draft message is sent.  If there are
151 errors in the formatting of the message,
152 .B send
153 will abort with a
154 (hopefully) helpful error message.
155 .PP
156 If a \*(lqBcc:\*(rq field is encountered, its addresses will be used for
157 delivery, and the \*(lqBcc:\*(rq field will be removed from the message
158 sent to sighted recipients.  The blind recipients will receive an entirely
159 new message with a minimal set of headers.  Included in the body of the
160 message will be a copy of the message sent to the sighted recipients.
161 If
162 .B \-filter
163 .I filterfile
164 is specified, then this copy is filtered
165 (re\-formatted) by
166 .B mhl
167 prior to being sent to the blind recipients.
168 Alternately, if you specify the
169 .B -mime
170 switch, then
171 .B send
172 will
173 use the MIME rules for encapsulation.
174 .PP
175 Prior to sending the message, the fields \*(lqFrom:\ user@local\*(rq,
176 and \*(lqDate:\ now\*(rq will be appended to the headers in the message.
177 If the environment variable
178 .B $SIGNATURE
179 is set, then its value
180 is used as your personal name when constructing the \*(lqFrom:\*(rq
181 line of the message.  If this environment variable is not set, then
182 .B send
183 will consult the profile entry \*(lqSignature\*(rq for
184 this information.
185 If
186 .B \-msgid
187 is specified, then a \*(lqMessage\-ID:\*(rq field will also
188 be added to the message.
189 .PP
190 If
191 .B send
192 is re\-distributing a message (when invoked by
193 .BR dist ),
194 then \*(lqResent\-\*(rq will be prepended to each of these
195 fields: \*(lqFrom:\*(rq, \*(lqDate:\*(rq, and \*(lqMessage\-ID:\*(rq.
196 If the message already contains a \*(lqFrom:\*(rq field, then a
197 \*(lqSender: user@local\*(rq field will be added as well.  (An already
198 existing \*(lqSender:\*(rq field is an error!)
199 .PP
200 By using the
201 .B \-format
202 switch, each of the entries in the \*(lqTo:\*(rq
203 and \*(lqcc:\*(rq fields will be replaced with \*(lqstandard\*(rq
204 format entries.  This standard format is designed to be usable by all
205 of the message handlers on the various systems around the Internet.
206 If
207 .B \-noformat
208 is given, then headers are output exactly as they appear
209 in the message draft.
210 .PP
211 If an \*(lqFcc:\ folder\*(rq is encountered, the message will be copied
212 to the specified folder for the sender in the format in which it will
213 appear to any non\-Bcc receivers of the message.  That is, it will have
214 the appended fields and field reformatting.  The \*(lqFcc:\*(rq fields
215 will be removed from all outgoing copies of the message.
216 .PP
217 By using the
218 .B \-width
219 .I columns
220 switch, the user can direct
221 .B send
222 as to how long it should make header lines containing addresses.
223 .PP
224 If
225 .B nmh
226 has been compiled with SASL support, the
227 .B \-sasl
228 switch will enable
229 the use of SASL authentication with the SMTP MTA.  Depending on the
230 SASL mechanism used, this may require an additional password prompt from the
231 user (but the
232 .RI \*(lq \&.netrc \*(rq
233 file can be used to store this password).
234 .B \-saslmech
235 switch can be used to select a particular SASL mechanism,
236 and the the
237 .B \-user
238 switch can be used to select a authorization userid
239 to provide to SASL other than the default.
240 .PP
241 Currently SASL security layers are not supported for SMTP.
242 .BR nmh 's
243 SMTP SASL code
244 will always negotiate an unencrypted connection.  This means that while the SMTP
245 authentication can be encrypted, the subsequent data stream can not.  This is in
246 contrast to
247 .BR nmh 's
248 POP3 SASL support, where encryption is supported for both the
249 authentication and the data stream.
250 .PP
251 The files specified by the profile entry \*(lqAliasfile:\*(rq and any
252 additional alias files given by the
253 .B \-alias
254 .I aliasfile
255 switch will be
256 read (more than one file, each preceded by
257 .BR \-alias ,
258 can be named).
259 See
260 .BR mh\-alias (5)
261 for more information.
262
263 .SH FILES
264 .fc ^ ~
265 .nf
266 .ta \w'/usr/local/nmh/etc/ExtraBigFileName  'u
267 ^$HOME/\&.mh\(ruprofile~^The user profile
268 .fi
269
270 .SH "PROFILE COMPONENTS"
271 .fc ^ ~
272 .nf
273 .ta 2.4i
274 .ta \w'ExtraBigProfileName  'u
275 ^Path:~^To determine the user's nmh directory
276 ^Draft\-Folder:~^To find the default draft\-folder
277 ^Aliasfile:~^For a default alias file
278 ^Signature:~^To determine the user's mail signature
279 ^mailproc:~^Program to post failure notices
280 ^postproc:~^Program to post the message
281 .fi
282
283 .SH "SEE ALSO"
284 comp(1), dist(1), forw(1), repl(1), mh\-alias(5), post(8)
285
286 .SH DEFAULTS
287 .nf
288 .RB ` file "' defaults to <mh\-dir>/draft"
289 .RB ` \-alias "' defaults to %etcdir%/MailAliases"
290 .RB ` \-nodraftfolder '
291 .RB ` \-nofilter '
292 .RB ` \-format '
293 .RB ` \-forward '
294 .RB ` \-nomime '
295 .RB ` \-nomsgid '
296 .RB ` \-nopush '
297 .RB ` \-noverbose '
298 .RB ` \-nowatch '
299 .RB ` "\-width\ 72" '
300 .fi
301
302 .SH CONTEXT
303 None
304
305 .SH BUGS
306 Under some configurations, it is not possible to monitor the mail delivery
307 transaction;
308 .B \-watch
309 is a no-op on those systems.
310 .PP
311 Using
312 .B \-split
313 .I 0
314 doesn't work correctly.