Administrative Emails
9.4C
The Sunbelt Data Manager allows administrative email messages to be sent for specialized events that occur during the execution of the server. This capability has been implemented in the ADMIN support services to provide maximum flexibility and usage in the Sunbelt products. The end-user can enable the ADMIN email functionality by setting keywords in the Data Manager configuration file. Appropriate entries are logged in the server log file that reflect actions executed by the server for email event processing.
When an ADMIN email errors occur, the appropriate 'Mnn' errors are logged in the server log file where the 'Mnn' description is the same as documented under the 'M(MailSend) Errors' section in the PL/B Runtime Reference manual.
A command line option named '-mt' exists for the Data Manager. When the '-mt' command line option is executed, the Data Manager mail parameters are reloaded and a test email message is sent if the email configuration is valid.
The following ADMIN mail keywords can be put in the [Environment] section of the Data Manager '.ini' configuration file:
|
Keyword |
Meaning |
|
ADMIN_MAIL={on|off} |
This required keyword enables or disables the administrative email services. If the keyword is not specified, the default action is the same as being set to 'off'. |
|
ADMIN_MAIL_OUT={out} |
This required keyword allows an administrative email to be sent for a Data Manager. The {out} string for this keyword specifies the SMTP outgoing mail server name (URL) or IP address. |
|
ADMIN_MAIL_TO={to} |
This required keyword allows an administrative email to be sent for a Data Manager. The {to} string for this keyword specifies the email address(es) of the recipients. |
|
ADMIN_MAIL_FROM={from} |
This required keyword allows an administrative email to be sent for a Data Manager. The {from} string for this keyword specifies a single email address of the sender. |
|
ADMIN_MAIL_MAXUSERS=[off] |
By default this administrative email event is enabled for the Data Manager. If this optional keyword is set to 'off', this email event is disabled.
When this email event is enabled, an email is sent that identifies when the maximum number of user connections has been exceeded. |
|
ADMIN_MAIL_STARTUP=[on] |
By default this administrative email event is disabled for the Data Manager. If this optional keyword is set to 'on', this email event is enabled.
When this email event is enabled, an email is sent that identifies when the Data Manager enters the startup phase that accepts user logons. |
|
ADMIN_MAIL_SHUTDOWN=[on] |
By default this administrative email event is disabled for the Data Manager. If this optional keyword is set to 'on', this email event is enabled.
When this email event is enabled, an email is sent that identifies when the Data Manager main logon process is terminated. |
|
ADMIN_MAIL_SUBJECT={subject} |
If this keyword is not specified, a default email subject is sent as follows:
"SunDm Administrator Message"
When the ADMIN_MAIL_SUBJECT keyword is specified, the {subject} string is sent as the subject for the email message. The {subject} string length is limited to 200 bytes. If the {subject} string contains a '%s' substitution parameter, the '%s' is replaced with the body text being sent for the message. The intended use of the '%s' is to allow the subject for the email to give the specific reason for the server event without having to open the email body. |
|
ADMIN_MAIL_BCC={bcc} |
This optional keyword specifies the email address or addresses of the Blind Copy recipients. The {bcc} string may contain one or more recipient addresses. If more than one email recipient is specified, a comma separates the email addresses. |
|
ADMIN_MAIL_CC={cc} |
This optional keyword specifies the email address or addresses of the Copy recipients. The {cc} string may contain one or more recipient addresses. If more than one email recipient is specified, a comma separates the email addresses. |
|
ADMIN_MAIL_USER={user} |
This optional keyword specifies the username used for the login to the {out} email server specified by the ADMIN_MAIL_OUT keyword. |
|
ADMIN_MAIL_PASSWORD={password} |
This optional keyword specifies the password for the login to the out} email server specified by the ADMIN_MAIL_OUT keyword. |
|
ADMIN_MAIL_PORT={port} |
This optional keyword specifies the port number used when logging on to the {out} email server specified by the ADMIN_MAIL_OUT keyword. If this keyword is not specified, the default port number of twenty-five (25) is used. The {port} string must be specified as decimal digits that identify the email server port number to be used. |
|
ADMIN_MAIL_SSL={on|off} |
This optional keyword enables the SSL ( Secure Sockets Layer ) support if the OpenSSL libraries have been installed on the system where the Data Manager is executing. |
|
ADMIN_MAIL_TIMEOUT={timeout} |
This optional keyword specifies the timeout value used when communicating with the {out} email server specified by the ADMIN_MAIL_OUT keyword. If this keyword is not specified, the default timeout of sixty (60) seconds is used. There are no restrictions placed on the value specified. The {timeout} string must be specified as decimal digits that identify the timeout value to be used. |
|
ADMIN_MAIL_TRACE={trace} |
This optional keyword specifies the file name created to store all data messages sent and received when communicating with the {out email server specified by the ADMIN_MAIL_OUT keyword. Note that a trace file is overwritten for a each email that is sent. This keyword is normally only needed to provide debug information when email problems are being researched. Otherwise, this keyword should not be used. The ADMIN_MAIL_TRACE keyword takes precedence over the ADMIN_MAIL_TRACEAPPEND keyword if both keywords are specified in the configuration file. |
|
ADMIN_MAIL_TRACEAPPEND={traceappend} |
This optional keyword allows the trace data to be appended to an existing trace log file. This keyword is normally only needed to provide debug information when email problems are being researched. Otherwise, this keyword should not be used. The ADMIN_MAIL_TRACE keyword takes precedence over the ADMIN_MAIL_TRACEAPPEND keyword if both keywords are specified in the configuration file. |
|
ADMIN_MAIL_DSNRECEIPT={dsn} |
This optional keyword specifies that this email requires a Delivery Service Notification as specified by the {dsn} string. The {dsn} string can be specified as follows:
DSNRECEIPT=Never
or
DSNRECEIPT=Success,Failure,Delay
Where:
When combining options in the {dsn} string, the options are separated with a comma delimiter. |
|
ADMIN_MAIL_MDNRECEIPT={on|off} |
This optional keyword requests that a client program receipt will be returned when the recipient reads this email. |
|
ADMIN_MAIL_RETURN={return} |
This optional keyword is only valid when the DSNRECEIPT keyword is used. This keyword specifies the recommended format of the return receipt that is being requested by the DSNRECEIPT keyword. The {return} string can be specified as follows:
RETURN=Full
or
RETURN=Hdrs
Where:
The options Full and Hdrs are mutually exclusive. |
|
ADMIN_MAIL_REPLYTO={replyto} |
This optional keyword specifies the email address that a recipient is to send a reply to when responding to this email. |
Example SUNDM.CFG entries for email setup:
[Environment]
ADMIN_MAIL=ON
ADMIN_MAIL_MAXUSERS=ON
ADMIN_MAIL_STARTUP=ON
ADMIN_MAIL_SHUTDOWN=ON
#
ADMIN_MAIL_OUT=mail.server.com
ADMIN_MAIL_TO=user@somemail.com
ADMIN_MAIL_FROM=userSundm@somemail.com
#
ADMIN_MAIL_SUBJECT=Sundm Server: '%s'
#
ADMIN_MAIL_PORT=465
ADMIN_MAIL_USER=userSundm@somemail.com
ADMIN_MAIL_PASSWORD=userPassword
ADMIN_MAIL_SSL=ON
![]() |