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