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