<?xml version="1.0" encoding="utf-8"?>
|
<!--
|
! CDDL HEADER START
|
!
|
! The contents of this file are subject to the terms of the
|
! Common Development and Distribution License, Version 1.0 only
|
! (the "License"). You may not use this file except in compliance
|
! with the License.
|
!
|
! You can obtain a copy of the license at legal-notices/CDDLv1_0.txt
|
! or http://forgerock.org/license/CDDLv1.0.html.
|
! See the License for the specific language governing permissions
|
! and limitations under the License.
|
!
|
! When distributing Covered Code, include this CDDL HEADER in each
|
! file and include the License file at legal-notices/CDDLv1_0.txt.
|
! If applicable, add the following below this CDDL HEADER, with the
|
! fields enclosed by brackets "[]" replaced with your own identifying
|
! information:
|
! Portions Copyright [yyyy] [name of copyright owner]
|
!
|
! CDDL HEADER END
|
!
|
!
|
! Copyright 2007-2008 Sun Microsystems, Inc.
|
! -->
|
<adm:managed-object name="smtp-alert-handler"
|
plural-name="smtp-alert-handlers"
|
package="org.opends.server.admin.std" extends="alert-handler"
|
xmlns:adm="http://www.opends.org/admin"
|
xmlns:ldap="http://www.opends.org/admin-ldap">
|
<adm:synopsis>
|
The
|
<adm:user-friendly-name />
|
may be used to send e-mail messages to notify administrators of
|
significant events that occur within the server.
|
</adm:synopsis>
|
<adm:profile name="ldap">
|
<ldap:object-class>
|
<ldap:name>ds-cfg-smtp-alert-handler</ldap:name>
|
<ldap:superior>ds-cfg-alert-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.SMTPAlertHandler
|
</adm:value>
|
</adm:defined>
|
</adm:default-behavior>
|
</adm:property-override>
|
<adm:property name="sender-address" mandatory="true">
|
<adm:synopsis>
|
Specifies the email address to use as the sender for messages
|
generated by this alert handler.
|
</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="recipient-address" mandatory="true"
|
multi-valued="true">
|
<adm:synopsis>
|
Specifies an email address to which the messages should be sent.
|
</adm:synopsis>
|
<adm:description>
|
Multiple values may be provided if there should be more than one
|
recipient.
|
</adm:description>
|
<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="message-subject" mandatory="true">
|
<adm:synopsis>
|
Specifies the subject that should be used for email messages
|
generated by this alert handler.
|
</adm:synopsis>
|
<adm: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.
|
</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-body" mandatory="true">
|
<adm:synopsis>
|
Specifies the body that should be used for email messages
|
generated by this alert handler.
|
</adm:synopsis>
|
<adm: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.
|
</adm:description>
|
<adm:syntax>
|
<adm:string />
|
</adm:syntax>
|
<adm:profile name="ldap">
|
<ldap:attribute>
|
<ldap:name>ds-cfg-message-body</ldap:name>
|
</ldap:attribute>
|
</adm:profile>
|
</adm:property>
|
</adm:managed-object>
|
