Mailbox

Prev Next

You can configure Mailboxes to enable Email Parsing. You can configure Exchange, POP3, and Office 365, IMAP Servers for the Mailboxes for a Tenant.

To configure a Mailbox, perform the following steps:

  1. Log in to the Application.

  2. Select Admin from the Workspace dropdown.

    Figure: Workspace

  3. Navigate to Notifications > General > Mailbox.

  4. Select Department and Server Type in the Filters pop-up and click Submit.

    Note

    The ALL option is displayed under Department when Smart is selected in the Intelligent Mail Parser Configuration section within Application Settings. For more information refer Application Settings.



    Figure: Mailbox Filters

  5. Select Add New in the right action panel to create a new Mailbox.

  6. Enter the required details for new Mailbox configuration.
    For more information, refer to below sections to configure based on the server type:

    • Exchange

    • POP3

    • O365 API

    • IMAP

  7. Click SUBMIT.
    The Notification Parser confirmation pop-up page is displayed.

    Figure:  Notification Parser confirmation pop-up page

    • If you click OK, you are redirected to Notification Parser page. For more information about the Notification Parser page, see Notification Parser.

    • If you click Cancel, you continue to create the configured mailbox.

Server Type: Exchange

The following screen is displayed when you select the Server Type as Exchange.

Note

  • Add the following key in ServerMonitor.exe.config (Apex Server) or in Apex_ProxyServer.exe.config (Apex proxy) to parse the e-mails in batches:
    <add key="ParserChunkSize" value="10"/>

  • By default, 10 e-mails are parsed in a batch from the configured Mailbox. This value can be set as per the organization's requirement.

Figure:  Mailbox page - Server Type: Exchange

Field Description

The following table describes the fields on the Mailbox page:

Field

Description

DETAILS

Server Type

Select the Server Type as Exchange from the drop-down list.

Mailbox Name

Type in the name of the Mailbox.

Version

Select an operating system from the list: Exchange 2007 SP1 and Exchange 2010.

Domain

Type in the selected server’s domain name.

User Name

Type in the configured user name for the selected domain.

Password

Type in the password.

Confirm Password

Type in the same password again for confirmation.

EWS URL

Type in the Exchange Web Service (EWS) URL for the selected server type. For example: office365.com and so on.

E-mail ID

Type in the e-mail ID of the user. Specifying EWS URL or the e-mail ID is mandatory.

Invalid E-mail ID

Mails sent from the e-mail ids specified in this field are not processed.

Forward Invalid E-mail to Administrator

If selected, the e-mails sent from an invalid e-mail id are forwarded to the Administrator and deleted.

Forward Error E-mail to Administrator

If selected, the e-mails which could not be processed due to an error is forwarded to the Administrator.

Administrator E-mail ID

Specify the Administrator e-mail id to receive the invalid and error e-mails.

Action for Unparsed E-mails

Select the action to be performed on the unparsed e-mails from the list: No Action, Delete or Move to Different Folder.

If Move to Different Folder option is selected, the Folder Path field is displayed. Specify the path for the folder where you want the unparsed e-mails to be moved in the Folder Path field.

Run at Source

Specify the source:  Server or  Proxy

  • Server: It refers to the machine, where  Suite is installed. It is also referred as  Centralized Server. Select this option to execute the Mailbox operations from the Apex Server.

  • Proxy: It refers to the machine configured at a client location for sending monitored data of the client machines to the  Server. Select this option to execute the Mailbox operations from the Proxy Server.

Do Not Process Mails Older than (Days)

Specify the number of days for which old mails have to be processed.

Error Notification

You can configure the users to notify about any errors occurred while parsing e-mails for a mailbox configuration. Search the user in the User Search field and click the icon.

Restrict E-mail Processing

Select this checkbox to restrict the processing of e-mails if the e-mail id configured in the mailbox is marked under Cc/Bcc.

Active

