Skip to main content
Skip table of contents


Connection Settings

Configure connection settings for IMAP server to download emails from.




The hostname or IP address of the IMAP server.


The port used for connecting to the IMAP server. The default port is 143 and is typically used for unsecure and Explicit SSL/TLS connections. Port 993 is typically used for Implicit SSL/TLS connections.

Security Type

The security type to use when connecting to the server.

The options are:

  • None

  • Explicit SSL/TLS (a.k.a Start TLS)

  • Implicit SSL/TLS

Authentication Type

Select an authentication type, default is Login.

The options are:

  • Login

  • OAuth

Login Authentication Settings




Login name to use when authenticating the user.


Password to use when authenticating with the IMAP server.

OAuth Authentication Settings



Grant Type

The OAuth grant type to use, default is Authorization Code.

The available options are:

  • Authorization Code

  • Client Credentials

  • Implicit

Authorization Code is recommended for EzeScan Desktop usage, and will require the user to sign-in via the web browser.

Client Credentials is recommended for EzeScan Server usage as it does not require user interaction to complete a sign-in.

Authorisation Endpoint

The authorisation endpoint of the authorisation server.

Not used for Client Credentials flow.

Token Endpoint

The token endpoint of the authorisation server.


Scopes to request from the authorisation server. Use a space to delimit scopes (e.g. offline_access).

Desktop Redirect URL

Redirect URI of the application registered in the authorisation server.

The redirect URL used for EzeScan Server is can be determined appending the suffix /api/integrations/oAuthCallback to the hosting address with suffix (for example, http://localhost:32392/api/integrations/oAuthCallback)

Client ID

Client ID of the client registered in the authorisation server.

Client Secret

Secret for the client registered in the authorisation server.


Username of the mailbox to download emails from.

Import Source Email Configuration

Functionality is added as Import Folder “Import Sources” as shown at right and is applicable to both an EzeScan Client and EzeScan Server configurations.

Import Document Settings

The Import Document Settings is the area related to the configuration the currently selected connector will use when downloading emails.

Values entered here will configure the methods of processing for downloading emails from an email server.


The IMAP mailbox folder to download emails from, default in Inbox.

Use the button […] to choose from the available mailbox folders.

Prompt for subfolder

Enable this setting for if there are subfolders under the mailbox to be processed. This will allow the operator to see the subfolder under the specified mailbox and choose one to import emails from.

Move to mailbox

Specify the mailbox folder to move the email to after processing, or leave blank to delete the email.

It is recommended to create a mailbox folder named Processed and then select it in this section. EzeScan will then move all processed emails to this mailbox from the selected inbox.

For testing purposes the Move To Folder value can be set as the same as the Mailbox import folder. The result will be the email remaining in the source mailbox folder.

Select emails to download

This will display a list of emails that reside in the mailbox and the operator can select which email to import.

Download attachments filter

Set this to either look for emails that have attachments configured in the import file types setting or sell to all for all attachment file types.

Email search filter

Optionally restrict email search using one of the following filters:

  • None

  • Has Attachments

  • No Attachments

Download Count Limit

Specify the number of emails to display/download, default is zero (0) for unlimited. If a number is set it will show the X number of oldest in that mailbox.

Document Basename

This allows the basename of the emails and attachments to be customised.

Where no Basename has been specified the default naming schema used is, Email_<<S3(YYYYMMDD)>>_<<S4(HHMMSS)>>

Available document basename placeholder options are:














<<NOW>> (Date & Time)

Create index from headers

This option will create an XML index file (in the specified import folder of the job) which will contain header information of the email.

These include:

  • From, To, CC, BCC, Reply Address, UID

  • Subject, Body

  • Date, Date Downloaded

The operator can use the optional licensed KFI module to extract this data for KFI field processing. Please refer to the “Entry in data file” feature in the Value Tab in the KFI User Guide.

Convert HTML body to XML

Convert HTML email body to XML when inserting into the XML index file

HTML tags to remove

Enter the name of the HTML tags to remove when converting the HTML body to XML

For example: “img;br;script” where each tag separated by a semi-colon.

Generate .eml file from email

When ticked this option tells EzeScan to download each individual email as an .eml file.

This will allow EzeScan to process both the body of the email as well as any attachment (rather than simply all attachments).

EzeScan uses the Email Render Profile to convert imported .eml files to tiff for processing.
See Render Profiles > Email Settings for more information.

File system subfolder

This setting works in conjunction with the “prompt for subfolder” settings.

If a subfolder is being used EzeScan can drop the documents into a subfolder (under the import folder) of the same name.

The placeholders available are.

<<Mailbox>> - i.e. INBOX

<<MailboxPath>> - i.e. INBOX/Customers/ABC Pty Ltd

<<MailboxRelativePath>> - i.e. Customers/ABC Pty Ltd

JavaScript errors detected

Please note, these errors can depend on your browser setup.

If this problem persists, please contact our support.