Skip to main content

Setting properties via EWS on a Draft message in a Compose Mail App

With the latest updates that have been released recently for Compose apps that are now available in OWA in Office365 and the Office/Exchange 16 preview the ability to extend what your compose apps can do has been greatly enhanced. With version 1.3 of the API you can now save an Item via the saveAsync method https://msdn.microsoft.com/en-us/library/office/mt269096.aspx .

Why this small change is important from an extensibility point of view is that when you save an Item this way, it creates a draft in the Mailbox you activated the compose app from which you can then modify anyway you like using the EWS updateItem operation. (normally you would be restricted in a compose app to just using the subset of properties and methods provided for in the Office.js).

One trick however is the ItemId which you need to make an UpdateItem EWS Request to update the Draft Item is still only available in Read Mode. So to get around this I've come up with the following workaround

  1. Set a custom property on the draft Item using the Mail App Custom properties method using something like https://msdn.microsoft.com/EN-US/library/office/fp142263.aspx . With my Mail Apps I generate a new GUID for the app session that I use as the value.
  2. Save the Item your composing as a Draft using saveAync
  3. Now you can use makeEwsRequestAsync to do a findItems on the drafts folder of the Mailbox with a restriction so it only finds the Item with the Custom property you have set. The Custom properties you can set in the Mail App API are documented in https://msdn.microsoft.com/en-us/library/hh968549(v=exchg.80).aspx . But basically what you have is they are a named property within the PS_PUBLIC_STRING propset of type String. The property name of the property is prefixed with cecp- and rest of the property name is the GUID of your Mail Apps as defined in the application's manifest Id .
  4. Once you have the ItemId and Change key you can then use UpdateItem in EWS to update any of the extended or strongly type properties on the draft Message.
One thing to note to use this workaround your Mail App needs the ReadWriteMailbox privilege to allow the use of the EWS Operations. I've put together a sample of using this workaround in my OWA Voting button app.

Also because this is using version 1.3 of the Mail App Api you should set the requirements in the Manifest file of your application eg

  <Requirements>
    <Sets DefaultMinVersion="1.3">
      <Set MinVersion="1.3" Name="Mailbox"></Set>
    </Sets>
  </Requirements>

This will mean your Mail App will only activate in clients that support version 1.3 which means at the moment it won't activate in Outlook 2013.

Labels:

Popular posts from this blog

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

Downloading a shared file from Onedrive for business using Powershell

I thought I'd quickly share this script I came up with to download a file that was shared using One Drive for Business (which is SharePoint under the covers) with Powershell. The following script takes a OneDrive for business URL which would look like https://mydom-my.sharepoint.com/personal/gscales_domain_com/Documents/Email%20attachments/filename.txt This script is pretty simple it uses the SharePoint CSOM (Client side object Model) which it loads in the first line. It uses the URI object to separate the host and relative URL which the CSOM requires and also the SharePointOnlineCredentials object to handle the Office365 SharePoint online authentication. The following script is a function that take the OneDrive URL, Credentials for Office365 and path you want to download the file to and downloads the file. eg to run the script you would use something like ./spdownload.ps1 ' https://mydom-my.sharepoint.com/personal/gscales_domain_com/Documents/Email%20attachments/filen...
Read more

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