Indicates the status of the Mailbox configuration.

  • If selected, the Mailbox configuration becomes an available option on the other pages of the application.

  • If not selected, the Mailbox configuration becomes an inactive value. The inactive Mailbox configurations are not displayed in the Mailbox list on the other pages of the application.

SCHEDULER DETAILS

Monitoring Source

Select a Monitoring Source from the list.

Job Frequency

Select time format from the list and specify the Time.

Server Type: POP3

The following screen is displayed when you select the Server Type as POP3.

Figure: Mailbox page - Server Type: POP3

Field Description

The following table describes the fields on the Mailbox page:

Field

Description

DETAILS

Server Type

Select the Server Type as Pop3 from the drop-down list.

Note: Select Pop3 when you cannot access the data directly. You can then remotely access the mailbox details.

Mailbox Name

Type in the name of the Mailbox.

Server Name

Type in the server name.

User Name

Type in the configured user name.

Password

Type in the password.

Confirm Password

Type in the same password again for confirmation.

Port

Type in the port details.

Secure Connection

If selected, the connection becomes secure.

Invalid E-mail ID

Mails sent from the e-mail ids specified in this field are not processed.

Forward Invalid E-mail to Administrator

If selected, the e-mails sent from an invalid e-mail id are forwarded to the Administrator and deleted

Forward Error E-mail to Administrator

If selected, the e-mails which could not be processed due to an error is forwarded to the Administrator.

Administrator E-mail ID

Specify the Administrator e-mail id to receive the invalid and error e-mails.

Action for Unparsed E-mails

Select the action to be performed on the unparsed e-mails from the list: No Action, Delete or Move to Different Folder.

If Move to Different Folder option is selected, the Folder Path field is displayed. Specify the path for the folder where you want the unparsed e-mails to be moved in the Folder Path field.

Run at Source

Specify the source:  Server or  Proxy

  • Server: It refers to the machine, where  Suite is installed. It is also referred as  Centralized Server. Select this option to execute the Mailbox operations from the  Server.

  • Proxy: It refers to the machine configured at a client location for sending monitored data of the client machines to the  Server. Select this option to execute the Mailbox operations from the Proxy Server.

Do Not Process Mails Older than (Days)

Specify the number of days for which old mails have to be processed.

Error Notification

You can configure the users to notify about any errors occurred while parsing e-mails for a mailbox configuration. Search the user in the User Search field and click the  icon.

Restrict E-mail Processing

Select this checkbox to restrict the processing of e-mails if the e-mail id configured in the mailbox is marked under Cc/Bcc.

Active

Indicates the status of the Mailbox configuration.

  • If selected, the Mailbox configuration becomes an available option on the other pages of the application.

  • If not selected, the Mailbox configuration becomes an inactive value. The inactive Mailbox configurations are not displayed in the Mailbox list on the other pages of the application.

SCHEDULER DETAILS

Monitoring Source

Select a Monitoring Source from the list.

Job Frequency

Select time format from the list and specify the Time.

Server Type O365 API

Mail Parser API Registration

