|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface SMTPAccountStatusNotificationHandlerCfg
A server-side interface for querying SMTP Account Status Notification Handler settings.
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.
Method Summary | |
---|---|
void |
addSMTPChangeListener(ConfigurationChangeListener<SMTPAccountStatusNotificationHandlerCfg> listener)
Register to be notified when this SMTP Account Status Notification Handler is changed. |
java.lang.Class<? extends SMTPAccountStatusNotificationHandlerCfg> |
configurationClass()
Gets the configuration class associated with this SMTP Account Status Notification Handler. |
java.util.SortedSet<AttributeType> |
getEmailAddressAttributeType()
Gets the "email-address-attribute-type" property. |
java.lang.String |
getJavaClass()
Gets the "java-class" property. |
java.util.SortedSet<java.lang.String> |
getMessageSubject()
Gets the "message-subject" property. |
java.util.SortedSet<java.lang.String> |
getMessageTemplateFile()
Gets the "message-template-file" property. |
java.util.SortedSet<java.lang.String> |
getRecipientAddress()
Gets the "recipient-address" property. |
java.lang.String |
getSenderAddress()
Gets the "sender-address" property. |
boolean |
isSendMessageWithoutEndUserAddress()
Gets the "send-message-without-end-user-address" property. |
void |
removeSMTPChangeListener(ConfigurationChangeListener<SMTPAccountStatusNotificationHandlerCfg> listener)
Deregister an existing SMTP Account Status Notification Handler configuration change listener. |
Methods inherited from interface org.opends.server.admin.std.server.AccountStatusNotificationHandlerCfg |
---|
addChangeListener, isEnabled, removeChangeListener |
Methods inherited from interface org.opends.server.admin.Configuration |
---|
dn |
Method Detail |
---|
java.lang.Class<? extends SMTPAccountStatusNotificationHandlerCfg> configurationClass()
configurationClass
in interface AccountStatusNotificationHandlerCfg
configurationClass
in interface Configuration
void addSMTPChangeListener(ConfigurationChangeListener<SMTPAccountStatusNotificationHandlerCfg> listener)
listener
- The SMTP Account Status Notification Handler configuration change listener.void removeSMTPChangeListener(ConfigurationChangeListener<SMTPAccountStatusNotificationHandlerCfg> listener)
listener
- The SMTP Account Status Notification Handler configuration change listener.java.util.SortedSet<AttributeType> getEmailAddressAttributeType()
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 OpenDS server sends a notification to all email addresses identified.
java.lang.String getJavaClass()
Specifies the fully-qualified name of the Java class that provides the SMTP Account Status Notification Handler implementation.
getJavaClass
in interface AccountStatusNotificationHandlerCfg
java.util.SortedSet<java.lang.String> getMessageSubject()
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.
java.util.SortedSet<java.lang.String> getMessageTemplateFile()
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.
java.util.SortedSet<java.lang.String> getRecipientAddress()
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.
java.lang.String getSenderAddress()
Specifies the email address from which the message is sent. Note that this does not necessarily have to be a legitimate email address.
boolean isSendMessageWithoutEndUserAddress()
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).
This is only applicable if both one or more email address attribute types and one or more additional recipient addresses are specified.
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |