Full path: /system/mail/send
Sends e-mail to the specified recipients, generally the administrator.
This function returns Boolean TRUE if execution was successful. If the job execution fails, the outcome depends on the value of the Abort on error parameter, as follows:
•If the Abort on error parameter is TRUE (default value), the job execution is aborted. In this case, you can still handle errors by means of protected blocks (see Handling Step Errors).
•If the Abort on error parameter is FALSE, the function returns FALSE.
Before using this function, ensure that the mail server settings are configured (see Setting Mail Parameters). |
Parameters
Name |
Type |
Description |
|---|---|---|
From |
string |
Email address from which the e-mail message is to be sent, for example: flowforce@<hostname>. |
To |
string |
Recipient's email address. Mandatory parameter. This field may also contain a comma-separated list of multiple destination e-mail addresses. |
Subject |
string |
Subject line of the message. Mandatory parameter. |
Message body |
string |
Optional parameter that provides the body text of the message, as string. The message body supports ASCII as well as Unicode characters.
The text box for the message body allows entering multiple lines and expressions in curly { } braces. |
Attachment |
string as file |
File name of the attachment sent with the email. |
Abort on error |
boolean |
This Boolean parameter determines what should be the return value of the function if the job fails. If Abort on error is FALSE, the function will return Boolean FALSE as well. If Abort on error is TRUE, the job execution is aborted. The default value is TRUE. |
Examples
