Docs API Reference

Context.roamingSettings property

Gets an object that represents the custom settings or state of a Outlook add-in saved to a user's mailbox.

Hosts: Outlook
Available in Requirement set Mailbox
Last changed in 1.0
var appSettings = office.context.roamingSettings;

Return value

A RoamingSettings object.


The RoamingSettings object lets you store and access data for a Outlook add-in that is stored in a user's mailbox, so that is available to that add-in when it is running from any host client application used to access that mailbox.

Support details

A capital Y in the following matrix indicates that this method is supported in the corresponding Office host application. An empty cell indicates that the Office host application doesn't support this method.

For more information about Office host application and server requirements, see Requirements for running Office Add-ins.

Office for Windows desktop Office Online (in browser) Outlook for Mac
Outlook Y Y Y
Available in requirement sets Mailbox
Minimum permission level Restricted
Add-in types Outlook
Library Office.js
Namespace Office

Support history

Version Changes
1.0 Introduced