Skip to content

Latest commit

 

History

History
 
 

outlook-tutorial

Folders and files

NameName
Last commit message
Last commit date

parent directory

..
Git the gist
Git the gist
 
 
README.md
README.md
 
 

README.md

page_type urlFragment products languages extensions description
sample
office-outlook-add-in-tutorial
office-outlook
m365
javascript
contentType technologies createdDate
samples
Add-ins
09/12/2023 4:00:00 PM
A completed version of the step-by-step Outlook tutorial hosted on learn.microsoft.com.

Outlook Tutorial - Completed

Summary

This sample is the result of completing the Tutorial: Build a message compose Outlook add-in. It was constructed with the Yeoman generator for Office Add-ins.

The tutorial gives step-by-step instructions on how to add functionality alongside explanations as to why code is being added. Use this sample if you want to explore and try the completed code, or if you need to debug any issues you encountered while following the tutorial.

Features

This sample demonstrates the basics of working with a compose message in Outlook. The functions collect information from the user, fetch data from an external service, implement a function command, and implement a task pane that inserts content into the body of a message. The sample also shows how to use a dialog box.

Applies to

  • Outlook on Windows
  • Outlook on Mac
  • Outlook on the web

Prerequisites

Solution

Solution Author(s)
Learn the basics of Outlook add-ins Microsoft

Version history

Version Date Comments
1.0 9-12-2023 Initial release

Run the sample

  1. Fork and download this repo.

  2. Go to the Samples/tutorials/outlook-tutorial/Git the gist folder via the command line.

  3. Run npm install.

  4. Start the local web server and sideload your add-in.

    • To test your add-in in Outlook, run the following command in the root directory of your Git the gist project. This starts the local web server (if it's not already running) and opens Outlook with your add-in loaded.

      npm start

      If your add-in doesn't sideload in Outlook, manually sideload it by following the instructions in Sideload Outlook add-ins for testing.

  5. In Outlook, compose a new message.

  6. In the message window, choose the Insert default gist button in the ribbon. This opens a dialog where you add your GitHub username and select the default gist.

    In Outlook on Windows, you may need to close and reopen the new message window to pick up the latest settings from the dialog.

  7. In the message window, choose the Insert gist button in ribbon. This opens a task pane where you select the GitHub gist you want to insert into the message body.

See also

The version of this sample that you create step-by-step is found in the article Tutorial: Build a message compose Outlook add-in.

Copyright

Copyright (c) 2023 Microsoft Corporation. All rights reserved.

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.