Skip to main content

EWS Basics : Reporting on the Age of Items in a Folder

One of the more common questions I get is around some of the EWS Item Age scripts I've written in the past. If we take the script I introduced in the first Basics post with some easy modifications we can turn this script that already enumerates all the Items in a folder into a script that will report on age of the Items in a folder. So in this post I'm going to try to explain a little better the changes that you would need to make.

EWS Changes

The EWS changes that need to be made to the basics script are to the Propertyset that is used in the FindItems Operation. A PropertySet in EWS basically tells Exchange which properties you want to be returned. So to make this script as efficient as possible we want to restrict Exchange to just returning the Size and DateTime the messages where received or created. So these are the only changes that are needed for the EWS side

$ivItemView =  New-Object Microsoft.Exchange.WebServices.Data.ItemView(1000) 
$ItemPropset= new-object Microsoft.Exchange.WebServices.Data.PropertySet([Microsoft.Exchange.WebServices.Data.BasePropertySet]::IdOnly)
$ItemPropset.Add([Microsoft.Exchange.WebServices.Data.ItemSchema]::Size)
$ItemPropset.Add([Microsoft.Exchange.WebServices.Data.ItemSchema]::DateTimeReceived)
$ItemPropset.Add([Microsoft.Exchange.WebServices.Data.ItemSchema]::DateTimeCreated)
$ivItemView.PropertySet = $ItemPropset

Reporting

When your reporting on the age of Items your basically aggregating the part of the Date/Time a Message was received. To do the aggregation in this script I'm just using a Hashtable which there is a good description of at https://technet.microsoft.com/en-us/library/ee692803.aspx . The way I'm using them to aggregate the number of Messages and the size of the messages for the Year a Message was received in. To get the Year a message was received in the item enumeration section of the script I'm using this simple function

$dateVal = $null
if($Item.TryGetProperty([Microsoft.Exchange.WebServices.Data.ItemSchema]::DateTimeReceived,[ref]$dateVal )-eq $false){
 $dateVal = $Item.DateTimeCreated
}
What this does is loads the DateTimeReceived property into the $dataVal variable and if that property isn't available (eg the message maybe a draft) it uses the DateTime created property.

Once we have this value its just a matter of firstly using the Year property of the (DateTime) Class and then we aggregate this value with the Hashtable. In the Values collection of the HashTable I'm using a Custom object (see https://technet.microsoft.com/en-us/magazine/hh750381.aspx) that does the aggregation part.  eg 

if($rptCollection.ContainsKey($dateVal.Year)){
 $rptCollection[$dateVal.Year].TotalNumber += 1
 $rptCollection[$dateVal.Year].TotalSize += [Int64]$Item.Size
}
else{
 $rptObj = "" | Select Year,TotalNumber,TotalSize
 $rptObj.TotalNumber = 1
        $rptObj.Year = $dateVal.Year
 $rptObj.TotalSize = [Int64]$Item.Size
 $rptCollection.add($dateVal.Year,$rptObj)
}

At the end of this we can just write the HashTable Values collection back to output Pipeline using write-object taking advantage of the sort-object cmdlet to make sure the values are sorted descending by Year 

Write-Output $rptCollection.Values | Sort-Object -Property Year -Descending

I've put a copy of this script on GitHub here https://github.com/gscales/Powershell-Scripts/edit/master/GetItemAgeFromItemsInFolder.ps1

An example of running this script would look like


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

Sending a Message in Exchange Online via REST from an Arduino MKR1000

This is part 2 of my MKR1000 article, in this previous post  I looked at sending a Message via EWS using Basic Authentication.  In this Post I'll look at using the new Outlook REST API  which requires using OAuth authentication to get an Access Token. The prerequisites for this sketch are the same as in the other post with the addition of the ArduinoJson library  https://github.com/bblanchon/ArduinoJson  which is used to parse the Authentication Results to extract the Access Token. Also the SSL certificates for the login.windows.net  and outlook.office365.com need to be uploaded to the devices using the wifi101 Firmware updater. To use Token Authentication you need to register an Application in Azure https://msdn.microsoft.com/en-us/office/office365/howto/add-common-consent-manually  with the Mail.Send permission. The application should be a Native Client app that use the Out of Band Callback urn:ietf:wg:oauth:2.0:oob. You ...
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.