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 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;  
  10. fpType.ParentFolderId = new TargetFolderIdType();  
  11. DistinguishedFolderIdType contactsFolder = new DistinguishedFolderIdType();  
  12. AddressListIdType adList = new AddressListIdType();  
  13. adList.Id = "2117949e-abe8-4915-91eb-6b9f867fd8de";  
  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);  

Popular posts from this blog

Export calendar Items to a CSV file using EWS and Powershell

Somebody asked about this last week and while I have a lot of EWS scripts that do access the Calendar I didn't have a simple example that just exported a list of the Calendar events with relevant information to a CSV file so here it is. I've talked on this one before in this howto  but when you query the calendar folder using EWS you need to use a CalendarView which will expand any recurring appointments in a calendar. There are some limits when you use a calendarview in that you can only return a maximum of 2 years of appointments at a time and paging will limit the max number of items to 1000 per call. So if you have a calendar with a very large number of appointments you need to break your query into small date time blocks. In this example script I'm just grabbing the next 7 days of appointments if you want to query a longer period you need to adjust the following lines (keeping in mind what I just mentioned) #Define Date to Query $StartDate = (Get-Date) $EndDate

Downloading a shared file from Onedrive for business using Powershell

I thought I'd quickly share this script I came up with to download a file that was shared using One Drive for Business (which is SharePoint under the covers) with Powershell. The following script takes a OneDrive for business URL which would look like This script is pretty simple it uses the SharePoint CSOM (Client side object Model) which it loads in the first line. It uses the URI object to separate the host and relative URL which the CSOM requires and also the SharePointOnlineCredentials object to handle the Office365 SharePoint online authentication. The following script is a function that take the OneDrive URL, Credentials for Office365 and path you want to download the file to and downloads the file. eg to run the script you would use something like ./spdownload.ps1 '

Writing a simple scripted process to download attachmentts in Exchange 2007/ 2010 using the EWS Managed API

Every complicated thing in life is made up of smaller simpler building blocks, when it comes to writing a script (or any code really) the more of these little building blocks you have to figure out the more the process of solving a problem can become bewildering. The Internet generally provides you with lots of half eaten sandwiches of information something someone else has taken a bite out but a lot of the time half done, and as with any code its usefulness declines over time as new and better API's and methods are derived. In this post I'm going to go through a simple scripted process that hopefully covers a few more of these smaller building blocks that you might face when asked to come up with a simple costless solution to perform an automated business function with a script. So the process im going to look at is one that comes up a lot and that is you have an Email that comes into to certain mailbox every day with a certain subject in my case "Daily Export" this
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.