Fixed printf's in test suite.
[mmh] / man / mh-mail.man
1 .TH MH-MAIL %manext5% "%nmhdate%" MH.6.8 [%nmhversion%]
2 .\"
3 .\" %nmhwarning%
4 .\"
5 .SH NAME
6 mh-mail \- message format for nmh message system
7 .SH SYNOPSIS
8 any
9 .B nmh
10 command
11 .SH DESCRIPTION
12 .B nmh
13 processes messages in a particular format.  It should be noted
14 that although neither Bell nor Berkeley mailers produce message files
15 in the format that
16 .B nmh
17 prefers,
18 .B nmh
19 can read message files in that antiquated format.
20 .PP
21 Each user possesses a mail drop box which initially receives all messages
22 processed by
23 .BR post .
24 .B Inc
25 will read from that drop
26 box and incorporate the new messages found there into the user's own
27 mail folders (typically
28 .RI \*(lq +inbox \*(rq).
29 The mail drop box consists of one or more messages.
30 .PP
31 Messages are expected to consist of lines of text.  Graphics and binary
32 data are not handled.  No data compression is accepted.  All text is
33 clear ASCII 7-bit data.
34 .PP
35 The general \*(lqmemo\*(rq framework of RFC\-822 is used.  A message
36 consists of a block of information in a rigid format, followed by
37 general text with no specified format.  The rigidly formatted first
38 part of a message is called the header, and the free-format portion is
39 called the body.  The header must always exist, but the body is optional.
40 These parts are separated by an empty line, i.e., two consecutive newline
41 characters.  Within
42 .B nmh ,
43 the header and body may be separated by a line consisting of dashes:
44 .PP
45 .RS 5
46 .nf
47 From: Local Mailbox <user@example.com>
48 To:
49 cc:
50 Fcc: +outbox
51 Subject:
52 .fi
53 .RE
54 .PP
55 The header is composed of one or more header items.  Each header item can
56 be viewed as a single logical line of ASCII characters.  If the text of
57 a header item extends across several real lines, the continuation lines
58 are indicated by leading spaces or tabs.
59 .PP
60 Each header item is called a component and is composed of a keyword or
61 name, along with associated text.  The keyword begins at the left margin,
62 may NOT contain spaces or tabs, may not exceed 63 characters (as specified
63 by RFC\-822), and is terminated by a colon (`:').  Certain components
64 (as identified by their keywords) must follow rigidly defined formats
65 in their text portions.
66 .PP
67 The text for most formatted components (e.g., \*(lqDate:\*(rq and
68 \*(lqMessage\-Id:\*(rq) is produced automatically.  The only ones entered
69 by the user are address fields such as \*(lqTo:\*(rq, \*(lqcc:\*(rq,
70 etc.  Internet addresses are assigned mailbox names and host computer
71 specifications.  The rough format is \*(lqlocal@domain\*(rq, such as
72 \*(lqMH@UCI\*(rq, or \*(lqMH@UCI\-ICSA.ARPA\*(rq.  Multiple addresses
73 are separated by commas.  A missing host/domain is assumed to be the
74 local host/domain.
75 .PP
76 As mentioned above, a blank line (or a line of dashes) signals that all
77 following text up to the end of the file is the body.  No formatting is
78 expected or enforced within the body.
79 .PP
80 Following is a list of header components that are considered
81 meaningful to various
82 .B nmh
83 programs.
84 .PP
85 .BR Date :
86 .RS 5
87 Added by
88 .BR post ,
89 contains date and time of the message's entry
90 into the mail transport system.
91 .RE
92 .PP
93 .BR From :
94 .RS 5
95 This header is filled in by default with the system's idea of the user's local
96 mailbox.  This can be changed with the
97 .B Local\-Mailbox
98 profile entry.  It
99 contains the address of the author or authors
100 (may be more than one if a \*(lqSender:\*(rq field is present).  For a
101 standard reply (using
102 .BR repl ),
103 the reply address is constructed by
104 checking the following headers (in this order): \*(lqMail-Reply\-To:\*(rq,
105 \*(lqReply\-To:\*(rq, \*(lqFrom:\*(rq, \*(lqSender:\*(rq.
106 A \*(lqFrom:\*(rq
107 header MUST exist when the message is sent to
108 .BR post,
109 otherwise the message will be rejected.
110 .RE
111 .PP
112 .BR Mail\-Reply\-To :
113 .RS 5
114 For a standard reply (using
115 .BR repl ),
116 the reply address is
117 constructed by checking the following headers (in this order):
118 \*(lqMail-Reply\-To:\*(rq, \*(lqReply\-To:\*(rq, \*(lqFrom:\*(rq,
119 \*(lqSender:\*(rq.
120 .RE
121 .PP
122 .BR Mail\-Followup\-To :
123 .RS 5
124 When making a \*(lqgroup\*(rq reply (using
125 .B repl
126 .BR \-group ),
127 any addresses in this field will take precedence, and no other reply address
128 will be added to the draft.  If this header is not available, then the
129 return addresses will be constructed from the \*(lqMail-Reply\-To:\*(rq,
130 or \*(lqReply\-To:\*(rq, or \*(lqFrom:\*(rq, along with adding the
131 addresses from the headers \*(lqTo:\*(rq, \*(lqcc:\*(rq, as well as
132 adding your personal address.
133 .RE
134 .PP
135 .BR Reply\-To :
136 .RS 5
137 For a standard reply (using
138 .BR repl ),
139 the reply address is
140 constructed by checking the following headers (in this order):
141 \*(lqMail-Reply\-To:\*(rq, \*(lqReply\-To:\*(rq, \*(lqFrom:\*(rq,
142 \*(lqSender:\*(rq.
143 .RE
144 .PP
145 .BR Sender :
146 .RS 5
147 Required by
148 .B post
149 in the event that the message has multiple addresses on the
150 \*(lqFrom:\*(rq line.  It is otherwise optional.  This line should
151 contain the address of the actual
152 sender.
153 .RE
154 .PP
155 .BR To :
156 .RS 5
157 Contains addresses of primary recipients.
158 .RE
159 .PP
160 .BR cc :
161 .RS 5
162 Contains addresses of secondary recipients.
163 .RE
164 .PP
165 .BR Bcc :
166 .RS 5
167 Still more recipients.  However, the \*(lqBcc:\*(rq line is not
168 copied onto the message as delivered, so these recipients are not
169 listed.
170 .B nmh
171 uses an encapsulation method for blind copies, see
172 .IR send (1).
173 .RE
174 .PP
175 .BR Dcc :
176 .RS 5
177 Still more recipients.  However, the \*(lqDcc:\*(rq line is not
178 copied onto the messages as delivered.  Recipients on the \*(lqDcc:\*(rq
179 line receive the same messsage as recipients on the \*(lqTo:\*(rq and
180 \*(lqcc:\*(rq lines.  See
181 .IR send (1)
182 for more details.
183 .B Dcc
184 is not supported with the
185 .B sendmail/pipe
186 mail transport method.
187 .RE
188 .PP
189 .BR Fcc :
190 .RS 5
191 Causes
192 .B post
193 to copy the message into the specified folder for the sender,
194 if the message was successfully given to the transport system.
195 .RE
196 .PP
197 .BR Message\-ID :
198 .RS 5
199 A unique message identifier added by
200 .B post
201 if the
202 .B \-msgid
203 flag is set.
204 .RE
205 .PP
206 .BR Subject :
207 .RS 5
208 Sender's commentary.  It is displayed by
209 .BR scan .
210 .RE
211 .PP
212 .BR In\-Reply\-To :
213 .RS 5
214 A commentary line added by
215 .B repl
216 when replying to a message.
217 .RE
218 .PP
219 .BR Resent\-Date :
220 .RS 5
221 Added when redistributing a message by
222 .BR post .
223 .RE
224 .PP
225 .BR Resent\-From :
226 .RS 5
227 Added when redistributing a message by
228 .BR post .
229 .RE
230 .PP
231 .BR Resent\-To:
232 .RS 5
233 New recipients for a message resent by
234 .BR dist .
235 .RE
236 .PP
237 .BR Resent\-cc :
238 .RS 5
239 Still more recipients. See \*(lqcc:\*(rq and \*(lqResent\-To:\*(rq.
240 .RE
241 .PP
242 .BR Resent\-Bcc :
243 .RS 5
244 Even more recipients. See \*(lqBcc:\*(rq and \*(lqResent\-To:\*(rq.
245 .RE
246 .PP
247 .BR Resent\-Fcc :
248 .RS 5
249 Copy resent message into a folder.
250 See \*(lqFcc:\*(rq and \*(lqResent\-To:\*(rq.
251 .RE
252 .PP
253 .BR Resent\-Message\-Id :
254 .RS 5
255 A unique identifier glued on by
256 .B post
257 if the
258 .B \-msgid
259 flag is set.
260 See \*(lqMessage\-Id:\*(rq and \*(lqResent\-To:\*(rq.
261 .RE
262 .PP
263 .BR Resent :
264 .RS 5
265 Annotation for
266 .B dist
267 under the
268 .B \-annotate
269 option.
270 .RE
271 .PP
272 .BR Forwarded :
273 .RS 5
274 Annotation for
275 .B forw
276 under the
277 .B \-annotate
278 option.
279 .RE
280 .PP
281 .BR Replied :
282 .RS 5
283 Annotation for
284 .B repl
285 under the
286 .B \-annotate
287 option.
288 .RE
289 .SH FILES
290 .fc ^ ~
291 .nf
292 .ta \w'%etcdir%/ExtraBigFileName  'u
293 ^%mailspool%/$USER~^Location of mail drop
294 .fi
295 .SH "SEE ALSO"
296 .I
297 Standard for the Format of ARPA Internet Text Messages
298 (RFC\-822)
299 .SH CONTEXT
300 None