Versions Compared

Key

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

The Email Account properties contains the 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.This page covers, in detail, all configuration options. However, if

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.
  • System Email Address so PhixFlow can email system requests. For example, PhixFlow uses this address to send user password reset requests; see Password Reset.

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

If checked, this is If checked, this Email Account is If checked, the port will be calculated automatically The If checked, the email account requires a The If checked, emails will be deleted
FieldDescription
Outbound

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

If not checked, this in

Insert excerpt
_check_box_untick
_check_box_untick
nopaneltrue
 to set this as an inbound account,

and is

used to receive (download) emails.

Enabled

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

NameThe Enter the name of the configured email account.
HostThe Enter the host address of the configured email account.
ProtocolThe

Available for inbound accounts (Outbound is not selected).

Select the protocol used during the email fetching

. (Visible only if this is an inbound account)

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

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

(Visible only if not using the default port)

Authorisation Required

Insert excerpt
_check_box_ticked
_check_box_ticked
nopaneltrue
 to required username and password in order to send or receive emails from the email account.

Login NameThe

Available when Authorisation Required is selected.

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

(Visible only if authorisation is required)

Password

Available when Authorisation Required is selected.

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

 (Visible only if authorisation is required)
Folder

The

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. (Visible only if this is an inbound account)( 

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
and FolderName is
  • FolderName is a system generated folder for each new message
)
  • .
PropertiesThe Enter the 'key=value' list of the configured email account properties. Each pair should appear on a new line.
Test To:The

Available when Outbound is selected.

Enter the address to which test emails will be sent.

(Visible only if this is an outbound account)

Polling Interval (sec)The 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.

(Visible only if this is an inbound account)

Delete Read Messages

Insert excerpt
_check_box_ticked
_check_box_ticked
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 DaysIf

Available when Delete Read Messages is

checked, messages are delete

selected.

Enter the number of days for which messages are kept before they are deleted from the server

after this many days

. If left empty or set to 0 messages are deleted immediately after they are downloaded.

DebugIf checked, will

Insert excerpt
_check_box_ticked
_check_box_ticked
nopaneltrue
 to output email debug messages to the log files

.
Description
DescriptionDescription of the email account

The Image RemovedTest Configuration button allows the user to test if the provided email configuration is correct.

...

.