Skip to main content

NDR hunt using the EWS Managed API and Powershell to find and delete NDR messages in a mailbox

While this is the time of year that we are more often concerned with hunting down round chocolate things to stuff in our gobs one endearing task most mail administrators must deal with is the management of NDR messages. NDR’s while exceedingly useful at the time a problem occurs once this time has passed their usefulness falls and they tend to become redundant fragments of information that can clutter a mailbox. Especially if you are copying these items to an administrator mailbox you can soon see the mailbox size and item count shot up exponentially if cleanups aren’t occurring on a frequent basis. Because deleting email can be a very tedious process this is something that can be easily scripted using the EWS Managed API and powershell with a few general provisos. First because in some case you maybe deleting a lot of items (eg I had to remove over 100000) using the batching features of EWS is highly desirable which will reduce the number of requests you need to make to the server and make the script run in some sort of reasonable time.

To use batching with the EWS Managed API you need to make use of generictypes which presents a little bit of challenge in Powershell v1. To get around this you need to use something like this is PS v1 to great a generic List type of EWS Items.

$Itemids = [activator]::createinstance(([type]'System.Collections.Generic.List`1').makegenerictype([Microsoft.Exchange.WebServices.Data.ItemId]))

Other important parts of this script is that with the Delete Method in exchange you can move items to the recycle bin, soft delete them or Hard delete them which method you use on a item will affect it retention and recoverability of that item. In this script because this is a example im using SoftDelete which give some chance of redemption in production once tested you probably want to switch to HardDelete.

[Microsoft.Exchange.WebServices.Data.DeleteMode]::SoftDelete

Care does need to be taken because when you hard delete an item it means generally you won’t be able to recover it except from backup.

The script uses the following searchfilter to limit the items returned to NDR’s

$Sfir = new-object Microsoft.Exchange.WebServices.Data.SearchFilter+IsEqualTo([Microsoft.Exchange.WebServices.Data.ItemSchema]::ItemClass, "REPORT.IPM.Note.NDR")

To run the script itself it takes the name of the mailbox you want to run it against as a cmdline parameter so to run it against the admin account it would take something like

./Ndrhunt.ps1 administrator

Warning this script has had no real testing and because it deletes email I advise you do your own testing first.

I've put a download of this script here the script itself look like


$MailboxName = $args[0]

function RepeartSearch{
$frFolderResult = $InboxFolder.FindItems($Sfir,$view)
$Itemids = [activator]::createinstance(([type]'System.Collections.Generic.List`1').makegenerictype([Microsoft.Exchange.WebServices.Data.ItemId]))
foreach($ndr in $frFolderResult.items){
$Itemids.add($ndr.Id)
}
if ($frFolderResult.Items.Count -ne 0){
$Result = $service.DeleteItems($Itemids,[Microsoft.Exchange.WebServices.Data.DeleteMode]::SoftDelete,[Microsoft.Exchange.WebServices.Data.SendCancellationsMode]::SendToNone,[Microsoft.Exchange.WebServices.Data.AffectedTaskOccurrence]::AllOccurrences)
[INT]$Rcount = 0
foreach ($res in $Result){
if ($res.Result -eq [Microsoft.Exchange.WebServices.Data.ServiceResult]::Success){
$Rcount++
}
}
$Rcount.ToString() + " Items Deleted"
if ($frFolderResult.Items.Count -eq 1000) {
RepeartSearch
}
}
else{
"No Items to delete"
}

}

$dllpath = "C:\Program Files\Microsoft\Exchange\Web Services\1.0\Microsoft.Exchange.WebServices.dll"
[void][Reflection.Assembly]::LoadFile($dllpath)
$service = New-Object Microsoft.Exchange.WebServices.Data.ExchangeService([Microsoft.Exchange.WebServices.Data.ExchangeVersion]::Exchange2007_SP1)

$windowsIdentity = [System.Security.Principal.WindowsIdentity]::GetCurrent()
$sidbind = "LDAP://<SID=" + $windowsIdentity.user.Value.ToString() + ">"
$aceuser = [ADSI]$sidbind

$service.AutodiscoverUrl($aceuser.mail.ToString())

$folderid = new-object Microsoft.Exchange.WebServices.Data.FolderId([Microsoft.Exchange.WebServices.Data.WellKnownFolderName]::Inbox,$MailboxName)
$InboxFolder = [Microsoft.Exchange.WebServices.Data.Folder]::Bind($service,$folderid)
$Sfir = new-object Microsoft.Exchange.WebServices.Data.SearchFilter+IsEqualTo([Microsoft.Exchange.WebServices.Data.ItemSchema]::ItemClass, "REPORT.IPM.Note.NDR")
$view = new-object Microsoft.Exchange.WebServices.Data.ItemView(1000)
$frFolderResult = $InboxFolder.FindItems($Sfir,$view)

$Itemids = [activator]::createinstance(([type]'System.Collections.Generic.List`1').makegenerictype([Microsoft.Exchange.WebServices.Data.ItemId]))
foreach($ndr in $frFolderResult.items){
$Itemids.add($ndr.Id)
}
if ($frFolderResult.Items.Count -ne 0){
$Result = $service.DeleteItems($Itemids,[Microsoft.Exchange.WebServices.Data.DeleteMode]::SoftDelete,[Microsoft.Exchange.WebServices.Data.SendCancellationsMode]::SendToNone,[Microsoft.Exchange.WebServices.Data.AffectedTaskOccurrence]::AllOccurrences)
[INT]$Rcount = 0
foreach ($res in $Result){
if ($res.Result -eq [Microsoft.Exchange.WebServices.Data.ServiceResult]::Success){
$Rcount++
}
}
$Rcount.ToString() + " Items Deleted"
if ($frFolderResult.Items.Count -eq 1000) {
RepeartSearch
}
}
else{
"No Items to delete"
}

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-

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

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
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.