Clarified post.man and send.man for those not completely up on SASL terminology.
[mmh] / man / send.man
1 .\"
2 .\" %nmhwarning%
3 .\" $Id$
4 .\"
5 .\" include the -mh macro file
6 .so %etcdir%/tmac.h
7 .\"
8 .TH SEND %manext1% MH.6.8 [%nmhversion%]
9 .SH NAME
10 send \- send a message
11 .SH SYNOPSIS
12 .in +.5i
13 .ti -.5i
14 send
15 \%[\-alias\ aliasfile]
16 \%[\-draft]
17 \%[\-draftfolder\ +folder]
18 .br
19 \%[\-draftmessage\ msg] \%[\-nodraftfolder]
20 .br
21 \%[\-filter\ filterfile] \%[\-nofilter]
22 \%[\-format] \%[\-noformat]
23 .br
24 \%[\-forward] \%[\-noforward]
25 \%[\-mime] \%[\-nomime]
26 \%[\-msgid]
27 .br
28 \%[\-nomsgid]
29 \%[\-push] \%[\-nopush]
30 \%[\-split\ seconds]
31 .br
32 \%[\-verbose] \%[\-noverbose]
33 \%[\-watch] \%[\-nowatch]
34 \%[\-sasl] \%[\-saslmech\ mechanism] \%[\-user\ username]
35 .br
36 \%[\-width\ columns]
37 \%[file\ ...] 
38 \%[\-version]
39 \%[\-help]
40 .in -.5i
41 .SH DESCRIPTION
42 \fISend\fR will cause each of the specified files to be delivered
43 to each of the destinations in the \*(lqTo:\*(rq, \*(lqcc:\*(rq,
44 \*(lqBcc:\*(rq, and \*(lqFcc:\*(rq fields of the message.  If \fIsend\fR
45 is re\-distributing a message, as invoked from \fIdist\fR, then the
46 corresponding \*(lqResent\-xxx\*(rq fields are examined instead.
47
48 By default, \fIsend\fR uses the program \fIpost\fR(8) to do the actual
49 delivery of the messages, although this can be changed by defining the
50 \fIpostproc\fR profile component.  Most of the features attributed to
51 \fIsend\fR are actually performed by \fIpost\fR.
52
53 If `\-push' is specified, \fIsend\fR will detach itself from the user's
54 terminal and perform its actions in the background.  If \fIpush\fR\0'd
55 and the draft can't be sent, then an error message will be sent (using
56 the mailproc) back to the user.  If `\-forward' is given, then a copy
57 of the draft will be attached to this failure notice.  Using `\-push'
58 differs from putting \fIsend\fR in the background because the output is
59 trapped and analyzed by \fInmh\fR.
60
61 If `\-verbose' is specified, \fIsend\fR will indicate the interactions
62 occurring with the transport system, prior to actual delivery.
63 If `\-watch' is specified \fIsend\fR will monitor the delivery of local
64 and network mail.  Hence, by specifying both switches, a large detail
65 of information can be gathered about each step of the message's entry
66 into the transport system.
67
68 The `\-draftfolder\ +folder' and `\-draftmessage\ msg' switches invoke
69 the \fInmh\fR draft folder facility.  This is an advanced (and highly
70 useful) feature.  Consult the \fImh-draft\fR(5) man page for more
71 information.
72
73 If `\-split' is specified, \fIsend\fR will split the draft into one
74 or more partial messages prior to sending.  This makes use of the
75 MIME features in nmh.  Note however that if \fIsend\fR is
76 invoked under \fIdist\fR\0(1), then this switch is ignored\0--\0it makes
77 no sense to redistribute a message in this fashion.  Sometimes you want
78 \fIsend\fR to pause after posting a partial message.  This is usually
79 the case when you are running \fIsendmail\fR and expect to generate a
80 lot of partial messages.  The argument to `\-split' tells it how long
81 to pause between postings.
82
83 \fISend\fR with no \fIfile\fR argument will query whether the draft
84 is the intended file, whereas `\-draft' will suppress this question.
85 Once the transport system has successfully accepted custody of the
86 message, the file will be renamed with a leading comma, which allows
87 it to be retrieved until the next draft message is sent.  If there are
88 errors in the formatting of the message, \fIsend\fR will abort with a
89 (hopefully) helpful error message.
90
91 If a \*(lqBcc:\*(rq field is encountered, its addresses will be used for
92 delivery, and the \*(lqBcc:\*(rq field will be removed from the message
93 sent to sighted recipients.  The blind recipients will receive an entirely
94 new message with a minimal set of headers.  Included in the body of the
95 message will be a copy of the message sent to the sighted recipients.
96 If `\-filter\ filterfile' is specified, then this copy is filtered
97 (re\-formatted) by \fImhl\fR prior to being sent to the blind recipients.
98 Alternately, if you specify the `-mime' switch, then \fIsend\fR will
99 use the MIME rules for encapsulation.
100
101 Prior to sending the message, the fields \*(lqFrom:\ user@local\*(rq,
102 and \*(lqDate:\ now\*(rq will be appended to the headers in the message.
103 If the environment variable \fB$SIGNATURE\fR is set, then its value
104 is used as your personal name when constructing the \*(lqFrom:\*(rq
105 line of the message.  If this environment variable is not set, then
106 \fIsend\fR will consult the profile entry \*(lqSignature\*(rq for
107 this information.  On hosts where \fInmh\fR was configured with the UCI
108 option, if \fB$SIGNATURE\fR is not set and the \*(lqSignature\*(rq profile
109 entry is not present, then the file \fB$HOME\fR/.signature is consulted.
110 If `\-msgid' is specified, then a \*(lqMessage\-ID:\*(rq field will also
111 be added to the message.
112
113 If \fIsend\fR is re\-distributing a message (when invoked by
114 \fIdist\fR\0), then \*(lqResent\-\*(rq will be prepended to each of these
115 fields: \*(lqFrom:\*(rq, \*(lqDate:\*(rq, and \*(lqMessage\-ID:\*(rq.
116 If the message already contains a \*(lqFrom:\*(rq field, then a
117 \*(lqSender: user@local\*(rq field will be added as well.  (An already
118 existing \*(lqSender:\*(rq field is an error!)
119
120 By using the `\-format' switch, each of the entries in the \*(lqTo:\*(rq
121 and \*(lqcc:\*(rq fields will be replaced with \*(lqstandard\*(rq
122 format entries.  This standard format is designed to be usable by all
123 of the message handlers on the various systems around the Internet.
124 If `\-noformat' is given, then headers are output exactly as they appear
125 in the message draft.
126
127 If an \*(lqFcc:\ folder\*(rq is encountered, the message will be copied
128 to the specified folder for the sender in the format in which it will
129 appear to any non\-Bcc receivers of the message.  That is, it will have
130 the appended fields and field reformatting.  The \*(lqFcc:\*(rq fields
131 will be removed from all outgoing copies of the message.
132
133 By using the `\-width\ columns' switch, the user can direct \fIsend\fR
134 as to how long it should make header lines containing addresses.
135
136 If nmh has been compiled with SASL support, the `\-sasl' switch will enable
137 the use of SASL authentication with the SMTP MTA.  Depending on the
138 SASL mechanism used, this may require an additional password prompt from the
139 user (but the \*(lq.netrc\*(rq file can be used to store this password).
140 `\-saslmech' switch can be used to select a particular SASL mechanism,
141 and the the `\-user' switch can be used to select a authorization userid
142 to provide to SASL other than the default.
143
144 Currently SASL security layers are not supported for SMTP.  nmh's SMTP SASL code
145 will always negotiate an unencrypted connection.  This means that while the SMTP
146 authentication can be encrypted, the subsequent data stream can not.  This is in
147 contrast to nmh's POP3 SASL support, where encryption is supported for both the
148 authentication and the data stream.
149
150 The files specified by the profile entry \*(lqAliasfile:\*(rq and any
151 additional alias files given by the `\-alias aliasfile' switch will be
152 read (more than one file, each preceded by `\-alias', can be named).
153 See \fImh\-alias\fR\0(5) for more information.
154 .Fi
155 ^$HOME/\&.mh\(ruprofile~^The user profile
156 .Pr
157 ^Path:~^To determine the user's nmh directory
158 .Ps
159 ^Draft\-Folder:~^To find the default draft\-folder
160 .Ps
161 ^Aliasfile:~^For a default alias file
162 .Ps
163 ^Signature:~^To determine the user's mail signature
164 .Ps
165 ^mailproc:~^Program to post failure notices
166 .Ps
167 ^postproc:~^Program to post the message
168 .Sa
169 comp(1), dist(1), forw(1), repl(1), mh\-alias(5), post(8)
170 .De
171 `file' defaults to <mh\-dir>/draft
172 .Ds
173 `\-alias %etcdir%/MailAliases'
174 .Ds
175 `\-nodraftfolder'
176 .Ds
177 `\-nofilter'
178 .Ds
179 `\-format'
180 .Ds
181 `\-forward'
182 .Ds
183 `\-nomime'
184 .Ds
185 `\-nomsgid'
186 .Ds
187 `\-nopush'
188 .Ds
189 `\-noverbose'
190 .Ds
191 `\-nowatch'
192 .Ds
193 `\-width\ 72'
194 .Co
195 None
196 .Bu
197 Under some configurations, it is not possible to monitor the mail delivery
198 transaction; `\-watch' is a no-op on those systems.
199 .sp
200 Using `\-split\00' doesn't work correctly.
201 .En