| Insert excerpt | ||||||||
|---|---|---|---|---|---|---|---|---|
|
Email Endpoints Properties
| Excerpt | ||
|---|---|---|
| ||
|
|
Worked Example
For an example of how to set up an Email Endpoint, see Setting up an API Email Endpoint.
| Insert excerpt | ||||||
|---|---|---|---|---|---|---|
|
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 API Email Endpoint. | ||||||||
Actionflow Icon | A custom icon for the API Email Endpoint. Upload a new icon by clicking the | ||||||||
| URL Alias | When set, instead of the URL (below) being constructed using the API Endpoint name and application name, it will use the alias instead. | ||||||||
URL | This field is read only. Displays the URL for the API that is used to call it. If URL Alias (above) is populated, this URL will change accordingly and any special characters will be translated, such as, spaces to their URL encoded form (%20). | ||||||||
API Mode | Choose if the API Endpoint should:
| Allow Anonymous Connections | |||||||
| Insert excerpt | Setting up an API Endpoint | Setting up an API Endpoint | |||||||
| name | AllowAnonymousConnections | ||||||||
| nopanel | true | ||||||||
| Timeout | Optional. Specify a maximum time in milliseconds that the API will wait for. When set, this value will override the default timeout, which is 60 seconds where API Mode is Synchronous and 500 milliseconds where API Mode is Asynchronous. However, if a timeout parameter has been provided in the URL calling this API, that will override both this Timeout value and the default value. |
Actions
Displays the actions in the API Endpoint, e.g. Calculate, View| 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.
| Insert excerpt | ||||||
|---|---|---|---|---|---|---|
|
Input Connections
Displays the input connection points coming into the API Email Endpoint, and their Type. See See Understanding Connection Points.Double Double-click a connection point to view and create Input Parameters. See Setting up an API Endpoint.
Output Connections
Displays the output connection points going out of the API Endpoint, and their Type.
Logging Settings
Disabled by default.
When enabled, this creates a message in the System Console containing the HTTP Method (GET, POST, etc.), URL, client, headers and truncated request body.
This is useful for debugging and testing, and should be disabled once testing is completed.
Disabled by default.
When enabled, this creates a message in the System Console containing the status code, status message, response headers and truncated response body.
This is useful for debugging and testing, and should be disabled once testing is completed.
Preconfigured Input Parameters
Email Endpoints contain a number of preconfigured input parameters, e.g. to, subject, from, bcc, body, etc. Each has a set Data Type.
In PhixFlow 12.1+, Input Parameters with the Data Type of Structured Data (e.g. to, from) can be changed to String by double-clicking the attribute and choosing a new Data Type from the drop down menu.
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.
Email Accounts
Displays the
that are being monitored by the Email Endpoint.Insert excerpt _emailConfiguration _emailConfiguration name accounts nopanel true
| Insert excerpt | ||||||||
|---|---|---|---|---|---|---|---|---|
|
Advanced
| Field | Description | ||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|
| Prioritise throughput over ordering |
| ||||||||||
Exclusion Group | This field is case insensitive. If this field is populated, only one Actionflow/API Endpoint with this Exclusion Group can be running at any one time. Attempting to run a second Actionflowsecond Actionflow/API 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/API Endpoints are started. If there is no Actionflowno Actionflow/API Endpoint already running with this exclusion group then the Actionflowthe Actionflow/API Endpoint will continue. The action will be considered to be using this exclusion group from this point until the Actionflowthe Actionflow/API Endpoint has completed. |
Description
| Field | Description |
|---|---|
| Description | A short explanation of the API Endpoint's purpose. |
| Insert excerpt | ||||||
|---|---|---|---|---|---|---|
|
| Insert excerpt | ||||||||
|---|---|---|---|---|---|---|---|---|
|
| Insert excerpt | ||||||
|---|---|---|---|---|---|---|
|
| title | Packages |
|---|