[an error occurred while processing this directive]

HP OpenVMS Systems Documentation

Content starts here >

Compaq TCP/IP Services for OpenVMS
Release Notes


Previous Contents

A.1.5.1.3 User Name-Only Address

If the address under consideration is a recipient address, and the From: address is a DECnet address, then the recipient address is prefixed with the same routing information as that of the From: address. Then it is processed as if it were a DECnet address, as shown in Section A.1.5.1.2.

Otherwise the IMAP Server appends the at sign (@) to the user name, and then appends one of the following, in order of preference:

  • The value of configuration option Gateway-Node, if defined
  • An SMTP substitute domain, if defined
  • The local host name

For example, with an SMTP substitute domain defined as acme.widgets.com , the message header From: Smith becomes:


From: smith@acme.widgets.com 
A.1.5.1.4 DECnet Address That Contains Quotation Marks

The values assigned to the configuration option Quoted-Decnet-Rewrite define how the IMAP Server rebuilds a DECnet address that contains quotation marks. The following list describes the possible values:

  • GENERIC
    The address is changed to the SMTP format. For example, on host widgets.xyzcorp.com , the message header From: ORDERS::"j_smith@acme.com" becomes:


    From: "ORDERS::\"j_smith@acme.com\""@widgets.xyzcorp.com 
    
  • NONE
    The From: line is passed to the IMAP client without being modified. For example:


    From: ORDERS::"j_smith@acme.com" 
    

    You cannot reply to this type of mail message because the SMTP server does not accept an address of this form.
  • TRANSFORM
    The IMAP Server uses the text inside the quotation marks. For example, the message header From: ORDERS::"j_smith@acme.com" becomes:


    From: j_smith@acme.com 
    
A.1.5.1.5 Cluster-Forwarding SMTP Address

With a cluster-forwarding SMTP address, the IMAP server uses the SMTP address within the quotation marks. For example, the message header From: ABCDEF::SMTP%"james.smith@federation.gov" becomes:


From: james.smith@federation.gov 
A.1.5.1.6 All Other Addresses

For all other address formats, the IMAP server changes the entire address to the SMTP format:

  • Quotation marks in the address are prefixed with the backslash (\) escape character.
  • The entire address is placed within quotation marks.
  • An at sign (@) is appended.
  • The value of configuration option Gateway-Node, if defined, is appended; if not, the value of the SMTP substitute domain is appended. If both are undefined, then the name of the local host is appended.

For example, if the substitute domain is xyz.org , the message header From: ABCMTS::MRGATE::"ORDERS::SPECIAL" becomes:


From: "ABCMTS::MRGATE::\"ORDERS::SPECIAL\""@xyz.org 

If the configuration option Ignore-Mail11-Headers is set to True and the address is an SMTP address, the rebuilt From: field is not displayed to the user. In this case, the IMAP Server sends the actual headers from the body of the mail as the mail headers.

A.1.6 Uploaded Messages

A user can copy mail messages stored on the local client system to OpenVMS Mail. This action is termed uploading and involves the creation of a new OpenVMS Mail message.

When a message is uploaded, OpenVMS Mail treats it as a new mail message, and a "New Mail" broadcast message is issued. The user will see this message if the user also has an OpenVMS VT session open with receipt of broadcast messages enabled.

When a message is uploaded, the entire message is copied along with the header information described in Table A-4. Note that the additional header information is visible only if the user reads it with MAIL or if the configuration option Ignore-Mail11-Headers is set to False.

Table A-4 describes the typical headers in an uploaded message.

Table A-4 Header Information in Uploaded Messages
Header Value
Body: The entire SMTP message, including headers.
From: The underscore character (_), followed by the name of the user who is uploading the message
To: The underscore character (_), followed by the name of the user who is uploading the message
Subj: The subject of the uploaded message.

A.2 IMAP Server Control

