Versions Compared
Key
- This line was added.
- This line was removed.
- Formatting was changed.
Insert excerpt | ||||||||
---|---|---|---|---|---|---|---|---|
|
Email Endpoints are available in PhixFlow version 11.3+
What is an Email Endpoint?
Insert excerpt | ||||||||
---|---|---|---|---|---|---|---|---|
|
How does an Email Endpoint work?
- An An Email Account (s) must be set up in your application to receive incoming emails. See Email Account Integrationfor an example.
- The email account setup must include:
- Type: choose Inbound
- On Email Received: choose Trigger an email endpoint actionflow
- Email Endpoint Action: choose your
Insert excerpt _email_endpoint _email_endpoint nopanel true
- The email account setup must include:
- To save the emails, a
must be created with appropriate attributes for the headers on the incoming emails, e.g. id, from, to, cc, subject, body, folderIdInsert excerpt _tables _tables nopanel true - To allow PhixFlow to save attachments, a
must be createdInsert excerpt _tableFile _tableFile nopanel true - The above Table and File Table must have a relation on an ERD, see Relationship
- Upon receiving an email, the
will run and perform the action(s) as specified within the Email Endpoint Actionflow, such as saving each incoming email as a record in a tableInsert excerpt _email_endpoint _email_endpoint nopanel true - If saving to a table, each received email saves as a seperate separate record
Creating an Email Endpoint
Email endpoints must be made using the specific option on the
Insert excerpt | ||||||
---|---|---|---|---|---|---|
|
Insert excerpt | ||||||||
---|---|---|---|---|---|---|---|---|
|
- Create a new
on theInsert excerpt _email_endpoint _email_endpoint nopanel true
homepage using the optionInsert excerpt _actionflow _actionflow nopanel true - Set a unique name and provide a useful description
- Additional attributes can be added to the
connection point which will obtain the value from a header with the same name on the incoming email(s)Insert excerpt _input _input name icon nopanel true - Note: Any '-' characters are removed from the name and the names are case insensitive
- Configure the endpoint to perform the required tasks on receiving of incoming emails, for example, save all records to a
, see Save Action ConfigurationInsert excerpt _tables _tables nopanel true - If saving any of the attributes with a Type of Structured Data, a
action can be used between theInsert excerpt _action_calculate _action_calculate nopanel true
andInsert excerpt _input _input nopanel true
action to convert these incoming values into a format that can be saved by PhixFlowInsert excerpt _action_save _action_save nopanel true - For each attribute, use the listToString function
- If saving any of the attributes with a Type of Structured Data, a
Note | ||||||||
---|---|---|---|---|---|---|---|---|
Email Endpoints cannot contain
|
Saving Attachments
Attachments can be saved in a separate
. Insert excerpt _tableFile _tableFile nopanel true
- On the Email Endpoint, click
in the toolbar to open the settings on the rightInsert excerpt _property_settings _property_settings nopanel true - For the full Properties list, see Email Endpoint Properties
In the Basic Settings, in the Save Attachments to field, set the File Table that incoming email attachments should be saved to
- A new
can be created by clicking theInsert excerpt _tableFile _tableFile nopanel true
icon or choose an existing table using theInsert excerpt _add_icon _add_icon nopanel true
icon or selecting from the drop down list.Insert excerpt _tableFile _tableFile name icon nopanel true - When creating a File Table to save attachments to, a folderId attribute is automatically created
- A new
Note | ||||||||
---|---|---|---|---|---|---|---|---|
If the Email Endpoint fails, any incoming attachments will still be saved to the specified If no location is specified in the Save Attachments to field, attachments will not be saved. |
Linking Emails and Attachments
The folderId attribute that is automatically created on new
s is used to link an email to its attachments. Insert excerpt _tableFile _tableFile nopanel true
- After receiving an incoming email with attachments:
- A value will generate for the folderId attribute on the
where the email records are saved for each email receivedInsert excerpt _tables _tables nopanel true - A value will generate for the folderId attribute on the
where the email attachments are saved for each email receivedInsert excerpt _tableFile _tableFile nopanel true
- A value will generate for the folderId attribute on the
Displaying Emails
HTML Comment | ||
---|---|---|
| ||
|
Emails can be displayed using a
view. Insert excerpt _grid _grid nopanel true
Worked Example
Coming Soon.
If you require further support on this topic, please contact PhixFlow Support via the
ChatBot, available in Image Modified Design Mode from the system controls in the top right of PhixFlow. Insert excerpt _chat_bot _chat_bot nopanel true
On this page
Table of Contents | ||||
---|---|---|---|---|
|