ProcessMaker API Documentation
Script Central

Send Email Connector

Automatically send emails during Requests for a Process.

Overview

The Send Email connector is part of the Email package. When you add the Send Email connector to your Process model and then reference a ProcessMaker Screen for email body content, ProcessMaker can send emails during Requests. The Send Email connector can email a specified email address when that Send Email connector triggers in a Request's workflow. The Send Email connector supports sending an email to only one email recipient.

ProcessMaker Package Required

The Send Email connector requires that the Send Email package be installed in your ProcessMaker instance. The Send Email connector and the Send Email package are not available in the ProcessMaker open-source edition. Contact ProcessMaker Sales or ask your ProcessMaker sales representative how the Send Email connector can be installed in your ProcessMaker instance.

The Send Email connector adds the following components to the ProcessMaker open-source edition:

The email recipient's name and email address can be specified in one of the following ways when configuring the Send Email connector:

  • Plain text

  • A Variable Name setting value using mustache syntax, for example {{ email_recipient }} and {{ email_address }}, respectively

  • A ProcessMaker Magic Variable value, specifically {{ _user.fullname }} and {{ _user.email }}, respectively

Add a Send Email Connector to the Process Model

ProcessMaker Package Required

The Send Email package is required. The Send Email package installs the Send Email connector, which is not available in the ProcessMaker open-source edition. Contact ProcessMaker Sales or ask your ProcessMaker sales representative how the Send Email connector can be installed in your ProcessMaker instance.

Permissions Required

Your ProcessMaker user account or group membership must have the following permissions to add a Send Email connector to the Process model unless your user account has the Make this user a Super Admin setting selected:

  • Processes: Edit Processes

  • Processes: View Processes

See the Process permissions or ask your ProcessMaker Administrator for assistance.

Follow these steps to add a Send Email connector to the Process model:

  1. View your Processes. The Processes page displays.

  2. Create a new Process or click the Open Modeler iconto edit the selected Process model. Process Modeler displays.

  3. Locate the Send Email connector in the Elements and Connectors palette that is to the left of the Process Modeler canvas. If the Hide Menus buttonis enabled, the Elements and Connectors palette displays the Send Email connector's icon.

  4. Drag the connector into the Process model canvas where you want to place it. If a Pool element is in your Process model, the Send Email connector cannot be placed outside of the Pool element.

Send Email connector

After adding the Data Connector connector, consider adding either of the following Boundary-type Process model elements to design business solutions when your best-case scenarios don't happen:

After the Send Email connector is placed into the Process model, you may move it by dragging it to the new location.

Moving a Send Email connector has the following limitations in regards to the following Process model elements:

  • Pool element: If the Send Email connector is inside of a Pool element, it cannot be moved outside of the Pool element. If you attempt to do so, Process Modeler places the Send Email connector inside the Pool element closest to where you attempt to move it.

  • Lane element: If the Send Email connector is inside of a Lane element, it can be moved to another Lane element in the same Pool element. However, the Send Email connector cannot be moved outside of the Pool element.

Settings

ProcessMaker Package Required

The Send Email package is required. The Send Email package installs the Send Email connector, which is not available in the ProcessMaker open-source edition. Contact ProcessMaker Sales or ask your ProcessMaker sales representative how the Send Email connector can be installed in your ProcessMaker instance.

Permissions Required

Your ProcessMaker user account or group membership must have the following permissions to configure a Send Email connector unless your user account has the Make this user a Super Admin setting selected:

  • Processes: Edit Processes

  • Processes: View Processes

See the Process permissions or ask your ProcessMaker Administrator for assistance.

Follow these steps to configure a Send Email connector:

  1. Ensure that the Hide Menus buttonis not enabled. See Maximize the Process Modeler Canvas View.

  2. Select the Send Email connector from the Process model in which to configure its settings. The Send Email configuration settings display.

  3. In the Email setting, enter the email address to which the Send Email connector sends an email when this Send Email control triggers. The Send Email connector only supports sending an email to one email recipient. You may use the value from a ProcessMaker Screen's Variable Name setting as a variable in this setting. For example, if your Process model references a ProcessMaker Screen that contains a Line Input control with the Variable Name setting value of EmailAddress that the Request participant enters an email address, use mustache syntax {{EmailAddress}} to use that Line Input control's value in the Email setting.

  4. In the Name setting, enter the name of the email recipient. You may use the value from a ProcessMaker Screen's Variable Name setting as a variable in this setting. For example, if your Process model references a ProcessMaker Screen that contains a Line Input control with the Variable Name setting value of FullName that the Request participant enters an name, use mustache syntax {{FullName}} to use that Line Inputs control's value in the Name setting.

  5. In the Subject setting, enter the subject of the email the Send Email connector sends.

  6. From the Email body drop-down menu, select which ProcessMaker Screen that Send Email connector references. This drop-down menu displays only Email-type ProcessMaker Screens so the email recipient can read the body of the email. Note that another Send Email connector located elsewhere in the Process model may reference a different ProcessMaker Screen to display a different email body when it triggers.

Related Topics