---
title: Elastic Outlook connector reference
description: The Elastic Outlook connector is built with the Elastic connector framework and is available as a self-managed self-managed connector. This connector...
url: https://www.elastic.co/elastic/docs-builder/docs/4155/reference/search-connectors/es-connectors-outlook
products:
- Elasticsearch
---
# Elastic Outlook connector reference
The Elastic Outlook connector is built with the Elastic connector framework and is available as a self-managed [self-managed connector](https://www.elastic.co/elastic/docs-builder/docs/4155/reference/search-connectors/self-managed-connectors).
## **Self-managed connector reference**
### Availability and prerequisites
This connector is available as a self-managed connector. To use this connector, satisfy all [self-managed connector prerequisites](https://www.elastic.co/elastic/docs-builder/docs/4155/reference/search-connectors/self-managed-connectors).
### Create a Outlook connector
#### Use the UI
To create a new Outlook connector:
1. In the Kibana UI, search for "connectors" using the [global search field](https://docs-v3-preview.elastic.dev/elastic/docs-builder/docs/4155/explore-analyze/query-filter/filtering#_finding_your_apps_and_objects) and choose the "Elasticsearch" connectors.
2. Follow the instructions to create a new **Outlook** self-managed connector.
#### Use the API
You can use the Elasticsearch [Create connector API](https://www.elastic.co/docs/api/doc/elasticsearch/group/endpoint-connector) to create a new self-managed Outlook self-managed connector.
For example:
```json
{
"index_name": "my-elasticsearch-index",
"name": "Content synced from Outlook",
"service_type": "outlook"
}
```
The user needs the cluster privileges `manage_api_key`, `manage_connector` and `write_connector_secrets` to generate API keys programmatically.
To create an API key for the connector:
1. Run the following command, replacing values where indicated. Note the `encoded` return values from the response:
```json
{
"name": "connector_name-connector-api-key",
"role_descriptors": {
"connector_name-connector-role": {
"cluster": [
"monitor",
"manage_connector"
],
"indices": [
{
"names": [
"index_name",
".search-acl-filter-index_name",
".elastic-connectors*"
],
"privileges": [
"all"
],
"allow_restricted_indices": false
}
]
}
}
}
```
2. Update your `config.yml` file with the API key `encoded` value.
Refer to the [Elasticsearch API documentation](https://www.elastic.co/docs/api/doc/elasticsearch/group/endpoint-connector) for details of all available Connector APIs.
### Usage
To use this connector as a **self-managed connector**, use the **Outlook** tile from the connectors list OR **Customized connector** workflow.
For additional operations, see [*Connectors UI in Kibana*](https://www.elastic.co/elastic/docs-builder/docs/4155/reference/search-connectors/connectors-ui-in-kibana).
### Connecting to Outlook
Outlook connector supports both cloud (Office365 Outlook) and on-premises (Exchange Server) platforms.
#### Connect to Exchange Server
In order to connect to Exchange server, the connector fetches Active Directory users with the help of `ldap3` python library.
#### Connect to Office365 Outlook (Outlook Cloud)
To integrate with the Outlook connector using Azure, follow these steps to create and configure an Azure application:
1. Navigate to the [Azure Portal](https://portal.azure.com/) and log in using your credentials.
2. Click on **App registrations** to register a new application.
3. Navigate to the **Overview** tab. Make a note of the `Client ID` and `Tenant ID`.
4. Click on the **Certificates & secrets** tab and create a new client secret. Keep this secret handy.
5. Go to the **API permissions** tab.
1. Click on "Add permissions".
2. Choose "APIs my organization uses".
3. Search for and select "Office 365 Exchange Online".
- Add the `full_access_as_app` application permission.
4. Search for and select "Microsoft Graph"
- Add the `User.Read.All` application permission.
You can now use the Client ID, Tenant ID, and Client Secret you’ve noted to configure the Outlook connector.
### Configuration
(required) Dropdown to determine Outlook platform type: `outlook_cloud` or `outlook_server`. Default value is `outlook_cloud`.
(required if data source is outlook_cloud) The Tenant ID for the Azure account hosting the Outlook instance.
(required if data source is outlook_cloud) The Client ID to authenticate with Outlook instance.
(required if data source is outlook_cloud) The Client Secret value to authenticate with Outlook instance.
(required if data source is outlook_server) IP address to connect with Exchange server. Example: `127.0.0.1`
(required if data source is outlook_server) IP address to fetch users from Exchange Active Directory to fetch data. Example: `127.0.0.1`
(required if data source is outlook_server) Username to authenticate with Exchange server.
(required if data source is outlook_server) Password to authenticate with Exchange server.
(required if data source is outlook_server) Domain name for Exchange server users such as `gmail.com` or `exchange.local`.
Whether SSL verification will be enabled. Default value is `False`. **Note:** This configuration is applicable for `Outlook Server` only.
(required if ssl is enabled) Content of SSL certificate. Example certificate:
```txt
-----BEGIN CERTIFICATE-----
MIID+jCCAuKgAwIBAgIGAJJMzlxLMA0GCSqGSIb3DQEBCwUAMHoxCzAJBgNVBAYT
...
7RhLQyWn2u00L7/9Omw=
-----END CERTIFICATE-----
```
Indexes mail from the user mail folders in each mailbox, not only Inbox, Sent, Junk, and Archive. Other folders are stored as `Mail` with a `folder_name` field. The four default folders keep their existing types. System folders such as Deleted Items, Drafts, Outbox, and search folders are never indexed. Enabling this setting increases sync time, load on Exchange, and index size. Default value is `False`. Introduced in 9.4.8, 9.5.5, and 9.6.
Use [self-hosted content extraction service](/elastic/docs-builder/docs/4155/reference/search-connectors/es-connectors-content-extraction#es-connectors-content-extraction-data-extraction-service). Default value is `False`.
Toggle to index the full raw MIME message. Default value is `False`. When off, only the email body (preferring `text/plain` over `text/html`) and a minimal set of headers (`Subject`, `From`, `Reply-To`, `To`, `Cc`, `Bcc`, `Date`, `Message-ID`) are indexed. Routing/authentication headers and binary attachments are dropped. Enable this toggle to restore the passthrough behavior when body extraction misses content. Available in 9.5.5 and later.
Toggle to enable [Document level security (DLS)](https://www.elastic.co/elastic/docs-builder/docs/4155/reference/search-connectors/document-level-security). When enabled:
- Full syncs will fetch access control lists for each document and store them in the `_allow_access_control` field.
- Access control syncs fetch users' access control lists and store them in a separate index.
**Note:** This configuration is applicable for `Outlook Server` only.
### Deployment using Docker
You can deploy the Outlook connector as a self-managed connector using Docker. Follow these instructions.
Download the sample configuration file. You can either download it manually or run the following command:
```sh
curl https://raw.githubusercontent.com/elastic/connectors/main/app/connectors_service/config.yml.example --output ~/connectors-config/config.yml
```
Remember to update the `--output` argument value if your directory name is different, or you want to use a different config file name.
Update the configuration file with the following settings to match your environment:
- `elasticsearch.host`
- `elasticsearch.api_key`
- `connectors`
If you’re running the connector service against a Dockerized version of Elasticsearch and Kibana, your config file will look like this:
```yaml
# When connecting to your cloud deployment you should edit the host value
elasticsearch.host: http://host.docker.internal:9200
elasticsearch.api_key:
connectors:
-
connector_id:
service_type: outlook
api_key:
```
Using the `elasticsearch.api_key` is the recommended authentication method. However, you can also use `elasticsearch.username` and `elasticsearch.password` to authenticate with your Elasticsearch instance.Note: You can change other default configurations by simply uncommenting specific settings in the configuration file and modifying their values.
Run the Docker image with the Connector Service using the following command:
```sh
docker run \
-v ~/connectors-config:/config \
--network "elastic" \
--tty \
--rm \
docker.elastic.co/integrations/elastic-connectors:9.5.4 \
/app/bin/elastic-ingest \
-c /config/config.yml
```
Refer to [`DOCKER.md`](https://github.com/elastic/connectors/tree/main/docs/DOCKER.md) in the `elastic/connectors` repo for more details.
Find all available Docker images in the [official registry](https://www.docker.elastic.co/r/integrations/elastic-connectors).
We also have a quickstart self-managed option using Docker Compose, so you can spin up all required services at once: Elasticsearch, Kibana, and the connectors service. Refer to this [README](https://github.com/elastic/connectors/tree/main/scripts/stack#readme) in the `elastic/connectors` repo for more information.
### Content Extraction
Refer to [Content extraction](https://www.elastic.co/elastic/docs-builder/docs/4155/reference/search-connectors/es-connectors-content-extraction).
### Documents and syncs
The connector syncs the following objects and entities:
- **Mails**
- **Inbox Mails**
- **Sent Mails**
- **Archive Mails**
- **Junk Mails**
- **Mail** — other user mail folders, when `sync_all_mail_folders` is enabled. Includes a `folder_name` field.
- **Contacts**
- **Calendar Events**
- **Tasks**
- **Attachments**
- **Mail Attachments**
- **Task Attachments**
- **Calendar Attachments**
- Content from files bigger than 10 MB won’t be extracted by default. You can use the [self-managed local extraction service](/elastic/docs-builder/docs/4155/reference/search-connectors/es-connectors-content-extraction#es-connectors-content-extraction-local) to handle larger binary files.
- Permissions are not synced. **All documents** indexed to an Elastic deployment will be visible to **all users with access** to that Elastic Deployment.
- For Outlook Cloud (Office 365), the connector only discovers mailboxes belonging to **enabled** directory users (`accountEnabled = true`) that have an email address. **Shared mailboxes are not synced by default**, because their backing Entra ID account has sign-in disabled. To sync a shared mailbox, enable sign-in for its account in Entra ID (this may require assigning a license).
#### Sync types
[Full syncs](/elastic/docs-builder/docs/4155/reference/search-connectors/content-syncs#es-connectors-sync-types-full) are supported by default for all connectors.
This connector also supports [incremental syncs](/elastic/docs-builder/docs/4155/reference/search-connectors/content-syncs#es-connectors-sync-types-incremental).
### Document level security
Document level security (DLS) enables you to restrict access to documents based on a user’s permissions. Refer to [configuration](#es-connectors-outlook-client-configuration) on this page for how to enable DLS for this connector.
Refer to [DLS in Search Applications](https://www.elastic.co/elastic/docs-builder/docs/4155/reference/search-connectors/es-dls-e2e-guide) to learn how to ingest data from a connector with DLS enabled, when building a search application. The example uses SharePoint Online as the data source, but the same steps apply to every connector.
### Sync rules
[Basic sync rules](/elastic/docs-builder/docs/4155/reference/search-connectors/es-sync-rules#es-sync-rules-basic) are identical for all connectors and are available by default.
### Advanced Sync Rules
Advanced sync rules are not available for this connector in the present version.
### Connector Client operations
#### End-to-end Testing
**Note:** End-to-end testing is not available in the current version of the connector.
#### Known issues
There are currently no known issues for this connector. Refer to [Known issues](https://www.elastic.co/elastic/docs-builder/docs/4155/release-notes/elasticsearch/known-issues) for a list of known issues for all connectors.
### Troubleshooting
See [Troubleshooting](https://www.elastic.co/elastic/docs-builder/docs/4155/reference/search-connectors/es-connectors-troubleshooting).
### Security
See [Security](https://www.elastic.co/elastic/docs-builder/docs/4155/reference/search-connectors/es-connectors-security).
### Framework and source
This connector is included in the [Elastic connector framework](https://github.com/elastic/connectors/tree/main).
View the [source code for this connector](https://github.com/elastic/connectors/tree/main/app/connectors_service/connectors/sources/outlook) (branch *main*, compatible with Elastic *9.0*).