<?xml version="1.0" encoding="utf-8"?>

<adm:managed-object name="smtp-account-status-notification-handler"

plural-name="smtp-account-status-notification-handlers"

extends="account-status-notification-handler"

package="org.forgerock.opendj.server.config"

xmlns:adm="http://opendj.forgerock.org/admin"

xmlns:ldap="http://opendj.forgerock.org/admin-ldap">

<adm:synopsis>

The

<adm:user-friendly-name />

is a notification handler that sends

email messages to end users and/or administrators whenever an

account status notification is generated.

</adm:synopsis>

<adm:profile name="ldap">

<ldap:object-class>

<ldap:name>

ds-cfg-smtp-account-status-notification-handler

</ldap:name>

<ldap:superior>

ds-cfg-account-status-notification-handler

</ldap:superior>

</ldap:object-class>

</adm:profile>

<adm:property-override name="java-class" advanced="true">

<adm:default-behavior>

<adm:defined>

<adm:value>

org.opends.server.extensions.SMTPAccountStatusNotificationHandler

</adm:value>

</adm:defined>

</adm:default-behavior>

</adm:property-override>

<adm:property name="email-address-attribute-type"

multi-valued="true">

<adm:synopsis>

Specifies which attribute in the user's entries may be used to obtain

the email address when notifying the end user.

</adm:synopsis>

<adm:description>

You can specify more than one email address as separate values. In this case,

the <adm:product-name /> server sends a notification to all email addresses identified.

</adm:description>

<adm:default-behavior>

<adm:alias>

<adm:synopsis>

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.

</adm:synopsis>

</adm:alias>

</adm:default-behavior>

<adm:syntax>

<adm:attribute-type />

</adm:syntax>

<adm:profile name="ldap">

<ldap:attribute>

<ldap:name>ds-cfg-email-address-attribute-type</ldap:name>

</ldap:attribute>

</adm:profile>

</adm:property>

<adm:property name="recipient-address" multi-valued="true">

<adm:synopsis>

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.

</adm:synopsis>

<adm:description>

This may be used to ensure that server administrators also receive

a copy of any notification messages that are generated.

</adm:description>

<adm:default-behavior>

<adm:alias>

<adm:synopsis>

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.

</adm:synopsis>

</adm:alias>

</adm:default-behavior>

<adm:syntax>

<adm:string />

</adm:syntax>

<adm:profile name="ldap">

<ldap:attribute>

<ldap:name>ds-cfg-recipient-address</ldap:name>

</ldap:attribute>

</adm:profile>

</adm:property>

<adm:property name="send-message-without-end-user-address"

mandatory="true" advanced="true">

<adm:synopsis>

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 be possible to

notify the end user).

</adm:synopsis>

<adm:description>

This is only applicable if both one or more email address

attribute types and one or more additional recipient addresses are

specified.

</adm:description>

<adm:default-behavior>

<adm:defined>

<adm:value>true</adm:value>

</adm:defined>

</adm:default-behavior>

<adm:syntax>

<adm:boolean />

</adm:syntax>

<adm:profile name="ldap">

<ldap:attribute>

<ldap:name>

ds-cfg-send-message-without-end-user-address

</ldap:name>

</ldap:attribute>

</adm:profile>

</adm:property>

<adm:property name="sender-address" mandatory="true">

<adm:synopsis>

Specifies the email address from which the message is sent.

Note that this does not necessarily have to be a legitimate email

address.

</adm:synopsis>

<adm:syntax>

<adm:string />

</adm:syntax>

<adm:profile name="ldap">

<ldap:attribute>

<ldap:name>ds-cfg-sender-address</ldap:name>

</ldap:attribute>

</adm:profile>

</adm:property>

<adm:property name="message-subject" mandatory="true"

multi-valued="true">

<adm:synopsis>

Specifies the subject that should be used for email messages

generated by this account status notification handler.

</adm:synopsis>

<adm:description>

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.

</adm:description>

<adm:syntax>

<adm:string />

</adm:syntax>

<adm:profile name="ldap">

<ldap:attribute>

<ldap:name>ds-cfg-message-subject</ldap:name>

</ldap:attribute>

</adm:profile>

</adm:property>

<adm:property name="message-template-file" mandatory="true"

multi-valued="true">

<adm:synopsis>

Specifies the path to the file containing the message template

to generate the email notification messages.

</adm:synopsis>

<adm:description>

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.

</adm:description>

<adm:syntax>

<adm:string />

</adm:syntax>

<adm:profile name="ldap">

<ldap:attribute>

<ldap:name>ds-cfg-message-template-file</ldap:name>

</ldap:attribute>

</adm:profile>

</adm:property>

</adm:managed-object>