Monday, August 13, 2012

How To Series Sample 7 : Reporting on Calendar Appointments with Attachments in EWS and Powershell

The following sample demonstrates how you can query all the calendar appointments in a Mailbox and report on those appointments that have attachments, the number of attachments on each item, attachment Size and largest attachment details.

Its uses the following AQS query to limit the result set EWS returns to only those appointments with attachments (this means the script will only run against Exchange 2010 or Exchange Online)

$AQSString = "hasattachment:true"

The script then does a batch GetItems to load all the details about attachments using the LoadPropertiesFromItems method. It then produces a report like the following

To Run the script make sure you change the following variable to the mailbox you want to run against.

$MailboxName = "user@domain.com"


I've put a downloadable copy of this script here the script itself looks like.


  1. $MailboxName = "user@domain.com"  
  2.   
  3. $rptcollection = @()  
  4. ## Load Managed API dll    
  5. Add-Type -Path "C:\Program Files\Microsoft\Exchange\Web Services\1.2\Microsoft.Exchange.WebServices.dll"    
  6.    
  7. ## Set Exchange Version    
  8. $ExchangeVersion = [Microsoft.Exchange.WebServices.Data.ExchangeVersion]::Exchange2010_SP2    
  9.    
  10. ## Create Exchange Service Object    
  11. $service = New-Object Microsoft.Exchange.WebServices.Data.ExchangeService($ExchangeVersion)    
  12.    
  13. ## Set Credentials to use two options are availible Option1 to use explict credentials or Option 2 use the Default (logged On) credentials    
  14.    
  15. #Credentials Option 1 using UPN for the windows Account    
  16. $psCred = Get-Credential    
  17. $creds = New-Object System.Net.NetworkCredential($psCred.UserName.ToString(),$psCred.GetNetworkCredential().password.ToString())    
  18. $service.Credentials = $creds      
  19.    
  20. #Credentials Option 2    
  21. #service.UseDefaultCredentials = $true    
  22.    
  23. ## Choose to ignore any SSL Warning issues caused by Self Signed Certificates    
  24.    
  25. ## Code From http://poshcode.org/624  
  26. ## Create a compilation environment  
  27. $Provider=New-Object Microsoft.CSharp.CSharpCodeProvider  
  28. $Compiler=$Provider.CreateCompiler()  
  29. $Params=New-Object System.CodeDom.Compiler.CompilerParameters  
  30. $Params.GenerateExecutable=$False  
  31. $Params.GenerateInMemory=$True  
  32. $Params.IncludeDebugInformation=$False  
  33. $Params.ReferencedAssemblies.Add("System.DLL") | Out-Null  
  34.   
  35. $TASource=@' 
  36.   namespace Local.ToolkitExtensions.Net.CertificatePolicy{ 
  37.     public class TrustAll : System.Net.ICertificatePolicy { 
  38.       public TrustAll() {  
  39.       } 
  40.       public bool CheckValidationResult(System.Net.ServicePoint sp, 
  41.         System.Security.Cryptography.X509Certificates.X509Certificate cert,  
  42.         System.Net.WebRequest req, int problem) { 
  43.         return true; 
  44.       } 
  45.     } 
  46.   } 
  47. '@   
  48. $TAResults=$Provider.CompileAssemblyFromSource($Params,$TASource)  
  49. $TAAssembly=$TAResults.CompiledAssembly  
  50.  
  51. ## We now create an instance of the TrustAll and attach it to the ServicePointManager  
  52. $TrustAll=$TAAssembly.CreateInstance("Local.ToolkitExtensions.Net.CertificatePolicy.TrustAll")  
  53. [System.Net.ServicePointManager]::CertificatePolicy=$TrustAll  
  54.  
  55. ## end code from http://poshcode.org/624  
  56.    
  57. ## 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    
  58.    
  59. #CAS URL Option 1 Autodiscover    
  60. $service.AutodiscoverUrl($MailboxName,{$true})    
  61. "Using CAS Server : " + $Service.url     
  62.     
  63. #CAS URL Option 2 Hardcoded    
  64.    
  65. #$uri=[system.URI] "https://casservername/ews/exchange.asmx"    
  66. #$service.Url = $uri      
  67.    
  68. ## Optional section for Exchange Impersonation    
  69.    
  70. #$service.ImpersonatedUserId = new-object Microsoft.Exchange.WebServices.Data.ImpersonatedUserId([Microsoft.Exchange.WebServices.Data.ConnectingIdType]::SmtpAddress, $MailboxName)   
  71.   
  72.   
  73. $folderid = new-object Microsoft.Exchange.WebServices.Data.FolderId([Microsoft.Exchange.WebServices.Data.WellKnownFolderName]::Calendar,$MailboxName)     
  74. $Calendar = [Microsoft.Exchange.WebServices.Data.Folder]::Bind($Service,$folderid)  
  75.   
  76. if($Calendar.TotalCount -gt 0){  
  77.   
  78.     $AQSString = "hasattachment:true"  
  79.     $ivItemView = New-Object Microsoft.Exchange.WebServices.Data.ItemView(1000)  
  80.     do{   
  81.           
  82.         $fiResults = $Calendar.findItems($AQSString,$ivItemView)    
  83.         if($fiResults.Items.Count -gt 0){  
  84.             $atAttachSet = new-object Microsoft.Exchange.WebServices.Data.PropertySet([Microsoft.Exchange.WebServices.Data.BasePropertySet]::FirstClassProperties)  
  85.             [Void]$service.LoadPropertiesForItems($fiResults,$atAttachSet)  
  86.             foreach($Item in $fiResults.Items){  
  87.                 $rptobj = "" | Select MailboxName,AppointmentSubject,DateCreated,Size,NumberOfAttachments,LargestAttachmentSize,LargestAttachmentName  
  88.                 $rptobj.MailboxName = $MailboxName  
  89.                 $rptobj.AppointmentSubject = $Item.Subject  
  90.                 $rptobj.DateCreated = $Item.DateTimeCreated   
  91.                 $rptobj.Size = [Math]::Round($Item.Size/1MB,2)  
  92.                 $rptobj.NumberOfAttachments = $Item.Attachments.Count  
  93.                 $rptobj.LargestAttachmentSize = 0  
  94.                 foreach($Attachment in $Item.Attachments){                        
  95.                     if($Attachment -is [Microsoft.Exchange.WebServices.Data.FileAttachment]){  
  96.                         $attachSize = [Math]::Round($Attachment.Size/1MB,2)  
  97.                         if($attachSize -gt $rptobj.LargestAttachmentSize){  
  98.                             $rptobj.LargestAttachmentSize = $attachSize  
  99.                             $rptobj.LargestAttachmentName = $Attachment.Name  
  100.                         }  
  101.                     }  
  102.                 }  
  103.                 $rptcollection += $rptobj  
  104.             }     
  105.         }  
  106.         $ivItemView.Offset += $fiResults.Items.Count      
  107.     }while($fiResults.MoreAvailable -eq $true)   
  108. }  
  109. $rptcollection  
  110. $rptcollection | Export-Csv -NoTypeInformation c:\temp\aptRpt.csv  


2 comments:

Jardel Weyrich said...

Do we need any explicit permission to read someone else's calendar? Via Outlook desktop I can see/read other's calendars, but via EWS I always get "The specified folder could not be found in the store." on FindItems. My application is written in C# and uses the official EWS 2.0 library from Microsoft, and it does exactly the same steps you did. Do you have any hints? Thanks!
- Jardel Weyrich

Glen Scales said...

If you can open the calendar as a shared calendar in Outlook it should work i would say the issue you have is you have FreeBusy Rights (with Detail) rights. Try granting rights to the calendar using add-mailboxfolderpermission

Cheers
Glen