Added all of the MH sources, including RCS files, in
[mmh] / docs / historical / mh-6.8.5 / conf / doc / mh-mail.rf
1 .\"     @(MHWARNING)
2 .\" @(#)$Id: mh-mail.rf,v 1.6 1992/05/12 22:23:34 jromine Exp $
3 .SC MH-MAIL 5
4 .NA
5 mh-mail \- message format for MH message system
6 .SY
7 any \fIMH\fR command
8 .DE
9 \fIMH\fR processes messages in a particular format.
10 It should be noted that although neither Bell nor Berkeley mailers produce
11 message files in the format that \fIMH\fR prefers,
12 \fIMH\fR can read message files in that antiquated format.
13
14 Each user possesses a mail drop box which initially receives
15 all messages processed by \fIpost\fR\0(8).
16 \fIInc\fR\0(1) will read from that drop box and incorporate the new messages
17 found there into the user's own mail folders (typically `+inbox').
18 The mail drop
19 box consists of one or more messages.
20 @BEGIN: MMDFMTS
21 To facilitate the
22 separation of messages, each message begins and ends with
23 a line consisting of nothing but four CTRL\-A (octal 001)
24 characters.
25 @END: MMDFMTS
26 @BEGIN: MHMTS
27 To facilitate the
28 separation of messages, each message begins and ends with
29 a line consisting of nothing but four CTRL\-A (octal 001)
30 characters.
31 @END: MHMTS
32
33 Messages
34 are expected to consist of lines of text.
35 Graphics and binary data are not handled.
36 No data compression is accepted.
37 All text is clear
38 ASCII 7-bit data.
39
40 The general \*(lqmemo\*(rq framework of RFC\-822 is used.
41 A message consists of a block of information in a rigid format,
42 followed by general text with no specified format.
43 The rigidly formatted first part of a message is called the header,
44 and the free-format portion is called the body.
45 The header must always exist, but the body is optional.
46 These parts are separated by an empty line,
47 i.e., two consecutive newline characters.
48 Within \fIMH\fR,
49 the header and body may be separated by a line consisting of dashes:
50
51 .nf
52 .in +.5i
53 .ne 10
54 .eo
55 .so @(MHETCPATH)/components
56 .ec
57 .in -.5i
58 .fi
59
60 The header is composed of one or more header items.
61 Each header item can be viewed as a single logical line of ASCII
62 characters.
63 If the text of a header item extends across several
64 real lines, the continuation lines are indicated by leading
65 spaces or tabs.
66
67 Each header item is called a component and is composed of a
68 keyword or name, along with associated text.
69 The keyword begins at the
70 left margin, may NOT contain spaces or tabs, may not exceed 63
71 characters (as specified by RFC\-822), and is terminated by a colon (`:').
72 Certain
73 components (as identified by their keywords) must follow rigidly
74 defined formats in their text portions.
75
76 The text for most formatted components
77 (e.g., \*(lqDate:\*(rq and \*(lqMessage\-Id:\*(rq)
78 is produced automatically.
79 The only ones entered by the
80 user are address fields such as \*(lqTo:\*(rq, \*(lqcc:\*(rq, etc.
81 Internet addresses
82 are assigned mailbox names and host computer specifications.
83 The
84 rough format is \*(lqlocal@domain\*(rq, such as \*(lqMH@UCI\*(rq,
85 or \*(lqMH@UCI\-ICSA.ARPA\*(rq.
86 Multiple addresses are separated by commas.
87 A missing host/domain is assumed to be the local host/domain.
88
89 As mentioned above,
90 a blank line (or a line of dashes)
91 signals that all following text up to the end of the file is the body.
92 No formatting is expected or enforced within the body.
93
94 Following is a list of header components that are considered
95 meaningful to various MH programs.
96 .in +.5i
97 .ti -.5i
98 Date:
99 .br
100 Added by \fIpost\fR\0(8),
101 contains date and time of the message's entry into the transport system.
102
103 .ti -.5i
104 From:
105 .br
106 Added by \fIpost\fR\0(8),
107 contains the address of the author or authors (may be more than one if a
108 \*(lqSender:\*(rq field is present).
109 Replies are typically directed to addresses in the \*(lqReply\-To:\*(rq or
110 \*(lqFrom:\*(rq field (the former has precedence if present).
111
112 .ti -.5i
113 Sender:
114 .br
115 Added by \fIpost\fR\0(8)
116 in the event that the message already has a \*(lqFrom:\*(rq line.
117 This line contains the address of the actual sender.
118 Replies are never sent to addresses in the \*(lqSender:\*(rq field.
119
120 .ti -.5i
121 To:
122 .br
123 Contains addresses of primary recipients.
124
125 .ti -.5i
126 cc:
127 .br
128 Contains addresses of secondary recipients.
129
130 .ti -.5i
131 Bcc:
132 .br
133 Still more recipients.
134 However, the \*(lqBcc:\*(rq line is not copied onto the message as delivered,
135 so these recipients are not listed.
136 \fIMH\fR uses an encapsulation method for blind copies, see \fIsend\fR\0(1).
137
138 .ti -.5i
139 Fcc:
140 .br
141 Causes \fIpost\fR\0(8) to copy the message into the specified folder for the
142 sender,
143 if the message was successfully given to the transport system.
144
145 .ti -.5i
146 Message\-ID:
147 .br
148 A unique message identifier added by \fIpost\fR\0(8) if the `\-msgid' flag
149 is set.
150
151 .ti -.5i
152 Subject:
153 .br
154 Sender's commentary.  It is displayed by \fIscan\fR\0(1).
155
156 .ti -.5i
157 In\-Reply\-To:
158 .br
159 A commentary line added by \fIrepl\fR\0(1) when replying to a message.
160
161 .ti -.5i
162 Resent\-Date:
163 .br
164 Added when redistributing a message by \fIpost\fR\0(8).
165
166 .ti -.5i
167 Resent\-From:
168 .br
169 Added when redistributing a message by \fIpost\fR\0(8).
170
171 .ti -.5i
172 Resent\-To:
173 .br
174 New recipients for a message resent by \fIdist\fR\0(1).
175
176 .ti -.5i
177 Resent\-cc:
178 .br
179 Still more recipients.
180 See \*(lqcc:\*(rq and \*(lqResent\-To:\*(rq.
181
182 .ti -.5i
183 Resent\-Bcc:
184 .br
185 Even more recipients.
186 See \*(lqBcc:\*(rq and \*(lqResent\-To:\*(rq.
187
188 .ti -.5i
189 Resent\-Fcc:
190 .br
191 Copy resent message into a folder.
192 See \*(lqFcc:\*(rq and \*(lqResent\-To:\*(rq.
193
194 .ti -.5i
195 Resent\-Message\-Id:
196 .br
197 A unique identifier glued on by \fIpost\fR\0(8) if the `\-msgid' flag
198 is set.
199 See \*(lqMessage\-Id:\*(rq and \*(lqResent\-To:\*(rq.
200
201 .ti -.5i
202 Resent:
203 .br
204 Annotation for \fIdist\fR\0(1) under the `\-annotate' option.
205
206 .ti -.5i
207 Forwarded:
208 .br
209 Annotation for \fIforw\fR\0(1) under the `\-annotate' option.
210
211 .ti -.5i
212 Replied:
213 .br
214 Annotation for \fIrepl\fR\0(1) under the `\-annotate' option.
215 .in -.5i
216 .sp
217 .Fi
218 ^@(MHDROPLOC)~^Location of mail drop
219 .Pr
220 None
221 .Sa
222 \fIStandard for the Format of ARPA Internet Text Messages\fR (aka RFC\-822)
223 .De
224 None
225 .Co
226 None
227 .En