Retrieve Data from Exchange Online

To retrieve information from Exchange Online, follow these steps.

To create a new Fetch Task

  1. Stop the connector.
  2. Open the configuration file in a text editor.
  3. In the [FetchTasks] section of the configuration file, specify the number of fetch tasks using the Number parameter. If you are configuring the first fetch task, type Number=1. If one or more fetch tasks have already been configured, increase the value of the Number parameter by one (1). Below the Number parameter, specify the names of the fetch tasks, starting from zero (0). For example:

    [FetchTasks]
    Number=1
    0=MyTask
  4. Below the [FetchTasks] section, create a new TaskName section. The name of the section must match the name of the new fetch task. For example:

    [FetchTasks]
    Number=1
    0=MyTask
    
    [MyTask]
  1. In the task section, set the following parameters:

    ExchangeOnline A Boolean value that specifies whether the repository is an instance of Exchange Online. Set this parameter to true.
    WSURL The URL of the Exchange Web Service.

    For example:

    [MyTask]
    ExchangeOnline=true
    WSURL=https://outlook.office365.com/EWS/Exchange.asmx
    
  2. Specify the list of mailboxes to synchronize, using one of the following methods:

    • The connector can obtain a list of mailboxes to synchronize through the Microsoft Graph API. To do this, set the configuration parameter CrawlExchangeOnlineMailboxes to TRUE. The Graph API requires OAuth authentication so you must create an application to represent the connector and run the OAuth configuration tool. For more information, see Configure OAuth Authentication (Graph API). The OAuth configuration tool creates a file named oauth.cfg that contains the OAuth tokens required by the connector. You can import this information into the connector configuration as in the following example:

      [MyTask] < "oauth.cfg" [OAUTH]
      ExchangeOnline=TRUE
      CrawlExchangeOnlineMailboxes=TRUE

      For more information about including parameters from another file, see Include an External Configuration File.

    • You can specify a list of mailboxes to synchronize by setting the configuration parameter ExchangeOnlineMailbox. This parameter accepts a comma-separated list of mailbox addresses. For example:

      ExchangeOnlineMailbox=user1@domain.com,user2@domain.com

  3. Set the configuration parameters that are required to authenticate with the Exchange Web Service:

    • To authenticate using basic authentication:

      WSUsername The user name to use to connect to the Exchange Web service.
      WSPassword The password to use to connect to the Exchange Web service.
    • To authenticate using OAuth authentication create an app registration in Azure Active Directory. This application must be granted some permissions by an administrator. For information about the permissions that are required, see Permissions. Then, using the tokens that are generated when the application is created, set the configuration parameters WSTenantID, WSClientID, and WSClientSecret. There is no need to run the OAuth configuration tool for configuring authentication with the Exchange Web Service.

  4. Save and close the configuration file.

    You can now start the connector.

    TIP: The connector saves or updates a data file for each completed fetch task. If you make changes to the configuration and want to reset the connector so that it retrieves all of your data again, use the PurgeDatastore action.