Email Endpoints are available in PhixFlow version 11.3+

What is an Email Endpoint?

How does an Email Endpoint work?

1. An Email Account must be set up in your application to receive incoming emails. See Email Account Integrationfor an example.
   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

         Insert excerpt
         _email_endpoint _email_endpoint nopanel true

2. To save the emails, a

   Insert excerpt
   _tables _tables nopanel true

   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

   Insert excerpt
   _tableFile _tableFile nopanel true

   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

   Insert excerpt
   _email_endpoint _email_endpoint nopanel true

   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 separate record

Creating an Email Endpoint

Email endpoints must be made using the specific option on the 

1. Create a new

   Insert excerpt
   _email_endpoint _email_endpoint nopanel true

    on the 

   Insert excerpt
   _actionflow _actionflow nopanel true

   homepage using the  option
   1. 
2. Set a unique name and provide a useful descriptionThe Email Endpoint
3. Additional attributes can be added to the 

   Insert excerpt
   _input _input name icon nopanel true

   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 
4. Configure the endpoint to perform the required tasks on receiving of incoming emails, for example, save all records to a 

   Insert excerpt
   _tables _tables nopanel true

   , see Save Action Configuration
   1. If saving any of the attributes with a Type of Structured Data, a 

      Insert excerpt
      _action_calculate _action_calculate nopanel true

      action can be used between the

      Insert excerpt
      _input _input nopanel true

      and 

      Insert excerpt
      _action_save _action_save nopanel true

      action to convert these incoming values into a format that can be saved by PhixFlow
      1. For each attribute, use the listToString function

Saving Attachments

Attachments can be saved in a separate 

1. On the Email Endpoint, click

   Insert excerpt
   _property_settings _property_settings nopanel true

   will open in the toolbar to open the settings on the right - for
   1. For the full Properties list,
   see 
   1. see Email Endpoint Properties
   Configure the endpoint to perform the required tasks, for example return all company data , or pass in a date and return all companies onboarded after this date

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

      Insert excerpt
      _tableFile _tableFile nopanel true

      can be created by clicking the

      Insert excerpt
      _add_icon _add_icon nopanel true

       icon or choose an existing table using the

      Insert excerpt
      _tableFile _tableFile name icon nopanel true

      icon or selecting from the drop down list.
      1. When creating a File Table to save attachments to, a folderId attribute is automatically created

Linking Emails and Attachments

The folderId attribute that is automatically created on new

• After receiving an incoming email with attachments:
  • A value will generate for the folderId attribute on the

    Insert excerpt
    _tables _tables nopanel true

     where the email records are saved for each email received
  • A value will generate for the folderId attribute on the

    Insert excerpt
    _tableFile _tableFile nopanel true

     where the email attachments are saved for each email received

Displaying Emails

Emails can be displayed using a

Worked Example

Coming Soon.

If you require further support on this topic, please contact PhixFlow Support via the 

available in Image Modified Design Mode from the system controls in the top right of PhixFlow.