## TCPware V5.7 NETCU Command Reference

Chapter 3

MAIL-CONFIG Commands

MAIL-CONFIG lets you examine, modify, and save configuration files for the SMTP mail system.

To invoke MAIL-CONFIG:

$ TCPWARE 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 @TCPWARE:START_SMTP.COM or @TCPWARE:START_SMTP_LOCAL.COM commands.

• Restart the SMTP component.

• Restart TCPware.

• Restart your system.

For details on configuring electronic mail, refer to the TCPware for OpenVMS Management Guide.

ADD GATEWAY

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.

FORMAT

ADD GATEWAY domain_name hostname

PARAMETERS

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.FLOWERS.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.

ADD LOCAL-DOMAIN

Adds a domain to a list of domains that the TCPware SMTP symbiont considers to be local. If users send mail to hosts beyond the local domains, TCPware 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.

FORMAT

ADD LOCAL-DOMAIN domain_name

PARAMETERS

domain_name

Specifies the name of a domain (for example, LOT-49.FLOWERS.COM) that TCPware considers to be local.

ADD QUEUE-GROUP

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.

FORMAT

ADD QUEUE-GROUP group_name [node_name_list]

PARAMETERS

group_name

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.

ATTACH

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 TCPWARE_DISABLE_SPAWN logical is enabled, ATTACH does not work.

FORMAT

ATTACH process-name

PARAMETERS

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.)

CLEAR

Clears all information from the current configuration. (Functionally equivalent to ERASE.)

FORMAT

CLEAR

DELETE GATEWAY

Deletes a mail gateway.

FORMAT

DELETE GATEWAY domain_name

PARAMETERS

domain_name

Specifies the name of the domain whose gateway will be deleted.

DELETE LOCAL-DOMAIN

Deletes a domain from TCPware's list of local domains.

FORMAT

DELETE LOCAL-DOMAIN domain_name

PARAMETERS

domain_name

Specifies the name of the domain to delete from the 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.

FORMAT

DELETE QUEUE-GROUP group_name [node_names]

PARAMETERS

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.

ERASE

Erases all information from the current configuration. (Functionally equivalent to CLEAR.)

FORMAT

ERASE

EXIT

Saves the configuration file and exits from MAIL-CONFIG.

Format

EXIT

GET

Reads in a TCPware SMTP configuration file. (Functionally equivalent to USE.) After a GET, you can use the various configuration commands to modify the SMTP configuration.

FORMAT

GET config_file

PARAMETERS

config_file

Specifies the name of the SMTP configuration file to read in.

HELP

Invokes MAIL-CONFIG command help.

Format

HELP [topic]

Parameter

topic

(Optional) Topic for which you want help.

PUSH

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 TCPWARE_DISABLE_SPAWN logical is set, PUSH does not work.

FORMAT

PUSH

QUIT

If the configuration file has been edited, QUIT prompts you to save the file before quitting.

FORMAT

QUIT

REMOVE GATEWAY

Functionally equivalent to DELETE GATEWAY.

FORMAT

REMOVE GATEWAY domain_name

PARAMETERS

domain_name

Specifies the name of the gateway to remove.

REMOVE QUEUE-GROUP

Functionally equivalent to DELETE QUEUE-GROUP.

FORMAT

REMOVE QUEUE-GROUP group_name [node_names]

PARAMETERS

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.

SAVE

Writes the current TCPware SMTP configuration to SMTP configuration files. (Functionally equivalent to WRITE.)

FORMAT

SAVE config_file

PARAMETERS

config_file

Specifies the name of the file to which to write the current TCPware SMTP configuration (by default, the same file from which it was read).

SET ALIAS-FILE

Identifies the file that holds system-wide mail aliases.

FORMAT

SET ALIAS-FILE [file-spec]

PARAMETERS

file-spec

Specifies the name of the file that contains system-wide mail aliases (by default, TCPWARE:SMTP_ALIASES).

SET DECNET-DOMAIN

Sets the domain name for DECnet mail.

FORMAT

SET DECNET-DOMAIN domain_name

PARAMETERS

domain_name

Specifies 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. If TRUE, mail receipts are sent.

FORMAT

SET DELIVERY-RECEIPTS { TRUE | FALSE }

SET DISABLE-PSIMAIL

When TRUE, the TCPware 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.

FORMAT

SET DISABLE-PSIMAIL { TRUE | FALSE }

SET DISALLOW-USER-REPLY-TO

When set to TRUE, prevents VMS MAIL users from setting a Reply-To: header address with the TCPWARE_SMTP_REPLY_TO logical name.

FORMAT

SET DISALLOW-USER-REPLY-TO { TRUE | FALSE }

SET FORWARDER

Specifies the host that will forward mail messages to other hosts.

FORMAT

SET FORWARDER [host_name]

PARAMETERS

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).

SET FORWARD-LOCAL-MAIL

When TRUE, TCPware forwards mail addressed to users on the local host to a central mail hub specified by the FORWARDER parameter.

