Added note that suffixes were removed from filenames of temporary files.

[nmh] / man / mh-mail.man

diff --git a/man/mh-mail.man b/man/mh-mail.man
index 69e5fe4f64030e77e206c91cfdafaa2f6924bc7a..b14c8101afb9cc50f20992bead388deaed680c21 100644 (file)
--- a/man/mh-mail.man
+++ b/man/mh-mail.man
@@ -1,13 +1,9 @@
+.TH MH-MAIL %manext5% "January 8, 2014" "%nmhversion%"

 .\"
 .\" %nmhwarning%
 .\"
 .\"
 .\" %nmhwarning%
 .\"

-.TH MH-MAIL %manext5% "%nmhdate%" MH.6.8 [%nmhversion%]

 .SH NAME
 mh-mail \- message format for nmh message system
 .SH NAME
 mh-mail \- message format for nmh message system

-.SH SYNOPSIS
-any
-.B nmh
-command

 .SH DESCRIPTION
 .B nmh
 processes messages in a particular format.  It should be noted
 .SH DESCRIPTION
 .B nmh
 processes messages in a particular format.  It should be noted


@@ -32,14 +28,14 @@ Messages are expected to consist of lines of text.  Graphics and binary
 data are not handled.  No data compression is accepted.  All text is
 clear ASCII 7-bit data.
 .PP
 data are not handled.  No data compression is accepted.  All text is
 clear ASCII 7-bit data.
 .PP

