The Email action can send the job results to users in various ways. It supports attaching and inlining job results as well as plain text and HTML-formatted emails. The configuration dialog requires the following options:
-
Receiver: one or more email addresses of the receiving party. Multiple addresses can be separated by semicolon
;
-
Sender: the optional sender email address if the default address is not to be used. It is important to note that the mail server is authenticated with the global settings. It must therefore support the fact that the sender field contains a different e-mail than is used in the login.
-
Subject: the subject line of the email
-
Message: the message. Please see the following section about how this can be customized
-
Attach Files: enable this option to attach file results to the email. Please see the Attachments section for details.
Note: For the server to be able to sent HTML-formatted emails, you have to have the HTML Engine plugin installed.
SMTP Settings
The Email action uses the global SMTP settings from the configuration to send the job results. The sender of the email will be the sender from the settings by default. If the sender email should be changed, the mail server has to support this feature.
Message Format
The message can be sent as plain text or HTML-formatted. The action will decide on its own when to switch from one to the other. That means you can write HTML into the message box or have job results that deliver HTML in a TEXT type of data, and this will be detected.
To embed the result of a job, it has to have the TEXT type of data. The result will be embedded at the location of the placeholder [jobresult]
- which is the default message.
If there were multiple jobs with the TEXT type of data, the results will be combined to one and replace the [jobresult]
placeholder.
Placeholders with multiple results
A single placeholder can be used for multiple results. The block with the placeholder will be replicated for each result that can be consumed with the placeholder.
Note: the placeholder line and block will be replicated as-is up to the next text or non-newline character.
Example 1
Hello, here is the result for your weather request: [weather.city] [weather.temperature] [weather.windspeed]
Result
Hello, here is the result for your weather request: Berlin 6.49 °C 2.1 km/h New York 3.46 °C 3.51 km/h
The placeholder line is replicated as is - if there wasn't a line break at the end, it won't be in the email as well.
Example 2
Hello, here is the result for your weather request: [weather.city] [weather.temperature] [weather.windspeed] [weather.pressure] Thanks, Bye.
Result
Hello, here is the result for your weather request: Berlin 6.49 °C 2.1 km/h 1027 hPa New York 3.31 °C 4.1 km/h 1023 hPa Thanks, Bye.
Now there is an empty line after the [weather.pressure]
entry. It is being replicated in the result.
Attachments
Any FILE data can additionally be attached to the email.
Important: a result that has already been processed by the [jobresult]
placeholder will not be attached.
File Name Format
There are three placeholders to dynamically determine the resulting file name:
-
[filename]
- the name of the file as generated by a job -
[date]
- the date, when the job was executed -
[time]
- the time at which the job was executed
Note: the File Name Format must not define the file extension. The extension will be added at the end.
Example
Pattern: [filename] [date] [time] File Input: abc.pdf File Output: abc 2017-04-07 09-45.pdf Path Input: abc/def.pdf Path Output: abc 2017-04-07 09-45/def.pdf