do-send-email-from-template

Generates an e-mail notification using an SMTP notification configuration object, e-mail template object, and replacement tokens. The target SMTP server along with credentials for authentication and the originating address are read from the SMTP notification configuration object. The subject and e-mail message are created using the template object and template replacement tokens. Replacement tokens are declared within a <arg-string> element and tag name attribute. The value of <arg-string> tag attribute is interpretted as html, if it is enclosed within <use-html></use-html> tags.Reserved replacement tokens specify the various recipient addresses.

Remarks

Reserved Token	Description
to	Adds the address to the list of e-mail recipients. Multiple instances are allowed.
cc	Adds the address to the list of CC e-mail recipients. Multiple instances are allowed.
bcc	Adds the address to the list of BCC e-mail recipients. Multiple instances are allowed.
reply-to	Specifies the address to be used as the e-mail message reply address.
encoding	Specifies the character encoding to use for the e-mail message.

Example

<do-send-email-from-template
     notification-dn="/cn=security/cn=DefaultNotification Collection"
     template-dn="/cn=security/cn=DefaultNotification Collection/cn=PS
     Sync Fail">
   <arg-password>
      <token-named-password name="email-server"/>
   </arg-password>
   <arg-string name="manager">
      <token-text>Bill Jones</token-text>
   </arg-string>
   <arg-string name="surname">
      <token-text>Smith</token-text>
   </arg-string>
   <arg-string name="given-name">
      <token-text>Joe</token-text>
   </arg-string>
   <arg-string name="to">
      <token-text>to_user@company.com</token-text>
   </arg-string>
   <arg-string name="cc">
      <token-text>cc_user@company.com</token-text>
   </arg-string>
   <arg-string name="custom-smtp-header">
      <token-text>X-Priority: 1(Highest)</token-text>
   </arg-string>
   <arg-string name="FailureReason">
      <token-text>
         <use-html><p>sample reason 1</p><p>sample reason 2</p></use-html>
      </token-text>
   </arg-string>
</do-send-email-from-template>

Allowed Content

Element	Description
arg-password	Password argument.
arg-string	String argument.

Attributes

Attribute	Possible Values	Default Value
disabled	true \| false True if this element is disabled.	false
notification-dn	CDATA Slash form DN of the SMTP notification configuration object.	#REQUIRED
disabled	true \| false True if this element is disabled.	false
password	CDATA Password for user on the SMTP server. Deprecated; use <arg-password> with <token-named-password> instead.	#IMPLIED
template-dn	CDATA Slash form DN of the e-mail template object. Supports variable expansion.	#REQUIRED

Content Rule

( arg-string * )

Parent Elements

Element	Description
actions	Actions that are performed by a <rule>.
arg-actions	Actions argument.