Skip to main content

Deleted Items Folder item type retention statistics script

This is a followup post to last weeks Mailbox Item type script based on a question somebody asked about the Deleted Items folder and retention of different item types. So what this script does is produces a more detailed ItemType report for all the Items in this case just in one particular folder the Deleted Items Folder. Instead of using a Search it just enumerates though all the Items in the target folder and uses some logic to calculate a few different statistics for Items in that folder. Here's the type of report it produces.


So the script reports  on
  • Total number of Items for each ItemType
  • Total Size of Items per ItemType
  • Oldest and Newest Received Date for each ItemType
  • Using the PR_RetentionDate extended property (if its set) it works out the number of days left until the Item expires and then calculates the number of Items that will expire within 7, 7-14,14-30 and over 30 days (or not at all) for each ItemType.
 To run the script you just enter the Mailbox you want to run against and the full path the Output csv file eg

 Get-DeletedItemsStats -MailboxName mailbox@domain.com -ReportFileName c:\temp\rep.csv

I've also created another version of the script that takes a -FolderPath parameter so you can run it against any folder in the mailbox

eg to run it against the clutter folder

 Get-FolderItemsStats -MailboxName mailbox@domain.com -FolderPath '\Clutter' -ReportFileName c:\temp\rep.csv

or the Junk Mail folder

 Get-FolderItemsStats -MailboxName mailbox@domain.com -FolderPath '\Junk Email' -ReportFileName c:\temp\rep.csv

I've put a download of both scripts here

The code itself looks like 

####################### 
<# 
.SYNOPSIS 
 Creates a Statistics Report of Items in the Deleted Items folder in a Mailbox using the  Exchange Web Services API 
 
.DESCRIPTION 
  Creates a Statistics Report of Items in the Deleted Item folder in a Mailbox using the  Exchange Web Services API 
  
 Requires the EWS Managed API from https://www.microsoft.com/en-us/download/details.aspx?id=42951

.EXAMPLE
 PS C:\>Get-DeletedItemsStats  -MailboxName user.name@domain.com -ReportFileName c:\temp\delItemStats.csv
 This Example creates a Creates a Statistics Report of Items in the Deleted Items folder in a Mailbox
