The Send Email step sends an email notification to one or more recipients when the step is run. This step type can be used to notify Workflow Manager users or administrators when a workflow has been completed or when a step didn't complete successfully.
Note:
You must configure email settings for Workflow Manager before the Send Email step can be used to send email notifications.
Step configuration
Complete these steps to configure the Send Email step:
- Create or edit a workflow diagram to access the Step Library panel.
- Drag Send Email from the Step Library to a connection arrow of a step on the workflow canvas.
The Settings panel appears.
- Provide a name for the step in the Step Name text box.
- Optionally, provide a description for the step in the Step Description text box.
- Configure step options in the Options section as necessary.
- Automatically Executes—Runs the step as soon as it becomes active.
- Can Be Skipped—Allows the step to be finished without being run.
- In the Logic section, type one or more email addresses separated by a semicolon in the To text box.
- Type a subject for the email notification in the Subject text box.
You can also use ArcGIS Arcade expressions to provide a dynamic value for the subject. For example, jobName($job)+' is ready'.
- Type the message text for the email notification in the Body text box.
You can also use the following example to provide a dynamic value for the body using ArcGIS Arcade expressions:
'<b>'+jobName($job)+'</b>, created by <b>'+jobCreator($job)+'</b>, was closed on <b>'+Text(Date(jobEndDate($job)), 'dddd, MMMM D, Y')+'</b>.'Note:
You must enable the HTML Notification option to use HTML tags in the email body field.
- Optionally, if your workflow diagram includes the Add Attachment step, you can choose to include job attachments in the email notification using the following options under Include Attachments:
- None—Don't include job attachments in the email notification.
- All—Include all job attachment folders in the email notification.
- By Folder—Type a comma separated list of folder names in the By Folder text box to specify the job attachment folders to include in the email notification.
Note:
If a job contains multiple attachments, they are sent as a single ZIP file and the Add Attachment step's folder structure will be maintained.
- Optionally, click the Help tab and provide help text for the step in the Help text box.
- Optionally, click the Style tab to change the shape and color of the step.
Return codes
When the step finishes running, it sends a return code to indicate the result of the step. The return code is evaluated, and the workflow follows all paths that match the step's return value. The following is a list of return codes:
| Return code | Description |
|---|---|
| Failure | The step failed to complete successfully. |
| Success | The step completed successfully. |