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