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