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

[nmh] / man / send.man

diff --git a/man/send.man b/man/send.man
index 0c65f5acd4975926fad5a284615215ead149c016..c83a74fe88cf894baf8b9e70acd025cf9bf8356d 100644 (file)
--- a/man/send.man
+++ b/man/send.man
@@ -1,8 +1,7 @@
 .\"
 .\" %nmhwarning%
 .\"
 .\" %nmhwarning%

-.\" $Id$

 .\"
 .\"

-.TH SEND %manext1% "%nmhdate%" MH.6.8 [%nmhversion%]
+.TH SEND %manext1% "January 23, 2014" "%nmhversion%"

 .SH NAME
 send \- send a message
 .SH SYNOPSIS
 .SH NAME
 send \- send a message
 .SH SYNOPSIS


@@ -24,26 +23,37 @@ send \- send a message
 .RB [ \-forward " | " \-noforward ]
 .RB [ \-mime " | " \-nomime ]
 .RB [ \-msgid " | " \-nomsgid ]
 .RB [ \-forward " | " \-noforward ]
 .RB [ \-mime " | " \-nomime ]
 .RB [ \-msgid " | " \-nomsgid ]

+.RB [ \-messageid
+.IR localname " | " random ]

 .RB [ \-push " | " \-nopush ]
 .RB [ \-split
 .IR seconds ]
 .RB [ \-verbose " | " \-noverbose ]
 .RB [ \-watch " | " \-nowatch ]
 .RB [ \-push " | " \-nopush ]
 .RB [ \-split
 .IR seconds ]
 .RB [ \-verbose " | " \-noverbose ]
 .RB [ \-watch " | " \-nowatch ]

+.RB [ \-mts
+.IR smtp " | " sendmail/smtp " | " sendmail/pipe ]
+.RB [ \-server
+.IR servername ]
+.RB [ \-port
+.IR port-name/number ]

 .RB [ \-sasl ]
 .RB [ \-sasl ]

+.RB [ \-nosasl ]
+.RB [ \-saslmaxssf
+.IR ssf ]

 .RB [ \-saslmech
 .IR mechanism ]
 .RB [ \-saslmech
 .IR mechanism ]

+.RB [ \-snoop ]

 .RB [ \-user
 .IR username ]
 .RB [ \-user
 .IR username ]

+.RB [ \-tls ]
+.RB [ \-initialtls ]
+.RB [ \-notls ]

 .RB [ \-width
 .IR columns ]
 .RB [ file
 .RB [ \-width
 .IR columns ]
 .RB [ file

-\&...] 
+\&...]

 .RB [ \-version ]
 .RB [ \-help ]
 .RB [ \-version ]
 .RB [ \-help ]

-.RB [ \-attach
-.IR header-field-name ]
-.RB [ \-attachformat
-.IR 0 " | " 1 " | " 2 ]

 .ad
 .SH DESCRIPTION
 .B Send
 .ad
 .SH DESCRIPTION
 .B Send


@@ -67,79 +77,83 @@ profile component.  Most of the features attributed to
 .B send
 are actually performed by
 .BR post .
 .B send
 are actually performed by
 .BR post .

-
-.PP
-If a
-.I header-field-name
-is supplied using the
-.B -attach
-option, the draft is scanned for a header whose field name matches the
-supplied
-.IR header-field-name .
+.PP
+Before
+.B send
+gives the message to
+.B post
+for delivery, the message is processed by
+.B mhbuild
+to perform any necessary MIME encoding of the outgoing message.  This
+can be changed by the
+.I buildmimeproc
+profile component.
+.B mhbuild
+is invoked with the
+.B \-auto
+switch, so
+.B mhbuild
+directives are not processed by default.  See
+.IR mhbuild (1)
+for more information.
+.PP
+.B mhbuild
+will scan the message draft for a header named
+.IR Attach .

 The draft is converted to a MIME message if one or more matches are found.
 The draft is converted to a MIME message if one or more matches are found.

