Versions Compared

Version Old Version 37 New Version 38
Changes made by

Zoe Baldwin

Zoe Baldwin

Saved on

Key

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

Insert excerpt
_Banners
_Banners
nameadministration
nopaneltrue

This page is for administrators who are creating system and user email accounts. It explains the email configuration that PhixFlow uses when fetching and sending emails.

Overview

When setting up users, you must also configure Email Accounts so that users can send and/or receive emails.

We also recommend you use the System Configuration options to configure the following emails to go to your support or administration team.

  • a Feedback Email Address so users can email any issues via the 
    Insert excerpt
    _administration
    _administration
    nopaneltrue
    → Support Menu → Email Support menu option.
  • an Error Reporting Email Address so users can email error logs via the Report button in a system error message; see Error Messages.

  • a System Email Address so PhixFlow can email system requests. For example, PhixFlow uses this address to send user password reset requests; see Changing or Resetting Your Password.

    Note

    It is important to set a system email address as the registered owner of the email account. This is because some email services reject emails that are not from the registered owner of the email account. 


If you are setting up a service to poll an email account for incoming messages, we recommend you read the article Reading Data From an Email Account, which covers a number of common examples.

If PhixFlow cannot connect to the email server, it will time-out the sending of email after 10 seconds.


Insert excerpt
_property_tabs
_property_tabs
namebasic-h
nopaneltrue

Insert excerpt
_property_toolbar
_property_toolbar
nopaneltrue

Once you have set up an account, use the toolbar Image ModifiedTest Configuration button to check you have configured the email account correctly.

Note

PhixFlow tests the values currently appearing on the screen. Remember to save the configuration after the test is successful.

Basic Settings

FieldDescription
NameEnter the name of the configured email account.
Enabled

Insert excerpt
_check_box_tick
_check_box_tick
nopaneltrue
 to make this email account active.

If this is an outbound account, it will be used to send emails whenever required.

If this is an inbound account, PhixFlow will connect to the server periodically (at the defined polling interval) and download new messages.


Protect During Import

Insert excerpt
_check_box_untick
_check_box_untick
nopaneltrue
 to allow this email account to be updated or deleted by import from another PhixFlow instance.

Insert excerpt
_check_box_tick
_check_box_tick
nopaneltrue
 to retain the email account settings if this email account is imported from another PhixFlow instance. Also to prevent this email account being deleted during import.

Expand

Insert excerpt
_protect_import
_protect_import
nopaneltrue


Type

Select Outbound to set this as an outbound email account, used to send emails. There can only be one active outbound account at any one time.

Select Inbound to set this as an inbound account, used to receive (download) emails.

HostEnter the host address of the configured email account.
Protocol

Available when Type is Inbound.

Select the protocol used during the email fetching

EncryptionSelect the encryption used during the sending or receiving of emails.
Use Default Port

Insert excerpt
_check_box_tick
_check_box_tick
nopaneltrue
 to automatically calculate the port from the protocol and encryption type.

Default PortEnter the default port number.
Port

Available when Use Default Port is not selected.

Enter the port number of the configured email account. 

Authorisation Type

Select:

  • No Authorisation: no user credentials will be provided.
  • Local: to provide user credentials from PhixFlow. When you select this option, the Login and Password properties are available.
  • External: to provide user credentials from the secure keystore. When you select this option, the Username Key and Password Key properties are available.
    Use this option for greater security.
  • OAuth 2: access using a client token. When you select this option, the Login, Client Token Configuration, Client Token Instance and Status properties are available.
Login

Available when Authorisation Type is Local or OAuth2.

Enter the username used to log in onto the configured email account. 

Password

Available when Authorisation Type is Local.

Enter the password used to log in onto the configured email account.

Username Key

Available when Authorisation Type is External.

Enter the aliasthat identifies the username in the keystore.

Insert excerpt
_keystore
_keystore
nopaneltrue
Password Key

Available when Authorisation Type is External.

Enter the alias that identifies the password in the keystore.

On Email Received (PhixFlow version 11.3+)

Available when Type is Inbound.

Choose from:

  • Hold for collection via file collector: the email is processed by a
    Insert excerpt
    _file_collector
    _file_collector
    nopaneltrue
     in an Analysis model
  • Trigger an email endpoint actionflow: the email is processed by an 
    Insert excerpt
    _email_endpoint
    _email_endpoint
    nopaneltrue
Client Token Configuration

Available when Authorisation Type is OAuth2.

Select an client token to use for OAuth2 authorisation from the dropdown menu or create one from the application repository.

Client Token  Instance

Available when Authorisation Type is OAuth2.

This field is read-only.

Status

Available when Authorisation Type is OAuth2.

This field is read-only. Select the 

Insert excerpt
_emailConfiguration
_emailConfiguration
nameicon
nopaneltrue
button to authenticate the email account.

Folder

Available when Type is Inbound.

Enter the folder which the emails will be fetched from. If left blank, the default inbox folder will be used. 

Collectedemailsare saved to FileUploadDirectory\default\in\YYYYMMDD\FolderName, where:

  • FileUploadDirectory is the value specified in System Configuration Screen
  • YYYYMMDD is a folder created by the system for each day
  • FolderName is a system generated folder for each new message.
PropertiesEnter the 'key=value' list of the configured email account properties. Each pair should appear on a new line.
Test To:

Available when Type is Outbound.

Enter the address to which test emails will be sent.

Polling Interval (s)

Available when Type is Inbound.

Enter the interval, in seconds, of the email fetching from the account. If left blank, the value configured in the server.properties file will be used.

Maximum emails fetched in one batch

Available when Type is Inbound.

Set a maximum number of emails to be retrieved at one time.

Delete Read Messages

Insert excerpt
_check_box_tick
_check_box_tick
nopaneltrue
 to delete emails from the mail server

  • either immediately after they are downloaded
  • or after a period of time, set in Delete After Days.
Delete After Days

Available when Delete Read Messages is selected.

Enter the number of days for which messages are kept before they are deleted from the server. If left empty or set to 0 messages are deleted immediately after they are downloaded.

Debug

Insert excerpt
_check_box_tick
_check_box_tick
nopaneltrue
 to output email debug messages to the log files.

Insert excerpt
_description
_description
nopaneltrue

Insert excerpt
_audit
_audit
nopaneltrue

Further Reading

Email Account Integration


Live Search
spaceKey@self
additionalnone
placeholderSearch all help pages
typepage

Panel
borderColor#00374F
titleColorwhite
titleBGColor#00374F
borderStylesolid
titleSections on this page

Table of Contents
maxLevel3
indent12px
stylenone