Renames: s/+outbox/+sent/ and s/cc:/Cc:/
[mmh] / man / mh-mail.man5
1 .\"
2 .\" %nmhwarning%
3 .\"
4 .TH MH-MAIL %manext5% "%nmhdate%" MH.6.8 [%nmhversion%]
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 %components%
48 .fi
49 .RE
50 .PP
51 The header is composed of one or more header items.  Each header item can
52 be viewed as a single logical line of ASCII characters.  If the text of
53 a header item extends across several real lines, the continuation lines
54 are indicated by leading spaces or tabs.
55 .PP
56 Each header item is called a component and is composed of a keyword or
57 name, along with associated text.  The keyword begins at the left margin,
58 may NOT contain spaces or tabs, may not exceed 63 characters (as specified
59 by RFC\-822), and is terminated by a colon (`:').  Certain components
60 (as identified by their keywords) must follow rigidly defined formats
61 in their text portions.
62 .PP
63 The text for most formatted components (e.g., \*(lqDate:\*(rq and
64 \*(lqMessage\-Id:\*(rq) is produced automatically.  The only ones entered
65 by the user are address fields such as \*(lqTo:\*(rq, \*(lqCc:\*(rq,
66 etc.  Internet addresses are assigned mailbox names and host computer
67 specifications.  The rough format is \*(lqlocal@domain\*(rq, such as
68 \*(lqMH@UCI\*(rq, or \*(lqMH@UCI\-ICSA.ARPA\*(rq.  Multiple addresses
69 are separated by commas.  A missing host/domain is assumed to be the
70 local host/domain.
71 .PP
72 As mentioned above, a blank line (or a line of dashes) signals that all
73 following text up to the end of the file is the body.  No formatting is
74 expected or enforced within the body.
75 .PP
76 Following is a list of header components that are considered
77 meaningful to various
78 .B nmh
79 programs.
80 .PP
81 .BR Date :
82 .RS 5
83 Added by
84 .BR post ,
85 contains date and time of the message's entry
86 into the mail transport system.
87 .RE
88 .PP
89 .BR From :
90 .RS 5
91 Added by
92 .BR post ,
93 contains the address of the author or authors
94 (may be more than one if a \*(lqSender:\*(rq field is present).  For a
95 standard reply (using
96 .BR repl ,
97 the reply address is constructed by
98 checking the following headers (in this order): \*(lqMail-Reply\-To:\*(rq,
99 \*(lqReply\-To:\*(rq, \*(lqFrom:\*(rq, \*(lqSender:\*(rq.
100 .RE
101 .PP
102 .BR Mail\-Reply\-To :
103 .RS 5
104 For a standard reply (using
105 .BR repl ),
106 the reply address is
107 constructed by checking the following headers (in this order):
108 \*(lqMail-Reply\-To:\*(rq, \*(lqReply\-To:\*(rq, \*(lqFrom:\*(rq,
109 \*(lqSender:\*(rq.
110 .RE
111 .PP
112 .BR Mail\-Followup\-To :
113 .RS 5
114 When making a \*(lqgroup\*(rq reply (using
115 .B repl
116 .BR \-group ),
117 any addresses in this field will take precedence, and no other reply address
118 will be added to the draft.  If this header is not available, then the
119 return addresses will be constructed from the \*(lqMail-Reply\-To:\*(rq,
120 or \*(lqReply\-To:\*(rq, or \*(lqFrom:\*(rq, along with adding the
121 addresses from the headers \*(lqTo:\*(rq, \*(lqCc:\*(rq, as well as
122 adding your personal address.
123 .RE
124 .PP
125 .BR Reply\-To :
126 .RS 5
127 For a standard reply (using
128 .BR repl ),
129 the reply address is
130 constructed by checking the following headers (in this order):
131 \*(lqMail-Reply\-To:\*(rq, \*(lqReply\-To:\*(rq, \*(lqFrom:\*(rq,
132 \*(lqSender:\*(rq.
133 .RE
134 .PP
135 .BR Sender :
136 .RS 5
137 Added by
138 .B post
139 in the event that the message already has a
140 \*(lqFrom:\*(rq line.  This line contains the address of the actual
141 sender.
142 .RE
143 .PP
144 .BR To :
145 .RS 5
146 Contains addresses of primary recipients.
147 .RE
148 .PP
149 .BR cc :
150 .RS 5
151 Contains addresses of secondary recipients.
152 .RE
153 .PP
154 Bcc:
155 .RS 5
156 Still more recipients.  However, the \*(lqBcc:\*(rq line is not
157 copied onto the message as delivered, so these recipients are not
158 listed.
159 .B nmh
160 uses an encapsulation method for blind copies, see
161 .BR send .
162 .RE
163 .PP
164 .BR Fcc :
165 .RS 5
166 Causes
167 .B post
168 to copy the message into the specified folder for the sender,
169 if the message was successfully given to the transport system.
170 .RE
171 .PP
172 .BR Message\-ID :
173 .RS 5
174 A unique message identifier added by
175 .B post
176 if the
177 .B \-msgid
178 flag is set.
179 .RE
180 .PP
181 .BR Subject :
182 .RS 5
183 Sender's commentary.  It is displayed by
184 .BR scan .
185 .RE
186 .PP
187 .BR In\-Reply\-To :
188 .RS 5
189 A commentary line added by
190 .B repl
191 when replying to a message.
192 .RE
193 .PP
194 .BR Resent\-Date :
195 .RS 5
196 Added when redistributing a message by
197 .BR post .
198 .RE
199 .PP
200 .BR Resent\-From :
201 .RS 5
202 Added when redistributing a message by
203 .BR post .
204 .RE
205 .PP
206 .BR Resent\-To:
207 .RS 5
208 New recipients for a message resent by
209 .BR dist .
210 .RE
211 .PP
212 .BR Resent\-Cc :
213 .RS 5
214 Still more recipients. See \*(lqCc:\*(rq and \*(lqResent\-To:\*(rq.
215 .RE
216 .PP
217 .BR Resent\-Bcc :
218 .RS 5
219 Even more recipients. See \*(lqBcc:\*(rq and \*(lqResent\-To:\*(rq.
220 .RE
221 .PP
222 .BR Resent\-Fcc :
223 .RS 5
224 Copy resent message into a folder.
225 See \*(lqFcc:\*(rq and \*(lqResent\-To:\*(rq.
226 .RE
227 .PP
228 .BR Resent\-Message\-Id :
229 .RS 5
230 A unique identifier glued on by
231 .B post
232 if the
233 .B \-msgid
234 flag is set.
235 See \*(lqMessage\-Id:\*(rq and \*(lqResent\-To:\*(rq.
236 .RE
237 .PP
238 .BR Resent :
239 .RS 5
240 Annotation for
241 .B dist
242 under the
243 .B \-annotate
244 option.
245 .RE
246 .PP
247 .BR Forwarded :
248 .RS 5
249 Annotation for
250 .B forw
251 under the
252 .B \-annotate
253 option.
254 .RE
255 .PP
256 .BR Replied :
257 .RS 5
258 Annotation for
259 .B repl
260 under the
261 .B \-annotate
262 option.
263 .RE
264
265 .SH FILES
266 .fc ^ ~
267 .nf
268 .ta \w'%etcdir%/ExtraBigFileName  'u
269 ^%mailspool%/$USER~^Location of mail drop
270 .fi
271
272 .SH "SEE ALSO"
273 .I "Standard for the Format of ARPA Internet Text Messages
274 (RFC\-822)
275
276 .SH CONTEXT
277 None