Configuring the CatchMail
The CatchMail must first be configured from the Administration console in order to be used.
Reference
For more information about the CatchMail, refer to Introduction to the CatchMail.
| 1 | From the Administration console, go to Configuration > CatchMail to specify the configuration information: |
| Parameters | Functions |
|---|---|
| CatchMail setup section | |
| Use CatchMail | Must be checked to enable the feature. |
| Akuiteo user |
Specify the CatchMail user name configured in the Desktop Application. Ex: CATCH |
| Akuiteo password | Specify the password of the user. |
| Start period (20s by default) |
Specify a period to take into account to start the Catch Mail service after the server has been started. In seconds. Ex: 20 |
| Email analysis interval (60s by default) |
Specify the interval between each check for new emails. In seconds. Ex: 60 |
| Use OAUTH authentication (Exchange 365 only) |
Enable or disable OAUTH authentication to connect to Exchange. This option must be enabled if Exchange 365 is used by Akuiteo in your organization. Otherwise, it must be disabled. |
| Use Graph API Library |
Check this box if you use the Microsoft Graph API. For more information about Microsoft graph configuration, refer to Configuration for Microsoft Graph. |
| Tenant ID |
This field must be specified if Use OAUTH authentication (Exchange 365 only) or Use Graph API Library is enabled. Specify the tenant ID provided by Microsoft for the OAUTH authentication or the connection to the Microsoft Graph API. |
| Client ID |
This field must be specified if Use OAUTH authentication (Exchange 365 only) or Use Graph API Library is enabled. Specify the client ID for the OAUTH authentication or the connection to the Microsoft Graph API. |
| Client Secret |
This field must be specified if Use OAUTH authentication (Exchange 365 only) or Use Graph API Library is enabled. Specify the client secret for the OAUTH authentication or the connection to the Microsoft Graph API. |
| Location of the Gmail credential key for Catchmail |
This field must be specified if you use Gmail authentication with a Gmail credential key. Specify the location of the Gmail credential key provided by Google from https://console.cloud.google.com/. Ex: c:/keys/catchmail.json |
| Email account setup section | |
| Setup name |
Name your configuration (optional). Ex: ConfigCatchMail |
| Account email |
Specify the email address of the account used for Catch Mail. Ex: catchmail@akuiteo.com |
| Type of email account |
Select the type of email. Ex: EXCHANGE or POP3 |
| Mail server address |
If EXCHANGE: Specify the Exchange Web Service address. Ex: https://serveraddress/EWS/exchange.asmx If POP3: Specify the POP3 server address. Ex: mail.serveraddress.net |
| Mail server port |
If EXCHANGE: Specify the email server port. Ex: 443 (if secured) If POP3: Specify the POP3 server port. Ex: 110 for POP, 995 for POP SSL |
| Is secured | Check this box if the mail server uses a secure port. |
| User |
Specify the email address of the account used for Catch Mail. Ex: catchmail@akuiteo.com |
| Password | Specify the password linked to this account. |
| Inbox | Specify the directory in which emails from your account will be saved. |
| Test connection to the Catch mail interface using the specified values | Click on the link to check the configuration. |
| 2 | Save then restart the Tomcat server. |
Configuration for Microsoft Graph
Accessing the Azure portal
| 1 | In a web browser, enter the following address https://portal.azure.com/ and log in as an administrator. |
| 2 | In the home page, click on Microsoft Entra ID. |
Registering Akuiteo in the Azure AD's directory
| 1 | Click on App registrations from the left menu, then click on New registration. |
| 2 | Give a Name to this new registration (for example Akuiteo Microsoft Graph CatchMail) and leave the Accounts in this organizational directory only (XXX only - Single tenant) option checked. Click on Register. |
The app page is displayed.
| 3 | Copy the following information: |
- Application ID (customer)
- Directory ID (tenant)
To do so, hover over each field then click on the icon that enables you to copy the information to the clipboard. Keep this information in a separate document.
Creating a "client secret" to identify the Akuiteo server
| 1 | Click on Certificates & secrets from the left menu, then click on New client secret. |
| 2 | Enter a Description ( Secret client Akuiteo for example) then select an Expiration date for the key, depending on your security policy. Click on Add. |
Important
When the expiration date is reached, you must create a new "client secret".
| 3 | Hover over the Value field then click on the button to copy the information to the clipboard. Keep this information in a separate document. |
Important
You must copy these values right after creating the client secret because the information will not be accessible afterward and you must generate a new client secret.
Requesting API permissions
| 1 | From the API permissions menu, click on Add an authorization then on Microsoft Graph API. |
| 2 | Click on Application permissions. |
| 3 | From the authorizations list, check the Mail.ReadWrite authorization then click on the Add authorizations button. |
| 4 | From the Configured permissions page, click on the Grant admin consent for XXX button, then click on Yes to confirm. |
Configuring the Administration console in Akuiteo
In the Administration console, from
| Field | Description |
|---|---|
| Use CatchMail | Check this option to enable the CatchMail. |
| Akuiteo user | Specify the CatchMail user's code. |
| Akuiteo password | Specify the CatchMail user's password. |
| Start period (20s by default) | Default value |
| Email analysis interval (60s by default) | Default value |
| Use OAUTH authentication (Exchange 365 only) | Uncheck this box. |
| Use Graph API Library | Check this box |
| Tenant ID | Enter the Directory ID (tenant) value from Azure. |
| Client ID | Enter the Directory ID (customer) value from Azure. |
| Client Secret | Enter the Value of the client secret from Azure. |
| Location of the Gmail credential key for Catchmail | Empty |
