SMTP Alert Handler

The SMTP Alert Handler may be used to send e-mail messages to notify administrators of significant events that occur within the server.

Parent

The SMTP Alert Handler object inherits from Alert Handler.

You can use configuration expressions to set property values at startup time. For details, see Property Value Substitution.

Basic Properties

Advanced Properties

disabled-alert-type

Synopsis	Specifies the names of the alert types that are disabled for this alert handler.
Description	If there are any values for this attribute, then no alerts with any of the specified types are allowed. If there are no values for this attribute, then only alerts with a type included in the set of enabled alert types are allowed, or if there are no values for the enabled alert types option, then all alert types are allowed.
Default Value	If there is a set of enabled alert types, then only alerts with one of those types are allowed. Otherwise, all alerts are allowed.
Allowed Values	A string.
Multi-valued	Yes
Required	No
Admin Action Required	None
Advanced	No
Read-Only	No

enabled

Synopsis	Indicates whether the Alert Handler is enabled.
Default Value	None
Allowed Values	true false
Multi-valued	No
Required	Yes
Admin Action Required	None
Advanced	No
Read-Only	No

enabled-alert-type

Synopsis	Specifies the names of the alert types that are enabled for this alert handler.
Description	If there are any values for this attribute, then only alerts with one of the specified types are allowed (unless they are also included in the disabled alert types). If there are no values for this attribute, then any alert with a type not included in the list of disabled alert types is allowed.
Default Value	All alerts with types not included in the set of disabled alert types are allowed.
Allowed Values	A string.
Multi-valued	Yes
Required	No
Admin Action Required	None
Advanced	No
Read-Only	No

message-body

Synopsis	Specifies the body that should be used for email messages generated by this alert handler.
Description	The token "%%alert-type%%" is dynamically replaced with the alert type string. The token "%%alert-id%%" is dynamically replaced with the alert ID value. The token "%%alert-message%%" is dynamically replaced with the alert message. The token "\n" is replaced with an end-of-line marker.
Default Value	None
Allowed Values	A string.
Multi-valued	No
Required	Yes
Admin Action Required	None
Advanced	No
Read-Only	No

message-subject

Synopsis	Specifies the subject that should be used for email messages generated by this alert handler.
Description	The token "%%alert-type%%" is dynamically replaced with the alert type string. The token "%%alert-id%%" is dynamically replaced with the alert ID value. The token "%%alert-message%%" is dynamically replaced with the alert message. The token "\n" is replaced with an end-of-line marker.
Default Value	None
Allowed Values	A string.
Multi-valued	No
Required	Yes
Admin Action Required	None
Advanced	No
Read-Only	No

recipient-address

Synopsis	Specifies an email address to which the messages should be sent.
Description	Multiple values may be provided if there should be more than one recipient.
Default Value	None
Allowed Values	A string.
Multi-valued	Yes
Required	Yes
Admin Action Required	None
Advanced	No
Read-Only	No

sender-address

Synopsis	Specifies the email address to use as the sender for messages generated by this alert handler.
Default Value	None
Allowed Values	A string.
Multi-valued	No
Required	Yes
Admin Action Required	None
Advanced	No
Read-Only	No

Use the --advanced option to access advanced properties.

java-class

Synopsis	Specifies the fully-qualified name of the Java class that provides the SMTP Alert Handler implementation.
Default Value	org.opends.server.extensions.SMTPAlertHandler
Allowed Values	A Java class that extends or implements: org.opends.server.api.AlertHandler
Multi-valued	No
Required	Yes
Admin Action Required	The object must be disabled and re-enabled for changes to take effect.
Advanced	Yes
Read-Only	No