-This conversion occurs before all other processing.
+This conversion occurs before all other processing.  The
+.IR whatnow (1)
+man page describes the user interface for managing MIME attachments via
+this mechanism.

 .PP
 The first part of the MIME message is the draft body if that body contains
 any non-blank characters.
 .PP
 The first part of the MIME message is the draft body if that body contains
 any non-blank characters.

-The body of each header field whose name matches the
-.I header-field-name
-is interpreted as a file name, and each file named is included as a separate
+The body of each
+.I Attach
+header field is interpreted as a file name, and each file named is included as a separate

 part in the MIME message.
 .PP
 part in the MIME message.
 .PP

-For file names with dot suffixes, the context is scanned for a
+Determination of the content MIME type inserted into the Content-Type
+header for each part depends on how the
+.B nmh
+installation was configured.  If a program, such as
+.B file
+with a
+.B \-\-mime
+or
+.B \-i
+option, was found that can specify the type of a file as a MIME type
+string, then that will be used.  To determine if your
+.B nmh
+was so configured, run
+.B mhparam mimetypeproc
+and see if a non-empty string is displayed.
+.PP
+If your
+.B nmh
+was not configured with a program to specify a file type as a MIME
+string, then a different method is used to determine the content-type
+string.  For file names with dot suffixes, the profile is scanned for a

 .I mhshow-suffix-
 entry for that suffix.
 .I mhshow-suffix-
 entry for that suffix.

-The content-type for the part is taken from that context entry if a match is
-found.
+The content-type for the part is taken from that profile entry if a match is
+found.  If a match is not found in the user profile, the mhn.defaults
+profile is scanned next.

 If no match is found or the file does not have a dot suffix, the content-type
 is text/plain if the file contains only ASCII characters or application/octet-stream
 If no match is found or the file does not have a dot suffix, the content-type
 is text/plain if the file contains only ASCII characters or application/octet-stream

-if it contains characters outside of the ASCII range.
-.PP
-Each part contains a name attribute that is the last component of the path name.
-A
-.I x-unix-mode
-attribute containing the file mode accompanies each part.
-Finally, a description attribute is generated by running the
-.I file
-command on the file.
+if it contains characters outside of the ASCII range.  See
+.IR mhshow (1)
+for more details and example syntax.

 .PP
 .PP

