Skip to content
This repository was archived by the owner on Mar 13, 2020. It is now read-only.

Commit 72d59c7

Browse files
committed
Added README
1 parent 125e717 commit 72d59c7

File tree

3 files changed

+55
-0
lines changed

3 files changed

+55
-0
lines changed

README.md

Lines changed: 55 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,55 @@
1+
# Getting Started with the Outlook Mail API and Node.js #
2+
3+
This sample app is the result of following the tutorial at [https://docs.microsoft.com/en-us/outlook/rest/node-tutorial](https://docs.microsoft.com/en-us/outlook/rest/node-tutorial). If you follow that tutorial, you should come up with something fairly close to the code in this repository.
4+
5+
> **NOTE:** Looking for the version of this tutorial that used the Outlook API directly instead of Microsoft Graph? Check out the `outlook-api` branch. Note that Microsoft recommends using the Microsoft Graph to access mail, calendar, and contacts. You should use the Outlook APIs directly (via https://outlook.office.com/api) only if you require a feature that is not available on the Graph endpoints.
6+
7+
## Prerequisites
8+
9+
- Node.js installed and working on your development machine.
10+
- An Office 365 tenant, with access to an administrator account in that tenant, **OR** an Outlook.com account.
11+
12+
## Running the sample
13+
14+
If you didn't follow the tutorial and just want to download this repo and try it out, you need to do a few things first.
15+
16+
## Register the app
17+
18+
Before we proceed, we need to register our app to obtain a client ID and secret. Head over to https://apps.dev.microsoft.com to quickly get a client ID and secret. Using the sign in buttons, sign in with either your Microsoft account (Outlook.com), or your work or school account (Office 365).
19+
20+
Once you're signed in, click the **Add an app** button. Enter `node-tutorial` for the name and click **Create application**. After the app is created, locate the **Application Secrets** section, and click the **Generate New Password** button. Copy the password now and save it to a safe place. Once you've copied the password, click **Ok**.
21+
22+
![The new password dialog.](readme-images/new-password.PNG)
23+
24+
Locate the **Platforms** section, and click **Add Platform**. Choose **Web**, then enter `http://localhost:3000/authorize` under **Redirect URIs**. Click **Save** to complete the registration. Copy the **Application Id** and save it along with the password you copied earlier. We'll need those values soon.
25+
26+
Here's what the details of your app registration should look like when you are done.
27+
28+
![The completed registration properties.](readme-images/node-tutorial.PNG)
29+
30+
## Configure the sample
31+
32+
Rename the `sample.env` file to `.env`. Replace the `YOUR APP ID HERE` with the application ID and `YOUR APP PASSWORD HERE` with the password you generated and save your changes.
33+
34+
Open your command prompt or shell and enter the following command to install dependencies.
35+
36+
```Shell
37+
npm install
38+
```
39+
40+
## Run the sample
41+
42+
Open your command prompt or shell and enter the following command.
43+
44+
```Shell
45+
npm start
46+
```
47+
48+
## Copyright ##
49+
50+
Copyright (c) Microsoft. All rights reserved.
51+
52+
----------
53+
Connect with me on Twitter [@JasonJohMSFT](https://twitter.com/JasonJohMSFT)
54+
55+
Follow the [Outlook/Exchange Dev Blog](https://blogs.msdn.microsoft.com/exchangedev/)

readme-images/new-password.PNG

8.13 KB
Loading

readme-images/node-tutorial.PNG

30.5 KB
Loading

0 commit comments

Comments
 (0)