Skip to main content

Using the EWS FindPeople operation in Exchange 2013 and Exchange Online (2013)

In previous versions of Exchange accessing the Directory (or Global Address List) with EWS was limited to just resolving a specific entry or expanding a Distribution list. In Exchange 2013 the concept of the persona's has been introduced http://msdn.microsoft.com/en-us/library/exchange/jj190898%28v=exchg.150%29.aspx. To distill this down a little a persona allows you to have a Contact that can pull its related information from multiple sources while previously everything was just stored in one object in the Exchange Store.

There are a number of new EWS operations to go along with personas and the Unified Contact Store the most interesting of these is the FindPeople operation which allows you to do something you couldn't do previously which is enumerate the entire GAL (or any other address list).  At this point I should make the point that the GAL is just one of the data sources that FindPeople can search you can also include searching the local contact folders. 

To able to search an Address List (including the GAL but it will work with any of the Address Lists like ("All Room", "All Contacts") you need to know the AddressList Id.  However this is one part of these new operations that really needs improvement because at the moment there is no way in EWS to get a list of AddressList Id's. While the FindPeople operation is used in OWA in 2013 they have a custom command in OWA called "GetPeopleFilters". So if you want to use the FindPeople operation you need to either Get the AddressList id from using OWA and capturing it with fiddler eg


(If your using Office365 this is the only way you can get this information that i know of as the Get-AddressList cmdlet or LDAP/AD access isn't available in the cloud)

In a OnPrem environment you can just use the Get-AddressList cmdlet eg

(or you could also use LDAP to get this information)

Once you have the address list Id your ready to code, there are no methods in the EWS Managed API for this operation so you need to use WSDL ProxyCode or RAW Soap to use this operation. For example the following is a C# sample for using the FindPeople operation to enumerate through the address list 100 entries at the a time


  1. FindPeopleType fpType = new FindPeopleType();  
  2. IndexedPageViewType indexPageView = new IndexedPageViewType();  
  3. indexPageView.BasePoint = IndexBasePointType.Beginning;  
  4. indexPageView.Offset = 0;  
  5. indexPageView.MaxEntriesReturned = 100;  
  6. indexPageView.MaxEntriesReturnedSpecified = true;  
  7. fpType.IndexedPageItemView = indexPageView;  
  8.              
  9.              
  10. fpType.ParentFolderId = new TargetFolderIdType();  
  11. DistinguishedFolderIdType contactsFolder = new DistinguishedFolderIdType();  
  12. AddressListIdType adList = new AddressListIdType();  
  13. adList.Id = "2117949e-abe8-4915-91eb-6b9f867fd8de";  
  14.               
  15. fpType.ParentFolderId.Item = adList;  
  16. FindPeopleResponseMessageType fpm = null;  
  17. do  
  18. {  
  19.     fpm = esb.FindPeople(fpType);  
  20.     if (fpm.ResponseClass == ResponseClassType.Success)  
  21.     {  
  22.         foreach (PersonaType PsCnt in fpm.People) {  
  23.             Console.WriteLine(PsCnt.EmailAddress.EmailAddress);  
  24.         }  
  25.         indexPageView.Offset += fpm.People.Length;                      
  26.     }  
  27.     else {  
  28.         throw new Exception("Error");  
  29.     }  
  30. } while (fpm.TotalNumberOfPeopleInView > indexPageView.Offset);  

Labels:

Popular posts from this blog

The MailboxConcurrency limit and using Batching in the Microsoft Graph API

If your getting an error such as Application is over its MailboxConcurrency limit while using the Microsoft Graph API this post may help you understand why. Background   The Mailbox  concurrency limit when your using the Graph API is 4 as per https://docs.microsoft.com/en-us/graph/throttling#outlook-service-limits . This is evaluated for each app ID and mailbox combination so this means you can have different apps running under the same credentials and the poor behavior of one won't cause the other to be throttled. If you compared that to EWS you could have up to 27 concurrent connections but they are shared across all apps on a first come first served basis. Batching Batching in the Graph API is a way of combining multiple requests into a single HTTP request. Batching in the Exchange Mail API's EWS and MAPI has been around for a long time and its common, for email Apps to process large numbers of smaller items for a variety of reasons.  Batching in the Gr...
Read more

Exporting and Uploading Mailbox Items using Exchange Web Services using the new ExportItems and UploadItems operations in Exchange 2010 SP1

Two new EWS Operations ExportItems and UploadItems where introduced in Exchange 2010 SP1 that allowed you to do a number of useful things that where previously not possible using Exchange Web Services. Any object that Exchange stores is basically a collection of properties for example a message object is a collection of Message properties, Recipient properties and Attachment properties with a few meta properties that describe the underlying storage thrown in. Normally when using EWS you can access these properties in a number of a ways eg one example is using the strongly type objects such as emailmessage that presents the underlying properties in an intuitive way that's easy to use. Another way is using Extended Properties to access the underlying properties directly. However previously in EWS there was no method to access every property of a message hence there is no way to export or import an item and maintain full fidelity of every property on that item (you could export the...
Read more

EWS-FAI Module for browsing and updating Exchange Folder Associated Items from PowerShell

Folder Associated Items are hidden Items in Exchange Mailbox folders that are commonly used to hold configuration settings for various Mailbox Clients and services that use Mailboxes. Some common examples of FAI's are Categories,OWA Signatures and WorkHours there is some more detailed documentation in the https://msdn.microsoft.com/en-us/library/cc463899(v=exchg.80).aspx protocol document. In EWS these configuration items can be accessed via the UserConfiguration operation https://msdn.microsoft.com/en-us/library/office/dd899439(v=exchg.150).aspx which will give you access to either the RoamingDictionary, XMLStream or BinaryStream data properties that holds the configuration depending on what type of FAI data is being stored. I've written a number of scripts over the years that target particular FAI's (eg this one that reads the workhours  http://gsexdev.blogspot.com.au/2015/11/finding-timezone-being-used-in-mailbox.html is a good example ) but I didn't have a gene...
Read more
All sample scripts and source code is provided by for illustrative purposes only. All examples are untested in different environments and therefore, I cannot guarantee or imply reliability, serviceability, or function of these programs.

All code contained herein is provided to you "AS IS" without any warranties of any kind. The implied warranties of non-infringement, merchantability and fitness for a particular purpose are expressly disclaimed.