-The general \*(lqmemo\*(rq framework of RFC\-822 is used.  A message
+The general \*(lqmemo\*(rq framework of RFC 822 is used.  A message

 consists of a block of information in a rigid format, followed by
 general text with no specified format.  The rigidly formatted first
 part of a message is called the header, and the free-format portion is
 called the body.  The header must always exist, but the body is optional.
 These parts are separated by an empty line, i.e., two consecutive newline
 characters.  Within
 consists of a block of information in a rigid format, followed by
 general text with no specified format.  The rigidly formatted first
 part of a message is called the header, and the free-format portion is
 called the body.  The header must always exist, but the body is optional.
 These parts are separated by an empty line, i.e., two consecutive newline
 characters.  Within

-.B nmh ,
+.BR nmh ,

 the header and body may be separated by a line consisting of dashes:
 .PP
 .RS 5
 the header and body may be separated by a line consisting of dashes:
 .PP
 .RS 5


@@ -60,7 +56,7 @@ are indicated by leading spaces or tabs.
 Each header item is called a component and is composed of a keyword or
 name, along with associated text.  The keyword begins at the left margin,
 may NOT contain spaces or tabs, may not exceed 63 characters (as specified
 Each header item is called a component and is composed of a keyword or
 name, along with associated text.  The keyword begins at the left margin,
 may NOT contain spaces or tabs, may not exceed 63 characters (as specified

-by RFC\-822), and is terminated by a colon (`:').  Certain components
+by RFC 822), and is terminated by a colon (`:').  Certain components

 (as identified by their keywords) must follow rigidly defined formats
 in their text portions.
 .PP
 (as identified by their keywords) must follow rigidly defined formats
 in their text portions.
 .PP


@@ -99,17 +95,29 @@ profile entry.  It
 contains the address of the author or authors
 (may be more than one if a \*(lqSender:\*(rq field is present).  For a
 standard reply (using
 contains the address of the author or authors
 (may be more than one if a \*(lqSender:\*(rq field is present).  For a
 standard reply (using

-.BR repl ,
+.BR repl ),

 the reply address is constructed by
 checking the following headers (in this order): \*(lqMail-Reply\-To:\*(rq,
 \*(lqReply\-To:\*(rq, \*(lqFrom:\*(rq, \*(lqSender:\*(rq.
 the reply address is constructed by
 checking the following headers (in this order): \*(lqMail-Reply\-To:\*(rq,
 \*(lqReply\-To:\*(rq, \*(lqFrom:\*(rq, \*(lqSender:\*(rq.

-A
-.BR From :
+A \*(lqFrom:\*(rq

 header MUST exist when the message is sent to
 .BR post,
 otherwise the message will be rejected.
 .RE
 .PP
 header MUST exist when the message is sent to
 .BR post,
 otherwise the message will be rejected.
 .RE
 .PP

+.BR Envelope\-From :
+.RS 5
+Used by
+.B post
+to specify a value for the sender's envelope address to the mail transport
+system.  If omitted, 
+.B post
+will use the value of the \*(lqSender:\*(rq or the \*(lqFrom:\*(rq header.
+See
+.IR send (1)
+for more details.
+.RE
+.PP

 .BR Mail\-Reply\-To :
 .RS 5
 For a standard reply (using
 .BR Mail\-Reply\-To :
 .RS 5
 For a standard reply (using


@@ -145,10 +153,11 @@ constructed by checking the following headers (in this order):
 .PP
 .BR Sender :
 .RS 5
 .PP
 .BR Sender :
 .RS 5

-Added by
+Required by

 .B post
 .B post

-in the event that the message already has a
-\*(lqFrom:\*(rq line.  This line contains the address of the actual
+in the event that the message has multiple addresses on the
+\*(lqFrom:\*(rq line.  It is otherwise optional.  This line should
+contain the address of the actual

 sender.
 .RE
 .PP
 sender.
 .RE
 .PP


@@ -162,14 +171,28 @@ Contains addresses of primary recipients.
 Contains addresses of secondary recipients.
 .RE
 .PP
 Contains addresses of secondary recipients.
 .RE
 .PP

-Bcc:
+.BR Bcc :

 .RS 5
 Still more recipients.  However, the \*(lqBcc:\*(rq line is not
 copied onto the message as delivered, so these recipients are not
 listed.
 .B nmh
 uses an encapsulation method for blind copies, see
 .RS 5
 Still more recipients.  However, the \*(lqBcc:\*(rq line is not
 copied onto the message as delivered, so these recipients are not
 listed.
 .B nmh
 uses an encapsulation method for blind copies, see

-.BR send .
+.IR send (1).
+.RE
+.PP
+.BR Dcc :
+.RS 5
+Still more recipients.  However, the \*(lqDcc:\*(rq line is not
+copied onto the messages as delivered.  Recipients on the \*(lqDcc:\*(rq
+line receive the same messsage as recipients on the \*(lqTo:\*(rq and
+\*(lqcc:\*(rq lines.  See
+.IR send (1)
+for more details.
+.B Dcc
+is not supported with the
+.B sendmail/pipe
+mail transport method.

 .RE
 .PP
 .BR Fcc :
 .RE
 .PP
 .BR Fcc :


@@ -210,8 +233,10 @@ Added when redistributing a message by
 .PP
 .BR Resent\-From :
 .RS 5
 .PP
 .BR Resent\-From :
 .RS 5

-Added when redistributing a message by
-.BR post .
+Used instead of the \*(lqFrom:\*(rq header when
+.B post 
+redistributes a message.  See \*(lqFrom:\*(rq for more information about
+this header is used.

 .RE
 .PP
 .BR Resent\-To:
 .RE
 .PP
 .BR Resent\-To:


@@ -272,17 +297,24 @@ under the
 .B \-annotate
 option.
 .RE
 .B \-annotate
 option.
 .RE

-
+.PP
+.BR Attach :
+.RS 5
+Used by
+.B mhbuild
+to specify a filename to attach to this message.  See
+.IR mhbuild (1)
+for more information.
+.RE

 .SH FILES
 .fc ^ ~
 .nf
 .ta \w'%etcdir%/ExtraBigFileName  'u
 ^%mailspool%/$USER~^Location of mail drop
 .fi
 .SH FILES
 .fc ^ ~
 .nf
 .ta \w'%etcdir%/ExtraBigFileName  'u
 ^%mailspool%/$USER~^Location of mail drop
 .fi

-

 .SH "SEE ALSO"
 .SH "SEE ALSO"

-.I "Standard for the Format of ARPA Internet Text Messages
-(RFC\-822)
-
+.I
+Standard for the Format of ARPA Internet Text Messages
+(RFC 822)

 .SH CONTEXT
 None
 .SH CONTEXT
 None