communications-mining
latest
false
UiPath logo, featuring letters U and I in white

Communications Mining Developer Guide

Last updated Dec 20, 2024

Overview

The Exchange integration provides a convenient, easy-to-setup way to sync your development and production email data into Communications Mining in real time.

Exchange Integration Architecture

The Exchange integration continuously polls your Exchange server for new emails in the configured mailboxes. The emails are cleaned, enriched, and converted into Communications Mining comment objects, and can be accessed by users on the Communications Mining web platform, and by applications or bots via the Communications Mining API. The Exchange integration runs in the Communications Mining cloud.

The mailboxes to poll can be conveniently configured in the Communications Mining UI, which also offers the functionality to start or stop the integration, and to update the configuration parameters used to connect to your Exchange server.

Note:
  • MICROSOFT EXCHANGE COMPATIBILITY

    The Exchange integration is compatible with Exchange Online, and with Microsoft Exchange 2010-2019 server using Exchange Web Services (EWS).

  • SECURITY

    The Exchange integration polls the Exchange server by making authenticated GET requests over HTTPS. The Exchange integration receives data via the GET requests it initiates, and does not accept any inbound connections initiated elsewhere. The Exchange integration can be configured with specific ciphers.

    It is sufficient to give the Exchange integration read-only access to your mailboxes.

How emails are synced

Example mailbox configuration

The integration will continuously sync emails from each configured mailbox. If no starting time is provided, all emails will be synced.

The integration will set the comment's message_id to the hex-encoded comment ID of the synced email. If multiple mailboxes containing the same email (e.g. due to being CC'ed on the same email) are synced into the same bucket, the resulting comment will have the metadata of the last synced of the duplicate emails.

The integration will update the Folder user property of a comment when the corresponding email is moved to a different folder. The integration won't update the comment subject or body if either is updated in the email after it has been sent or received.

You can also enable attachment syncing at mailbox level on an Exchange integration. The streams API then makes the attachments retrievable via an attachment reference. Check more about syncing attachments in the Attachments and Using Exchange Integrations pages.

Integration Errors

Integrations experiencing persistent issues will automatically be disabled at the integration level if the integration is incorrectly configured, or at the mailbox level, if the mailbox is incorrectly configured.

You will be notified to address the issue(s), and once resolved, you can re-enable the integration(s).

This happens when the mailbox can't be found, in case it was deleted, the service account doesn't have access to the Inbox, or the credentials expired and need to be updated.

Examples of errors that disable the integration include:
  • Incorrect credentials
  • Expired credentials
  • Reaching a quota limit for uploading data
  • Misconfiguration of Exchange server details
Examples of errors that disable a mailbox include:
  • Invalid permissions for service account or app authentication
  • Misspelled mailbox address
  • Deleted mailbox
Note: You will be auto-subscribed to notifications if you have the View integrations permission, but can also self-subscribe (or unsubscribe) via the Notification Service. To update integration configurations, the Modify integrations permission is required.
  • How emails are synced
  • Integration Errors

Was this page helpful?

Get The Help You Need
Learning RPA - Automation Courses
UiPath Community Forum
Uipath Logo White
Trust and Security
© 2005-2024 UiPath. All rights reserved.