Skip to main content

Using eDiscovery to search mailboxes using EWS in Exchange 2013 (the new Exchange)

eDiscovery is one of the new features in Exchange 2013 that has been built on the top of new operations added in Exchange Web Services in 2013. While its very useful for ITPro's for handling legal discoveries and compliance issues, it opens up a whole new world for application developers building Apps that search Exchange Mailboxes. Like the AQS querystring that was introduced in Exchange 2010 the eDiscovery operations make use of the Exchange Search service's content indexes.

There isn't much documentation around at the moment about how to use eDiscovery in EWS so this is just a dump of what I've learned so far.

All up there are four new EWS operations for eDiscovery however the two that you will use most of the time would be.



GetSearchableMailboxes
Gets a list of mailboxes that the client has permission to search or perform eDiscovery on.
SearchMailboxes
Searches for items in specific mailboxes that match query keywords.

from http://msdn.microsoft.com/en-us/library/exchange/jj190897.aspx

Permissions wise you need to be a member of the Discovery Management RBAC role

The eDiscovery operations make use of the Keyword Query Language (KQL) which there is some decent documentation for in the Protocol documents for KQL http://msdn.microsoft.com/en-us/library/hh644280%28v=office.12%29.aspx although this isn't very Exchange specific. KQL is pretty cool and gives greater control and functionality over the queries you make when compared against AQS. The syntax does bare similarities to AQS and in some cases your AQS queries should just be transferable.

Some KQL samples would be

Subject:"New Time Proposed: test"  -  This would do an exact match on the Subject

Subject:Football    - This would do a SubString type query on the Subject

attachment:'.pdf'  - The would search for attachment with a pdf attachment

To use the new eDisocvery operations in the EWS Managed API you need to have v2.0 which was released recently http://www.microsoft.com/en-au/download/details.aspx?id=35371 .

So now it comes to using the SearchMaiboxes operation, to do this you need to have a properly formated KQL query and you need to know the Mailbox Identifier to use. The Mailbox identifier was a bit of tricky one where in most other things in EWS this would be the PrimarySMTPAddress, for this operation its the X500 (or legacyExchangedn) of the mailbox. There are a few ways you could get this the eaiest and most reliable would be to use the GetSearchableMailboxes operation to build the MailboxSearchScope array for the mailboxes you want to search . eg

  1. GetSearchableMailboxesResponse gsMBResponse = service.GetSearchableMailboxes("fsmith", false);  
  2. MailboxSearchScope[] msbScope = new MailboxSearchScope[gsMBResponse.SearchableMailboxes.Length];  
  3. Int32 mbCount = 0;  
  4. foreach (SearchableMailbox sbMailbox in gsMBResponse.SearchableMailboxes) {  
  5.     msbScope[mbCount] = new MailboxSearchScope(sbMailbox.ReferenceId, MailboxSearchLocation.All);  
  6.     mbCount++;  
  7. }  
The Important point is the ReferenceId (which is the X500 address) is the Id that SearchMailbox seems to want.
Next you build the actually request

  1. SearchMailboxesParameters smSearchMailbox = new SearchMailboxesParameters();  
  2. MailboxQuery mbq = new MailboxQuery("attachment:'.pdf'", msbScope);  
  3. MailboxQuery[] mbqa = new MailboxQuery[1] { mbq };  
  4. smSearchMailbox.SearchQueries = mbqa;  
  5. smSearchMailbox.PageSize = 1000;  
  6. smSearchMailbox.ResultType = Microsoft.Exchange.WebServices.Data.SearchResultType.PreviewOnly;  
  7. service.TraceEnabled = true;  
  8. ServiceResponseCollection<SearchMailboxesResponse> srCol =  service.SearchMailboxes(smSearchMailbox);  
There are a bunch of options for manipulating the results such as deduplication and the ability to page and sort the results in different ways and orders. You can also choose just to return the statistics of the query without the results, or return the resutls as PreviewItems where you can control what properties are returned in the PreviewItem.

So for me its a big thumbs up for eDiscovery, so far anyway I can see some frustrations in the way the PriviewItems are returned and there needs to be a lot better info for using KQL and the discovery options.

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

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

Sending a MimeMessage via the Microsoft Graph using the Graph SDK, MimeKit and MSAL

One of the new features added to the Microsoft Graph recently was the ability to create and send Mime Messages (you have been able to get Message as Mime for a while). This is useful in a number of different scenarios especially when trying to create a Message with inline Images which has historically been hard to do with both the Graph and EWS (if you don't use MIME). It also opens up using SMIME for encryption and a more easy migration path for sending using SMTP in some apps. MimeKit is a great open source library for parsing and creating MIME messages so it offers a really easy solution for tackling this issue. The current documentation on Send message via MIME lacks any real sample so I've put together a quick console app that use MSAL, MIME kit and the Graph SDK to send a Message via MIME. As the current Graph SDK also doesn't support sending via MIME either there is a workaround for this in the future my guess is this will be supported.
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.