annotate conf/doc/mh-mail.rf @ 12:441a2190cfae

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