PhixFlow Help
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 Reading Data From an Email Account, which covers a number of common examples.
The toolbar has the standard icons. For information about the sections Parent Details, Analysis Models, Description and Audit Summary, see Common Properties. For information about other property tabs, see Property Tabs.
The following fields are configured on the Details tab:
Field | Description |
---|---|
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. |
Name | The name of the configured email account |
Host | The host address of the configured email account. |
Protocol | The protocol used during the email fetching. (Visible only if this is an inbound account) |
Encryption | The encryption used during the sending or receiving of emails. |
Use Default Port | If checked, the port will be calculated automatically from the protocol and encryption type. |
Port | The port number of the configured email account. (Visible only if not using the default port) |
Authorisation Required | If checked, the email account requires a username and password in order to send or receive emails. |
Login Name | The username used to log in onto the configured email account. (Visible only if authorisation is required) |
Password | The 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) (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 and FolderName is a system generated folder for each new message) |
Properties | The 'key=value' list of the configured email account properties. Each pair should appear on a new line. |
Test To: | The address to which test emails will be sent. (Visible only if this is an outbound 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 Messages | If checked, emails will be deleted from the mail server after they are downloaded. |
Delete After Days | If 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 |
Debug | If checked, will output email debug to the log files. |
Description | |
Description | Description of the email account |
The Test Configuration button allows the user to test if the provided email configuration is correct.
The system will test values currently appearing on the screen. Remember to save the configuration after the test is successful.
Please let us know if we could improve this page feedback@phixflow.com