]> diplodocus.org Git - nmh/blobdiff - man/send.man
Fix tests with oauth disabled.
[nmh] / man / send.man
index 83cf19ae7f9d9ed3e7667493bff28ccd59987f87..2691c899ba6c042d1e4de785b61b2ffa1747a842 100644 (file)
@@ -1,7 +1,7 @@
 .\"
 .\" %nmhwarning%
 .\"
-.TH SEND %manext1% "December 22, 2013" "%nmhversion%"
+.TH SEND %manext1% "March 23, 2016" "%nmhversion%"
 .SH NAME
 send \- send a message
 .SH SYNOPSIS
@@ -32,6 +32,8 @@ send \- send a message
 .RB [ \-watch " | " \-nowatch ]
 .RB [ \-mts
 .IR smtp " | " sendmail/smtp " | " sendmail/pipe ]
+.RB [ \-sendmail
+.IR program ]
 .RB [ \-server
 .IR servername ]
 .RB [ \-port
@@ -42,6 +44,8 @@ send \- send a message
 .IR ssf ]
 .RB [ \-saslmech
 .IR mechanism ]
+.RB [ \-authservice
+.IR service ]
 .RB [ \-snoop ]
 .RB [ \-user
 .IR username ]
@@ -54,11 +58,6 @@ send \- send a message
 \&...]
 .RB [ \-version ]
 .RB [ \-help ]
-.RB [ \-attach
-.IR header-field-name ]
-.RB [ \-noattach ]
-.RB [ \-attachformat
-.IR 0 " | " 1 " | " 2 ]
 .ad
 .SH DESCRIPTION
 .B Send
@@ -83,24 +82,39 @@ profile component.  Most of the features attributed to
 are actually performed by
 .BR post .
 .PP
-By default the draft is scanned for a header named
-.IR Nmh-Attachment .
+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.
-This conversion occurs before all other processing.  The header name
-can be changed with the
-.B \-attach
-option.  This behavior can be disabled completely with the
-.B \-noattach
-option.  The
-.B whatnow
+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.
-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
 Determination of the content MIME type inserted into the Content-Type
@@ -109,9 +123,9 @@ header for each part depends on how the
 installation was configured.  If a program, such as
 .B file
 with a
-.B --mime
+.B \-\-mime
 or
-.B -i
+.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
@@ -135,56 +149,21 @@ if it contains characters outside of the ASCII range.  See
 .IR mhshow (1)
 for more details and example syntax.
 .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.
-.PP
-The
-.B -attachformat
-option specifies the MIME header field formats:  a value of
-.B 0
-includes the
-.I x-unix-mode
-attribute as noted above.  A value of
-.BR 1 ,
-the default,
-suppresses that, puts the file name in 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 an attachment, 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
--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; name="VERSION"; charset="us-ascii"
 Content-Description: VERSION
 Content-Disposition: attachment; filename="VERSION"
-
--attachformat 2:
-Content-Type: text/plain; name="VERSION"; charset="us-ascii"
-Content-Description: VERSION
-Content-Disposition: attachment; filename="VERSION"; modification-date="Mon, 19 Dec 2005 22:39:51 -0600"
 .fi
 .PP
+See
+.IR mhbuild (1)
+for explanation of how the Content-Disposition value is selected.
+.PP
 If
 .B \-push
 is specified,
@@ -387,23 +366,33 @@ switch, the user can direct
 as to how long it should make header lines containing addresses.
 .PP
 The mail transport system default is provided in
-.I %etcdir%/mts.conf
+.I %nmhetcdir%/mts.conf
 but can be overriiden here with the
 .B \-mts
 switch.
 .PP
+If nmh is using as its mail transport system
+.BR sendmail/pipe ,
+the
+.B \-sendmail
+switch can be used to override the default
+.B sendmail
+program.
+.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
+.I %nmhetcdir%/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.)
+plaintext or easily decoded base64.)  If
+.B \-saslmech xoauth2
+is used, the HTTP transaction is also shown.
 .PP
 If
 .B nmh
@@ -424,7 +413,7 @@ and the
 .B \-user
 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
+mh\-profile(5) man page describes the ways to supply a username and
 password.
 .PP
 If SASL authentication is successful,
@@ -441,6 +430,24 @@ underlying SASL mechanism.  A value of 0 disables encryption.
 .PP
 If
 .B nmh
+has been compiled with OAuth support, the
+.B \-saslmech xoauth2
+switch will enable OAuth authentication.  The
+.B \-user
+switch must be used, and the
+.I user-name
+must be an email address the user has for the service, which must
+be specified with the
+.B \-authservice
+.I service
+switch.  Before using this, the user must authorize nmh by running
+.B mhlogin
+and grant authorization to that account.  See the
+.B mhlogin
+man page for more details.
+.PP
+If
+.B nmh
 has been compiled with TLS support, the
 .B \-tls
 and
@@ -461,6 +468,12 @@ The
 .B \-notls
 switch will disable all attempts to negotiate TLS.
 .PP
+If port 465 is specified and none of the TLS switches were enabled,
+.B \-initialtls
+will be implied if TLS support was compiled in.  Though port 465 for
+SMTPS (SMTP over SSL) was deregistered by IANA in 1998, it is still
+used for that service.
+.PP
 The files specified by the profile entry \*(lqAliasfile:\*(rq and any
 additional alias files given by the
 .B \-alias
@@ -475,7 +488,7 @@ for more information.
 .SH FILES
 .fc ^ ~
 .nf
-.ta \w'%etcdir%/ExtraBigFileName  'u
+.ta \w'%nmhetcdir%/ExtraBigFileName  'u
 ^$HOME/\&.mh\(ruprofile~^The user profile
 .fi
 .SH "PROFILE COMPONENTS"
@@ -495,7 +508,9 @@ for more information.
 .IR dist (1),
 .IR file (1),
 .IR forw (1),
+.IR mhbuild (1),
 .IR mhparam (1),
+.IR mhlogin (1),
 .IR repl (1),
 .IR whatnow (1),
 .IR mh\-alias (5),
@@ -505,7 +520,7 @@ for more information.
 .SH DEFAULTS
 .nf
 .RB ` file "' defaults to <mh\-dir>/draft"
-.RB ` \-alias "' defaults to %etcdir%/MailAliases"
+.RB ` \-alias "' defaults to %nmhetcdir%/MailAliases"
 .RB ` \-nodraftfolder '
 .RB ` \-nofilter '
 .RB ` \-format '
@@ -517,8 +532,6 @@ for more information.
 .RB ` \-noverbose '
 .RB ` \-nowatch '
 .RB ` "\-width\ 72" '
-.RB ` "\-attach\ Nmh-Attachment" '
-.RB ` "\-attachformat\ 1" '
 .fi
 .SH CONTEXT
 None