ETERNUS SF Storage Cruiser User's Guide 13.2 - Solaris (TM) Operating System / Linux / Microsoft(R) Windows(R) -

Appendix F Mail client function program with the Windows Version of Manager (stxsmail)

The explanation described as follows is how to use mail client function program (henceforth stxsmail) which sends event inftion with bat linkage of the Windows version manager.

Stxsmail is a program which achieves the mail client function in Windows.

For Solaris OS or Linux, SMTP server is used on the server where the SSC administrative server is running.

For details, see "6.4 Event Display and Linkage".

F.1 stxsmail Operating Requirements

stxsmail has the following operating requirements:

OS
- Windows 2000 Server
- Windows 2000 Advanced Server
- Windows Server 2003 Standard Edition
- Windows Server 2003 Enterprise Edition
Memory

OS operating requirements must be satisfied.
HDD

OS operating requirements must be satisfied.
Network

TCP/IP protocol must be installed, and communication with external SMTP servers must be enabled.
Mail server

The mail server which can be used is UNIX system server equipped with sendmail which supports the SMTP protocol or Windows Server which supports the SMTP protocol.

F.2 Command Format

The format of the stxsmail command is described.

Format: stxsmail [-v] [-l <LogFile>] [-p <PortNo>] [-t <Timeout>] <MailServer> <MailFile>

The following table explains the options and parameters:

Option	Parameter description
-v	This sets Verbose (redundant) mode. Specifying this option outputs different types of information to standard output during stxsmail execution. The option is mainly used for debugging, such as to find the cause of a failure.
-l <LogFile>	Specify a log file name. If this option is specified, the execution status of this program is recorded in the specified log file. The option is mainly used for debugging, such as to find the cause of a failure. The information recorded in the log file is the same as the information output to standard output by specifying "-v".
-p <PortNo>	Specify an SMTP port number. Generally, the SMTP port number is set to 25, but if the SMTP port number of a destination mail server is not 25, specify the SMTP port number of the mail server.
-t <Timeout>	Specify a timeout value for communication with the mail server. Specify a time in seconds in a range of 1 to 65535. The default value of this option is 60 seconds. Specify this option only if required.
<MailServer>	Specify the server node name (FQDN) or IP address of the mail server. This parameter cannot be omitted.
<MailFile>	Specify a mail file to be sent. This parameter cannot be omitted.

F.3 Mail File Format

Mail files handled by stxsmail must satisfy the following requirements:

The files are text files.
Each line ends (EOL) with CRLF(\r\n).
Similar to the end of a line, each file ends (EOF) with CRLF(\r\n).
The mail header contains at least one "From:" and one "To:".

A sample mail file is shown below.

The mail file contains a mail header and text, which are separated by one blank line.

General mail header items can be specified in the mail header.

The basic mail header items are described below.

From

Specify a sender mail address.
To

Specify a destination mail address.
Cc

Specify a CC destination mail address.
Bcc

Specify a BCC destination mail address.
Subject

Describe the subject of the mail (title).

Be sure to confirm that "From" and "To" are correctly specified in the mail header.

If "From" or "To" is omitted, stxsmail posts an error and terminates.

The other mail header items can be omitted.

Specify mail addresses for "From", "To", "Cc", and "Bcc" only as follows:

Example:

From: mgr@foo.bar.com

Be sure not to include a non-mail address. See the following examples:

Example:

From: < mgr @foo.bar.com>
Example:

From: "Administrator" < mgr @foo.bar.com>
Example:

From: manager (mgr @foo.bar.com)

Multiple mail addresses can be specified on one line for "To", "Cc", and "Bcc" as follows:

Example:

Cc: admin@foo.bar.com, root@foo.bar.com

A mail address can be specified over multiple lines for "To", "Cc", and "Bcc" as follows:

Example:

Cc: admin@foo.bar.com

Cc: root@foo.bar.com

A total of 16 mail addresses can be specified for "To", "Cc", and "Bcc".

General mail headers not described above can be specified, however, stxsmail does not guarantee operating results. Mail header items not described above are sent by stxsmail as is to the mail server.

F.4 Errors and Responses

stxsmail posts messages depending on the execution results.

The messages and appropriate responses are described below.

[Message]

Usage: stxsmail [-v] [-l <LogFile>] [-p <PortNo>] [-t <Timeout>] <MailServer> <MailFile>

-v : Verbose mode

-l <LogFile> : Log file name

-p <PortNo> : SMTP port number (default=25)

