Description
Mail is a step in the Utility Plugin both for Process Studio Workflows and Process Studio Processes. Mail step is used to send a text or HTML email with optional file attachments.
Most commonly Mail is used as a process entry at the end of a process. It can be used to announce a process failure or success, 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.
Note: No email messages are sent when a process crashes during a run. If you are bound by service level agreements, you may configure Email Notification settings in AutomationEdge.
Configurations
| No. | Field Name | Description |
|---|---|---|
| 1 | Step name | Specify the name of the step as it appears in the workflow workspace. This name has to be unique in a single workflow. |
| 2 | Destination Address | The destination for the email; you can specify multiple addresses if you separate them with a space. Best practice: Do not maintain your distribution list within a process. Rather, have your email administrators set up a list so that you can send to a specified list each time you create the process. |
| 3 | 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. |
| 4 | BCc: | Send to a recipient whose email address does not appear in the message |
| 5 | Sender name | Name of the person sending the email |
| 6 | Sender address | Email address of the person sending the email |
| 7 | Reply to | Email address of the person to which to send a reply |
| 8 | Contact person | The name of the contact person to be placed in the email |
| 9 | Contact phone | The contact telephone number to be placed in the email |
| Server Tab: | ||
| 1 | SMTP Server | The SMTP server address. SMTP server is mandatory. You can use authentication and security as part of the connection but you must have the SMTP credentials and enable Use Authentication checkbox below. |
| 2 | Port | The port on which the SMTP Server is running |
| 3 | Connection timeout (in milliseconds) | Specify the socket connection timeout value in milliseconds. Default value is infinite. |
| 4 | Timeout (in milliseconds) | Specify the socket read timeout in milliseconds. Default value is infinite. |
| 5 | Write timeout (in milliseconds) | Specify the socket write timeout value in milliseconds. Default value is infinite. |
| 6 | Use Authentication | Enable Use Authentication checkbox to authenticate to the SMTP Server. In this way you can use authentication and security as part of the connection to SMTP server. |
| 7 | Authentication user | SMTP user account name. |
| 8 | Authentication password | SMTP user account password. |
| 9 | Use Secure Authentication? | Enable to use secure authentication. |
| 10 | Secure Connection Type | Select authentication type (SSL, TSL). |
| 11 | Protocols | Select the checkbox of the TLS version for sending the email message. The available versions are: TLSv1, TLSv1.1, TLSv1.2, or TLSv1.3. You can select one or all versions. |
| Email Message Tab | ||
| 1 | Include date in message? | Enable checkbox to Include date in message |
| 2 | Only send comment in mail body? | Enable to Only send comment in mail body. |
| 3 | Use HTML in mail body | Enable to Use HTML in mail body |
| 4 | Encoding | Select encoding type |
| 5 | Manage Priority | Enable to manage priority. Note: The support of this flag is depending on the mail server. - Priority - Importance - Sensitivity |
| 6 | Subject | Enter the subject of the mail into this field. |
| 7 | Comment | Enter the comment within the body of the mail into this field. |
| Attached files Tab: | ||
| 1 | Attach files to message? | Enable to attach a file to your email message. 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. |
| 2 | 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: - General - Log - Error line - Error - Warning |
| 3 | Zip files to single archive? | Enable to have attachments archived in a zip file |
| 4 | Name of the zip archive | Define the filename of your zip archive |
| 5 | Filename | Name of a single image file to add. Note: This works only when Use HTML format is defined in the EMail Message tab. |
| 6 | Content ID | Automatically entered |
| 7 | 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 |
| 8 | 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 |