Sends an e-mail notification to the specified server. Optional credentials for authentication to the SMTP server are provided in the ID and password attributes. The type attribute identifies if the e-mail message contains plain text or HTML data. The various e-mail addresses, subject, and message are provided within <arg-string> elements and corresponding tag name attributes.
Tag Name |
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. |
from |
Specifies the address to be used as the originating e-mail address. |
reply-to |
Specifies the address to be used as the e-mail message reply address. |
subject |
Specifies the e-mail subject. |
message |
Specifies the content of the e-mail message. |
encoding |
Specifies the character encoding to use for the e-mail message. |
custom-smtp-header |
Specifies a custom SMTP header to add to the email message. |
<do-send-email server="smtp.company.com" id="user" password="emailpwd" type="text"> <arg-string name="to"> <token-text>to_user1@company.com</token-text> </arg-string> <arg-string name="to"> <token-text>to_user2@company.com</token-text> </arg-string> <arg-string name="cc"> <token-text>cc_user@company.com</token-text> </arg-string> <arg-string name="bcc"> <token-text>bcc_user@company.com</token-text> </arg-string> <arg-string name="from"> <token-text>from_user@company.com</token-text> </arg-string> <arg-string name="subject"> <token-text>This is the email subject</token-text> </arg-string> <arg-string name="message"> <token-text>This is the email body</token-text> </arg-string> </do-send-email>
Element |
Description |
---|---|
String argument. |
|
Password argument. |
Attribute |
Possible Values |
Default Value |
---|---|---|
disabled |
true | false True if this element is disabled. |
false |
id |
CDATAUser account on the SMTP server. Support variable expansion. |
#IMPLIED |
password |
CDATA Password for the user on the SMTP server. Deprecated; use <arg-password> with <token-named-password> instead. |
#IMPLIED |
server |
CDATA DNS name or IP address of the SMTP server. Support variable expansion. |
#REQUIRED |
type |
text | htmlIdentifies if e-mail message contains plain text or HTML data. |
text |
( arg-string * )
Element |
Description |
---|---|
Actions that are performed by a <rule>. |
|
Actions argument. |