Register a new application using the Azure portal

  1. Sign in to the Azure portal using either a work or school account or a personal Microsoft account.

  2. If your account gives you access to more than one tenant, select your account in the top right corner, and set your portal session to the Azure AD tenant that you want.

  3. In the left-hand navigation pane, select the Azure Active Directory service, and then select App registrations > New registration.

  4. When the Register an application page appears, enter your application's registration information:

    • Name - Enter a meaningful application name that will be displayed to users of the app.

    • Supported account types – select Accounts in this organizational directory Only.

    • Redirect URI: Enter https://localhost/ as redirect URI.

    • Select Register.
      Figure: Register an Application

  5. Azure AD assigns a unique application (client) ID to your app, and you're taken to your application's Overview page. To add additional capabilities to your application, you can select other configuration options including branding, certificates and secrets, API permissions, and more.

    Figure: Azure

  6. Create a new application secret. If you choose not to use a certificate, you can create a new application secret.

    • Select Certificates & secrets.

    • Select Client secrets > New client secret.

    • Provide a description of the secret, and a duration. When done, select Add.

      After saving the client secret, the value of the client secret is displayed. Copy this value because you can’t retrieve the key later. You provide the key value with the application ID to sign in as the application. Store the key value where your application can retrieve it.

  7. For API permissions, you need to add additional permissions in order to use Microsoft Graph notifications. Choose Add a permission, and under Microsoft APIs, select Microsoft Graph, and then Provide Delegated and Application permissions.

  8. To grant admin consent when registering an app:

    • Select API permissions.

    • Click Grant admin consent.

  9. Share/Configure below in Apex AI application.

    • Application ID

    • Tenant ID

    • Client Secret

    • O365 Mailbox Email

  10. Below Microsoft URLs and its sub APIs should be accessible from Apex AI application server:

Notes

  • Applications call Microsoft Graph using their own identity and not on behalf of a user. These are usually background services or daemon apps that run on a server without the presence of a signed-in user. These apps make use of OAuth 2.0 client credentials grant flow to authenticate and are configured with application permissions, which enable such apps to access all mailboxes in an organization on Exchange Online. For example, the Mail. Read application permission allows apps to read mail in all mailboxes without a signed-in user.

  • Administrators who want to limit the app access to a specific set of mailboxes can use the New-ApplicationAccessPolicy PowerShell cmdlet to configure access control. Below article covers the basic steps to configure an application access policy. These steps are specific to Exchange Online resources and do not apply to other Microsoft Graph workloads. For more information, see https://docs.microsoft.com/en-us/graph/auth-limit-mailbox-access.

The following screen is displayed when you select the Server Type as O365 API.


Figure:  Mailbox page - Server Type: O365 API

Field Description

The following table describes the fields on the Mailbox page:

Field

Description

DETAILS

Server Type

Select the Server Type as O365 API from the drop-down list.

Mailbox Name

Type in the name of the Mailbox.

E-Mail ID

Type in the e-mail id from which you want to parse the e-mail.

Tenant ID

Type in the Tenant ID of O365 API.

Client Secret

Type in the Client Secret O365 API.

Application ID

Type in the Application ID O365 API.

Invalid E-mail ID

Mails sent from the e-mail ids specified in this field are not processed.

Forward Invalid E-mail to Administrator

If selected, the e-mails sent from an invalid e-mail id are forwarded to the Administrator and deleted.

Forward Error E-mail to Administrator

If selected, the e-mails, which could not be processed due to an error is forwarded to the Administrator.

Administrator E-mail ID

Specify the Administrator e-mail id to receive the invalid and error e-mails.

Action for Unparsed E-mails

Select the action to be performed on the unparsed e-mails from the list: No Action, Delete or Move to Folder.

If Move to Folder option is selected, the Get Mailbox Folder field is displayed. Click this icon to browse the folder where you want the unparsed e-mails to be moved.

Folder Name

The folder that is selected through the Get Mailbox Folder is displayed in this field.

Do Not Process Mails Older than (Days)

Specify the number of days for which old mails have to be processed.

Error Notification

You can configure the users to notify about any errors occurred while parsing e-mails for a mailbox configuration. Search the user in the User Search field and click the icon.

Restrict E-mail Processing

Select this checkbox to restrict the processing of e-mails if the e-mail id configured in the mailbox is marked under Cc/Bcc.

Parser Mailbox E-mail Id

Type the Parser mailbox e-mail id.

Active

Indicates the status of the Mailbox configuration.

  • If selected, the Mailbox configuration becomes an available option on the other pages of the application.

  • If not selected, the Mailbox configuration becomes an inactive value. The inactive Mailbox configurations are not displayed in the Mailbox list on the other pages of the application.

SCHEDULER DETAILS

Monitoring Source

