Description
The Mail action sends a text or HTML email with optional file attachments.
This action can be used at the end of a workflow run to either announce a successful run or send a notifications about a failure in the workflow.
For example, it is not uncommon at the end of a successful load, to send an email to a distribution list announcing that the load was successful and include a log file.
If there are errors, an email can be sent to alert individuals on a distribution list.
The Mail action requires an SMTP server.
You can use authentication and security as part of the connection but you must have the SMTP credentials.
You can attach files to your email messages such as error logs and regular logs.
In addition, logs can be zipped into a single archive for convenience.
The mail action can either work with mail server configuration defined in the action itself, or take the server connection from a Mail Server Connection metadata type. In the latter case, the server configuration in the action itself is ignored.
Options
Addresses Tab
Action name
The name of the workflow action.
Destination
Destination Address
The destination for the email; you can specify multiple addresses if you separate them with a space.
Cc
An identical copy of the message is also sent to all the addresses listed in the Cc: field. To enter more than one address in the Cc: field, separate them with a space.
BCc
Send to a recipient whose email address does not appear in the message
Sender
Sender name
Name of the person sending the email
Sender address
Email address of the person sending the email
Reply to
Email address of the person to which to send a reply
Contact person
The name of the contact person to be placed in the email
Contact phone
The contact telephone number to be placed in the email
Server Tab
Mail Server Connection
Mail Connection
If a mail server connection is selected here, the rest of this tab is ignored. The server configuration will be taken from the Mail Server Connection metadata item.
SMTP Server
SMTP Server
The SMTP server address
Port
The port on which the SMTP Server is running
Authentication
Use Authentication
Enable to use authentication to the SMTP Server
Use XOAUTH2
If checked XOAuth2 will be used to authenticate with the server.
Authentication user
SMTP user account name
Authentication password
SMTP user account password
Use Secure Authentication?
Enable to use secure authentication
Secure Connection Type
Select authentication type (SSL, TLS, TLS 1.2)
Check server identity?
Check the server identity?
Trusted hosts
A list of trusted hosts separated by a space, for example: "host1 host2 host3"
Email Message Tab
Include date in message?
Enable to include the current date in the message
Only send comment in mail body?
If not enabled the email will contain information about the workflow and its execution in addition to the comment
Use HTML in mail body
The message is sent in HTML format
Encoding
Select the character encoding type used for the HTML format
Manage Priority
Enable to set the priority and sensitivity of the message. Typically, failures might be sent with a higher priority than successes. Note: The support of this flag is depending on the mail server.
Priority: Low, Normal, or High
Importance: Low, Normal, or High
Sensitivity: Normal, Personal, Private, or Confidential
Subject
Enter the subject of the mail into this field.
Comment
Enter the comment within the body of the mail into this field.
Attached Files Tab
Attach files to message?
Enable to attach a file to your email message
Select file type
The files to send are defined within the internal files result set. Every file in this list is marked with a file type and you can select what type of file you want to send (see also the tips at the end of this document):
General
Log
Error line
Error
Warning
Zip files to single archive?
Enable to have attachments archived in a zip file
Name of the zip archive
Define the filename of your zip archive
Filename
Name of a single image file to add. Note: This works only when Use HTML format is defined in the EMail Message tab.
Content ID
Automatically entered
Image
The full path to image (used when embedding multiple images) Click Edit to edit the path; click Delete to delete the path to the image
Content ID
The image content ID (used when embedding multiple images) Click Edit to edit the content ID; click Delete to delete the Content ID
Tips
How to attach a particular file to the e-mail
You can attach "Result Files" of a particular type(s) to the e-mail, either individually or as a single ZIP archive by checking the option "Attach files to message" and selecting the types to attach under "Select the result files types to attach". What is a Result File and how to create one? Well, just about any file created during a pipeline may become a Result File, you only need to mark it as such. There are several ways to do that:
When creating a file with a transform that supports it, allow it to mark the file as a Result File. For example the "Text file output" transform has the check-box "Add filenames to result" on the File tab for that purpose. The file type will be General.
Use the transform "Set files in result" from the workflow category to mark a file as a result file of a particular type. This transforms expects the file name to be in a field (you can use e.g. "Generate Rows" in combination with "Add constants" to produce a row containing the file name).
Attaching pipeline’s log
You can attach a log file with log of a pipeline run by the workflow prior to sending the mail as follows. This assumes the workflow consists of three actions: Start → Pipeline → Mail.
In the Pipeline workflow action’s options, check "Specify logfile?" and enter a name and extension for the file. You can also specify the desired log level.
In the Mail workflow action’s options, check "Attach files to message" and select (at least) the file type "Log".
The next time the mail is send, it will have the pipeline’s log attached.
Last updated