Note: this component is designated "advanced", which means that objects of this type are not expected to be created or altered in most environments. If you believe that such a change is necessary, you may want to contact support in order to understand the potential impact of that change.
The SMTP Account Status Notification Handler is a notification handler that sends email messages to end users and/or administrators whenever an account status notification is generated.
The SMTP Account Status Notification Handler component inherits from the Account Status Notification Handler
The properties supported by this managed object are as follows:
| Description | A description for this Account Status Notification Handler |
| Default Value | None |
| Allowed Values | A string |
| Multi-Valued | No |
| Required | No |
| Admin Action Required | None. Modification requires no further action |
| Description | Indicates whether the Account Status Notification Handler is enabled. Only enabled handlers are invoked whenever a related event occurs in the server. |
| Default Value | None |
| Allowed Values | true false |
| Multi-Valued | No |
| Required | Yes |
| Admin Action Required | None. Modification requires no further action |
| Description | Indicates whether the server should attempt to invoke this Account Status Notification Handler in a background thread so that any potentially-expensive processing (e.g., performing network communication to deliver a message) will not delay processing for the operation that triggered the notification. |
| Default Value | true |
| Allowed Values | true false |
| Multi-Valued | No |
| Required | No |
| Admin Action Required | None. Modification requires no further action |
account-authentication-notification-result-criteria
| Description | A result criteria object that identifies which successful bind operations should result in account authentication notifications for this handler. If this is not defined, then account authentication notifications will not be processed by this account status notification handler. If it is defined, then account authentication notifications will only be handled for successful bind operations that match the provided criteria. |
| Default Value | Account authentication notifications will not be processed by this account status notification handler. |
| Allowed Values | The DN of any Result Criteria. |
| Multi-Valued | No |
| Required | No |
| Admin Action Required | None. Modification requires no further action |
account-creation-notification-request-criteria
| Description | A request criteria object that identifies which add requests should result in account creation notifications for this handler. If this is not defined, then account creation notifications will not be processed by this account status notification handler. If it is defined, then account creation notifications will only be handled for add requests that match the provided criteria. |
| Default Value | Account creation notifications will not be processed by this account status notification handler. |
| Allowed Values | The DN of any Request Criteria. |
| Multi-Valued | No |
| Required | No |
| Admin Action Required | None. Modification requires no further action |
account-deletion-notification-request-criteria
| Description | A request criteria object that identifies which delete requests should result in account deletion notifications for this handler. If this is not defined, then account deletion notifications will not be processed by this account status notification handler. If it is defined, then account deletion notifications will only be handled for delete requests that match the provided criteria. |
| Default Value | Account deletion notifications will not be processed by this account status notification handler. |
| Allowed Values | The DN of any Request Criteria. |
| Multi-Valued | No |
| Required | No |
| Admin Action Required | None. Modification requires no further action |
account-update-notification-request-criteria
| Description | A request criteria object that identifies which modify and modify DN requests should result in account update notifications for this handler. If this is not defined, then account update notifications will not be processed by this account status notification handler. If it is defined, then account update notifications will only be handled for modify and modify DN requests that match the provided criteria. |
| Default Value | Account update notifications will not be processed by this account status notification handler. |
| Allowed Values | The DN of any Request Criteria. |
| Multi-Valued | No |
| Required | No |
| Admin Action Required | None. Modification requires no further action |
| Description | Specifies which attribute in the user's entries may be used to obtain the email address when notifying the end user. You can specify more than one email address as separate values. In this case, the Directory Server sends a notification to all email addresses identified. |
| Default Value | If no email address attribute types are specified, then no attempt is made to send email notification messages to end users. Only those users specified in the set of additional recipient addresses are sent the notification messages. |
| Allowed Values | The name or OID of an attribute type defined in the server schema. |
| Multi-Valued | Yes |
| Required | No |
| Admin Action Required | None. Modification requires no further action |
| Description | The name of the JSON field whose value is the email address to which the message should be sent. The email address must be contained in a top-level field whose value is a single string. If this is present, then the attribute type specified in the email-address-attribute-type property must have a JSON object syntax. Each value of the specified attribute type must contain information about a single email address, and if there are multiple values for that attribute then all values that contain the specified field (and that matches the filter specified in the email-address-json-object-filter property, if present) will be selected. If the ubidEmailJSON attribute type is to be used, then the field name should be "value". |
| Default Value | None |
| Allowed Values | A string |
| Multi-Valued | No |
| Required | No |
| Admin Action Required | None. Modification requires no further action |
email-address-json-object-filter
| Description | A JSON object filter that may be used to identify which email address value to use when sending the message. If this is present, then the attribute type specified in the email-address-attribute-type property must have a JSON object syntax, and the email-address-json-field property must be used to specify which field contains the email address value. This property may be useful in cases in which the JSON object containing the email address also includes other information that might be useful in determining whether that address is suitable for use. For example, if the ubidEmailJSON attribute type is to be used, then it may be desirable to only consider sending messages to email addresses that are marked as verified. In that case, a filter of (ubidEmailJSON:jsonObjectFilterExtensibleMatch:={ "filterType":"equals", "field":"verified", "value":true }) may be used to match only verified email address values. If the target attribute type has multiple values that match the filter, then the all matching values will be used. See the "Managing JSON Attribute Values" section of the administration guide, or the Javadoc documentation for the com.unboundid.ldap.sdk.unboundidds.jsonfilter.JSONObjectFilter class, for more details on creating and using JSON object filters. |
| Default Value | None |
| Allowed Values | A valid LDAP search filter |
| Multi-Valued | No |
| Required | No |
| Admin Action Required | None. Modification requires no further action |
| Description | Specifies an email address to which notification messages are sent, either instead of or in addition to the end user for whom the notification has been generated. This may be used to ensure that server administrators also receive a copy of any notification messages that are generated. |
| Default Value | If no additional recipient addresses are specified, then only the end users that are the subjects of the account status notifications receive the notification messages. |
| Allowed Values | A string |
| Multi-Valued | Yes |
| Required | No |
| Admin Action Required | None. Modification requires no further action |
| Description | Specifies the email address from which the message is sent. Note that this does not necessarily have to be a legitimate email address. |
| Default Value | None |
| Allowed Values | A string |
| Multi-Valued | No |
| Required | Yes |
| Admin Action Required | None. Modification requires no further action |
| Description | Specifies the subject that should be used for email messages generated by this account status notification handler. The values for this property should begin with the name of an account status notification type followed by a colon and the subject that should be used for the associated notification message. If an email message is generated for an account status notification type for which no subject is defined, then that message is given a generic subject. |
| Default Value | None |
| Allowed Values | A string |
| Multi-Valued | Yes |
| Required | Yes |
| Admin Action Required | None. Modification requires no further action |
| Description | Specifies the path to the file containing the message template to generate the email notification messages. The values for this property should begin with the name of an account status notification type followed by a colon and the path to the template file that should be used for that notification type. If an account status notification has a notification type that is not associated with a message template file, then no email message is generated for that notification. |
| Default Value | None |
| Allowed Values | A string |
| Multi-Valued | Yes |
| Required | Yes |
| Admin Action Required | None. Modification requires no further action |
send-message-without-end-user-address (Advanced Property)
| Description | Indicates whether an email notification message should be generated and sent to the set of notification recipients even if the user entry does not contain any values for any of the email address attributes (that is, in cases when it is not possible to notify the end user). This is only applicable if both one or more email address attribute types and one or more additional recipient addresses are specified. |
| Default Value | true |
| Allowed Values | true false |
| Multi-Valued | No |
| Required | Yes |
| Admin Action Required | None. Modification requires no further action |
To list the configured Account Status Notification Handlers:
dsconfig list-account-status-notification-handlers
[--property {propertyName}] ...
To view the configuration for an existing Account Status Notification Handler:
dsconfig get-account-status-notification-handler-prop
--handler-name {name}
[--tab-delimited]
[--script-friendly]
[--property {propertyName}] ...
To update the configuration for an existing Account Status Notification Handler:
dsconfig set-account-status-notification-handler-prop
--handler-name {name}
(--set|--add|--remove) {propertyName}:{propertyValue}
[(--set|--add|--remove) {propertyName}:{propertyValue}] ...
To create a new SMTP Account Status Notification Handler:
dsconfig create-account-status-notification-handler
--handler-name {name}
--type smtp
--set enabled:{propertyValue}
--set sender-address:{propertyValue}
--set message-subject:{propertyValue}
--set message-template-file:{propertyValue}
[--set {propertyName}:{propertyValue}] ...
To delete an existing Account Status Notification Handler:
dsconfig delete-account-status-notification-handler
--handler-name {name}