Configuration Reference Home
OpenDJ Server - SMTP Alert Handler

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 Component

The SMTP Alert Handler component inherits from the Alert Handler

Properties

A description of each property follows.


Basic Properties: Advanced Properties:
↓ disabled-alert-type ↓ java-class
↓ enabled
↓ enabled-alert-type
↓ message-body
↓ message-subject
↓ recipient-address
↓ sender-address

Basic Properties

disabled-alert-type

Description
Specifies the names of the alert types that are disabled for this alert handler.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 Property
No
Read-only
No

enabled

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

enabled-alert-type

Description
Specifies the names of the alert types that are enabled for this alert handler.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 Property
No
Read-only
No

message-body

Description
Specifies the body that should be used for email messages generated by this alert handler.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 Property
No
Read-only
No

message-subject

Description
Specifies the subject that should be used for email messages generated by this alert handler.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 Property
No
Read-only
No

recipient-address

Description
Specifies an email address to which the messages should be sent.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 Property
No
Read-only
No

sender-address

Description
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 Property
No
Read-only
No


Advanced Properties

java-class

Description
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 implements or extends the class(es) :
org.opends.server.api.AlertHandler
Multi-valued
No
Required
Yes
Admin Action Required
The SMTP Alert Handler must be disabled and re-enabled for changes to this setting to take effect
Advanced Property
Yes
Read-only
No