PMDF User's Guide
UNIX Edition
send- Send a mail message
Sends a mail message using PMDF.
restrictions
None.
Syntax
pmdf send message-file-spec[,...] recipient-address[,...]
Qualifiers |
Defaults |
-abort
|
See text
|
-comments=comment
|
None
|
-delivery_receipt_to=address
|
None
|
-errors_to=address
|
None
|
-expand_limit=limit
|
None
|
-extra=header_line
|
None
|
-from=address
|
See text
|
-headers
|
-noheaders
|
-ignore
|
See text
|
-importance=importance
|
None
|
-keywords=keywords
|
None
|
-log=log-list
|
-nolog
|
-multipart
|
None
|
-organization=organization
|
None
|
-priority=priority
|
None
|
-read_receipt_to=address
|
None
|
-references=references
|
None
|
-reply_to=address
|
None
|
-return_address=address
|
See text
|
-rfrom=address
|
None
|
-rreply_to=address
|
None
|
-sensitivity=sensitivity
|
None
|
-subaddress=subaddress
|
None
|
-subject=subject
|
None
|
-user=username
|
See text
|
-warnings_to=address
|
None
|
-x_ps_qualifiers=qualifiers
|
None
|
Positional Qualifiers |
Defaults |
-bcc
|
-to
|
-cc
|
-to
|
-encoding=encoding
|
See text
|
-filename=name
|
-nofilename
|
-mode=mode
|
-mode=TEXT
|
-to
|
-to
|
prompts
Message file:
|
message-file-spec[,...]
|
Address:
|
recipient-address
|
Parameters
message-file-spec[,...]
One or more files to comprise the message; wildcards are not allowed.
Each file is included in the mail message as a separate part.
recipient-address[,...]
The recipients who are to receive copies of the message. Standard RFC
822 format addresses must be used. Quoting may be needed to preserve
case and special characters.
Description
The pmdf send
utility provides a simple easy-to-use interface to PMDF for sending
messages.
Qualifiers
-abort
By default, if an error occurs while processing an input message file or recipient address, pmdf send
will ask the user whether or not to send the message anyhow. If the -abort
qualifier is specified, then pmdf send
will merely exit (with an error) when a problem occurs during file or address processing. The -abort
and -ignore
qualifiers are mutually exclusive --- only one or the other may be used.
-bcc
Positional parameter which may be used to specify that the given recipient address, and subsequent recipient addresses, should be treated as Bcc:
addresses. By default, recipient addresses are interpreted as To:
addresses. Must be placed after the address to which it should apply.
-cc
Positional parameter which may be used to specify that the given recipient address, and subsequent recipient addresses, should be treated as cc:
addresses. By default, recipient addresses are interpreted as To:
addresses. Must be placed after the address to which it should apply.
-comments=comments
This qualifier may be used to specify the contents of the Comments:
header line. If this qualifier is not used, any existing Comments:
header line is used; if none exists no Comments:
header line will appear in the outgoing message unless the PMDF_COMMENTS
environment variable is defined.
-delivery_receipt_to=address
This qualifier may be used to specify the contents of the Delivery-receipt-to:
header line. If this qualifier is not used, any existing Delivery-receipt-to:
header line is used; if none exists, no Delivery-receipt-to:
header line will appear in the outgoing message.
-encoding=encoding
Specify the encoding method to use to encode an input message file. Normally, no encoding is used; however, this depends upon the file type as determined by the file extension. The available encoding methods are BASE32
, BASE64
, CBASE64
(compressed base64), BASE85
, BINHEX
, BTOA HEXADECIMAL
, QUOTED_PRINTABLE
, UUENCODE
, and CUUENCODE
(compressed UUENCODE). No encoding may be specified for a file containing header information (-header
)
. Must be placed after the address to which it should apply.
-errors_to=address
This qualifier may be used to specify the contents of the Errors-to:
header line. If this qualifier is not used, any existing Errors-to:
header line is used; if none exists no Errors-to:
header line will appear in the outgoing message unless the PMDF_ERRORS_TO
environment variable is defined.
-expand_limit=limit
If, during the process of expanding the message's recipient addresses, the count of recipients exceeds the specified limit then the address expansion will be deferred. pmdf send
will expand the addresses "off-line" so that the user need
not wait.
-extra=header_line
Additional header lines may be specified with the -extra
qualifier. Specify the entire text of the header line; e.g., -extra="X-Sign: Aquarius"
. Multiple header lines should be specified using the format -extra=(hdr1,hdr2,...)
; note that you will need to escape the parentheses characters to the
shell by quoting each with a backslash.
-filename=name
-nofilename (default)
This positional qualifier, when specified, causes the name of the input file to be included as a parameter to the associated MIME Content-type:
header line. Must be placed after the input file to which it should
apply. You can specify the name to be included in the header line, or
if you do not specify a name, by default the name of the input file
will be used.
-from=address
This qualifier may be used to specify the contents of the From:
header line. If this qualifier is not used, any existing From:
header line is used; if none exists and the PMDF_FROM
environment variable is not defined, then a From:
header line will be constructed from the username of the user invoking pmdf send
and from the local host name. Note that even if a From: address is provided your address will appear in a Sender:
header line.
-headers
-noheaders (default)
The input message is assumed to have no header attached to it by default. The -headers
qualifier tells pmdf send
that a header is already attached to the message; it is modified and
used to form the header for the message that is actually sent.
-ignore
By default, if an error occurs while processing an input message file or recipient address, pmdf send
will ask the user whether or not to send the message anyhow. If the -ignore
qualifier is specified, then pmdf send
will not ask the user whether or not to send the message --- it will send the good input files to the good recipient addresses. The -abort
and -ignore
qualifiers are mutually exclusive --- only one or the other may be used.
-importance=importance
This qualifier may be used to specify the contents of the Importance:
header line. If this qualifier is not used, any existing Importance:
header line is used; if none exists no Importance:
header line will appear in the outgoing message unless the PMDF_IMPORTANCE
environment variable is defined.
-keywords=keywords
This qualifier may be used to specify the contents of the Keywords:
header line. If this qualifier is not used, any existing Keywords:
header line is used; if none exists no Keywords:
header line will appear in the outgoing message unless the PMDF_KEYWORDS
environment variable is defined.
-log=log-list
Specify what sort of informational message pmdf send
should issue. The log-list is a list of zero or more of the following: NONE
, ADDRESSES
, FILES
, MESSAGES
, IDS
, or ALL
. NONE
indicates no logging, is equivalent to -nolog
, and is the default. ADDRESSES
causes one informational message to be output for each specified recipient address. FILES
causes one information message to be output for each input file. MESSAGES
produces a summary message that indicates how many addresses and files were processed successfully. IDS produces an informational message showing the contents of the Message-Id:
header of the resulting message. ALL activates all forms of logging; it cannot be specified simultaneously with NONE
. -log=messages
is the default if -log
is specified without an explicit log-list.
-mode=mode
Specify the file access mode to use when reading an input message file. By default, input files are read in text mode. The access modes are TEXT
and BLOCK
. A file containing header information must be accessed using TEXT
mode. Must be placed after the address to which it should apply.
-multipart
This qualifier may be used to tell pmdf send
to always format the messages it sends as multipart MIME messages.
-organization=organization
This qualifier may be used to specify the contents of the Organization:
header line. This qualifier is ignored if an Organization:
header line is already present. If this qualifier is not specified or negated, no Organization:
header line is added unless the PMDF_ORGANIZATION
environment variable is defined.
-priority=priority
This qualifier may be used to specify the contents of the Priority:
header line. If this qualifier is not used, any existing Priority:
header line is used; if none exists, no Priority:
header line will appear in the outgoing message.
-read_receipt_to=address
This qualifier may be used to specify the contents of the Read-receipt-to:
header line. If this qualifier is not used, any existing Read-receipt-to:
header line is used; if none exists, no Read-receipt-to:
header line will appear in the outgoing message.
-references=references
This qualifier may be used to specify the contents of the References:
header line. If this qualifier is not used, any existing References:
header line is used; if none exists no References:
header line will appear in the outgoing message unless the PMDF_REFERENCES
environment variable is defined.
-reply_to=address
This qualifier may be used to specify the contents of the Reply-to:
header line. If this qualifier is not used, any existing Reply-to:
header line is used; if none exists, no Reply-to:
header line will appear in the outgoing message unless the PMDF_REPLY_TO
environment variable is defined.
-return_address=address
Specify the address to be used as the envelope originator address. If
the message is returned as undeliverable by the mail system transport
the non-delivery notice is normally sent to this address.
-rfrom=address
This qualifier may be used to specify the contents of the Resent-From:
header line. If this qualifier is not used, any existing Resent-From:
header line is used; if no such header line exists, no Resent-From:
header line will be attached to the outgoing message.
-rreply_to=address
This qualifier may be used to specify the contents of the Resent-Reply-to:
header line. If this qualifier is not used, any existing Resent-Reply-to:
header line is used; if no such header line exists no Resent-Reply-to:
header line will be attached to the outgoing message.
-sensitivity=sensitivity
This qualifier may be used to specify the contents of the Sensitivity:
header line. If this qualifier is not used, any existing Sensitivity:
header line is used; if none exists, no Sensitivity:
header line will appear in the outgoing message unless the PMDF_SENSITIVITY
environment variable is defined.
-subaddress=subaddress
Specify a subaddress to attach to the envelope From:
address; e.g., if the envelope From:
address is rex@example.com then specifying -subaddress="Postmaster"
would result in the envelope From:
address rex+Postmaster@example.com.
-subject=subject
This qualifier may be used to specify the contents of the Subject:
header line. If this qualifier is not used, any existing Subject:
header line is used; if none exists no Subject:
header line will appear in the outgoing message.
-to
Positional parameter which may be used to specify that a given recipient address should be treated as a To:
address, which is the default interpretation. Must be placed after the
address to which it should apply.
-user=username
Specify the local username to use in the message sender's address; (this will be the From: address if no other From:
address is given and the Sender:
address otherwise). You must either have superuser privilege or be in the pmdf_world
or pmdf_world_username
group id in order to use this qualifier and specify a username other than your own. The special case of a blank string will not insert any Sender:
information.
-warnings_to=address
This qualifier may be used to specify the contents of the Warnings-to:
header line. If this qualifier is not used, any existing Warnings-to:
header line is used; if none exists, no Warnings-to:
header line will appear in the outgoing message unless the PMDF_WARNINGS_TO
environment variable is defined.
-x_ps_qualifiers=qualifiers
This qualifier may be used to specify the contents of the X-ps-qualifiers:
header line. If this qualifier is not used, any existing X-ps-qualifiers:
header line is used; if none exists no X-ps-qualifiers:
header line will appear in the outgoing message unless the PMDF_X_PS_QUALIFIERS
environment variable is defined.
EXAMPLES
#1 |
% pmdf send -subject=\"Test message\" msg.txt bob@example.com
|
This command will send as a mail message the contents of the file msg.txt
to the address bob@example.com. The Subject:
line of the message will read Subject: Test message
.
#2 |
% pmdf send -subject=\"Test message\" \
-extra='("X-Favorite-Drink: Hot chocolate", \
"X-IQ: 20/20")' msg.txt bob@example.com
|
Send a message to bob@example.com with the header lines
Subject: Test message
X-Favorite-Drink: Hot chocolate
X-IQ: 20/20
|
(Of course, these will not be the only header lines present.)
#3 |
% pmdf send -headers hdr.txt,msg.txt bob@example.com
|
Send a message to bob@example.com. The headers for the message will be derived from the file hdr.txt
while the body of the message will be the contents of the file msg.txt
.
#4 |
% pmdf send msg.txt -filename bob@example.com -to, sue@college.com -cc
|
This command shows the use of the positional qualifiers -filename
, -to
, and -cc
. They are placed after the parameter to which they apply.