Skip to main content

EWS Basics : Enumerating all the Items in any folder in a Mailbox

I've decided to start a new series on the blog called EWS Basics where I'll post some reusable scripts that are fit for easy customization by those people unfamiliar with EWS. So the basic idea is to have a group of samples where most of the underlying EWS plumbing code is done and you can just plug in whatever customized action you want to do on particular Items

Enumerate all the Items in any folder in a Mailbox

A common task when you want to report on the Item content in a Folder or you want to perform some type of action on Items (Delete,Move,Copy etc) is you will want to enumerate all the items in a folder. One analogy is doing a dir on directory (just don't mention the M: drive!)

So what this sample does is lets you input the MailboxName (PrimarySMTP Address) and Path to the Folder in the mailbox where the Item are  you want to access and it will write back to the pipeline the Items it finds.

So to put that together in a sample say you want to enumerate the Items in the Clutter Folder and output the ReceivedDateTime and Subject you could use the following

Get-FolderItems -MailboxName gscales@domain.com -FolderPath \clutter | Select DateTimeReceived,Subject

If the folder you wanted to access was a subfolder of the Inbox you could use

Get-FolderItems -MailboxName gscales@domain.com -FolderPath \Inbox\Subfolder| Select DateTimeReceived,Subject

Another example of doing something a little more advanced is where you modify the script to produce statistics of the domains of the senders for email in a Mailbox folder. To do this you need to modify the part of the script that enumerates each of the Items so instead of writing the object to the pipeline it does some summarizations. I've added some lines in that uses a HashTable to compile the statistics on Email Domains and then writes out and sorts those values in the last line.

do{    
    $fiItems = $service.FindItems($SubFolderId,$ivItemView)   
 Write-Host ("Processed " + $fiItems.Items.Count)
    #[Void]$service.LoadPropertiesForItems($fiItems,$ItemPropset)  
    foreach($Item in $fiItems.Items){      
  #Process Item
  $EmailAddress = new-object System.Net.Mail.MailAddress($Item.Sender.Address)
  if($rptCollection.ContainsKey($EmailAddress.Host))
  {
   $rptCollection[$EmailAddress.Host].NumberOfItems +=1
   $rptCollection[$EmailAddress.Host].SizeOfItems = $Item.Size
  }
  else
  {
   $rptObj = "" | select Domain,NumberOfItems,SizeOfItems
   $rptObj.Domain = $EmailAddress.Host
   $rptObj.NumberOfItems = 1
   $rptObj.SizeOfItems = $Item.Size
   $rptCollection.Add($EmailAddress.Host,$rptObj)
  }
    }    
    $ivItemView.Offset += $fiItems.Items.Count    
}while($fiItems.MoreAvailable -eq $true) 
Write-Output $rptCollection.Values | Sort-Object -Property NumberOfItems -Descending
}

I've posted this script on GitHub https://github.com/gscales/Powershell-Scripts/blob/master/EnumerateItemsInFolder.ps1


Popular posts from this blog

Testing and Sending email via SMTP using Opportunistic TLS and oAuth in Office365 with PowerShell

As well as EWS and Remote PowerShell (RPS) other mail protocols POP3, IMAP and SMTP have had OAuth authentication enabled in Exchange Online (Official announcement here ). A while ago I created  this script that used Opportunistic TLS to perform a Telnet style test against a SMTP server using SMTP AUTH. Now that oAuth authentication has been enabled in office365 I've updated this script to be able to use oAuth instead of SMTP Auth to test against Office365. I've also included a function to actually send a Message. Token Acquisition  To Send a Mail using oAuth you first need to get an Access token from Azure AD there are plenty of ways of doing this in PowerShell. You could use a library like MSAL or ADAL (just google your favoured method) or use a library less approach which I've included with this script . Whatever way you do this you need to make sure that your application registration  https://docs.microsoft.com/en-us/azure/active-directory/develop/quickstart-register-

How to test SMTP using Opportunistic TLS with Powershell and grab the public certificate a SMTP server is using

Most email services these day employ Opportunistic TLS when trying to send Messages which means that wherever possible the Messages will be encrypted rather then the plain text legacy of SMTP.  This method was defined in RFC 3207 "SMTP Service Extension for Secure SMTP over Transport Layer Security" and  there's a quite a good explanation of Opportunistic TLS on Wikipedia  https://en.wikipedia.org/wiki/Opportunistic_TLS .  This is used for both Server to Server (eg MTA to MTA) and Client to server (Eg a Message client like Outlook which acts as a MSA) the later being generally Authenticated. Basically it allows you to have a normal plain text SMTP conversation that is then upgraded to TLS using the STARTTLS verb. Not all servers will support this verb so if its not supported then a message is just sent as Plain text. TLS relies on PKI certificates and the administrative issue s that come around certificate management like expired certificates which is why I wrote th

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 Graph is limited to a m
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.