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