Office.CustomProperties interface

The CustomProperties object represents custom properties that are specific to a particular item and specific to a mail add-in for Outlook. For example, there might be a need for a mail add-in to save some data that is specific to the current email message that activated the add-in. If the user revisits the same message in the future and activates the mail add-in again, the add-in will be able to retrieve the data that had been saved as custom properties.

Because Outlook for Mac doesn't cache custom properties, if the user's network goes down, mail add-ins cannot access their custom properties.

[ API set: Mailbox 1.0 ]

Remarks

Minimum permission levelReadItem
Applicable Outlook modeCompose or read

Methods

get(name)

Returns the value of the specified custom property.

remove(name)

Removes the specified property from the custom property collection.

To make the removal of the property permanent, you must call the saveAsync method of the CustomProperties object.

saveAsync(callback, asyncContext)

Saves item-specific custom properties to the server.

You must call the saveAsync method to persist any changes made with the set method or the remove method of the CustomProperties object. The saving action is asynchronous.

It's a good practice to have your callback function check for and handle errors from saveAsync. In particular, a read add-in can be activated while the user is in a connected state in a read form, and subsequently the user becomes disconnected. If the add-in calls saveAsync while in the disconnected state, saveAsync would return an error. Your callback method should handle this error accordingly.

set(name, value)

Sets the specified property to the specified value.

The set method sets the specified property to the specified value. You must use the saveAsync method to save the property to the server.

The set method creates a new property if the specified property does not already exist; otherwise, the existing value is replaced with the new value. The value parameter can be of any type; however, it is always passed to the server as a string.

[ API set: Mailbox 1.0 ]

Method Details

get(name)

Returns the value of the specified custom property.

get(name: string): any;

Parameters

name
string

The name of the custom property to be returned.

Returns

any

The value of the specified custom property.

[Api set: Mailbox 1.0]

Remarks

Minimum permission levelReadItem
Applicable Outlook modeCompose or read

remove(name)

Removes the specified property from the custom property collection.

To make the removal of the property permanent, you must call the saveAsync method of the CustomProperties object.

remove(name: string): void;

Parameters

name
string

The name of the property to be removed.

[Api set: Mailbox 1.0]

Returns

void

Remarks

Minimum permission levelReadItem
Applicable Outlook modeCompose or read

saveAsync(callback, asyncContext)

Saves item-specific custom properties to the server.

You must call the saveAsync method to persist any changes made with the set method or the remove method of the CustomProperties object. The saving action is asynchronous.

It's a good practice to have your callback function check for and handle errors from saveAsync. In particular, a read add-in can be activated while the user is in a connected state in a read form, and subsequently the user becomes disconnected. If the add-in calls saveAsync while in the disconnected state, saveAsync would return an error. Your callback method should handle this error accordingly.

saveAsync(callback?: (result: AsyncResult<void>) => void, asyncContext?: any): void;

Parameters

callback
(result: AsyncResult<void>) => void

Optional. When the method completes, the function passed in the callback parameter is called with a single parameter of type Office.AsyncResult.

asyncContext
any

Optional. Any state data that is passed to the callback method.

[Api set: Mailbox 1.0]

Returns

void

Remarks

Minimum permission levelReadItem
Applicable Outlook modeCompose or read

set(name, value)

Sets the specified property to the specified value.

The set method sets the specified property to the specified value. You must use the saveAsync method to save the property to the server.

The set method creates a new property if the specified property does not already exist; otherwise, the existing value is replaced with the new value. The value parameter can be of any type; however, it is always passed to the server as a string.

[ API set: Mailbox 1.0 ]

set(name: string, value: string): void;

Parameters

name
string

The name of the property to be set.

value
string

The value of the property to be set.

Returns

void

Remarks

Minimum permission levelReadItem
Applicable Outlook modeCompose or read