-The
-.B -attachformat
-option specifies the MIME header field formats:  a value of
-.B 0,
-the default,
-includes the
-.I x-unix-mode
-attribute as noted above.  A value of
-.B 1
-suppresses both that and the \*(lqContent-Description\*(rq header, and
-adds a \*(lqContent-Disposition\*(rq header.  A value of
-.B 2
-adds the file
-.I modification-date
-parameter to the \*(lqContent-Disposition\*(rq header.  You can
-specify one value in your profile, and override it for individual
-messages at the
-.I whatnow
-prompt.
-.PP
-Here are example message part headers for each of the
-.B -attachformat
-values:
+Each attached MIME part contains a 
+\*(lqContent-Description\*(rq header that includes the filename, and
+adds a \*(lqContent-Disposition\*(rq header.
+Here is an example of MIME part headers for an attachment:

 .PP
 .nf
 .PP
 .nf

--attachformat 0:
-Content-Type: text/plain; name="VERSION"; x-unix-mode="0644";
-       charset="us-ascii"
-Content-Description: ASCII text 
-
--attachformat 1:
-Content-Type: text/plain; charset="us-ascii"
+Content-Type: text/plain; name="VERSION"; charset="us-ascii"
+Content-Description: VERSION

 Content-Disposition: attachment; filename="VERSION"
 Content-Disposition: attachment; filename="VERSION"

-
--attachformat 2:
-Content-Type: text/plain; charset="us-ascii"
-Content-Disposition: attachment; filename="VERSION"; modification-date="Mon, 19 Dec 2005 22:39:51 -0600"

 .fi
 .PP
 If
 .fi
 .PP
 If


@@ -187,7 +201,7 @@ the
 .B nmh
 draft folder facility.  This is an advanced (and highly
 useful) feature.  Consult the
 .B nmh
 draft folder facility.  This is an advanced (and highly
 useful) feature.  Consult the

-.BR mh-draft (5)
+.IR mh-draft (5)

 man page for more
 information.
 .PP
 man page for more
 information.
 .PP


@@ -224,7 +238,8 @@ is the intended file, whereas
 .B \-draft
 will suppress this question.
 Once the transport system has successfully accepted custody of the
 .B \-draft
 will suppress this question.
 Once the transport system has successfully accepted custody of the

-message, the file will be renamed with a leading comma, which allows
+message, the file will be renamed with a site-dependent prefix
+(usually a comma), which allows

 it to be retrieved until the next draft message is sent.  If there are
 errors in the formatting of the message,
 .B send
 it to be retrieved until the next draft message is sent.  If there are
 errors in the formatting of the message,
 .B send


@@ -237,7 +252,9 @@ sent to sighted recipients.  The blind recipients will receive an entirely
 new message with a minimal set of headers.  Included in the body of the
 message will be a copy of the message sent to the sighted recipients.
 .PP
 new message with a minimal set of headers.  Included in the body of the
 message will be a copy of the message sent to the sighted recipients.
 .PP

-If a \*(lqDcc:\*(rq field is encountered, its addresses will be used for
+If a \*(lqDcc:\*(rq field is encountered and the
+.B sendmail/pipe
+mail transport method is not in use, its addresses will be used for

 delivery, and the \*(lqDcc:\*(rq field will be removed from the message.  The
 blind recipients will receive the same message sent to the sighted
 recipients. *WARNING* Recipients listed in the \*(lqDcc:\*(rq field receive no
 delivery, and the \*(lqDcc:\*(rq field will be removed from the message.  The
 blind recipients will receive the same message sent to the sighted
 recipients. *WARNING* Recipients listed in the \*(lqDcc:\*(rq field receive no


@@ -266,30 +283,55 @@ switch, then
 will
 use the MIME rules for encapsulation.
 .PP
 will
 use the MIME rules for encapsulation.
 .PP

-Prior to sending the message, the fields \*(lqFrom:\ user@local\*(rq,
-and \*(lqDate:\ now\*(rq will be appended to the headers in the message.
-If the environment variable
-.B $SIGNATURE
-is set, then its value
-is used as your personal name when constructing the \*(lqFrom:\*(rq
-line of the message.  If this environment variable is not set, then
-.B send
-will consult the profile entry \*(lqSignature\*(rq for
-this information.
+Prior to sending the message, the \*(lqDate:\ now\*(rq field will be appended to the headers in the message.

 If
 .B \-msgid
 is specified, then a \*(lqMessage\-ID:\*(rq field will also
 be added to the message.
 .PP
 If
 .B \-msgid
 is specified, then a \*(lqMessage\-ID:\*(rq field will also
 be added to the message.
 .PP

+The
+.B \-messageid
+switch selects the style used for the part appearing after the @
+in \*(lqMessage\-ID:\*(rq, \*(lqResent\-Message\-ID:\*(rq, and
+\*(lqContent\-ID:\*(rq header fields.  The two acceptable options are
+.B localname
+(which is the default),
+and
+.BR random .
+With
+.BR localname ,
+the local hostname is used.  With
+.BR random ,
+a random sequence of characters is used instead.  Note that the
+.B \-msgid
+switch must be enabled for this switch to have any effect.
+.PP

 If
 .B send
 is re\-distributing a message (when invoked by
 .BR dist ),
 then \*(lqResent\-\*(rq will be prepended to each of these
 fields: \*(lqFrom:\*(rq, \*(lqDate:\*(rq, and \*(lqMessage\-ID:\*(rq.
 If
 .B send
 is re\-distributing a message (when invoked by
 .BR dist ),
 then \*(lqResent\-\*(rq will be prepended to each of these
 fields: \*(lqFrom:\*(rq, \*(lqDate:\*(rq, and \*(lqMessage\-ID:\*(rq.

-If the message already contains a \*(lqFrom:\*(rq field, then a
-\*(lqSender: user@local\*(rq field will be added as well.  (An already
-existing \*(lqSender:\*(rq field is an error!)
+.PP
+A \*(lqFrom:\*(rq field is required for all outgoing messages.  Multiple
+addresses are permitted in the \*(lqFrom:\*(rq field, but a \*(lqSender:\*(rq
+field is required in this case.  Otherwise a \*(lqSender:\*(rq field
+is optional.
+.PP
+If a message with multiple \*(lqFrom:\*(rq
+addresses does
+.B NOT
+include a \*(lqSender:\*(rq field but does include an \*(lqEnvelope\-From:\*(rq
+field, the \*(lqEnvelope\-From:\*(rq field will be used to construct
+a \*(lqSender:\*(rq field.
+.PP
+When using SMTP for mail submission, the envelope\-from used for the SMTP
+transaction is derived from the \*(lqEnvelope\-From:\*(rq field.
+If no \*(lqEnvelope\-From:\*(rq field is present, the \*(lqSender:\*(rq
+field is used.  If neither the \*(lqEnvelope\-From:\*(rq nor the
+\*(lqSender:\*(rq field is present, the \*(lqFrom:\*(rq field is used.
+When \*(lqEnvelope\-From:\*(rq appears in a message
+it will be removed from the final outgoing message.

 .PP
 By using the
 .B \-format
 .PP
 By using the
 .B \-format


@@ -315,32 +357,80 @@ switch, the user can direct
 .B send
 as to how long it should make header lines containing addresses.
 .PP
 .B send
 as to how long it should make header lines containing addresses.
 .PP

+The mail transport system default is provided in
+.I %etcdir%/mts.conf
+but can be overriiden here with the
+.B \-mts
+switch.
+.PP
+If nmh is using the SMTP MTA, the
+.B \-server
+and the
+.B \-port
+switches can be used to override the default mail server (defined by the
+.I %etcdir%/mts.conf
+.RI servers
+entry).  The
+.B \-snoop
+switch can be used to view the SMTP transaction.  (Beware that the
+SMTP transaction may contain authentication information either in
+plaintext or easily decoded base64.)
+.PP

 If
 .B nmh
 has been compiled with SASL support, the
 .B \-sasl
 If
 .B nmh
 has been compiled with SASL support, the
 .B \-sasl

-switch will enable
+and
+.B \-nosasl
+switches will enable and disable

 the use of SASL authentication with the SMTP MTA.  Depending on the
 SASL mechanism used, this may require an additional password prompt from the
 user (but the
 the use of SASL authentication with the SMTP MTA.  Depending on the
 SASL mechanism used, this may require an additional password prompt from the
 user (but the

-.RI \*(lq \&.netrc \*(rq
-file can be used to store this password).
+.I netrc
+file can be used to store this password, as described in the
+mh-profile(5) man page).  The

 .B \-saslmech
 switch can be used to select a particular SASL mechanism,
 .B \-saslmech
 switch can be used to select a particular SASL mechanism,

-and the the
+and the

 .B \-user
 .B \-user

-switch can be used to select a authorization userid
-to provide to SASL other than the default.
-.PP
-Currently SASL security layers are not supported for SMTP.
-.BR nmh 's
-SMTP SASL code
-will always negotiate an unencrypted connection.  This means that while the SMTP
-authentication can be encrypted, the subsequent data stream can not.  This is in
-contrast to
-.BR nmh 's
-POP3 SASL support, where encryption is supported for both the
-authentication and the data stream.
+switch can be used to select a authorization userid to provide to SASL
+other than the default.  The credentials profile entry in the
+mh_profile(5) man page describes the ways to supply a username and
+password.
+.PP
+If SASL authentication is successful,
+.BR nmh
+will attempt to negotiate a security layer for session encryption.
+Encrypted data is labelled with `(encrypted)' and `(decrypted)' when
+viewing the SMTP transaction with the
+.B \-snoop
+switch.  The
+.B \-saslmaxssf
+switch can be used to select the maximum value of the Security Strength Factor.
+This is an integer value and the exact meaning of this value depends on the
+underlying SASL mechanism.  A value of 0 disables encryption.
+.PP
+If
+.B nmh
+has been compiled with TLS support, the
+.B \-tls
+and
+.B \-initialtls
+switches will require the negotiation of TLS when
+connecting to the SMTP MTA.  The
+.B \-tls
+switch will negotiate TLS as part of the normal SMTP protocol
+using the STARTTLS command.  The
+.B \-initialtls
+will negotiate TLS immediately after the connection has
+taken place, before any SMTP commands are sent or received.  Encrypted data
+is labelled with `(tls-encrypted)' and
+`(tls-decrypted)' when viewing the SMTP transction with the
+.B \-snoop
+switch.
+The
+.B \-notls
+switch will disable all attempts to negotiate TLS.

 .PP
 The files specified by the profile entry \*(lqAliasfile:\*(rq and any
 additional alias files given by the
 .PP
 The files specified by the profile entry \*(lqAliasfile:\*(rq and any
 additional alias files given by the


@@ -351,16 +441,14 @@ read (more than one file, each preceded by
 .BR \-alias ,
 can be named).
 See
 .BR \-alias ,
 can be named).
 See

-.BR mh\-alias (5)
+.IR mh\-alias (5)

 for more information.
 for more information.

-

 .SH FILES
 .fc ^ ~
 .nf
 .ta \w'%etcdir%/ExtraBigFileName  'u
 ^$HOME/\&.mh\(ruprofile~^The user profile
 .fi
 .SH FILES
 .fc ^ ~
 .nf
 .ta \w'%etcdir%/ExtraBigFileName  'u
 ^$HOME/\&.mh\(ruprofile~^The user profile
 .fi

-

 .SH "PROFILE COMPONENTS"
 .fc ^ ~
 .nf
 .SH "PROFILE COMPONENTS"
 .fc ^ ~
 .nf


@@ -373,10 +461,18 @@ for more information.
 ^mailproc:~^Program to post failure notices
 ^postproc:~^Program to post the message
 .fi
 ^mailproc:~^Program to post failure notices
 ^postproc:~^Program to post the message
 .fi

-

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

-comp(1), dist(1), forw(1), repl(1), mh\-alias(5), post(8)
-
+.IR comp (1),
+.IR dist (1),
+.IR file (1),
+.IR forw (1),
+.IR mhparam (1),
+.IR repl (1),
+.IR whatnow (1),
+.IR mh\-alias (5),
+.IR mh\-profile (5),
+.IR mh\-tailor (5),
+.IR post (8)

 .SH DEFAULTS
 .nf
 .RB ` file "' defaults to <mh\-dir>/draft"
 .SH DEFAULTS
 .nf
 .RB ` file "' defaults to <mh\-dir>/draft"


@@ -387,16 +483,14 @@ comp(1), dist(1), forw(1), repl(1), mh\-alias(5), post(8)
 .RB ` \-forward '
 .RB ` \-nomime '
 .RB ` \-nomsgid '
 .RB ` \-forward '
 .RB ` \-nomime '
 .RB ` \-nomsgid '

+.RB ` "\-messageid\ localname" '

 .RB ` \-nopush '
 .RB ` \-noverbose '
 .RB ` \-nowatch '
 .RB ` "\-width\ 72" '
 .RB ` \-nopush '
 .RB ` \-noverbose '
 .RB ` \-nowatch '
 .RB ` "\-width\ 72" '

-.RB ` "\-attachformat\ 0" '

 .fi
 .fi

-

 .SH CONTEXT
 None
 .SH CONTEXT
 None

-

 .SH BUGS
 Under some configurations, it is not possible to monitor the mail delivery
 transaction;
 .SH BUGS
 Under some configurations, it is not possible to monitor the mail delivery
 transaction;