# Microsoft Outlook Email Reader
```bash
pip install llama-index-readers-microsoft-outlook-emails
```
The loader retrieves emails from an Outlook mailbox and indexes the subject and body of the emails.
## Prerequisites
### App Authentication using Microsoft Entra ID (formerly Azure AD)
1. You need to create an App Registration in Microsoft Entra ID. Refer [here](https://learn.microsoft.com/en-us/azure/healthcare-apis/register-application)
2. API Permissions for the created app:
1. Microsoft Graph --> Application Permissions --> Mail.Read (**Grant Admin Consent**)
More info on Microsoft Graph APIs - [Refer here](https://learn.microsoft.com/en-us/graph/permissions-reference)
## Usage
To use this loader, `client_id`, `client_secret`, and `tenant_id` of the registered app in Microsoft Azure Portal are required.
This loader fetches emails from a specified folder in an Outlook mailbox.
```python
from llama_index.readers.outlook_emails import OutlookEmailReader
loader = OutlookEmailReader(
client_id="<Client ID of the app>",
client_secret="<Client Secret of the app>",
tenant_id="<Tenant ID of the Microsoft Azure Directory>",
user_email="<User Email Address>",
folder="Inbox",
num_mails=10,
)
documents = loader.load_data()
```
The loader retrieves the subject and body of the emails from the specified folder in Outlook.
Raw data
{
"_id": null,
"home_page": null,
"name": "llama-index-readers-microsoft-outlook-emails",
"maintainer": "llama-index",
"docs_url": null,
"requires_python": "<4.0,>=3.9",
"maintainer_email": null,
"keywords": "emails, microsoft 365, microsoft365, outlook",
"author": "Your Name",
"author_email": "you@example.com",
"download_url": "https://files.pythonhosted.org/packages/3f/60/0c3a2baf48f98e3578993c7c45b2d4a9c46c930e8b9e2be13be2a0480252/llama_index_readers_microsoft_outlook_emails-0.1.0.tar.gz",
"platform": null,
"description": "# Microsoft Outlook Email Reader\n\n```bash\npip install llama-index-readers-microsoft-outlook-emails\n```\n\nThe loader retrieves emails from an Outlook mailbox and indexes the subject and body of the emails.\n\n## Prerequisites\n\n### App Authentication using Microsoft Entra ID (formerly Azure AD)\n\n1. You need to create an App Registration in Microsoft Entra ID. Refer [here](https://learn.microsoft.com/en-us/azure/healthcare-apis/register-application)\n2. API Permissions for the created app:\n 1. Microsoft Graph --> Application Permissions --> Mail.Read (**Grant Admin Consent**)\n\nMore info on Microsoft Graph APIs - [Refer here](https://learn.microsoft.com/en-us/graph/permissions-reference)\n\n## Usage\n\nTo use this loader, `client_id`, `client_secret`, and `tenant_id` of the registered app in Microsoft Azure Portal are required.\n\nThis loader fetches emails from a specified folder in an Outlook mailbox.\n\n```python\nfrom llama_index.readers.outlook_emails import OutlookEmailReader\n\nloader = OutlookEmailReader(\n client_id=\"<Client ID of the app>\",\n client_secret=\"<Client Secret of the app>\",\n tenant_id=\"<Tenant ID of the Microsoft Azure Directory>\",\n user_email=\"<User Email Address>\",\n folder=\"Inbox\",\n num_mails=10,\n)\n\ndocuments = loader.load_data()\n```\n\nThe loader retrieves the subject and body of the emails from the specified folder in Outlook.\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "llama-index readers microsoft_outlook_emails integration",
"version": "0.1.0",
"project_urls": null,
"split_keywords": [
"emails",
" microsoft 365",
" microsoft365",
" outlook"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "ae3e8e1c66159cda9710734838e8dad7975286915b43b1ded2e17ce9c847a663",
"md5": "1cb90919de38f2e6468700783cad4806",
"sha256": "b0dbf0859a2c1fdf01f1295571166f8e272b35d254b252b0138d9fbc3f764027"
},
"downloads": -1,
"filename": "llama_index_readers_microsoft_outlook_emails-0.1.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "1cb90919de38f2e6468700783cad4806",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": "<4.0,>=3.9",
"size": 3499,
"upload_time": "2025-02-17T00:29:19",
"upload_time_iso_8601": "2025-02-17T00:29:19.523435Z",
"url": "https://files.pythonhosted.org/packages/ae/3e/8e1c66159cda9710734838e8dad7975286915b43b1ded2e17ce9c847a663/llama_index_readers_microsoft_outlook_emails-0.1.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "3f600c3a2baf48f98e3578993c7c45b2d4a9c46c930e8b9e2be13be2a0480252",
"md5": "0e3a72f7be7a5df7735b7eef13ba31d4",
"sha256": "5066366aa8a780ce043cdb10488f098e8f8ba6e7447d43ad672b0542f65036f8"
},
"downloads": -1,
"filename": "llama_index_readers_microsoft_outlook_emails-0.1.0.tar.gz",
"has_sig": false,
"md5_digest": "0e3a72f7be7a5df7735b7eef13ba31d4",
"packagetype": "sdist",
"python_version": "source",
"requires_python": "<4.0,>=3.9",
"size": 3006,
"upload_time": "2025-02-17T00:29:21",
"upload_time_iso_8601": "2025-02-17T00:29:21.370388Z",
"url": "https://files.pythonhosted.org/packages/3f/60/0c3a2baf48f98e3578993c7c45b2d4a9c46c930e8b9e2be13be2a0480252/llama_index_readers_microsoft_outlook_emails-0.1.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2025-02-17 00:29:21",
"github": false,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"lcname": "llama-index-readers-microsoft-outlook-emails"
}
JSON