#> 
function Get-DeletedItemsStats 
{ 
    [CmdletBinding()] 
    param( 
             [Parameter(Position=0, Mandatory=$true)] [string]$MailboxName,
  [Parameter(Position=1, Mandatory=$true)] [PSCredential]$Credentials,
  [Parameter(Position=2, Mandatory=$true)] [string]$ReportFileName
    )  
  Begin
   {
  ## Load Managed API dll  
  ###CHECK FOR EWS MANAGED API, IF PRESENT IMPORT THE HIGHEST VERSION EWS DLL, ELSE EXIT
  $EWSDLL = (($(Get-ItemProperty -ErrorAction SilentlyContinue -Path Registry::$(Get-ChildItem -ErrorAction SilentlyContinue -Path 'Registry::HKEY_LOCAL_MACHINE\SOFTWARE\Microsoft\Exchange\Web Services'|Sort-Object Name -Descending| Select-Object -First 1 -ExpandProperty Name)).'Install Directory') + "Microsoft.Exchange.WebServices.dll")
  if (Test-Path $EWSDLL)
      {
      Import-Module $EWSDLL
      }
  else
      {
      "$(get-date -format yyyyMMddHHmmss):"
      "This script requires the EWS Managed API 1.2 or later."
      "Please download and install the current version of the EWS Managed API from"
      "http://go.microsoft.com/fwlink/?LinkId=255472"
      ""
      "Exiting Script."
      exit
      } 
  
  ## Set Exchange Version  
  $ExchangeVersion = [Microsoft.Exchange.WebServices.Data.ExchangeVersion]::Exchange2010_SP2  
    
  ## Create Exchange Service Object  
  $service = New-Object Microsoft.Exchange.WebServices.Data.ExchangeService($ExchangeVersion)  
    
  ## Set Credentials to use two options are availible Option1 to use explict credentials or Option 2 use the Default (logged On) credentials  
    
  #Credentials Option 1 using UPN for the windows Account  
  #$psCred = Get-Credential  
  $creds = New-Object System.Net.NetworkCredential($Credentials.UserName.ToString(),$Credentials.GetNetworkCredential().password.ToString())  
  $service.Credentials = $creds      
  #Credentials Option 2  
  #service.UseDefaultCredentials = $true  
   #$service.TraceEnabled = $true
  ## Choose to ignore any SSL Warning issues caused by Self Signed Certificates  
    
  ## Code From http://poshcode.org/624
  ## Create a compilation environment
  $Provider=New-Object Microsoft.CSharp.CSharpCodeProvider
  $Compiler=$Provider.CreateCompiler()
  $Params=New-Object System.CodeDom.Compiler.CompilerParameters
  $Params.GenerateExecutable=$False
  $Params.GenerateInMemory=$True
  $Params.IncludeDebugInformation=$False
  $Params.ReferencedAssemblies.Add("System.DLL") | Out-Null

$TASource=@'
  namespace Local.ToolkitExtensions.Net.CertificatePolicy{
    public class TrustAll : System.Net.ICertificatePolicy {
      public TrustAll() { 
      }
      public bool CheckValidationResult(System.Net.ServicePoint sp,
        System.Security.Cryptography.X509Certificates.X509Certificate cert, 
        System.Net.WebRequest req, int problem) {
        return true;
      }
    }
  }
'@ 
  $TAResults=$Provider.CompileAssemblyFromSource($Params,$TASource)
  $TAAssembly=$TAResults.CompiledAssembly

  ## We now create an instance of the TrustAll and attach it to the ServicePointManager
  $TrustAll=$TAAssembly.CreateInstance("Local.ToolkitExtensions.Net.CertificatePolicy.TrustAll")
  [System.Net.ServicePointManager]::CertificatePolicy=$TrustAll

  ## end code from http://poshcode.org/624
    
  ## Set the URL of the CAS (Client Access Server) to use two options are availbe to use Autodiscover to find the CAS URL or Hardcode the CAS to use  
    
  #CAS URL Option 1 Autodiscover  
  $service.AutodiscoverUrl($MailboxName,{$true})  
  "Using CAS Server : " + $Service.url   
     
  #CAS URL Option 2 Hardcoded  
    
  #$uri=[system.URI] "https://casservername/ews/exchange.asmx"  
  #$service.Url = $uri    
    
  ## Optional section for Exchange Impersonation  
    
  #$service.ImpersonatedUserId = new-object Microsoft.Exchange.WebServices.Data.ImpersonatedUserId([Microsoft.Exchange.WebServices.Data.ConnectingIdType]::SmtpAddress, $MailboxName) 
  # Bind to Deleted Items Folder
  $folderid= new-object Microsoft.Exchange.WebServices.Data.FolderId([Microsoft.Exchange.WebServices.Data.WellKnownFolderName]::DeletedItems,$MailboxName)   
  $DeletedItems = [Microsoft.Exchange.WebServices.Data.Folder]::Bind($service,$folderid)
  #Define ItemView to retrive just 1000 Items    
  $ivItemView =  New-Object Microsoft.Exchange.WebServices.Data.ItemView(1000) 
  $PR_RETENTION_DATE = New-Object Microsoft.Exchange.WebServices.Data.ExtendedPropertyDefinition(0x301C,[Microsoft.Exchange.WebServices.Data.MapiPropertyType]::SystemTime); 
  $ItemPropset= new-object Microsoft.Exchange.WebServices.Data.PropertySet([Microsoft.Exchange.WebServices.Data.BasePropertySet]::FirstClassProperties)
  $ItemPropset.Add($PR_RETENTION_DATE);
  $ivItemView.PropertySet = $ItemPropset
  $rptCollection = @{}
  $fiItems = $null    
  do{    
      $fiItems = $service.FindItems($DeletedItems.Id,$ivItemView)    
      #[Void]$service.LoadPropertiesForItems($fiItems,$psPropset)  
      foreach($Item in $fiItems.Items){      
    #Process Item
    if($rptCollection.Contains($Item.ItemClass) -eq $false){
     $rptObj = "" | Select ItemClass,NumberOfItems,SizeOfItems,OldestItem,NewestItem,RetentionExpire7,RetentionExpire7To14,RetentionExpire14To30,RetentionExpire30Plus,NoRetention
     $rptObj.OldestItem = $Item.datetimereceived
     $rptObj.NewestItem = $Item.datetimereceived
     $rptObj.ItemClass = $Item.ItemClass
     $rptObj.NumberOfItems = 1
     $rptObj.SizeOfItems = $Item.Size
     $rptObj.RetentionExpire7 = 0
     $rptObj.RetentionExpire7To14 = 0
     $rptObj.RetentionExpire14To30 = 0
     $rptObj.RetentionExpire30Plus = 0
     $rptObj.NoRetention = 0
     $RetvalObj = $null
     if($Item.TryGetProperty($PR_RETENTION_DATE,[ref]$RetvalObj)){
      $rDays = ($RetvalObj - (Get-Date)).Days
      if($rDays -le 7){
       $rptObj.RetentionExpire7++
      }
      if($rDays -gt 7 -band $rDays -le 14 ){
       $rptObj.RetentionExpire7To14++
      }
      if($rDays -gt 14 -band $rDays -le 30 ){
       $rptObj.RetentionExpire14To30++
      }
      if($rDays -gt 30){
       $rptObj.RetentionExpire30Plus++
      }
     }
     else{
      $rptObj.NoRetention++
     }
     $rptCollection.Add($Item.ItemClass,$rptObj)
    }
    else{
     if($Item.datetimereceived -ne $null){
      if($Item.datetimereceived -gt $rptObj.NewestItem){
       $rptObj.NewestItem = $Item.datetimereceived
      }
      if($Item.datetimereceived -lt $rptObj.OldestItem){
       $rptObj.OldestItem = $Item.datetimereceived
      }
     }
     $RetvalObj = $null
     if($Item.TryGetProperty($PR_RETENTION_DATE,[ref]$RetvalObj)){
      $rDays = ($RetvalObj - (Get-Date)).Days
      if($rDays -le 7){
       $rptCollection[$Item.ItemClass].RetentionExpire7++
      }
      if($rDays -gt 7 -band $rDays -le 14 ){
       $rptCollection[$Item.ItemClass].RetentionExpire7To14++
      }
      if($rDays -gt 14 -band $rDays -le 30 ){
       $rptCollection[$Item.ItemClass].RetentionExpire14To30++
      }
      if($rDays -gt 30){
       $rptCollection[$Item.ItemClass].RetentionExpire30Plus++
      }
     }
     else{
      $rptCollection[$Item.ItemClass].NoRetention++
     }
     $rptCollection[$Item.ItemClass].NumberOfItems += 1
     $rptCollection[$Item.ItemClass].SizeOfItems += $Item.Size
    }
      }    
      $ivItemView.Offset += $fiItems.Items.Count    
  }while($fiItems.MoreAvailable -eq $true)  
  $rptCollection.Values | Export-Csv -NoTypeInformation -Path $ReportFileName
  Write-Output $rptCollection.Values
  }
}
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.