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