Search code examples
c#outlookoutlook-addin

Outlook OpenSharedItem lose User properties


I'm trying to store some data in the user properties, then write the mail to a .msg file, and (later) reload the .msg file to read the user property.

The problem is: after reloading the file, I don't have any user property any more.

I'm using Outlook 2010 32 bit

Here is a piece of code that show the behaviour:

Outlook.MailItem originalItem = ((MailItemWrapper)this.Item)._item;

var path = System.IO.Path.GetTempFileName() + ".msg";
var propName = "ActionId123456789";

// Set a user property "ActionId" with value "test"
var ps = originalItem.UserProperties;
var p = ps.Find(propName);
if (p == null)
    p = ps.Add(propName, Outlook.OlUserPropertyType.olText, Type.Missing);
p.Value = "test";

// Save to a temp file
originalItem.Save(); // --> I also tried without this line
originalItem.SaveAs(path);

// Chech the the property is correctly set
p = originalItem.UserProperties[propName];
if (p != null)
    Console.WriteLine(p.Value); // ---> Show 'test'

// Open the temp file
Outlook.MailItem newItem = AddinModule.CurrentInstance.OutlookApp.Session.OpenSharedItem(path) as Outlook.MailItem;

// Check that the property still exists
p = newItem.UserProperties[propName];
if (p != null)
    Console.WriteLine(p.Value); // ---> Not executed: p is NULL !

Does someone know how to do this ?

Instead of using OpenSharedItem, I also tried opening the mail using Process.Start, but in this case the user property is also null ...

BTW this piece of code is a test sample, so it doesn't dispose properly all COM references.


Solution

  • Ok I've found a solution that seems to works. For this, I need to use a 3rd party : Redemption.

    The solution is to use a custom MAPI property, not the UserProperties collection. In the code below, "this._item" reference the Outlook.MailItem object you need to get/set the property

    To do this, you need a Guid, always the same for your add-in

    private const string customPropId = "{XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX}";
    

    To set the property

    public void SetCustomProperty(string propertyName, string propertyValue)
    {
        var sfe = new SafeMailItem() { Item = this._item };
        var propId = sfe.GetIDsFromNames(customPropId, propertyName);
        sfe.set_Fields(propId, propertyValue);
    }
    

    To get the property:

    public string GetCustomProperty(string propertyName)
    {
        var sfe = new SafeMailItem() { Item = this._item };
        var propId = sfe.GetIDsFromNames(customPropId, propertyName);
    
        var value = sfe.get_Fields(propId);
        if (value != null)
            return value.ToString();
    
        return null;
    }
    

    That's it

    warning: I've not yet tested this code in a real situation, it only works in the same test case than the one posted in my question