FORMAT

SET FORWARD-LOCAL-MAIL { TRUE | FALSE }

DESCRIPTION

To configure TCPware 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 TCPware host send mail to each other, TCPware does not route the messages through the mail hub. When FORWARD-LOCAL-MAIL is TRUE, TCPware 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 TCPWARE:SMTP_ALIASES:

username : *

SET FORWARD-REMOTE-MAIL

When TRUE, TCPware forwards mail addressed to non-local users on a central mail hub specified by the FORWARDER parameter.

FORMAT

SET FORWARD-REMOTE-MAIL { TRUE | FALSE }

DESCRIPTION

To configure TCPware 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 TCPware users send mail to users on other hosts, TCPware does not route the messages through the mail hub. When FORWARD-REMOTE-MAIL is TRUE, TCPware forwards non-local mail to the mail hub.

By default TCPware considers all remote hosts non-local. You can add hosts in other domains to the local-domain list with the ADD LOCAL-DOMAIN command.

SET HEADER-CONTROL

Specifies which RFC-822 message headers are included in messages delivered to local VMS MAIL users.

FORMAT

SET HEADER-CONTROL header_type

PARAMETERS

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.

SET HOST-ALIAS-FILE

Specifies a file from which TCPware 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 TCPWARE:SMTP_HOST_ALIASES by default.

FORMAT

SET HOST-ALIAS-FILE file_spec

PARAMETERS

file_spec

Specifies the file that contains a list of SMTP host names.

SET LOCAL-MAIL-FORWARDER

Forwards failed local mail to a specific host.

FORMAT

SET LOCAL-MAIL-FORWARDER hostname

PARAMETERS

hostname

Specifies the name of the host to which failed local mail is directed.

SET LOCASE-USERNAME

When FALSE, disables the lower-casing of usernames on outgoing VMS mail.

FORMAT

SET LOCASE-USERNAME

SET POSTMASTER

Identifies the user responsible for mail on the system.

FORMAT

SET POSTMASTER [username]

PARAMETERS

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;

SET QUEUE-COUNT

Specifies the number of mail processing queues that should be created on a system.

FORMAT

SET QUEUE-COUNT node_name [count]

PARAMETERS

node_name

Specifies the VMScluster (SCS) node name of the node whose queue count you wish 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.

SET REPLY-CONTROL

Specifies how Internet mail headers are mapped to the VMS MAIL "From" header.

FORMAT

SET REPLY-CONTROL [hdr_types]

PARAMETERS

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."

SET RESENT-HEADERS

When FALSE, the TCPware 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.

FORMAT

SET RESENT-HEADERS { TRUE | FALSE }

SET RETRY-INTERVAL

Specifies the amount of time that elapses before another attempt is made to send a message after a failed attempt.

FORMAT

SET RETRY-INTERVAL [interval]

PARAMETERS

interval

Specifies the interval, in minutes (by default, 30 minutes).

SET RETURN-INTERVAL

Specifies the amount of time that a message can remain in the processing queue before it is returned to the sender.

FORMAT

SET RETURN-INTERVAL [interval]

PARAMETERS

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.

SET RFC822-TO-HEADER

When FALSE, disables the use of the RFC 822 To: header value for the VMS mail To.

FORMAT

SET RFC822-TO-HEADER

SET SEND-BROADCAST-CLASS

Specifies the broadcast class to use to deliver immediate (SEND) messages.

FORMAT

SET SEND-BROADCAST-CLASS [class_number]

PARAMETERS

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).

SET SMTP-HOST-NAMES

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.

FORMAT

SET SMTP-HOST-NAMES host_names

PARAMETERS

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.

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.

SET START-QUEUE-MANAGER

Determines whether START_SMTP.COM starts the VMS queue manager if it is not already running. The default is TRUE.

FORMAT

SET START-QUEUE-MANAGER { TRUE | FALSE}

SHOW

Displays the current configuration.

Format

SHOW

SPAWN

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 TCPWARE_DISABLE_SPAWN logical is set, SPAWN does not work.

FORMAT

SPAWN [command]

PARAMETERS

command

Specifies a command to execute. If you omit command, a DCL command line subprocess is created.

QUALIFIERS

/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.

STATUS

Indicates whether the SMTP configuration has been modified.

FORMAT

STATUS

USE

Reads in a TCPware SMTP configuration file. After a USE, you can use the various configuration commands to modify the SMTP configuration. (Functionally equivalent to GET.)

FORMAT

USE config_file

PARAMETERS

config_file

Specifies the name of the SMTP configuration file to read in.

VERSION

Displays the MAIL-CONFIG version and release information.

FORMAT

VERSION

WRITE

Writes the current TCPware SMTP configuration to SMTP configuration files. (Functionally equivalent to SAVE.)

FORMAT

WRITE config_file

PARAMETERS

config_file

Specifies the name of the file to which to write the current TCPware SMTP configuration. By default, the configuration is saved to the same file from which it was read.