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


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

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

EWS Managed API and Powershell How-To series Part 1

I thought I'd start the year with a series of posts that goes back over the basics of using the EWS Managed API from Powershell and provides a modular remarked example that you can easily cut and paste to build your own scripts. Along the way in this series I'll show a whole bunch of examples around specific things. As a starting point for versions this will be Powershell Version 2.0  and the EWS Managed API 1.1 (which will soon change to 1.2 once released) http://www.microsoft.com/download/en/details.aspx?id=13480. The starting point for any EWS script your going to write is connecting to Exchange for which there are three important pieces of information you will need. Firstly you need to know the version of Exchange your running in this script its going to be held in the following variable $ExchangeVersion = [Microsoft.Exchange.WebServices.Data.ExchangeVersion]::Exchange2010_SP1 Other valid values for Exchange 2007 would be $ExchangeVersion = [Microsoft.Exchange.Web
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.