Configuring Mailbox
- Enterprise IT
You can configure Mailboxes to enable E-mail Parsing. You can configure Exchange, POP3, and Office 365 Servers for the Mailboxes for a Tenant. For more information about E-mail Parsing, see E-mail Parsing.
To configure a Mailbox:
- Select Admin > Advanced > Notifications > Mailbox.
- On the MAILBOX page, click ADD NEW on the ACTIONS panel.
- Select the Tenant and type in the details for new Mailbox configuration. For information about the fields on the MAILBOX page, see Field Description.
- 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 Configuring Notification Parser.
- If you click Cancel, new Mailbox is configured.
The following screen is displayed when you select the Server Type as Exchange.
Note:
- Add the following key in ServerMonitor.exe.config (Summit Server) or in Summit_ProxyServer.exe.config (Summit 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: SummitAI Server or SummitAI Proxy
|
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 |
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.
|
SCHEDULER DETAILS | |
Monitoring Source | Select a Monitoring Source from the list. |
Job Frequency | Select time format from the list and specify the Time. |
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: SummitAI Server or SummitAI Proxy
|
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.
|
SCHEDULER DETAILS | |
Monitoring Source | Select a Monitoring Source from the list. |
Job Frequency | Select time format from the list and specify the Time. |
Mail Parser API Registration
Register a new application using the Azure portal
- Sign in to the Azure portal using either a work or school account or a personal Microsoft account.
- 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.
- In the left-hand navigation pane, select the Azure Active Directory service, and then select App registrations > New registration.
- 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.
- When finished, select Register.
- 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.
- 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.
- 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 as in below screen shot:
- To grant admin consent when registering an app:
- Select API permissions.
- Click Grant admin consent.
- Share/Configure below in Summit AI application.
- Application ID
- Tenant ID
- Client Secret
- O365 Mailbox Email
- Below Microsoft URLs and its sub APIs should be accessible from Summit AI application server:
Note:
- 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 |
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.
|
SCHEDULER DETAILS | |
Monitoring Source | Select a Monitoring Source from the list. |
Job Frequency | Select time format from the list and specify the Time. |
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.
Figure: FILTERS pop-up page
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.
Figure: MAILBOX page : List of Mailboxes
- To edit any Mailbox configuration, click the Mailbox Name. Make appropriate changes and click SUBMIT.
Figure: MAILBOX page: Edit Mailbox Configuration
- 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. See screen shot.
Figure: ERROR LOG pop-up page
NOTIFICATION PARSER
- Click NOTIFICATION PARSER to view Rule list. NOTIFICATION PARSER pop up page is displayed.
Figure: NOTIFICATION PARSER pop up page
- Click Rule name to configure NOTIFICATION PARSER. NOTIFICATION PARSER configuration page is displayed. For more information about the NOTIFICATION PARSER page, see Configuring Notification Parser.
Figure: NOTIFICATION PARSER configuration page
CREATE NOTIFICATION PARSER
Click CREATE NOTIFICATION PARSER to create NEW NOTIFICATION PARSER. For more information about the NOTIFICATION PARSER page, see Configuring Notification Parser.
CUSTOM SCHEDULER
Click CUSTOM SCHEDULER to configure CUSTOM SCHEDULER for the Mail Box. CUSTOM SCHEDULER page is displayed. For more information about the CUSTOM SCHEDULER page, see Configuring Custom Scheduler.
Figure: CUSTOM SCHEDULER page
Confluence Cloud Migration Alert: Please refer to known issues you may encounter in Confluence Cloud: https://eitdocs.atlassian.net/wiki/x/wDGwAQ