Skip to end of metadata
Go to start of metadata

You are viewing an old version of this page. View the current version.

Compare with Current View Page History

« Previous Version 5 Next »

Email Endpoints are available in PhixFlow version 11.3+

What is an Email Endpoint?

  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. 

How does an Email Endpoint work?

  1. An Email Account(s) must be set up in your application to receive incoming emails
    1. The email account setup must include:
      1. Type: choose Inbound
      2. On Email Received: choose Trigger an email endpoint actionflow
      3. Email Endpoint Action: choose your   Email Endpoint
  2. To save the emails, a  Table must be created with appropriate attributes for the headers on the incoming emails, e.g. id, from, to, cc, subject, body, folderId
  3. To allow PhixFlow to save attachments, a  File Table must be created
  4. The above Table and File Table must have a relation on an ERD, see Relationship
  5. Upon receiving an email, the   Email Endpoint 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 table 
    1. If saving to a table, each received email saves as a seperate record

Creating an Email Endpoint

Email endpoints must be made using the specific option on the  Actionflow homepage to ensure the set of predefined input parameters are configured on the  incoming connection point.

  1. Create a new   Email Endpoint on the  Actionflow homepage using the  option
  2. Set a unique name and provide a useful description
  3. Configure the endpoint to perform the required tasks on receiving of incoming emails, for example, save all records to a  Table, see Save Action Configuration
    1. 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) 
      1. Note: Any '-' characters are removed from the name and the names are case insensitive 

Email Endpoints cannot contain  Open Screen actions, output connection points, lookups or phases.

Saving Attachments

Attachments can be saved in a separate   File Table.

  1. On the Email Endpoint, click  Properties in the toolbar to open the settings on the right
    1. For the full Properties list, see Email Endpoint Properties
  2. In the Basic Settings, in the Save Attachments to field, set the File Table that incoming email attachments should be saved to

    1. A new  File Table can be created by clicking the  icon or choose an existing table using the icon or selecting from the drop down list.
      1. When creating a File Table to save attachments to, a folderId attribute is automatically created

If the Email Endpoint fails, any incoming attachments will still be saved to the specified  File Table.

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  File Tables is used to link an email to its attachments.

  • After receiving an incoming email with attachments:
    • A value will generate for the folderId attribute on the  Table where the email records are saved for each email received
    • value will generate for the folderId attribute on the  File Table where the email attachments are saved for each email received

Displaying Emails

Emails can be displayed using a  Grid view.  

Worked Example

Coming Soon.

If you require further support on this topic, please contact PhixFlow Support via the  ChatBot, available in  Design Mode from the system controls in the top right of PhixFlow.


  • No labels