Email Endpoint Properties
- Zoe Baldwin
- Anthony George
Email Endpoints are available in PhixFlow version 11.3+
Email Endpoints
Email Endpoints are a type of Actionflow that run in response to an incoming email and can read data into tables. They include the ability to handle attachments and save these to a file table.
Worked Example
For an example of how to set up an Email Endpoint, see Setting up an Email Endpoint.
Properties Tab
Parent Details
The name of the container that this item is within or belongs to, if applicable. See Parent Details on Common Properties.
Basic Settings
| Field | Description |
|---|---|
| Name | The name of the Email Endpoint. |
Actionflow Icon | A custom icon for the Email Endpoint. Upload a new icon by clicking the |
| Save Attachments to | The location where email attachments are saved to. If no location is specified, attachments will not be saved. Create a new |
Actions
Displays the action nodes in the Email Endpoint, e.g. 
Save.
Input Connections
Displays the input connection points coming into the Email Endpoint, and their Type. See Understanding Connection Points. Double-click a connection point to view and create Input Parameters.
Email Endpoints contain a number of preconfigured input parameters, e.g. to, subject, from, bcc, body, etc. Note: Some of these parameters are of Type, Structured Data, e.g. to, from.
Additional attributes can be added which will obtain the value from a header with the same name on the incoming email(s). Note: Any '-' characters are removed from the name and the names are case insensitive.
Use the Log File Retention Settings to decide how log files are treated. Note: Whilst actions are running the entire log file is available, but when the action completes, the log file is deleted or retained depending on the below settings. Log files are automatically deleted upon completion, unless a warning or error message was written to the log. Log files are automatically deleted upon completion, unless an error message was written to the log. Log files are automatically deleted upon completion, unless an info, warning or error message was written to the log. Log files are automatically deleted upon completion, unless a warning or error message was written to the log. Log files are automatically deleted upon completion, unless an error message was written to the log.Log File Retention Settings
System Messages
Field Description Always Retain Log files are never deleted upon completion. Retain if Warning or Error message received Retain if Error message received Never retain Log files are always deleted upon completion. User Messages
Field Description Always Retain Log files are never deleted upon completion. Retain if Info, Warning or Error message received Retain if Warning or Error message received Retain if Error message received Never retain Log files are always deleted upon completion.
Advanced
| Field | Description |
|---|---|
| Prioritise throughput over ordering | When enabled, records are processed in parallel to optimise performance. This means the order records are processed is nondeterministic. When disabled (default), records are processed in the order they are provided. |
Exclusion Group | This field is case insensitive. If this field is populated, only one Actionflow/Endpoint with this Exclusion Group can be running at any one time. Attempting to run a second Actionflow/Endpoint with the same exclusion group will return a warning and the Actionflow will not run. This applies whether the Actionflow is run manually or automatically using a schedule. Exclusion Group are evaluated before any Actionflow/Endpoints are started. If there is no Actionflow/Endpoint already running with this exclusion group then the Actionflow/Endpoint will continue. The action will be considered to be using this exclusion group from this point until the Actionflow/Endpoint has completed. |
Description
| Field | Description |
|---|---|
| Description | A short explanation of the Endpoint's purpose. |
Security
Security can be applied to Actionflows so that only those with sufficient permissions can run the Actionflow. In addition, if an Actionflow is assigned to a button and the user does not have permission to run the Actionflow, the button will not be displayed on a screen. Permissions can also be set on form fields, table attributes and screens. For example, if a user does not have permission to view the form fields but runs an Actionflow that uses these fields, the Actionflow will show an error.
See the Common Properties page, Audit Summary section.
Audit TabAudit Summary