Tuesday, June 21, 2016

EWS Basics: Message Flagging and Marking Messages Read/Unread

Messages that are stored in Exchange can be flagged in a number of ways to indicate different states to the user or as an effective method to prompt the user to action (or make them remember to do something).

Unread/Read Flags

 The most commonly used Flag in Exchange is the Unread/Read Message flag which is used so when a message arrives in Mailbox a user can track which messages they have read. In EWS this flag is surfaced in the API in the form of a Strongly type property isRead  https://msdn.microsoft.com/en-us/library/office/bb408987(v=exchg.150).aspx . (The underlying Store property that back this is PidTagMessageFlags property https://msdn.microsoft.com/en-us/library/ee160304(v=exchg.80).aspx  which is a bitwise flag representing many states of a message).

The other place the Unread Message flag is surfaced is on the Folder object in the guise of the Unread Item count. So in the below example we Bind to Inbox folder and we can look at the Total Number of Items in a Folder and the Total number of those that are unread

$folderid= new-object Microsoft.Exchange.WebServices.Data.FolderId([Microsoft.Exchange.WebServices.Data.WellKnownFolderName]::Inbox,$MailboxName)     
$Inbox = [Microsoft.Exchange.WebServices.Data.Folder]::Bind($service,$folderid) 
Write-Host ("Total Message Count : " + $Inbox.TotalCount)
Write-Host ("Total Unread Message Count : " +$Inbox.UnreadCount)


Marking all Messages in a Folder Read

One of the new features added to EWS in 2013 was an operation that allows you to mark all messages as read in a folder. Also with the other important feature of being able to suppress Read Receipts when you do so. Eg the following is a function that will Mark all the Messages in a Folder as Read and Suppress Read Recipients.

$folderId = FolderIdFromPath -FolderPath $FolderPath -SmtpAddress $MailboxName
if($folderId -ne $null){
 $Folder = [Microsoft.Exchange.WebServices.Data.Folder]::Bind($service,$folderId) 
 Write-Host ("Total Message Count : " + $Folder.TotalCount)
 Write-Host ("Total Unread Message Count : " +$Folder.UnreadCount)
 Write-Host ("Marking all messags a unread in folder")
 $Folder.MarkAllItemsAsRead($true)
}

Marking just one message as Read

To mark just the current message your enumerating in a function as Read as you need to do is use the isRead Strongly typed property eg the mark the last message received in a Mailbox read

$folderid= new-object Microsoft.Exchange.WebServices.Data.FolderId([Microsoft.Exchange.WebServices.Data.WellKnownFolderName]::Inbox,$MailboxName)     
$Inbox = [Microsoft.Exchange.WebServices.Data.Folder]::Bind($service,$folderid) 
$ivItemView =  New-Object Microsoft.Exchange.WebServices.Data.ItemView(1)
$fiItems = $service.FindItems($Inbox.Id,$ivItemView)
if($fiItems.Items.Count -eq 1)
{
      $fiItems.Items[0].isRead = $true
      $fiItems.Items[0].Update([Microsoft.Exchange.WebServices.Data.ConflictResolutionMode]::AutoResolve);     
}     

All these example are in the following GitHub Script https://github.com/gscales/Powershell-Scripts/blob/master/unReadModule.ps1

Flagging a Message for Follow-up

Flagging a Message for follow-up is a common task you might do it to remind you that a message needs some other actions on it after you have read it (eg you need to phone the sender etc). In 2013 some strongly type properties where added to help read and set the follow-up flags. However these don't cover all the possible flag properties (listed here) you might want to set when setting a followup in particular the followup Text (eg the custom option in Outlook). To cater for this you can use a combination of Extended property's and the strongly typed properties. Eg To flag the last message with a follow-up to call the sender in 1 hour you can use the following

$FlagRequest = New-Object Microsoft.Exchange.WebServices.Data.ExtendedPropertyDefinition([Microsoft.Exchange.WebServices.Data.DefaultExtendedPropertySet]::Common, 0x8530,[Microsoft.Exchange.WebServices.Data.MapiPropertyType]::String);  
$PR_FLAG_ICON = New-Object Microsoft.Exchange.WebServices.Data.ExtendedPropertyDefinition(0x1095,[Microsoft.Exchange.WebServices.Data.MapiPropertyType]::Integer);  
$folderid= new-object Microsoft.Exchange.WebServices.Data.FolderId([Microsoft.Exchange.WebServices.Data.WellKnownFolderName]::Inbox,$MailboxName)     
$Inbox = [Microsoft.Exchange.WebServices.Data.Folder]::Bind($service,$folderid) 
$ivItemView =  New-Object Microsoft.Exchange.WebServices.Data.ItemView(1)
$fiItems = $service.FindItems($Inbox.Id,$ivItemView)
if($fiItems.Items.Count -eq 1)
{
       $fiItems.Items[0].Flag.FlagStatus = [Microsoft.Exchange.WebServices.Data.ItemFlagStatus]::Flagged;
       $fiItems.Items[0].Flag.DueDate = $DueDate
       $fiItems.Items[0].Flag.StartDate = (Get-Date)
       $fiItems.Items[0].SetExtendedProperty($FlagRequest,$FollowupText)
       $fiItems.Items[0].SetExtendedProperty($PR_FLAG_ICON,$Color)
       $fiItems.Items[0].Update([Microsoft.Exchange.WebServices.Data.ConflictResolutionMode]::AutoResolve);     
}     

This example is covered in the following GitHub Script https://github.com/gscales/Powershell-Scripts/blob/master/flaggfollowup.ps1

Sender Flags are a more advanced Outlook feature that allows you to transmit a specific flag to a recipient with the message. There is no support in EWS for setting this type of flag but I have another workaround solution I've published before for this http://gsexdev.blogspot.com.au/2013/12/using-sender-flags-in-ews.html