Versions Compared

Key

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

Forms: Email Account

The Email Account is an object which contains a configuration which is used by the PhixFlow during fetching and sending emails.

This page covers, in detail, all configuration options. However, if you are setting up a service to poll an email account for incoming messages, a good starting place is the article How To: Read data from an email account, which covers a number of common examples.

Form: Email Account Details

The following fields are configured on the Details tab:

FieldDescription
Host The host address
Outbound

If checked, this is 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 an inbound account, and is used to receive (download) emails.

Enabled

If checked, this Email Account is 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 name of the configured email account
.
Port
HostThe
port number
host address of the configured email account.
ProtocolThe protocol used during the email fetching. (Visible only if this is an inbound account)
EncryptionThe encryption used during the sending or receiving of emails.
Use Default PortIf checked, the port will be calculated automatically from the protocol and encryption type.
PortThe port number of the configured email account
)Usernamesec) 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
(Visible only if not using the default port)
Authorisation RequiredIf checked, the email account requires a username and password in order to send or receive emails.
Login NameThe username used to log in onto the configured email account. (Visible only if authorisation is required)
PasswordThe password used to log in onto the configured email account. (Visible only if authorisation is required)
Folder

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)

Polling Interval (sec) The interval (

(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 a system generated folder for each new message)

PropertiesThe 'key=value' list of the configured email account properties. Each pair should appear on a new line.
Test
Email
To:The address to which
the
test
email
emails will be sent
to
. (Visible only if this is an outbound account)
Outbound The flag which indicates if the account is an outbound or inbound account. Enabled The flag which indicates if the system should fetch email from the account.

...

Polling Interval (sec)The interval (sec) 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 MessagesIf checked, emails will be deleted from the mail server after they are downloaded.
Delete After DaysIf Delete Read Messages is checked, messages are delete 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 output email debug to the log files.
Description
DescriptionDescription of the email account

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

Warning: The system will test values currently appearing on the screen. Remember to save the configuration after the test is successful.

The following field is configured on the Description tab:

...

Form Icons

The form provides the standard form icons.

See Also