The system manager controls the management functions of the IMAP Server. These functions include:
  • Starting and stopping the server
  • Viewing event logs for each server
  • Modifying options that control server behavior
  • Tuning the server

The following sections describe these management functions.

A.2.1 Starting Up and Shutting Down the Server

The IMAP Server process starts automatically if you specified automatic startup during the configuration procedure (TCPIP$CONFIG.COM).

The IMAP Server can be shut down and started independently of TCP/IP Services. This is useful if you change configuration options that require the service to be restarted.

The following files are provided:

  • SYS$STARTUP:TCPIP$IMAP_STARTUP.COM allows you to start the IMAP Server.
  • SYS$STARTUP:TCPIP$IMAP_SHUTDOWN.COM allows you to shut down the IMAP Server.

To preserve site-specific parameter settings and commands, create the following files:

  • SYS$STARTUP:TCPIP$IMAP_SYSTARTUP.COM --- to be used as a repository for site-specific definitions and parameters to be invoked when the IMAP server is started.
  • SYS$STARTUP:TCPIP$IMAP_SYSHUTDOWN.COM --- to be used as a repository for site-specific definitions and parameters to be invoked when the IMAP Server is shut down.

Note that these files are not overwritten when you reinstall TCP/IP Services.

A.2.2 Viewing Server Event Log Files

The IMAP Server records start and stop server events in an event log file. Other events, such as failed user authentication events, are also recorded in this log file. The file is called TCPIP$IMAP_HOME:TCPIP$IMAP_EVENT$node.LOG, where node is the name of the node on which the server is running.

A.2.3 Modifying IMAP Server Characteristics

To modify the default IMAP Server settings and to configure additional characteristics, edit the configuration file TCPIP$IMAP_HOME:TCPIP$IMAP.CONF. If you modify the IMAP Server configuration file, restart the IMAP Server to make the changes take effect.

You can modify the following IMAP Server characteristics:

  • Server port number
  • Mail header options
  • Number of live connections per server process

The format of each line in the configuration file is:

option:value

where option is the setting name and value is the value given to the setting. For example:


Server-Port:143 

Comment lines may be added to the configuration file, and these lines are defined to be lines that start with the '#' character.

Table A-5 describes the IMAP option names, default settings, and characteristics that you can modify.

Table A-5 IMAP Configuration Options
Option Name Description
Server-Port TCP/IP port number for connection between IMAP clients and the IMAP Server. The default value is 143.
Ignore-Mail11-Headers If set to True, the default, the IMAP Server ignores the OpenVMS message headers when mail is sent via SMTP, which contains an SMTP address in the From: field. For information about how IMAP forms message headers, see Section A.1.5.
Send-ID-Headers If set to True, the IMAP Server sends X-IMAP4-Server and X-IMAP4-ID headers for each mail message. If not defined or if set to False (the default), the ID headers are not sent for any mail from an SMTP address. For information about how IMAP handles message headers, see Section A.1.5.
Decnet-Rewrite Determines how the IMAP Server rebuilds a simple DECnet address (of the form node:: user) when it sends the mail to the IMAP client The value of this option may be one of the following:
  • GENERIC

    Simple DECnet addresses are changed to the SMTP address format.

  • NONE

    Simple DECnet addresses are sent unmodified to the IMAP client.

  • TRANSFORM (default)

    The IMAP server attempts to transform the DECnet address into an SMTP address by translating the DECnet node name to a TCP/IP host name.

For more information about how IMAP rebuilds the message headers, see Section A.1.5.1.2.

Quoted-Decnet-Rewrite Determines how the IMAP Server rebuilds a DECnet address that contains quotation marks (of the form node:: "user@host") in the OpenVMS Mail From: field when it sends the message to the IMAP client. The value of this option may be one of the following:
  • GENERIC

    DECnet addresses that contain quotation marks are changed to the SMTP address format.

  • NONE

    DECnet addresses that contain quotation marks are sent unmodified to the IMAP client.

  • TRANSFORM (default)

    The IMAP server uses the text within the quotation marks in the From: field it sends to the IMAP server.

