--- title: SMTP Alert Handler description: The SMTP Alert Handler may be used to send e-mail messages to notify administrators of significant events that occur within the server. component: pingds version: 8.1 page_id: pingds:configref:objects-smtp-alert-handler canonical_url: https://docs.pingidentity.com/pingds/8.1/configref/objects-smtp-alert-handler.html section_ids: parent: Parent smtp_alert_handler_properties: SMTP Alert Handler properties basic_properties: Basic properties disabled-alert-type: disabled-alert-type enabled: enabled enabled-alert-type: enabled-alert-type message-body: message-body message-subject: message-subject recipient-address: recipient-address sender-address: sender-address advanced_properties: Advanced properties java-class: java-class --- # 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](objects-alert-handler.html). ## SMTP Alert Handler properties You can use configuration expressions to set property values at startup time. For details, see [Property value substitution](expressions.html). | Basic Properties | Advanced Properties | | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------- | | [disabled-alert-type](#disabled-alert-type) [enabled](#enabled) [enabled-alert-type](#enabled-alert-type) [message-body](#message-body) [message-subject](#message-subject) [recipient-address](#recipient-address) [sender-address](#sender-address) | [java-class](#java-class) | ### Basic properties Use the `--advanced` option to access 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* | truefalse | | *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 | ## Advanced properties 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 |