Configuring Mail Connector settings
Updated in 2021.1
MAPI support is being deprecated and will not be available in future versions. Please use EWS for Exchange on-premises or migrate your mailbox to Exchange Online.
You create or modify Mail Connector jobs using the Mail Connector window. Mail Connector settings, which are available on the Settings tab, include the following sections:
-
Mail Server - Mail server settings are mandatory to start using the Mail Connector. Other settings are optional, you have to configure them only if you need to customize the default Mail Connector behavior.
-
Schedule - In this section you can customize the default schedule according to which the Mail Connector runs.
-
Profile Account (for MAPI only) - Here you can configure the Mail Connector job to run under a dedicated Windows account.
IMPORTANT: Mail Connector jobs run on the Automation Server, which must be properly configured and started beforehand. For details, see Starting and stopping the Automation Server.
To access the Mail Connector window, from the Sidebar, navigate to the E-mail Processing > Mail Connector section and click New to create a new job or double-click an existing one to modify it. The Mail Connector window appears.
If you have multiple jobs and you want to change their default names (such as "Mail Connector", "Mail Connector (1)", "Mail Connector (2)", etc), assign a special name for each job on the Settings tab.
Configuring mail server settings for the Mail Connector job
Each Mail Connector job integrates with a single e-mail account for incoming messages. You can use a POP3, IMAP4 e-mail account, use an Microsoft Exchange e-mail account (MAPI and EWS protocols are supported) or Microsoft Exchange Online account (MS Graph and EWS API integration is supported). Depending on the type of your account, specify the mail server settings as follows:
Before you begin:
-
Choose which Microsoft Exchange account the Mail Connector will use. This must be a Windows account with sufficient permissions to access the Microsoft Exchange mailbox you want to use for the Mail Connector. You can create a special Exchange mailbox account for this task, or use an existing one.
-
On the Automation Server computer, start the Alloy Automation Server Manager and change the Automation Server startup account to your Microsoft Exchange account. For details, see Configuring the Automation Server.
-
If you plan to use MAPI:
Create an e-mail profile for the Microsoft Exchange account. The profile must be created using a 64-bit edition of Microsoft Outlook. For details, see E-mail profile for integration with Microsoft Exchange.
To configure Microsoft Exchange Server settings:
-
On the Settings tab of the Mail Connector window, under Mail Server, choose which service to use for integrating with the Microsoft Exchange Server:
-
Messaging Application Programming Interface (MAPI) - MAPI is a standard method of e-mail integration for all versions of Microsoft Exchange. Using this method requires an e-mail profile for the Microsoft Exchange account on the Automation Server computer. For details, see MAPI e-mail profile for integration with Microsoft Exchange.
-
Exchange Web Services (EWS) - EWS are an enhanced method of e-mail integration for newer versions of Microsoft Exchange, introduced in Exchange 2007 SP1. EWS are installed and configured by default if Outlook Web Access is enabled in your environment.
-
Specify the connection details:
-
Click Test Connection to verify that the Mail Connector can connect to the specified mail server.
Before you begin:
-
Exchange Online is part of the Office 365 suite of products. By Microsoft account here we understand the account you use to work with your Microsoft 365. This account will be used by the Mail Connector so it must have sufficient permissions to work with your Microsoft mailbox. You can create a special mailbox account for this task, or use an existing one.
To configure Microsoft Exchange Online with OAuth authentication settings:
-
On the Settings tab of the Mail Connector window, under Mail Server, choose Exchange Online with OAuth authentication from the drop-down list.
-
Choose one of the API options:
- MS Graph (recommended) - MS Graph is the gateway to data and intelligence in Microsoft 365. Microsoft Graph API usage ensures the latest Microsoft standards in Office 365 Email protocols for very latest in security and connectivity.
- Exchange Web Services (EWS) - EWS was launched as a part of Microsoft Exchange 2007 as a SOAP based API that allows access to Exchange Online data.
-
Click the Sign in hyperlink to sign in to your Microsoft account. If you're already signed in with one account, you can change it by clicking the Change hyperlink and choosing another account.
-
Specify which folder on the server the Mail Connector will monitor for incoming messages. The default folder is INBOX. If needed, you can use a subfolder, such as "INBOX/Support".
- Click Test Connection to verify that the Mail Connector can access the specified mailbox.
Customizing the job schedule for the Mail Connector job
Mail Connector jobs has the default schedule, which you can customize as needed.
-
On the Settings tab of the Mail Connector window, under Schedule, click Change to bring up the Schedule window.
-
Configure a schedule for the job. You can set the job occurrence (daily, weekly, monthly, or yearly), daily frequency, and duration (start and end date). For details, see Setting the schedule.
Configuring the profile account for the Mail Connector job (for MAPI only)
MAPI support is being deprecated. Please use EWS for Exchange on-premises or migrate your mailbox to Exchange Online.
If you use the Microsoft Exchange Server and you want to process several Microsoft Exchange accounts for receiving users’ requests, you must create multiple Mail Connector jobs, providing an individual job for each Microsoft Exchange account. This scenario may require you to configure a profile account for each job. For details, see MAPI e-mail profile for integration with Microsoft Exchange.
Next Steps
To understand how your job will work, switch to the Processing tab and view the default processing rules. You can customize them, if needed.
To clean the message from unwanted text, switch to the Preprocessing Rules tab and choose preprocessing rules for your job. Alloy Navigator offers a set of pre-configured rules for the popular e-mail clients. These rules are initially disabled. You can view the rules and change their order.
NOTE: Rules are applied in the order they are displayed.
You can create or modify preprocessing rules in the E-mail Processing> Preprocessing section. For instructions, see Configuring preprocessing rules.
After you have configured Mail Connector settings, you can test the job and check its results to make sure it works correctly. You can test even a disabled job. For instructions, see Checking Mail Connector job results.
Related Information:
Understanding the Mail Connector
Configuring parsing rules
Configuring processing rules
Configuring preprocessing rules