Outlook Add-in: Using RoamingSettings to store add-in state in a user's mailbox

Code Sample
06/29/2021

Summary

Scream into the void is a Microsoft Outlook add-in that lets you rant about the email you are reading. This sample also demonstrates the use of RoamingSettings, a feature of Outlook add-ins to store roaming data in the user's mailbox.

Required tools

How to install

Clone this repository.
Run npm install to install both npm and Bower dependencies.
Run gulp serve-static to start development server.
Go to mail.office365.com and sign in with your Microsoft Office 365 account. If you don't have one, join the Office 365 Developer Program and get a free 1 year subscription to Office 365.
Click the gear icon for the Settings menu on the nav bar, and then choose Manage add-ins.
Click the plus (+) icon, and then choose Add from a file.
Browse to this repository folder and choose manifest-outlook-add-in-scream.xml.
Complete the wizard (Next, Install, OK) to make the Add-in available on your Office 365 account.
Open the app in a browser and trust the certificate for localhost:8443. The add-in won't run if your computer doesn't trust it.

How to run

After installing the add-in, go to mail.office365.com.
Open an email.
Click Add-ins at the top of the window to see available add-ins and choose Scream into the void.

Troubleshooting

If the add-in doesn't appear in the task pane, choose Insert > My Add-ins > Scream into the void.

Questions and comments

If you have any trouble running this sample, please log an issue.
Questions about Microsoft Office add-ins development in general should be posted to Stack Overflow. Make sure that your questions or comments are tagged with [office-addins].

Contributing

We encourage you to contribute to our samples. For guidelines on how to proceed, see our contribution guide

This project has adopted the Microsoft Open Source Code of Conduct. For more information see the Code of Conduct FAQ or contact opencode@microsoft.com with any additional questions or comments.

Additional resources

More Add-in samples
Office Add-ins
Anatomy of an Add-in
Creating an Office add-in with Visual Studio
Yeoman generator - Yeoman generator for building Microsoft Office related projects (including Add-ins). This project was built using it.
Office UI Fabric - The front-end framework for building experiences for Office 365. This project uses it to get an Office "look and feel".
dev.office.com - Find documentation, samples, and other helpful information relevant to Office development.

Share via