> ## Documentation Index
> Fetch the complete documentation index at: https://nango.dev/docs/llms.txt
> Use this file to discover all available pages before exploring further.

# Outlook

> Integrate your application with the Outlook API

## 🚀 Quickstart

Connect to Outlook with Nango and see data flow in 2 minutes.

<Steps>
  <Step title="Create the integration">
    In Nango ([free signup](https://app.nango.dev)), go to [Integrations](https://app.nango.dev/dev/integrations) -> *Configure New Integration* -> *Outlook*. Nango doesn't provide a test OAuth app for Outlook yet. You'll need to set up your own by following the setup guide linked below. After that, make sure to add the OAuth client ID, secret, and scopes in the integration settings in Nango.
  </Step>

  <Step title="Authorize Outlook">
    Go to [Connections](https://app.nango.dev/dev/connections) -> *Add Test Connection* -> *Authorize*, then log in to Outlook. Later, you'll let your users do the same directly from your app.
  </Step>

  <Step title="Call the Outlook API">
    Let's make your first request to the Outlook (Microsoft Graph) API (fetch the profile of the currently signed-in user). Replace the placeholders below with your [secret key](https://app.nango.dev/dev/environment-settings), [integration ID](https://app.nango.dev/dev/integrations), and [connection ID](https://app.nango.dev/dev/connections):

    <Tabs>
      <Tab title="cURL">
        ```bash theme={null}
        curl "https://api.nango.dev/proxy/v1.0/me" \
          -H "Authorization: Bearer <NANGO-SECRET-KEY>" \
          -H "Provider-Config-Key: <INTEGRATION-ID>" \
          -H "Connection-Id: <CONNECTION-ID>"
        ```
      </Tab>

      <Tab title="Node">
        Install Nango's backend SDK with `npm i @nangohq/node`. Then run:

        ```typescript theme={null}
        import { Nango } from '@nangohq/node';

        const nango = new Nango({ secretKey: '<NANGO-SECRET-KEY>' });

        const res = await nango.get({
            endpoint: '/v1.0/me',
            providerConfigKey: '<INTEGRATION-ID>',
            connectionId: '<CONNECTION-ID>'
        });

        console.log(res.data);
        ```
      </Tab>
    </Tabs>

    Or fetch credentials with the [Node SDK](/reference/sdks/node#get-a-connection-with-credentials) or [API](/reference/api/connection/get).

    ✅ You're connected! Check the [Logs](https://app.nango.dev/dev/logs) tab in Nango to inspect requests.
  </Step>

  <Step title="Implement Nango in your app">
    Follow our [Auth implementation guide](/guides/primitives/auth) to integrate Nango in your app.

    To obtain your own production credentials, follow the setup guide linked below.
  </Step>
</Steps>

## 📚 Outlook Integration Guides

Nango maintained guides for common use cases.

* [How to register your own Outlook OAuth app](/api-integrations/outlook/how-to-register-your-own-outlook-api-oauth-app)\
  Register an OAuth app with Outlook and obtain credentials to connect it to Nango

Official docs: [Microsoft Graph API documentation](https://learn.microsoft.com/en-us/graph/overview)

## 🧩 Pre-built syncs & actions for Outlook

Enable them in your dashboard. Extend and customize to fit your needs.

### Calendar

| Function name  | Description                      | Type                                         | Source code                                                                                                          |
| -------------- | -------------------------------- | -------------------------------------------- | -------------------------------------------------------------------------------------------------------------------- |
| `delete-event` | Delete an event from a calendar. | [Action](/guides/functions/action-functions) | [🔗 Github](https://github.com/NangoHQ/integration-templates/blob/main/integrations/outlook/actions/delete-event.ts) |

### Calendars

| Function name     | Description                                 | Type                                         | Source code                                                                                                             |
| ----------------- | ------------------------------------------- | -------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------- |
| `create-calendar` | Create a secondary calendar in the mailbox. | [Action](/guides/functions/action-functions) | [🔗 Github](https://github.com/NangoHQ/integration-templates/blob/main/integrations/outlook/actions/create-calendar.ts) |
| `delete-calendar` | Delete a secondary calendar.                | [Action](/guides/functions/action-functions) | [🔗 Github](https://github.com/NangoHQ/integration-templates/blob/main/integrations/outlook/actions/delete-calendar.ts) |
| `get-calendar`    | Retrieve a calendar by ID.                  | [Action](/guides/functions/action-functions) | [🔗 Github](https://github.com/NangoHQ/integration-templates/blob/main/integrations/outlook/actions/get-calendar.ts)    |
| `list-calendars`  | List calendars in the mailbox.              | [Action](/guides/functions/action-functions) | [🔗 Github](https://github.com/NangoHQ/integration-templates/blob/main/integrations/outlook/actions/list-calendars.ts)  |
| `update-calendar` | Update calendar properties.                 | [Action](/guides/functions/action-functions) | [🔗 Github](https://github.com/NangoHQ/integration-templates/blob/main/integrations/outlook/actions/update-calendar.ts) |

### Events

| Function name            | Description                                                    | Type                                         | Source code                                                                                                                    |
| ------------------------ | -------------------------------------------------------------- | -------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------ |
| `add-event-attachment`   | Attach a small file (under 3 MB) to an Outlook event.          | [Action](/guides/functions/action-functions) | [🔗 Github](https://github.com/NangoHQ/integration-templates/blob/main/integrations/outlook/actions/add-event-attachment.ts)   |
| `cancel-event`           | Cancel a meeting and send the cancellation notice to attendees | [Action](/guides/functions/action-functions) | [🔗 Github](https://github.com/NangoHQ/integration-templates/blob/main/integrations/outlook/actions/cancel-event.ts)           |
| `create-event`           | Create an event on a calendar.                                 | [Action](/guides/functions/action-functions) | [🔗 Github](https://github.com/NangoHQ/integration-templates/blob/main/integrations/outlook/actions/create-event.ts)           |
| `get-event`              | Retrieve an event by ID from the user's calendar               | [Action](/guides/functions/action-functions) | [🔗 Github](https://github.com/NangoHQ/integration-templates/blob/main/integrations/outlook/actions/get-event.ts)              |
| `list-event-attachments` | List attachments on an event.                                  | [Action](/guides/functions/action-functions) | [🔗 Github](https://github.com/NangoHQ/integration-templates/blob/main/integrations/outlook/actions/list-event-attachments.ts) |
| `update-event`           | Update event details in Outlook calendar.                      | [Action](/guides/functions/action-functions) | [🔗 Github](https://github.com/NangoHQ/integration-templates/blob/main/integrations/outlook/actions/update-event.ts)           |

### Mail

| Function name        | Description                                  | Type                                         | Source code                                                                                                                |
| -------------------- | -------------------------------------------- | -------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------- |
| `create-mail-folder` | Create a child mail folder in Outlook.       | [Action](/guides/functions/action-functions) | [🔗 Github](https://github.com/NangoHQ/integration-templates/blob/main/integrations/outlook/actions/create-mail-folder.ts) |
| `list-mail-folders`  | List top-level mail folders from the mailbox | [Action](/guides/functions/action-functions) | [🔗 Github](https://github.com/NangoHQ/integration-templates/blob/main/integrations/outlook/actions/list-mail-folders.ts)  |
| `send-mail`          | Send a new email message immediately         | [Action](/guides/functions/action-functions) | [🔗 Github](https://github.com/NangoHQ/integration-templates/blob/main/integrations/outlook/actions/send-mail.ts)          |

### Mail Folders

| Function name               | Description                            | Type                                         | Source code                                                                                                                       |
| --------------------------- | -------------------------------------- | -------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------- |
| `list-mail-folder-children` | List child folders under a mail folder | [Action](/guides/functions/action-functions) | [🔗 Github](https://github.com/NangoHQ/integration-templates/blob/main/integrations/outlook/actions/list-mail-folder-children.ts) |

### Messages

| Function name                 | Description                                                               | Type                                         | Source code                                                                                                                         |
| ----------------------------- | ------------------------------------------------------------------------- | -------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------- |
| `add-message-attachment`      | Attach a file to a draft message. Note: 3 MB simple upload limit applies. | [Action](/guides/functions/action-functions) | [🔗 Github](https://github.com/NangoHQ/integration-templates/blob/main/integrations/outlook/actions/add-message-attachment.ts)      |
| `create-draft-message`        | Create a draft email message                                              | [Action](/guides/functions/action-functions) | [🔗 Github](https://github.com/NangoHQ/integration-templates/blob/main/integrations/outlook/actions/create-draft-message.ts)        |
| `delete-message`              | Delete a message from the mailbox                                         | [Action](/guides/functions/action-functions) | [🔗 Github](https://github.com/NangoHQ/integration-templates/blob/main/integrations/outlook/actions/delete-message.ts)              |
| `download-message-attachment` | Download the content of a file attachment on a message.                   | [Action](/guides/functions/action-functions) | [🔗 Github](https://github.com/NangoHQ/integration-templates/blob/main/integrations/outlook/actions/download-message-attachment.ts) |
| `get-message`                 | Retrieve a message by ID.                                                 | [Action](/guides/functions/action-functions) | [🔗 Github](https://github.com/NangoHQ/integration-templates/blob/main/integrations/outlook/actions/get-message.ts)                 |
| `list-message-attachments`    | List attachments on a message.                                            | [Action](/guides/functions/action-functions) | [🔗 Github](https://github.com/NangoHQ/integration-templates/blob/main/integrations/outlook/actions/list-message-attachments.ts)    |
| `list-messages`               | List messages from a mail folder.                                         | [Action](/guides/functions/action-functions) | [🔗 Github](https://github.com/NangoHQ/integration-templates/blob/main/integrations/outlook/actions/list-messages.ts)               |
| `move-message`                | Move a message to another mail folder.                                    | [Action](/guides/functions/action-functions) | [🔗 Github](https://github.com/NangoHQ/integration-templates/blob/main/integrations/outlook/actions/move-message.ts)                |
| `reply-all-to-message`        | Reply to all recipients on a message                                      | [Action](/guides/functions/action-functions) | [🔗 Github](https://github.com/NangoHQ/integration-templates/blob/main/integrations/outlook/actions/reply-all-to-message.ts)        |
| `reply-to-message`            | Reply to a message sender.                                                | [Action](/guides/functions/action-functions) | [🔗 Github](https://github.com/NangoHQ/integration-templates/blob/main/integrations/outlook/actions/reply-to-message.ts)            |
| `send-draft-message`          | Send an existing draft message.                                           | [Action](/guides/functions/action-functions) | [🔗 Github](https://github.com/NangoHQ/integration-templates/blob/main/integrations/outlook/actions/send-draft-message.ts)          |
| `update-message`              | Update a draft or mutable message fields.                                 | [Action](/guides/functions/action-functions) | [🔗 Github](https://github.com/NangoHQ/integration-templates/blob/main/integrations/outlook/actions/update-message.ts)              |

### Others

| Function name          | Description                                               | Type                                           | Source code                                                                                                                  |
| ---------------------- | --------------------------------------------------------- | ---------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------- |
| `copy-message`         | Copy a message to another mail folder.                    | [Action](/guides/functions/action-functions)   | [🔗 Github](https://github.com/NangoHQ/integration-templates/blob/main/integrations/outlook/actions/copy-message.ts)         |
| `list-calendar-events` | List events from a calendar or date window.               | [Action](/guides/functions/action-functions)   | [🔗 Github](https://github.com/NangoHQ/integration-templates/blob/main/integrations/outlook/actions/list-calendar-events.ts) |
| `calendars`            | Sync mailbox calendars and basic calendar metadata        | [Sync](/guides/functions/syncs/sync-functions) | [🔗 Github](https://github.com/NangoHQ/integration-templates/blob/main/integrations/outlook/syncs/calendars.ts)              |
| `events`               | Sync events in a bounded calendar view with delta tokens. | [Sync](/guides/functions/syncs/sync-functions) | [🔗 Github](https://github.com/NangoHQ/integration-templates/blob/main/integrations/outlook/syncs/events.ts)                 |
| `mail-folders`         | Sync the mail folder hierarchy                            | [Sync](/guides/functions/syncs/sync-functions) | [🔗 Github](https://github.com/NangoHQ/integration-templates/blob/main/integrations/outlook/syncs/mail-folders.ts)           |
| `messages`             | Sync folder-scoped messages with delta tokens             | [Sync](/guides/functions/syncs/sync-functions) | [🔗 Github](https://github.com/NangoHQ/integration-templates/blob/main/integrations/outlook/syncs/messages.ts)               |

***