Select a Monitoring Source from the list.

Job Frequency

Select time format from the list and specify the Time.

Server Type: IMAP

The following screen is displayed when you select the Server Type as IMAP.

Figure: Server Type IMAP

For more information on the fields, refer to the following Field Description.

Field Description

Field

Description

Mailbox Name *

Enter the unique name assigned to the mailbox.

E-mail ID *

Enter primary e-mail address configured for the mailbox.

Server Name *

Enter IMAP server hostname or IP address.

Port *

Enter port number used for the IMAP server connection.

Client ID *

Enter authentication client ID (used for OAuth or API access). Required field.

Client Secret *

Enter authentication client secret (used for OAuth or API access). Required field.

Invalid E-mail ID

Enter e-mail addresses considered invalid for processing.

The configured e-mail ids are not processed.

Indicates that mails from invalid e-mail IDs listed above will not be processed.

Forward Invalid E-mail to Administrator

If enabled, e-mails from invalid IDs will be forwarded to the Administrator and deleted from the mailbox.

Forward Error E-mail to Administrator

If enabled, error e-mails (couldn't be processed) are forwarded to the Administrator.

Administrator E-mail ID

E-mail address of the administrator to receive notifications or error mails.

Action for Unparsed E-mails

Specifies the action to be taken for e-mails that cannot be parsed.

Folder Name

The mailbox folder to monitor or process for incoming e-mails.

Do not Process Mails Older than (Days) *

E-mails older than the specified number of days will not be processed.

Error Notification

Settings/option for notifying users/admins in case of processing errors.

Mailbox

Mailbox configuration or selection details.

User Search

Allows searching for users associated with the mailbox.

Type in...

Field for entering user search criteria.

Add

Option to add users or configurations to the mailbox.

Emp ID, Name, E-mail, Customer

Columns representing employee details linked to mailbox processing.

No Data

Indicates no data found for the selected criteria.

Restrict E-mail Processing

Limits e-mail processing if configured e-mail ID is in Cc/Bcc fields.
Select this check box to restrict.

Parser Mailbox E-mail Id

The specific parser mailbox e-mail ID used in processing.

The specified parser mailbox e-mail in Cc\Bcc is not processed.

Indicates that if parser mailbox e-mail is in Cc/Bcc, mails are not processed.

Active

Indicates whether the mailbox configuration is currently active/enabled.

Scheduler Details

Information regarding the schedule for mailbox monitoring or processing.

Monitoring Source

Source or method used for mailbox monitoring.

Job Frequency *

Frequency at which mailbox processing jobs are executed.

Actions

This section explains all the icons on the Actions panel of the Mailbox page.

Filters

Click Filters to specify a particular filter criteria to display the configured Mailboxes. On clicking the Filters icon, the Filters pop up page is displayed. Select the Tenant and Server Type, and click SUBMIT.

Show List

Click Show List to display the List table showing all the configured Mailboxes as per the selected Server Type value for the selected Tenant.

  • To edit any Mailbox configuration, click the Mailbox Name. Make appropriate changes and click Submit.

  • To display the inactive Mailbox configurations, click the Include Inactive check box.

Note

When the configured Mailboxes are displayed under the List table, the Add New action is displayed under Actions. Click Add New to configure a new Mailbox.

Error Log

Click Error Log to view the error details. The Error Log pop-up page is displayed.

Figure: Error Log

Notification Parser

  • Click Notification Parser to view Rule list. Notification Parser  pop up page is displayed.

  • Click Rule name to configure Notification Parser. Notification Parser configuration page is displayed. For more information about the Notification Parser page, see Configure Notification Parser.

Create Notification Parser

Click Create Notification Parser to create New Notification Parser.

Custom Scheduler

Click Custom Scheduler to configure Custom Scheduler for the Mailbox.
Custom Scheduler page is displayed. For more information about the Custom Scheduler page, see Configure Custom Scheduler.