Mail send is a processor (although conceptually it is a consumer) that sends an e-mail message to an SMTP e-mail relay server for each incoming job.
Some properties for this tool (such as the SMTP server details) must be set up in the global user preferences, since these values are the same for all outgoing email. For more information, refer to Switch preferences: Mail send.
If you enter one of the following keywords in the Search field at the top of the Flow elements pane, the Mail send element will be shown in the list:
Mail send supports optional outgoing connections to provide in-flow feedback about the operation and to keep the job around without extra copying. This allows multiple send operations to be chained in an intelligent manner; for example:
Successively mail and FTP the same job.
Provide a fallback operation when a mail operation fails.
Mail send supports traffic-light connections of the following types (other types are not allowed):
Data error: carries the incoming job if the operation fails at the first attempt; if there are no data error connections the tool keeps retrying the operation as specified in the user preferences.
Data success: carries the incoming job after the operation succeeds; if there are no data success connections the output is simply suppressed (without logging a warning or error).
Log success: carries a small log file in XML format after the operation succeeds; if there are no log success connections the output is simply suppressed. The log file contains relevant information about the operation such as destination, time sent, transfer time, list of files, etc. See Processing results schema.
Data with log success: carries both the job and the log file (as metadata in a dataset), allowing access to the results of the operation through variables or scripting.
|
Property |
Description |
|---|---|
|
Name |
The name of the flow element displayed in the canvas. |
Description |
A description of the flow element displayed in the canvas. This description is also shown in the tooltip that appears when moving your cursor over the flow element. |
|
Subject |
The subject line for the message. |
|
To addresses |
The list of destination email addresses for the message. Email addresses are separated by a semicolon or by a newline. |
|
Include attached addresses |
If set to Yes, the email addresses from the job's internal job ticket are added to the To addresses. For more information about attached email info, refer to Using email info in Switch. |
|
CC addresses |
A comma/semicolon/newline separated list of carbon-copy email addresses for the message. |
|
BCC addresses |
A comma/semicolon/newline separated list of blind carbon-copy email addresses for the message. |
|
Reply address |
The email address to which a receiver of the message should send a reply. If the value is empty or Default, the sender address specified in the Switch preferences is used. See Switch preferences: Mail send. Note: The value of this property is used in the Reply-To
SMTP header that is normally used by email client applications to send a reply.
However, the From field of an email in the client
application does not display this address, instead it shows the sender address
specified in the Switch preferences. See Switch preferences: Mail send.
|
|
Message format |
The format of the message body, either Plain text or HTML. When set to HTML, the email message has two bodies. The first is in HTML format and the second is a plain text version of the HTML message. |
|
Body template |
The location of the template of the email body.
|
|
Attach files |
If set to Yes, the incoming file or job folder is compressed (zipped) and attached to the email message being sent. |
|
Strip unique name |
If set to Yes, the unique name prefix added to the filename by Switch is removed before emailing the job; the default is to strip the prefixes from jobs before emailing them This property affects both the actual attachments and the names of the jobs listed in the email body. |