For more information about how IMAP rebuilds the message headers, see Section A.1.5.1.4.

Personal-Name If defined, the IMAP server provides the IMAP clients with the message header From: fields that include the sender's personal name, if one appeared in the sender's From: field.
Gateway-Node If defined, the local node or cluster name is superseded by the value of this configuration option, when supplying a route from SMTP into DECnet as part of an address. The Gateway-Node value should be an Internet address of a TCP/IP Services SMTP server node.

For example, suppose a Decnet node name of ORDERS cannot be mapped, and the address is ORDERS::J_SMITH and Gateway-Node is defined to be widgets.xyzcorp.com, then the resulting address will be "ORDERS::J_SMITH"@widgets.xyzcorp.com.

Max-Connections Each time the number of live connections to the server reaches the Max-Connections parameter (default = 25), a new process is started. The old server does not accept new connections and will shut down as soon as all existing connections are closed by the client or after 20 minutes, whichever comes first. Service may be interrupted for up to 5 seconds while one process takes over from the other. You should avoid changing the value of this option unless instructed by Compaq support personnel. Too low a setting will result in unnecessary delays, and too high a setting will result in too many connections contesting per-process-limited OpenVMS Mail resources.
Message-Cap The IMAP Server has a configurable limit on the number of messages displayed in a folder, defined by the Message-Cap parameter. If this parameter is not defined, or is set to the default of 0, then no limit is applied.

If a user tries to list a folder containing more messages than the limit, then only the first n messages will be displayed, where n is the limit. In addition the user will be informed with the message "Only the first n messages in each folder will be displayed. Delete or move messages to another folder to display more."

Server-Trace The default for this setting is False. If set to True a trace file will be created as TCPIP$IMAP_HOME:TCPIP$IMAP_node_yyyymmddhhmmssTRACE.LOG where "node" is the node name where the IMAP Server is running and "yyyymmddhhmmss" is the time that the trace log is created. All communication between IMAP clients and the IMAP Server will be logged, with the exception of passwords. Since a large amount of data will be recorded on a busy system, it is recommended that tracing is only turned on for short periods. To turn tracing on or off, it is necessary to restart the IMAP Server.
Trace-Synch This setting only appl >A.3 Enabling MIME Mail The MIME (Multipurpose Internet Mail Extensions) specification provides a set of additional headers you can use so that users can send mail messages composed of more than simple ASCII text. MIME is an enhancement to RFC 822.

For MIME mail to be decoded correctly, follow these guidelines:

  • Configure the SMTP server with the /OPTION=TOP_HEADERS qualifier, because the first lines of mail text after the four OpenVMS message header lines and the initial separating line must be the MIME headers.
  • Configure the IMAP Server with the option Ignore-Mail11-Headers set to True, or leave this option undefined, since True is the default value. Otherwise, MIME headers are not parsed as message headers.
  • The OpenVMS message From: field must be recognized as an SMTP address. Otherwise, the IMAP server sends the headers it creates from OpenVMS message headers as the headers of the mail message. For information about IMAP message headers, see Section A.1.5.
    Define the logical name TCPIP$SMTP_JACKET_LOCAL to 1 for all SMTP cluster systems. This ensures that the mail is delivered if the domain in the From: or To: field appears local. For example:


    $ DEFINE/SYSTEM TCPIP$SMTP_JACKET_LOCAL 1 
    

If MIME mail does not decode, check the mail headers on the client system. If you see multiple blocks of headers and the MIME version header is not in the first block, confirm that you have followed these guidelines. Note that the headers of messages forwarded over OpenVMS Mail are mapped only if there is no cover note (that is, if the headers of a forwarded message are at the top of the message immediately following the headers of the forwarding message).


Previous Next Contents