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.
Multi Part Email Account Status Notification Handlers provide the ability to send email messages to end users and/or administrators with information about events affecting accounts. The body of the email messages may be formatted in plain text and/or HTML, and the messages may optionally include attachments.
You can choose whether or not to send an email message on a per-notification-type basis, and you can have different message content for each type of notification. See the README.txt file in the config/account-status-notification-email-templates directory for complete details on the message template format.
The Multi Part Email 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 |
account-temporarily-failure-locked-message-template
| Description | The path to a file containing the template to use to generate the email message to send in the event that an account becomes temporarily locked as a result of too many authentication failures. |
| Default Value | No email message will be generated for this notification type. |
| Allowed Values | A filesystem path |
| Multi-Valued | No |
| Required | No |
| Admin Action Required | None. Modification requires no further action |
account-permanently-failure-locked-message-template
| Description | The path to a file containing the template to use to generate the email message to send in the event that an account becomes permanently locked as a result of too many authentication failures. |
| Default Value | No email message will be generated for this notification type. |
| Allowed Values | A filesystem path |
| Multi-Valued | No |
| Required | No |
| Admin Action Required | None. Modification requires no further action |
account-idle-locked-message-template
| Description | The path to a file containing the template to use to generate the email message to send in the event that authentication attempt fails because it has been too long since the user last successfully authenticated. |
| Default Value | No email message will be generated for this notification type. |
| Allowed Values | A filesystem path |
| Multi-Valued | No |
| Required | No |
| Admin Action Required | None. Modification requires no further action |
account-reset-locked-message-template
| Description | The path to a file containing the template to use to generate the email message to send in the event that authentication attempt fails because the user failed to choose a new password in a timely manner after an administrative reset. |
| Default Value | No email message will be generated for this notification type. |
| Allowed Values | A filesystem path |
| Multi-Valued | No |
| Required | No |
| Admin Action Required | None. Modification requires no further action |
account-unlocked-message-template
| Description | The path to a file containing the template to use to generate the email message to send in the event that a user's account has been unlocked (e.g., by an administrative password reset). |
| Default Value | No email message will be generated for this notification type. |
| Allowed Values | A filesystem path |
| Multi-Valued | No |
| Required | No |
| Admin Action Required | None. Modification requires no further action |
account-disabled-message-template
| Description | The path to a file containing the template to use to generate the email message to send in the event that a user's account is disabled by an administrator. |
| Default Value | No email message will be generated for this notification type. |
| Allowed Values | A filesystem path |
| Multi-Valued | No |
| Required | No |
| Admin Action Required | None. Modification requires no further action |
account-enabled-message-template
| Description | The path to a file containing the template to use to generate the email message to send in the event that a user's account is enabled by an administrator. |
| Default Value | No email message will be generated for this notification type. |
| Allowed Values | A filesystem path |
| Multi-Valued | No |
| Required | No |
| Admin Action Required | None. Modification requires no further action |
account-not-yet-active-message-template
| Description | The path to a file containing the template to use to generate the email message to send in the event that an authentication attempt fails because the account has an activation time that is in the future. |
| Default Value | No email message will be generated for this notification type. |
| Allowed Values | A filesystem path |
| Multi-Valued | No |
| Required | No |
| Admin Action Required | None. Modification requires no further action |
account-expired-message-template
| Description | The path to a file containing the template to use to generate the email message to send in the event that an authentication attempt fails because the account has an expiration time that is in the past. |
| Default Value | No email message will be generated for this notification type. |
| Allowed Values | A filesystem path |
| Multi-Valued | No |
| Required | No |
| Admin Action Required | None. Modification requires no further action |
password-expired-message-template
| Description | The path to a file containing the template to use to generate the email message to send in the event that an authentication attempt fails because the account has an expired password. |
| Default Value | No email message will be generated for this notification type. |
| Allowed Values | A filesystem path |
| Multi-Valued | No |
| Required | No |
| Admin Action Required | None. Modification requires no further action |
password-expiring-message-template
| Description | The path to a file containing the template to use to generate the email message to send in the event that an authentication attempt succeeds, but the user's password is about to expire. This notification will only be generated the first time the user authenticates within the window of time that the server should warn about an upcoming password expiration. |
| Default Value | No email message will be generated for this notification type. |
| Allowed Values | A filesystem path |
| Multi-Valued | No |
| Required | No |
| Admin Action Required | None. Modification requires no further action |
password-reset-message-template
| Description | The path to a file containing the template to use to generate the email message to send in the event that a user's password has been reset by an administrator. |
| Default Value | No email message will be generated for this notification type. |
| Allowed Values | A filesystem path |
| Multi-Valued | No |
| Required | No |
| Admin Action Required | None. Modification requires no further action |
password-changed-message-template
| Description | The path to a file containing the template to use to generate the email message to send in the event that a user changes their own password. |
| Default Value | No email message will be generated for this notification type. |
| Allowed Values | A filesystem path |
| Multi-Valued | No |
| Required | No |
| Admin Action Required | None. Modification requires no further action |
account-authenticated-message-template
| Description | The path to a file containing the template to use to generate the email message to send in the event that an account has successfully authenticated in a bind operation that matches the criteria provided in the account-authentication-notification-request-criteria property. |
| Default Value | No email message will be generated for this notification type. |
| Allowed Values | A filesystem path |
| Multi-Valued | No |
| Required | No |
| Admin Action Required | None. Modification requires no further action |
account-created-message-template
| Description | The path to a file containing the template to use to generate the email message to send in the event that a new account is created in an add request that matches the criteria provided in the account-creation-notification-request-criteria property. |
| Default Value | No email message will be generated for this notification type. |
| Allowed Values | A filesystem path |
| Multi-Valued | No |
| Required | No |
| Admin Action Required | None. Modification requires no further action |
account-deleted-message-template
| Description | The path to a file containing the template to use to generate the email message to send in the event that an existing accout has been removed in a delete request that matches the criteria provided in the account-deletion-notification-request-criteria property. |
| Default Value | No email message will be generated for this notification type. |
| Allowed Values | A filesystem path |
| Multi-Valued | No |
| Required | No |
| Admin Action Required | None. Modification requires no further action |
account-updated-message-template
| Description | The path to a file containing the template to use to generate the email message to send in the event that an existing account is updated with a modify or modify DN operation that matches the criteria provided in the account-update-notification-request-criteria property. |
| Default Value | No email message will be generated for this notification type. |
| Allowed Values | A filesystem path |
| Multi-Valued | No |
| Required | No |
| Admin Action Required | None. Modification requires no further action |
bind-password-failed-validation-message-template
| Description | The path to a file containing the template to use to generate the email message to send in the event that a user authenticated with a password that failed to satisfy the criteria for one or more of the configured password validators. |
| Default Value | No email message will be generated for this notification type. |
| Allowed Values | A filesystem path |
| Multi-Valued | No |
| Required | No |
| Admin Action Required | None. Modification requires no further action |
must-change-password-message-template
| Description | The path to a file containing the template to use to generate the email message to send in the event that a user successfully authenticates to the server but will be required to choose a new password before they will be allowed to perform any other operations. |
| Default Value | No email message will be generated for this notification type. |
| Allowed Values | A filesystem path |
| Multi-Valued | No |
| Required | No |
| 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 Multi Part Email Account Status Notification Handler:
dsconfig create-account-status-notification-handler
--handler-name {name}
--type multi-part-email
--set enabled:{propertyValue}
[--set {propertyName}:{propertyValue}] ...
To delete an existing Account Status Notification Handler:
dsconfig delete-account-status-notification-handler
--handler-name {name}