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 Email Account(s) must be set up in your application to receive incoming emails
    1. The email account setup should be:
      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. If the emails are to be saved, a 
    Insert excerpt
    _tables
    _tables
    nopaneltrue
    must be created with appropriate attributes for the incoming emails, e.g. id, from, to, cc, subject, body, folderId
  3. To allow PhixFlow to save attachments, a
    Insert excerpt
    _tableFile
    _tableFile
    nameicon
    nopaneltrue
    must be created
    1. The above Table and File Table must be related, see Relationship
  4. Upon receiving an email, the
    Insert excerpt
    _email_endpoint
    _email_endpoint
    nopaneltrue
    will run and perform the action(s) as specified with 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 

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 descriptionThe Email Endpoint
  3. 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
    1. Note: Email Endpoints cannot contain 
      Insert excerpt
      _action_screen
      _action_screen
      nopaneltrue
      actions

Saving Attachments

Attachments can be saved in a seperate

Insert excerpt
_tableFile
_tableFile
nameicon
nopaneltrue
.

  1. Click 
    Insert excerpt
    _property_settings
    _property_settings
    nopaneltrue
    will open in the Actionflow toolbar to open the settings for the Email Endpoint 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 

    Insert excerpt
    _tableFile
    _tableFile
    nopaneltrue
    that incoming email attachments should be saved to

    1. Create a new
      Insert excerpt
      _tableFile
      _tableFile
      nopaneltrue
      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
      .
    2. When creating a
      Insert excerpt
      _tableFile
      _tableFile
      nopaneltrue
      to save attachments to, a folderId attribute is automatically created
      1. This attribute will also populate on the
        Insert excerpt
        _tables
        _tables
        nopaneltrue
         where the email records are saved to for each email received and is used to link the attachment(s) saved in the
        Insert excerpt
        _tableFile
        _tableFile
        nopaneltrue
        to the email fields (e.g. id, from, to, cc, subject, body, folderId) saved in the
        Insert excerpt
        _tables
        _tables
        nopaneltrue


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.

Displaying Emails

File Display

File Gallery Display


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.