Monday, February 21, 2011

Exporting and Uploading Mailbox Items using Exchange Web Services using the new ExportItems and UploadItems operations in Exchange 2010 SP1

Two new EWS Operations ExportItems and UploadItems where introduced in Exchange 2010 SP1 that allowed you to do a number of useful things that where previously not possible using Exchange Web Services. Any object that Exchange stores is basically a collection of properties for example a message object is a collection of Message properties, Recipient properties and Attachment properties with a few meta properties that describe the underlying storage thrown in. Normally when using EWS you can access these properties in a number of a ways eg one example is using the strongly type objects such as emailmessage that presents the underlying properties in an intuitive way that's easy to use. Another way is using Extended Properties to access the underlying properties directly. However previously in EWS there was no method to access every property of a message hence there is no way to export or import an item and maintain full fidelity of every property on that item (you could export the item as an EML but this doesn't provide any fidelity of the properties on item).

Now with these two new operations there is a method of exporting and uploading items and maintaining all the Mapi properties. The only real restriction is by default the maximum import payload is 25MB of base64 encoded data but these setting can be modified in the web.config file. The export/import format that these two operations use in a stream format which is a stream of all the Exchange properties separated with meta properties to represent the different property collections on the Item. This format while it bares some similarity to TNEF and Compound Message format (MSG) is not the same.

There are no methods in the EWS Managed API to use these operations so you need to use EWS Proxy code or just raw SOAP when writing applications or script to use this. However you do need the EWSid's of the Items and Folder to upload or export items and the Managed API is the easiest way of getting these. For this post I've create a sample of exporting the last received item in the Inbox first using the EWS Managed API to find the last item and then use raw SOAP to export the items.

I posted a downloadable copy of the following EWS Managed API script here the code itself looks like

$MailboxName = "mailbox@domain.com"
$fileName = 'c:\exp.fts'
$cred = New-Object System.Net.NetworkCredential("username@domain.com","password")

$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]::Exchange2010_SP1)
$service.TraceEnabled = $false

$windowsIdentity = [System.Security.Principal.WindowsIdentity]::GetCurrent()
$sidbind = "LDAP://<SID=" + $windowsIdentity.user.Value.ToString() + ">"
$aceuser = [ADSI]$sidbind
$service.Credentials = $cred
$service.autodiscoverurl($MailboxName,{$true})

$folderid = new-object Microsoft.Exchange.WebServices.Data.FolderId([Microsoft.Exchange.WebServices.Data.WellKnownFolderName]::Inbox,$MailboxName)

$view = New-Object Microsoft.Exchange.WebServices.Data.ItemView(1)
$findResults = $service.FindItems($folderid,$view)
$itemid = $findResults.Items[0].Id.Uniqueid

$expRequest = @"
<?xml version="1.0" encoding="utf-8" ?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xmlns:xsd="http://www.w3.org/2001/XMLSchema"
xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/"
xmlns:t="http://schemas.microsoft.com/exchange/services/2006/types"
xmlns:m="http://schemas.microsoft.com/exchange/services/2006/messages">
<soap:Header>
<t:RequestServerVersion Version="Exchange2010_SP1" />
</soap:Header>
<soap:Body>
<m:ExportItems>
<m:ItemIds>
<t:ItemId Id="$itemId"/>
</m:ItemIds>
</m:ExportItems>
</soap:Body>
</soap:Envelope>
"@
$mbMailboxFolderURI = New-Object System.Uri($service.url)
$wrWebRequest = [System.Net.WebRequest]::Create($mbMailboxFolderURI)
$wrWebRequest.KeepAlive = $false;
$wrWebRequest.Headers.Set("Pragma", "no-cache");
$wrWebRequest.Headers.Set("Translate", "f");
$wrWebRequest.Headers.Set("Depth", "0");
$wrWebRequest.ContentType = "text/xml";
$wrWebRequest.ContentLength = $expRequest.Length;
$wrWebRequest.Timeout = 60000;
$wrWebRequest.Method = "POST";
$wrWebRequest.Credentials = $cred
$bqByteQuery = [System.Text.Encoding]::ASCII.GetBytes($expRequest);
$wrWebRequest.ContentLength = $bqByteQuery.Length;
$rsRequestStream = $wrWebRequest.GetRequestStream();
$rsRequestStream.Write($bqByteQuery, 0, $bqByteQuery.Length);
$rsRequestStream.Close();
$wrWebResponse = $wrWebRequest.GetResponse();
$rsResponseStream = $wrWebResponse.GetResponseStream()
$sr = new-object System.IO.StreamReader($rsResponseStream);
$rdResponseDocument = New-Object System.Xml.XmlDocument
$rdResponseDocument.LoadXml($sr.ReadToEnd());
$Datanodes = @($rdResponseDocument.getElementsByTagName("m:Data"))
if ($Datanodes.length -ne 0){
$Data = [System.Convert]::FromBase64String($Datanodes[0].'#text')
$fsFileStream = new-object system.io.filestream $fileName, ([io.filemode]::create), ([io.fileaccess]::write), ([io.fileshare]::none)
$fsFileStream.Write($Data, 0, $Data.Length);
$fsFileStream.Close();
}

