Skip to main content

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  


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.