Sample: Create and retrieve Outlook filters

This sample shows how to retrieve filters for Microsoft Dynamics 365 for Outlook. You can download the sample from here.


This sample applies to both Dynamics 365 Customer Engagement (on-premises) and Dataverse.

How to run this sample

To obtain a local copy of all samples and build them, do the following:

  1. Download or clone the Samples repo so that you have a local copy.
  2. (Optional) Edit the cds/App.config file to define a connection string specifying the instance/organization you want to connect to.
  3. Open the sample solution in Visual Studio and press F5 to run the sample. After you specify a connection string in cds/App.config, any sample you run will use that connection information.

If you do not specify a connection string in cds/App.config file, a dialog will open each time you run the sample and you will need to enter information about which instance/org you want to connect to and which credentials you want to use. This dialog will cache previous connections so that you can choose a previously used connection.

How this sample works

In order to simulate the scenario described above, the sample will do the following:


Checks for the current version of the org.


  1. The fetchXml method creates asn retrieves offline filter. In your Outlook client, this will appear in System Filters tab under File -> CRM -> Synchronize -> Outlook Filters.
  2. The InstantiateFiltersRequest method activates the selected offline templates for the current user.
  3. The ResetUserFilterRequest method resets the current user's offline templates to the defaults.

Clean up

Display an option to delete the sample data that is created in Setup. The deletion is optional in case you want to examine the entities and data created by the sample. You can manually delete the records to achieve the same result.

See also

Extend Dynamics 365 for Outlook
Sample: Use Outlook Methods
Offline and Outlook Filters and Templates
SavedQuery Entity