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
→ 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.

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.

Once you have set up an account, use the toolbar

Test Configuration button to check you have configured the email account correctly.

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

Basic Settings

Field	Description

Field	Description
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. to set this as an inbound account, used to receive (download) emails.
Enabled	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	to allow this email account to be updated or deleted by import from another PhixFlow instance. 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.
Name	Enter the name of the configured email account.
Host	Enter the host address of the configured email account.
Protocol	Available for inbound accounts (Outbound is not selected). Select the protocol used during the email fetching
Encryption	Select the encryption used during the sending or receiving of emails.
Use Default Port	to automatically calculate the port from the protocol and encryption type.
Default Port	Enter 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 Name 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.
Login	Available when Authorisation Type is Local. 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.
Password Key	Available when Authorisation Type is External. Enter the alias that identifies the password in the keystore.
Folder	Available for inbound accounts (Outbound is not selected). Enter the folder which the emails will be fetched from. If left blank, the default inbox folder will be used. Collected emails are 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.
Properties	Enter the '`key=value`' list of the configured email account properties. Each pair should appear on a new line.
Test To:	Available when Outbound is selected. Enter the address to which test emails will be sent.
Polling Interval (s)	Available for inbound accounts (Outbound is not selected). 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.
Delete Read Messages	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	to output email debug messages to the log files.

Search
Search all help pages

Sections on this page