Versions Compared

Version Old Version 31 New Version 32
Changes made by

Fiona Sargeant

Fiona Sargeant

Saved on

Key

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

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.

...

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

Properties

Insert excerpt
_standard_settings
_standard_settings
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.

...

FieldDescription
Outbound

Insert excerpt
_check_box_tick
_check_box_tick
nopaneltrue
 to set this as an outbound email account, used to send emails. There can only be one active outbound account at any one time.

Insert excerpt
_check_box_untick
_check_box_untick
nopaneltrue
 to set this as an inbound account, used to receive (download) emails.

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 On 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
titleMore ...

Insert excerpt
_protect_import
_protect_import
nopaneltrue


NameEnter the name of the configured email account.
HostEnter 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

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 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 Name

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.

Insert excerpt
_keystore
_keystore
nopaneltrue
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. 

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 Outbound is selected.

Enter the address to which test emails will be sent.

Polling Interval (sec)

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

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.

...