Send SMTP Email Index Stage
This stage sends an SMTP message from Fusion, for alerting, reporting, and more, using Fusion’s Messaging Services.
Before you can use the Email pipeline stage, you must enable Email messaging in Fusion:
-
Click Applications > System > Messaging Services.
-
Select SMTP Message Service from the drop-down menu.
-
Verify that the default settings are sufficient.
-
Click Save message service.
|
When entering configuration values in the UI, use unescaped characters, such as \t for the tab character. When entering configuration values in the API, use escaped characters, such as \\t for the tab character.
|
Send an SMTP Message using the Fusion Messaging Service. This can be used for things like alerting, emailing results and more.
skip - boolean
Set to true to skip this stage.
Default: false
label - string
A unique label for this stage.
<= 255 characters
condition - string
Define a conditional script that must result in true or false. This can be used to determine if the stage should process or not.
storeInContext - boolean
Put the generated Message later in the pipeline.
Default: false
responseKey - string
The name of the key to store the MessageResponse under in the Pipeline Context.
Default: messageResponse
errorKey - string
The name of the key to store a boolean if sending a message failed. If set, you can check the MessageResponse errorCode and other attributes for the reason.
Default: messageResponseFailure
to - array[string]required
Who to send the message to. May be a string template similar to the body and subject.
from - stringrequired
Who the message is from. May be a string template similar to the body and subject.
messageBodyTemplate - stringrequired
A Message Template that is used to create the message body to send. See https://github.com/antlr/stringtemplate4/blob/master/doc/index.md for details on the template language.
Default: Processing Document <doc.id>
messageSubjectTemplate - stringrequired
A Message Template that is used to create the message subject to send. See https://github.com/antlr/stringtemplate4/blob/master/doc/index.md for details on the template language.
Default: Hello
smtpUser - stringrequired
The SMTP user to send the message from.
smtpPassword - stringrequired
The SMTP password for the user credentials.