This chapter describes the commands you can run from the MAIL-CONFIG command line. MAIL-CONFIG lets you examine, modify, and save configuration files for the MultiNet SMTP mail system.
To invoke MAIL-CONFIG:
$ MULTINET CONFIGURE /MAIL
At any MAIL-CONFIG prompt, type ? to list the available commands. Use the MAIL-CONFIG HELP command to view online help for each MAIL-CONFIG command.
Changes do not take effect until you do one of the following:
· Restart the SMTP service with the commands:
@MULTINET:START_SMTP.COM
or
@MULTINET:START_SMTP_LOCAL.COM
· Restart your system.
For details on configuring electronic mail, refer to the MultiNet Installation and Administrator’s Guide.
The below table lists the commands you can run from the MAIL-CONFIG prompt.
|
MAIL-CONFIG Command |
Description |
|
ADD GATEWAY |
Adds a mail gateway to another domain. |
|
ADD LOCAL-DOMAIN |
Adds a domain to a list of domains that the MultiNet SMTP symbiont considers to be local. If users send mail to hosts beyond the local domains, MultiNet forwards the mail to the mail hub specified by the FORWARDER parameter. The local domain list affects mail forwarding only when the FORWARD-REMOTE-MAIL parameter is TRUE. |
|
ADD QUEUE-GROUP |
Forms a mail queue grouping of nodes in a cluster, or adds new nodes to an existing queue group. |
|
ATTACH |
Attaches your terminal to another process. |
|
CLEAR |
Erases all information from the current configuration; same as ERASE. |
|
DELETE GATEWAY |
Deletes a mail gateway. |
|
DELETE LOCAL-DOMAIN |
Deletes a domain from MultiNet's list of local domains. |
|
DELETE QUEUE-GROUP |
Deletes a queue group or removes a node from a queue group. When a node is removed from a named queue group, it becomes part of the default queue group. |
|
ERASE |
Erases all information from the current configuration; same as CLEAR. |
|
EXIT |
Saves the configuration file and exits from MAIL-CONFIG. |
|
GET |
Reads in a MultiNet SMTP configuration file. (Functionally equivalent to USE.) |
|
HELP |
Invokes MAIL-CONFIG command help. |
|
PUSH |
Accesses the DCL command interpreter. |
|
QUIT |
Prompts you to save the configuration file if it has been modified, then exits MAIL-CONFIG. |
|
REMOVE GATEWAY |
Functionally equivalent to DELETE GATEWAY. |
|
REMOVE QUEUE-GROUP |
Functionally equivalent to DELETE QUEUE-GROUP. |
|
SAVE |
Saves the current configuration file. |
|
SET ACCOUNTING-HOST |
Sets the host that SMTP accounting information should be sent to. |
|
SET ACCOUNTING-PORT |
Sets the port that the accounting logger is to listen on. |
|
SET ALIAS-FILE |
Identifies the file that holds mail aliases. |
|
SET DECNET-DOMAIN |
Sets the domain name for DECnet mail. |
|
SET DELIVERY-RECEIPTS |
Specifies whether mail receipts are sent when incoming mail containing Delivery-Receipt-To: or Return-Receipt-To: headers is submitted to the SMTP queue. |
|
SET DISABLE-PSIMAIL |
When TRUE, the MultiNet SMTP symbiont looks for messages addressed through PSImail, usually of the form PSI%address::user, and returns them to the sender marked user unknown. |
|
SET DISALLOW-USER-REPLY-TO |
When set to TRUE, prevents VMS MAIL users from setting a Reply-To: header address with the logical name MULTINET_SMTP_REPLY_TO. |
|
SET FORWARDER |
Specifies the host that will forward mail messages to other hosts. |
|
SET FORWARD-LOCAL-MAIL |
Forwards mail addressed to users on the local host to a central mail hub specified by the FORWARDER parameter. |
|
SET FORWARD-REMOTE-MAIL |
Forwards mail addressed to users on non-local hosts to a central mail hub specified by the FORWARDER parameter. |
|
SET HEADER-CONTROL |
Specifies which RFC-822 message headers should be included in messages delivered to local VMS MAIL users. |
|
SET HOST-ALIAS-FILE |
Specifies a file from which MultiNet obtains a list of host aliases. |
|
SET LOCAL-MAIL-FORWARDER |
Forwards local mail to a specific host. |
|
SET POSTMASTER |
Identifies the user responsible for mail on the system. |
|
SET QUEUE-COUNT |
Specifies the number of mail processing queues that should be created on a particular system. |
|
SET REPLY-CONTROL |
Specifies how Internet mail headers should be mapped to the VMS MAIL "From" header. |
|
SET RESENT-HEADERS |
When FALSE, the MultiNet SMTP symbiont omits the Resent-From, Resent-To, and Resent-Date headers that are usually included when a message is forwarded using a VMS MAIL forwarding address. |
|
SET RETRY-INTERVAL |
Specifies the amount of time that elapses before another attempt is made to send a message after a failed attempt. |
|
SET RETURN-INTERVAL |
Specifies the amount of time that a message can remain in the processing queue before it is returned to sender. |
|
SET RFC2789 |
Enables the startup of the Mail Monitoring MIB (RFC 2789). Requires SNMP AGENTX to be set. |
|
SET SEND-BROADCAST-CLASS |
Specifies the broadcast class to use to deliver immediate SEND messages. |
|
SET SMTP-HOST-NAMES |
Sets the host name from which all outgoing mail appears to be sent and aliases for which this host accepts incoming mail. |
|
SET START-QUEUE-MANAGER |
Determines whether START_SMTP.COM starts the VMS queue manager if it is not already running. |
|
SHOW |
Displays the current configuration. |
|
SPAWN |
Executes a single DCL command. |
|
STATUS |
Indicates whether the SMTP configuration has been modified. |
|
USE |
Reads in a non-standard configuration file. |
|
VERSION |
Displays the MAIL-CONFIG version and release information. |
|
WRITE |
Saves the current configuration file. |
Adds a mail gateway to another domain. Specifies a gateway host to which mail for the specified host or domain will be forwarded.
|
Note: To define a mail gateway to an IP address (instead of a host name), you must enclose the IP address in square brackets.
|
ADD GATEWAY domain_name hostname
domain_name
Specifies the name of the domain for which the new gateway will handle mail. This can be a fully qualified host name (for example, WHORFIN.EXAMPLE.COM) or a domain tag beginning with a dot (for example, .BITNET).
hostname
Specifies the name of the host that acts as a gateway for mail addressed to domain_name.
Adds a domain to a list of domains that the MultiNet SMTP symbiont considers to be local. If users send mail to hosts beyond the local domains, MultiNet forwards the mail to the mail hub specified by the FORWARDER parameter. The local domain list affects mail forwarding only when the FORWARD-REMOTE-MAIL parameter is TRUE.
ADD LOCAL-DOMAIN domain_name
domain_name
Specifies the name of a domain (for example, LOT-49.EXAMPLE.COM) that MultiNet considers to be local.
Forms a mail queue grouping of nodes in a cluster, or adds new nodes to an existing queue group. The SMTP queues on the nodes in the group you create will share responsibility for handling mail messages generated on nodes within the group. If a node is not placed in a named queue group, it is made part of the default queue group.
ADD QUEUE-GROUP groupname [node_name_list]
groupname
Specifies the name of the queue group to add, or the name of an existing group to which nodes will be added.
node_name_list
Contains a list of names of VMScluster (SCS) nodes to add to the queue group.
Detaches the terminal from the calling process and reattaches it to another process. Use the SPAWN SHOW PROCESS /SUBPROCESSES command to list the names of the subprocesses. Use the DCL LOGOUT command to return to the original process. If the MULTINET_DISABLE_SPAWN logical is enabled, ATTACH does not work.
ATTACH process-name
process_name
Specifies the name of a process to which you want your terminal attached. (Not all subprocesses can be attached; some testing may be required.)
Clears all information from the current configuration. (Functionally equivalent to ERASE.)
CLEAR
Deletes a mail gateway.
DELETE GATEWAY domain_name
domain_name
Specifies the name of the domain whose gateway will be deleted.
Deletes a domain from MultiNet's list of local domains.
DELETE LOCAL-DOMAIN domain_name
domain_name
Specifies the name of the domain to delete from the list of local domains.
Deletes a queue group or removes a node from a queue group. When a node is removed from a named queue group, it becomes part of the default queue group.
DELETE QUEUE-GROUP group_name [node_names]
group_name
Specifies the name of the group to delete or the name of the group from which to remove the specified nodes.
node_names
Specifies the VMScluster (SCS) node name to remove from the specified queue group.
Erases all information from the current configuration. (Functionally equivalent to CLEAR.)
ERASE
Saves the current configuration, if it has been modified, then quits.
EXIT
Reads in a MultiNet SMTP configuration file. (Functionally equivalent to USE.) After a GET, you can use the various configuration commands to modify the SMTP configuration.
GET config_file
config_file
Specifies the name of the SMTP configuration file to read in.
Invokes command help.
HELP [topics]
topics
Contains a space-delimited list of topics that begins with a topic followed by subtopics. The default topic is HELP.
Starts and attaches a DCL subprocess. If a parent process exists, attach to it. To return from DCL, use the ATTACH or the LOGOUT command. To switch back from a DCL subprocess, use the ATTACH command.
If the MULTINET_DISABLE_SPAWN logical is set, PUSH does not work.
PUSH
If the configuration file has been edited, QUIT prompts you to save the file before quitting.
QUIT
Functionally equivalent to DELETE GATEWAY.
REMOVE GATEWAY domain_name
domain_name
Specifies the name of the gateway to remove.
Functionally equivalent to DELETE QUEUE-GROUP.
REMOVE QUEUE-GROUP group_name [node_names]
group_name
Specifies the name of the group to remove or the name of the group from which to remove the specified nodes.
node_names
Specifies the VMScluster (SCS) node name to remove from the specified queue group.
Writes the current MultiNet SMTP configuration to SMTP configuration files. (Functionally equivalent to WRITE.)
SAVE config_file
config_file
Specifies the name of the file to which to write the current MultiNet SMTP configuration (by default, the same file from which it was read).
Sets the host that SMTP accounting information should be sent to.
SET ACCOUNTING-HOST hostname
hostname
Specifies the name of the host that SMTP accounting information should be sent to. ACCOUNTING-PORT must be specified also.
Sets the port that the accounting logger is to listen on.
SET ACCOUNTING-PORT port_number
port_number
Specifies the port number that the accounting logger is listening on. ACCOUNTING-HOST must be specified also.
Identifies the file that holds system-wide mail aliases.
SET ALIAS-FILE [file-spec]
file-spec
Specifies the name of the file that contains system-wide mail aliases (by default, MULTINET:SMTP_ALIASES).
Sets the domain name for DECnet mail.
SET DECNET-DOMAIN domain_name
domain_name
Specifies the domain name for DECnet mail. For information on the SMTP-DECnet gateway, see the MultiNet Installation and Administrator’s Guide.
Specifies whether mail receipts are sent when incoming mail containing Delivery-Receipt-To: or Return-Receipt-To: headers is submitted to the SMTP queue. If TRUE, mail receipts are sent.
SET DELIVERY-RECEIPTS {TRUE | FALSE}
When set to TRUE, prevents VMS MAIL users from setting a Reply-To: header address with the MULTINET_SMTP_REPLY_TO logical name.
SET DISALLOW-USER-REPLY-TO {TRUE | FALSE}
When TRUE, the MultiNet SMTP symbiont looks for messages addressed through PSImail, usually of the form PSI%address::user, and returns them to the sender marked user unknown. The default is FALSE. This parameter does not affect mail delivery to local users who have set up forwarding entries to PSImail addresses with the VMS MAIL SET FORWARD command.
SET DISABLE-PSIMAIL {TRUE | FALSE}
Specifies the host that will forward mail messages to other hosts.
SET FORWARDER [host_name]
host_name
Specifies the name of the host to which mail is forwarded when attempts by the local system to send mail to a remote system fail because of a host name lookup failure.
If no host name is specified, no forwarder is used, and failed messages are tried repeatedly (based on the RETRY-INTERVAL setting) until they are returned to sender (based on the RETURN-INTERVAL setting).
When TRUE, MultiNet forwards mail addressed to users on the local host to a central mail hub specified by the FORWARDER parameter.
SET FORWARD-LOCAL-MAIL {TRUE | FALSE}
To configure MultiNet to direct mail to a central mail hub, you must specify the IP address of the mail hub with the FORWARDER parameter, and define the scope of addresses that you want the mail hub to handle.
By default, when users on the same MultiNet host send mail to each other, MultiNet does not route the messages through the mail hub. When FORWARD-LOCAL-MAIL is TRUE, MultiNet forwards local mail to the mail hub.
To exclude a specific user from the local mail-forwarding system, add the following type of mail alias to MULTINET:SMTP_ALIASES:
username : *;
When TRUE, MultiNet forwards mail addressed to non-local users on a central mail hub specified by the FORWARDER parameter.
SET FORWARD-REMOTE-MAIL {TRUE | FALSE}
To configure MultiNet to direct mail to a central mail hub, you must specify the IP address of the mail hub with the FORWARDER parameter, and define the scope of addresses that you want the mail hub to handle.
By default, when MultiNet users send mail to users on other hosts, MultiNet does not route the messages through the mail hub. When FORWARD-REMOTE-MAIL is TRUE, MultiNet forwards non-local mail to the mail hub.
By default MultiNet considers all remote hosts non-local. You can add hosts in other domains to the local-domain list with the ADD LOCAL-DOMAIN command.
Specifies which RFC-822 message headers are included in messages delivered to local VMS MAIL users.
SET HEADER-CONTROL header_type
header_type
Either NONE, MAJOR, or ALL:
· NONE eliminates the RFC-822 message headers from locally delivered VMS MAIL messages.
· MAJOR (the default) includes all but Received and Return Path headers.
· ALL includes all headers.
Specifies a file from which MultiNet obtains a list of host aliases. A common use for SMTP host names is when your system is a member of a homogeneous VMScluster, and you want all mail from any cluster member to appear to be from the same host (for example, the cluster alias).
Unlike the MAIL-CONFIG SET SMTP-HOST-NAMES command which has a limit of 16 host names, SET HOST-ALIAS-FILE lets you specify a host alias file containing as many host aliases as needed.
|
Note: The host name or alias you specify should be registered in the Domain Name System or in the host tables of any system to which you send mail; otherwise, the recipients of your mail will be unable to reply to it.
|
If this logical name is not defined, the SMTP software looks for the file MULTINET:SMTP_HOST_ALIASES by default.
SET HOST-ALIAS-FILE file_spec
file_spec
Specifies the file that contains a list of SMTP host names.
Forwards failed local mail to a specific host.
SET LOCAL-MAIL-FORWARDER hostname
hostname
Specifies the name of the host to which failed local mail is directed.
Identifies the user responsible for mail on the system.
SET POSTMASTER [username]
username
Specifies the name of the user who will receive messages addressed to Postmaster on the local host. If omitted, the user name POSTMASTER is used.
To assign multiple users as the postmaster, enter POSTMASTER, then create an alias for postmaster in the alias file. For example, to make both username1 and username2 postmasters, enter the following line in the alias file:
postmaster: username1, username2;
Specifies the number of mail processing queues that should be created on a system.
SET QUEUE-COUNT node_name [count]
node_name
Specifies the VMScluster (SCS) node name of the node whose queue count you want to set, or specifies DEFAULT to set the default for all nodes not specifically set. In a non-cluster environment, only the DEFAULT setting is used.
count
Specifies the number of queues to create on the specified node. If a count is omitted, the queue-count setting for the specified node is removed.
Specifies how Internet mail headers are mapped to the VMS MAIL "From" header.
SET REPLY-CONTROL [hdr_types]
hdr_types
Specifies a comma-delimited list of SMTP headers (ENVELOPE-FROM, FROM, or REPLY-TO) that are mapped to the VMS MAIL "From" header. The default is ENVELOPE-FROM, FROM, REPLY-TO
When FALSE, the MultiNet SMTP symbiont omits the Resent-From, Resent-To, and Resent-Date headers that are usually included when a message is forwarded using a VMS MAIL forwarding address. The default is TRUE.
Use this option if mail user agents at your site cannot properly distinguish between normal "From" headers and "Resent-From" headers.
SET RESENT-HEADERS {TRUE | FALSE}
Specifies the amount of time that elapses before another attempt is made to send a message after a failed attempt.
SET RETRY-INTERVAL [interval]
interval
Specifies the interval, in minutes (by default, 30 minutes).
Specifies the amount of time that a message can remain in the processing queue before it is returned to the sender.
SET RETURN-INTERVAL [interval]
interval
Specifies the interval, in hours; by default, 96 (four days). A message typically only remains in the processing queue if it cannot be sent over the network to a remote host. When such a message is returned to its sender, the returned message includes the reason why it could not be sent.
Enables the startup of the Mail Monitoring MIB (RFC 2789). Requires SNMP AGENTX to be set.
SET RFC2789
Specifies the broadcast class to use to deliver immediate (SEND) messages.
SET SEND-BROADCAST-CLASS [class_number]
class_number
Specifies the class-number in a range from 1 to 16, corresponding to the VMS USER1 through USER16 broadcast classes (by default, 16).
Sets the host name from which all outgoing mail appears to be sent and the aliases for which this host accepts incoming mail.
A common use for SMTP HOST NAME is when your system is a member of a homogeneous VMScluster, and you want all mail from any cluster member to appear to be from the same host.
SET SMTP-HOST-NAMES host_names
host_names
Contains a comma-delimited list of host names. The first name in the list specifies the host name from which all outgoing mail appears to be sent. The remaining host names in the list specify the aliases for which this host accepts incoming mail.
|
Note: The specified host name or alias should be registered in the Domain Name System or in the host tables of any system that you send mail to; otherwise, the recipients of your mail will be unable to reply to it.
|
Determines whether START_SMTP.COM starts the VMS queue manager if it is not already running. The default is TRUE.
SET START-QUEUE-MANAGER {TRUE | FALSE}
Displays the current configuration.
SHOW
Executes a single DCL command, or if entered without options, starts a subprocess with the same effect as PUSH. To return from DCL, use the LOGOUT command. If the MULTINET_DISABLE_SPAWN logical is set, SPAWN does not work.
SPAWN [command]
command
Specifies a command to execute. If you omit command, a DCL command line subprocess is created.
/INPUT=file-spec
Specifies an input file to the command you enter with SPAWN.
/LOGICAL_NAMES
/NOLOGICAL_NAMES
Specifies that logical names and logical name tables are not copied to the subprocess.
/SYMBOLS
/NOSYMBOLS
Specifies that global and local names are not passed to the subprocess.
/WAIT
/NOWAIT
Returns control without waiting for the command to complete. Do not use this qualifier with commands that have prompts or screen displays.
/OUTPUT=file-spec
Specifies a file that retains the output of the command invoked with SPAWN. This qualifier only works when a single command is entered without creating a DCL subprocess. In addition, this qualifier is positional; you must enter it immediately after SPAWN or other qualifiers.
Indicates whether the SMTP configuration has been modified.
STATUS
Reads in a MultiNet SMTP configuration file. After a USE, you can use the various configuration commands to modify the SMTP configuration. (Functionally equivalent to GET.)
USE config_file
config_file
Specifies the name of the SMTP configuration file to read in.
Displays the MAIL-CONFIG version and release information.
VERSION
Writes the current MultiNet SMTP configuration to SMTP configuration files. (Functionally equivalent to SAVE.)
WRITE config_file
config_file
Specifies the name of the file to which to write the current MultiNet SMTP configuration. By default, the configuration is saved to the same file from which it was read.