Versions Compared

Key

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

...

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

...

FieldDescription
HostThe host address of the configured email account.
PortThe port number of the configured email account.
ProtocolThe protocol used during the email fetching. (Visible only if this is an inbound account)
UsernameThe username used to log in onto the configured email account.
PasswordThe password used to log in onto the configured email account.
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)

(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)

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)
PropertiesThe 'key=value' list of the configured email account properties. Each pair should appear on a new line.
Test EmailTo:The address to which the test email emails will be sent to. (Visible only if this is an outbound account)
Delete Read MessagesThe flag which indicates if emails should If checked, emails will be deleted from the mailbox after fetchingmail server after they are downloaded.
After ... DaysThe number of days after which emails will be deleted (Visible only if If Delete Read Messages is ticked)checked, messages are delete from the server after this many days. If left empty or set to 0 email will be messages are deleted immediately .after they are downloaded
OutboundThe flag which indicates if the account is an outbound or inbound account.EnabledThe flag which indicates if the system should fetch email from the account

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.

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

...