getEmailMsg Step
Description:
This step retrieves the email message info for an email stored from the email trigger.
Inputs
- msgIDVariable-Variable that holds the message ID
- varToStoreFromAddress– Variable to store the from email address.
- varToStoreToAddress- Variable to store the to email address
- varToStoreSubject- Variable to store the email subject
- varToStoreBody- Variable to store the email body
- varToStoreFileList- Variable to store the file lists
Returns
- True – step executed successfully
- False – step failed to execute
Usage:
This step is related to email triggers.
To create and manage triggers, navigate to Process > Triggers > Email.
Example:
Let’s build and execute the “getEmailMsgDef” example.
- Create a new process definition called “getEmailMsgDef” and open the definition in designer mode.
- Drag a “getEmailMsg” step to the canvas.
- Connect the dots between the Start and “getEmailMsg” steps, as shown above.
- Define a variable or a global to store the result.
- Click the "getEmailMsg" step to configure its "Required" properties. Provide a name for the step. Provide a variable or a global reference to store the email address, message body, and attachments. Click the Save button. Note: Click the "AI Predict" button for the Copilot to add new process steps that match your process description.
- The “Logging” setting configuration is necessary for documentation and also measures the workflow progress and the percent complete. This is achieved by configuring the step state and percent fields individually, as shown below. Configure the “Logging” using the following properties.
- Save the process definition, create a new instance, and then execute it. Render the process instance. Click the process step to view the properties. The step should get the email information for the email stored from the email trigger.
Definition Sample:
You may download the sample definition(s) from the link here and later import them (drag-and-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.