Tuesday, February 08, 2011

Creating Inbox Rules with the EWS Managed API in Exchange 2010 SP1 with Powershell

One of the new features that was added in Exchange Web Services in 2010 SP1 (and improved in the Exchange Management Shell) was the ability to add Inbox Rules. Previously the only method for doing this programatically was a variety of Mapi methods some of which where not particular easy to use. Using the Exchange Management Shell New-InboxRule, Get-InboxRule and Set-InboxRule cmdlets offers an easy one-liner approach for the Admin but if you want to run your code as a non admin or you want to take advantage of EWS Impersonation to create rules on behalf of the user then Exchange Web Services is a good option for this.

There are 3 major components to rules
  • RuleConditions
  • RuleExceptions (Optional)
  • RuleActions
Rule Conditions and Exceptions are essential the same they use the same objecttype RulePredicates the difference is that the conditions in ruleconidtions dictate what items a rule fires on and the exceptions dictates the conditions it doesn't fire on.

With both the RulePredicates and RuleActions to cater for actions such as moving items, replying with an auto response etc you will need to use other EWS operations to find the EWSID's of the particular folder or autoreply message you want to work with so this will require the use of other code. Also for conditions if you have used an email address the address's stored in rule objects are in EX type so using the EWS Resolve names operations can be useful to resolve the name back to an SMTP Address or users displayName.

The following example shows how to create a Move rule based on the Subject of a message it uses a function to find the EWS folderid of the folder to move the message to. Note this script could be easily adapted to instead of using the Subject to move the message move the message based on a X-header eg by modifying the following line

$nrNewRule.Conditions.ContainsHeaderStrings.Add("X-SpamScore: 7");

For the straight EWS Managed API powershell version I've put a download of this script here the code itself looks like

$mailbox = "user@domain.com"
$fldname = "\\Inbox\Sales"

Function FindTargetFolder($FolderPath){
$tfTargetFolder = [Microsoft.Exchange.WebServices.Data.Folder]::Bind($service,[Microsoft.Exchange.WebServices.Data.WellKnownFolderName]::MsgFolderRoot,$mailbox)
$pfArray = $FolderPath.Split("\")
for ($lint = 2; $lint -lt $pfArray.Length; $lint++) {
$pfArray[$lint]
$fvFolderView = new-object Microsoft.Exchange.WebServices.Data.FolderView(1)
$SfSearchFilter = new-object Microsoft.Exchange.WebServices.Data.SearchFilter+IsEqualTo([Microsoft.Exchange.WebServices.Data.FolderSchema]::DisplayName,$pfArray[$lint])
$findFolderResults = $service.FindFolders($tfTargetFolder.Id,$SfSearchFilter,$fvFolderView)
if ($findFolderResults.TotalCount -gt 0){
foreach($folder in $findFolderResults.Folders){
$tfTargetFolder = $folder
}
}
else{
"Error Folder Not Found"
$tfTargetFolder = $null
break
}
}
$Global:findFolder = $tfTargetFolder
}

$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]::Exchange2010_SP1)
$service.TraceEnabled = $false

$windowsIdentity = [System.Security.Principal.WindowsIdentity]::GetCurrent()
$sidbind = "LDAP://<SID=" + $windowsIdentity.user.Value.ToString() + ">"
$aceuser = [ADSI]$sidbind
$service.autodiscoverurl($mailbox,{$true})

$irInboxRules = service.GetInboxRules

$nrNewRule = New-Object Microsoft.Exchange.WebServices.Data.Rule
$nrNewRule.DisplayName = "Move all Mails with Sales Reports in Subject"
$nrNewRule.Conditions.ContainsSubjectStrings.Add("Sales Reports");

FindTargetFolder($fldname)

$nrNewRule.Actions.MoveToFolder = $Global:findFolder.Id.UniqueId

$RuleOperation = New-Object Microsoft.Exchange.WebServices.Data.createRuleOperation[] 1
$RuleOperation[0] = $nrNewRule

$service.UpdateInboxRules($RuleOperation,$irInboxRules.OutlookRuleBlobExists)