Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

Insert excerpt
_Banners
_Banners
nameactionflow
nopaneltrue

Email Endpoints are available in PhixFlow version 11.3+

What is an Email Endpoint?

Insert excerpt
Email Endpoint Properties
Email Endpoint Properties
nameOverview
nopaneltrue

How does an Email Endpoint work?

  1. An An Email Account (s) 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
        nopaneltrue
  2. To save the emails, a
    Insert excerpt
    _tables
    _tables
    nopaneltrue
    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
    nopaneltrue
    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
    nopaneltrue
    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 separate record

Creating an Email Endpoint

Email endpoints must be made using the specific option on the 

Insert excerpt
_actionflow
_actionflow
nopaneltrue
 homepage to ensure the set of predefined input parameters are configured on the 
Insert excerpt
_input
_input
nameicon
nopaneltrue
incoming connection point.

  1. Create a new
    Insert excerpt
    _email_endpoint
    _email_endpoint
    nopaneltrue
     on the 
    Insert excerpt
    _actionflow
    _actionflow
    nopaneltrue
    homepage using the  option
  2. Set a unique name and provide a useful description
  3. Additional attributes can be added to the 
    Insert excerpt
    _input
    _input
    nameicon
    nopaneltrue
    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
    nopaneltrue
    , see Save Action Configuration
    1. If saving any of the attributes with a Type of Structured Data, a 
      Insert excerpt
      _action_calculate
      _action_calculate
      nopaneltrue
      action can be used between the
      Insert excerpt
      _input
      _input
      nopaneltrue
      and 
      Insert excerpt
      _action_save
      _action_save
      nopaneltrue
      action to convert these incoming values into a format that can be saved by PhixFlow
      1. For each attribute, use the listToString function
Note

Email Endpoints cannot contain 

Insert excerpt
_action_screen
_action_screen
nopaneltrue
actions, output connection points, lookups or phases.

Saving Attachments

Attachments can be saved in a separate 

Insert excerpt
_tableFile
_tableFile
nopaneltrue
.

  1. On the Email Endpoint, click
    Insert excerpt
    _property_settings
    _property_settings
    nopaneltrue
    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
      Insert excerpt
      _tableFile
      _tableFile
      nopaneltrue
      can be created by clicking the
      Insert excerpt
      _add_icon
      _add_icon
      nopaneltrue
       icon or choose an existing table using the
      Insert excerpt
      _tableFile
      _tableFile
      nameicon
      nopaneltrue
      icon or selecting from the drop down list
      .
      1. When creating a File Table to save attachments to, a folderId attribute is automatically created
Note

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

Insert excerpt
_tableFile
_tableFile
nopaneltrue
.

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

Insert excerpt
_tableFile
_tableFile
nopaneltrue
s 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
      Insert excerpt
      _tables
      _tables
      nopaneltrue
       where the email records are saved for each email received
    • value will generate for the folderId attribute on the
      Insert excerpt
      _tableFile
      _tableFile
      nopaneltrue
       where the email attachments are saved for each email received

Displaying Emails

HTML Comment
hiddentrue
  • A grid view is created backed by the correspondence table. This includes the summary, date and a count of the records in myFiles by using the collectionId relationship.

  • Double clicking on the grid opens a view screen.

    • The body of the email is shown in an html editor

    • A view backed by the correspondence record adds columns from myFiles via the relationship, this includes the name, size and preview image

    • A gallery is included in edit mode. It is backed by the correspondence.collectionId.

      • Dropping new files on the gallery will upload the files and create a new myFiles entry using the same collectionId.

      • Deleting entries in the gallery will remove the colllectionId value from the filetable record.

      • If all the files are removed the corrsespondence.collectionId value is cleared when the record is saved.

Emails can be displayed using a

Insert excerpt
_grid
_grid
nopaneltrue
view.  

Worked Example

Coming Soon.

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

Insert excerpt
_chat_bot
_chat_bot
nopaneltrue
 ChatBot, available in Image Modified Design Mode from the system controls in the top right of PhixFlow.