Skip to main content

Displaying the OOF log in a mailbox using Exchange Web Services and Powershell

On a Exchange 2007 and 2010 when changes are made to the Out of Office setting these changes are logged into an Item sitting in the Non_IPM_Subtree folder of a mailbox which has a message class of IPM.Microsoft.OOF.Log .

The log of changes is written to the body of this message and can be useful if for any reason you need a historical record of the oof setting for a particular mailbox. For instance if someone set an inappropriate OOF message and you need some evidence of this. You could also sequence this data to get picture over a certain time period of what users had their oof set and for how long it was enabled and did it say anything useful.

I've put together a script to show how to get at this log using the EWS Managed API and powershell and I've also included a parser to parse the log entries into an object to make it easier to export this data to csv or email etc.

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

$MailboxName = "user@domain"
$rptCollection = @()

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


$windowsIdentity = [System.Security.Principal.WindowsIdentity]::GetCurrent()
$sidbind = "LDAP://<SID=" + $windowsIdentity.user.Value.ToString() + ">"
$aceuser = [ADSI]$sidbind
# $service.Credentials = New-Object System.Net.NetworkCredential("user","password")
$service.AutodiscoverUrl($MailboxName ,{$true})

$nonipmRoot = new-object Microsoft.Exchange.WebServices.Data.FolderId([Microsoft.Exchange.WebServices.Data.WellKnownFolderName]::Root,$MailboxName)
$ivItemView = new-object Microsoft.Exchange.WebServices.Data.ItemView(2)
$sfSearchFilter = new-object Microsoft.Exchange.WebServices.Data.SearchFilter+IsEqualTo([Microsoft.Exchange.WebServices.Data.ItemSchema]::ItemClass, "IPM.Microsoft.OOF.Log")
$psPropertySet = new-object Microsoft.Exchange.WebServices.Data.PropertySet([Microsoft.Exchange.WebServices.Data.BasePropertySet]::FirstClassProperties)
$psPropertySet.RequestedBodyType = [Microsoft.Exchange.WebServices.Data.BodyType]::Text;
$fiItems = $service.finditems($nonipmRoot,$sfSearchFilter,$ivItemView)
foreach($itItem in $fiItems.Items){

$itItem.load($psPropertySet)
$itItem.Body.Text.Split("`r") | ForEach-Object{
$line = $_
if($line.indexof("Mailbox:")-gt 0){
$elen = $line.indexof("Mailbox:")
if($elen -gt 0){
$datetime = $line.SubString(1,$elen-3)
}
}
if($line.indexof("Mailbox:")-gt 0){
$slen = $line.indexof("Mailbox:")
$elen = $line.indexof("OofState:",$slen)
if($slen -gt 0){
$slen += 10
$mailbox = $line.SubString($slen,($elen-$slen)-3)
}
}
if($line.indexof("OofState:")-gt 0){
$slen = $line.indexof("OofState:")
$elen = $line.indexof("ExternalAudience:",$slen)
if($slen -gt 0){
$slen += 10
$OofState = $line.SubString($slen,($elen-$slen)-2)
}
}
if($line.indexof("ExternalAudience:")-gt 0){
$slen = $line.indexof("ExternalAudience:")
$elen = $line.indexof("InternalReply:",$slen)
if($slen -gt 0){
$slen += 18
$ExternalAudience = $line.SubString($slen,($elen-$slen)-2)
}
}
if($line.indexof("InternalReply:")-gt 0){
$slen = $line.indexof("InternalReply:")
$elen = $line.indexof("ExternalReply:",$slen)
if($slen -gt 0){
$slen += 15
$InternalReply = $line.SubString($slen,($elen-$slen)-2)
}
}
if($line.indexof("ExternalReply:")-gt 0){
$slen = $line.indexof("ExternalReply:")
$elen = $line.indexof("SetByLegacyClient:",$slen)
if($slen -gt 0){
$slen += 15
$ExternalReply = $line.SubString($slen,($elen-$slen)-2)
}
}
if($line.indexof("SetByLegacyClient:")-gt 0){
$slen = $line.indexof("SetByLegacyClient:")
$elen = $line.indexof("comment:")
if($slen -gt 0){
$slen += 20
$SetByLegacyClient = $line.SubString($slen,($elen-$slen)-3)
}
}
if($line.indexof("comment:")-gt 0){
$slen = $line.indexof("comment")
$elen = $line.indexof("'",$slen)
if($slen -gt 0){
$slen += 9
$comment = $line.SubString($slen,($elen-$slen))
}
}
$mbcomb = "" | select datetime,mailbox,OofState,ExternalAudience,InternalReply,ExternalReply,SetByLegacyClient,comment
$mbcomb.datetime = $datetime
$mbcomb.mailbox = $mailbox
$mbcomb.OofState = $OofState
$mbcomb.ExternalAudience = $ExternalAudience
$mbcomb.InternalReply = $InternalReply
$mbcomb.ExternalReply = $ExternalReply
$mbcomb.SetByLegacyClient = $SetByLegacyClient
$mbcomb.comment = $comment
$rptCollection += $mbcomb
}
}
$rptCollection

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

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.

Export calendar Items to a CSV file using Microsoft Graph and Powershell

For the last couple of years the most constantly popular post by number of views on this blog has been  Export calendar Items to a CSV file using EWS and Powershell closely followed by the contact exports scripts. It goes to show this is just a perennial issue that exists around Mail servers, I think the first VBS script I wrote to do this type of thing was late 90's against Exchange 5.5 using cdo 1.2. Now it's 2020 and if your running Office365 you should really be using the Microsoft Graph API to do this. So what I've done is create a PowerShell Module (and I made it a one file script for those that are more comfortable with that format) that's a port of the EWS script above that is so popular. This script uses the ADAL library for Modern Authentication (which if you grab the library from the PowerShell gallery will come down with the module). Most EWS properties map one to one with the Graph and the Graph actually provides better information on recurrences then...
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.