Description:
Send an email to a selected number of users.
Inputs
- replyTo – reply to email address
- fromEmail – from email address
- emailTo – select users to send emails to
- emailToRoles - select roles to send emails to
- emailAddresses – external email addresses
- subject – subject of the email
- body – body of the email
- cc – carbon copy list of email addresses
- bcc – blink carbon copy list of email addresses
- fileList – list of file attachments
- sendUsingQueue – sends the email message using the email queue
- priority - set priority
- encryptBody - encrypt and store in queue
Returns
- True – email sent successfully
- False – failed to send the email
Usage:
FlowWright must be configured with the SMTP email server information to use this step. To do this, you must navigate to the Status - Status - Settings - Email menu option as below.
The Email Settings page is rendered as below. You must set the SMTP host, port, user, and password configuration here. Click on the Save button to confirm.
NOTE: The Email Trigger Service engine should be running to use the Email Queue feature for the process steps like RouteTo, Task, and Email steps.
Example:
Let’s build and execute the “emailDef” example.
- Create a new definition called “emailDef”
- Select the definition and click the “design” button
- Drag an “email” step from the toolbox
- Connect the dots between the Start and “email” step
- Click the "email" step to configure its "Required" properties. Provide a name to the step. Provide the Word document file path on the app server. Provide the variable/global reference to store the output file path. Click the Save button to confirm.
- Click the "email" step to configure its "Optional" properties. Provide the reply to the email address. Provide from an email address or use the default email address configured in app settings. Click on the button to select the users to whom to send emails. Click on the button to choose application roles to send emails to. Provide a list of external email addresses (separated by semi-colon). Provide the subject text for the message. Click on the button to provide email context information.
- Click on the button to select users to whom you want to send emails. You can also search for and add users to the list.
- Click on the button to select the application roles you want to email. You can also search for and add roles to the list.
- Click on the button to provide email context information.
- Click the "email" step to configure its "Optional" properties. Provide the CC email addresses (separated by semi-colon). Provide the BCC email addresses (separated by semi-colon). Click on the button to add file attachments on the application server. Select if an email queue is required to send an email. Select the priority value from the drop-down list. Select ON to enable the message encryption.
- Click on the button to add file attachments to the application server. Then, provide the file path on the server.
- The “Logging” setting is necessary for documentation and measures workflow progress and the percent complete. As shown in the images below, this is achieved by configuring the step state and percent fields individually. Configure the “Logging” using the following properties. The "Send Test Mail" feature is provided to send a test email with the contents configured in the body to the current (logged-in) user.
- Save the process definition, create a process instance, and execute. The step should send an email to the selected users and require the FlowWright Email service to run. To check on email delivery, navigate to Status—Email Queue.
Definition Sample:
You may download the sample definition(s) from the link here and later import it (drag-drop) to your FlowWright Process Definition (XML file) or Form Definition (HTML file) page.
NOTE: Please verify and complete the process steps for any missing configurations, such as file path references and database connections after import. Then, save the definition to confirm the changes.
Click here to download the sample file.