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

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

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.