-t <Timeout> : Timeout value (default=60sec)

<MailServer> : Mail server (IP address or host name)

<MailFile> : Mail file (must be contains MAIL-HEADERS)

[Explanation]

stxsmail was started incorrectly. (Parameters are missing, invalid options are specified, or invalid values are specified for options.)

[Response]

Check the operations for stxsmail, and specify correct options and parameters.

[Message]

Cannot send a mail - Error on WSACleanup()... Maybe WINSOCK is not available or illegal.

[Explanation]

Initialization of WinSock failed. (An error occurred in the WSACleanup() function.)

[Response]

Confirm that WinSock can be used on the system. (WinSock can generally be used, so if this error occurs, the OS must be reinstalled.)

[Message]

Cannot send a mail - Error on WSAStartup()... Maybe WINSOCK is not available or illegal.

[Explanation]

Initialization of WinSock failed. (An error occurred in the WSAStartup() function.)

[Response]

Confirm that WinSock can be used on the system. (WinSock can generally be used, so if this error occurs, the OS must be reinstalled.)

[Message]

Cannot send a mail - Error on socket()... Maybe WINSOCK is not available or illegal.

[Explanation]

Creating a WinSock socket failed. (An error occurred in the socket() function.)

[Response]

Confirm that WinSock can be used on the system. (WinSock can generally be used, so if this error occurs, the OS must be reinstalled.)

[Message]

Cannot send a mail - Error on gethostbyname()... Maybe missing DNS or name server not respond.

[Explanation]

The server node name specified for <MailServer> could not be converted to an IP address.

[Response]

Check the network environment to determine whether the server node name can be correctly converted to an IP address (make sure that DNS settings are correct).

[Message]

Cannot send a mail - Error on connect()... Maybe host unreachable.

[Explanation]

Connection to the mail server failed.

[Response]

Check whether the mail server specified in <MailServer> is functioning normally.

[Message]

Cannot send a mail - Error on send()... Maybe communication error occoured on mail server.

[Explanation]

Data sending to the mail server failed.

[Response]

Check whether the mail server specified in <MailServer> is functioning normally. If it is, then check whether the mail server supports the standard protocol, SMTP.

[Message]

Cannot send a mail - Error on recv()... Maybe communication error occoured on mail server.

[Explanation]

Data receiving from the mail server failed.

[Response]

Check whether the mail server specified in <MailServer> is functioning normally. If it is, then check whether the mail server supports the standard protocol, SMTP.

[Message]

Cannot send a mail - SMTP protocol error... Protocol violation on mail server.

[Explanation]

Mail sending failed.

[Response]

Check whether the mail server specified in <MailServer> supports the standard protocol, SMTP.

[Message]

Cannot send a mail - SMTP server not respond.

[Explanation]

The mail server sends no response.

[Response]

Check whether the mail server specified in <MailServer> is functioning normally. If it is, then check whether the mail server supports the standard protocol, SMTP.

[Message]

Cannot send a mail - No "From" header.

[Explanation]

No "From:" header item was found in the mail file.

[Response]

Specify the "From:" mail header item correctly in the mail file.

[Message]

Cannot send a mail - No "To" header.

[Explanation]

No "To:" mail header item was found in the mail file.

[Response]

Specify the "To:" mail header item correctly in the mail file.

[Message]

Cannot send a mail - Not found mail file.

[Explanation]

The specified mail file was not found.

[Response]

Check for the mail file specified in <MailFile>.

[Message]

Cannot send a mail - Timeout detected.

[Explanation]

The mail server sends no response.

[Response]

Check whether the mail server specified in <MailServer> is functioning normally. If it is, then check whether the mail server supports the standard protocol, SMTP.

F.5 Restrictions

Note the following points about using stxsmail:

Up to 16 mail addresses can be specified for mail destinations (To, Cc, Bcc).
Only mail addresses can be specified for each mail address item. (Aliases and other such names cannot be specified.)
The maximum size of a mail file including EOF is 65536 bytes.
The maximum length of one line including EOL in a mail file is 4096 bytes.
A mail file must be consisting of plain text with 7-bit ASCII characters. Accordingly, Japanese or other languages cannot be written in a mail file.
The mail server which can be used is Windows2000 Server which supports the SMTP protocol of UNIX system server equipped with sendmail or supports the SMTP service equipped standard appending.
Authentication technologies such as SMTP authentication of mail server (SMTP AUTH) and SMTP before POP are not supported.
stxsmail does not check the validity of mail headers.

Contents Index