Attaching email info to a job - flow elements

Associating email information with jobs submitted to Switch is possible through the configuration of the relevant flow element properties. Not all flow elements support email information; only the ones that have properties related to email info. These properties must be configured appropriately as described further in this document.

Note: Remember that the (email) info attached to the job can be used by other flow elements that support variables.

The following table gives an overview of the flow elements that allow you to attach email info to the job's internal job ticket.

Flow element Properties
Mail receive (submitted jobs)
  • Attach email info: if enabled, the sender's email address (not the body text!) is copied to the job's metadata.
  • Attach extra email info: allows you to add extra email addresses or body text to the job's metadata. You can define different email info depending on who's the sender (email address or email account name), or what's in the message subject line. For example, you could attach mail X to jobs from customer X and mail Y to jobs from customer Y. How to do this is explained in Attaching email info - the email info map.
FTP receive (submitted jobs) Attach email info: allows you to associate email addresses and body text based on the name of the folder on the FTP server that holds the job. This is useful if the folder name reflects the type of job, or if it refers to the customer.
Submit hierarchy (submitted jobs) Attach email info: allows you to associate email addresses and body text based on the name of the folder the job resides in. This is useful if the folder name reflects the type of job, or if it refers to the customer.
Folder (submitted jobs + jobs moving along the flow)
  • Attach email addresses: allows you to add one or more email addresses.
  • Attach email body text: allows you to add an email message.

Note that here it is not possible to differentiate between jobs; all jobs will get associated with the same list of addresses and with the same body text.

Some use cases:
  • Accumulate an audit trail of status messages in the email body text as a job moves along a flow, and email the audit trail to a supervisor at the end of the flow.

  • Associate a different email address with a job depending on its status in the flow (e.g. passed preflight test or not).

  • Sort jobs based on filename (or any other criteria) and then associate a different email address with a job depending in how it was sorted.

Job Dismantler (jobs moving along the flow) Attach email info: allows you to associate email addresses and body text based on the folder name the job belongs to. This is useful if the folder name reflects the type of job, or if it refers to the customer.

Flow elements that become available if you have licensed the SwitchClient Module also allow attaching email info, as shown in the table below. For more info, refer to the SwitchClient Module.

Flow element Properties
Submit point
  • Attach user as email info: allows you to add the email address of the user that submits the job to Switch.
  • Attach extra email info: allows you to add extra email information. The information added can vary depending on the user submitting the job.
Checkpoint Attach user as email info: allows you to add the email address of the user that handles the job.