Added Outlook integration toolkit

docs/core_docs/docs/integrations/toolkits/outlook.mdx

@@ -0,0 +1,143 @@
+# Outlook Toolkit
+
+## Overview
+
+Using this toolkit, you can integrate Microsoft Graph API functionalities into your applications to manage email interactions.
+
+## Learn Microsoft Graph
+
+Microsoft Graph is a RESTful web API that enables you to access Microsoft Cloud service resources. With Microsoft Graph, you can integrate various Microsoft services and data, including users' emails, calendar, contacts, and more, into your applications.
+
+After you register your app and get authentication tokens for a user or service, you can make requests to the Microsoft Graph API.
+
+How to get authentication tokens for a user:   
+https://learn.microsoft.com/en-us/graph/auth-v2-user
+
+## App register and set environment variables
+Azure App Registration for Microsoft Outlook API Integration
+
+1. Register an Application:
+   - Go to Azure Portal.
+   - Navigate to Azure Active Directory -> App registrations.
+   - Register a new application, note down the Client ID.
+
+2. Generate Client Secret:
+   - In the application settings, go to Certificates & Secrets.
+   - Create a new client secret and note down the Client Secret.
+
+3. Configure Redirect URI:
+   - In the application settings, go to Authentication.
+   - Add a Redirect URI and note down the Redirect URI.
+
+4. Permissions and Admin Consent:
+   - In API permissions, grant necessary permissions for Microsoft Graph API or Outlook API.
+   - Grant admin consent for the added permissions.
+
+6. Environment Variables:
+   - Set the following environment variables:
+
+     ```env
+     OUTLOOK_CLIENT_ID=your_client_id
+     OUTLOOK_CLIENT_SECRET=your_client_secret
+     OUTLOOK_REDIRECT_URI=your_redirect_uri
+     OUTLOOK_ACCESS_TOKEN=your_access_token
+     OUTLOOK_REFRESH_TOKEN=your_refresh_token
+
+     ```
+
+   **Keep these values secure and avoid exposing them in public repositories.**
+
+## Setup
+
+You only need an `accessToken` to use the Outlook Toolkit, but they expire after an hour.
+
+If you only have a valid `accessToken`, the following two ways can create an Outlook tool instance.  
+
+```typescript
+const authFlow = new AuthFlowToken(accessToken);
+// if you have accessToken stored in .env
+const authFlow = new AuthFlowToken();
+const outlookReadMail = new OutlookReadMailTool(authFlow=authFlow);
+```
+```typescript
+// you must have accessToken stored in .env
+const outlookReadMail = new OutlookReadMailTool(choice="token");
+```
+
+If you do not have a valid accessToken, the `AuthFlowREST` class obtains the accessToken for you. A temporary server will be opened on your `redirectUri` and you need to manually open the printed link to login on behalf of the user. For every `AuthFlowREST` instance, you only need to login once. 
+
+You'll need to provide a `clientId`, `clientSecret`, and `redirectUri`.
+You can either pass them to the constructor or put them in the environment.
+```typescript
+const authFlow = new AuthFlowREST();
+const outlookReadMail = new OutlookReadMailTool(authFlow=authFlow);
+```
+
+```typescript
+const outlookReadMail = new OutlookReadMailTool(choice="rest");
+```
+
+Usually when you obtain a accessToken you also get a refreshToken used to refresh expired accessToken. The `AuthFlowREST` class needs the following credentials: `clientId`, `clientSecret`, `redirectUri` and `refreshToken`. In this way you won't need to login, no server will be open.
+
+```typescript
+const authFlow = new AuthFlowRefresh();
+const outlookReadMail = new OutlookReadMailTool(authFlow=authFlow);
+```
+```typescript
+const outlookReadMail = new OutlookReadMailTool(choice="refresh");
+```
+
+## Usage
+
+This example shows how to read emails by using agent.
+
+```typescript
+import { ChatOpenAI } from 'langchain/chat_models/openai';
+import { initializeAgentExecutorWithOptions } from 'langchain/agents';
+import { OutlookReadMailTool, AuthFlowREST, AuthFlowToken} from 'langchain_community/tools/outlook';
+
+async function createAndRunAgent() {
+  const gpt4 = new ChatOpenAI({ modelName: 'gpt-4', openAIApiKey: getEnvironmentVariable("OPENAI_API_KEY")});
+
+  const outlookReadMail = new OutlookReadMailTool("token");
+
+  const executor = await initializeAgentExecutorWithOptions([outlookReadMail], gpt4, {
+    agentType: "openai-functions",
+    verbose: true,
+  });
+
+  const input = 'show emails sent to YOUR_EMAIL';
+  const result = await executor.invoke({ input });
+
+  console.log(result);
+}
+
+createAndRunAgent();
+```
+
+This example shows how to send emails by using agent.
+
+```typescript
+import { ChatOpenAI } from 'langchain/chat_models/openai';
+import { initializeAgentExecutorWithOptions } from 'langchain/agents';
+import { OutlookSendMailTool, AuthFlowREST } from 'langchain_community/tools/outlook';
+
+
+async function createAndRunAgent() {
+  const gpt4 = new ChatOpenAI({ modelName: 'gpt-4', openAIApiKey: getEnvironmentVariable("OPENAI_API_KEY")});
+
+  const sendMailTool = new OutlookSendMailTool("token");
+
+  const executor = await initializeAgentExecutorWithOptions([sendMailTool], gpt4, {
+    agentType: "openai-functions",
+    verbose: true,
+  });
+
+  const input = 'send an email to YOUR_EMAIL and say Hello';
+  const result = await executor.invoke({ input });
+
+  console.log(result);
+}
+
+createAndRunAgent();
+```

langchain/.env.example

@@ -92,6 +92,11 @@ NEO4J_USERNAME=ADD_YOURS_HERE
 NEO4J_PASSWORD=ADD_YOURS_HERE
 CLOSEVECTOR_API_KEY=ADD_YOURS_HERE
 CLOSEVECTOR_API_SECRET=ADD_YOURS_HERE
+OUTLOOK_CLIENT_ID=ADD_YOURS_HERE
+OUTLOOK_CLIENT_SECRET=ADD_YOURS_HERE
+OUTLOOK_REDIRECT_URI=ADD_YOURS_HERE
+OUTLOOK_REFRESH_TOKEN=ADD_YOURS_HERE
+OUTLOOK_ACCESS_TOKEN=ADD_YOURS_HERE
 GPLACES_API_KEY=ADD_YOURS_HERE
 CONFLUENCE_USERNAME=ADD_YOURS_HERE
 CONFLUENCE_PASSWORD=ADD_YOURS_HERE

libs/langchain-community/.gitignore

@@ -46,6 +46,9 @@ tools/google_places.d.ts
 tools/ifttt.cjs
 tools/ifttt.js
 tools/ifttt.d.ts
+tools/outlook.cjs
+tools/outlook.js
+tools/outlook.d.ts
 tools/searchapi.cjs
 tools/searchapi.js
 tools/searchapi.d.ts

libs/langchain-community/package.json

@@ -550,6 +550,11 @@
       "import": "./tools/ifttt.js",
       "require": "./tools/ifttt.cjs"
     },
+    "./tools/outlook": {
+      "types": "./tools/outlook.d.ts",
+      "import": "./tools/outlook.js",
+      "require": "./tools/outlook.cjs"
+    },
     "./tools/searchapi": {
       "types": "./tools/searchapi.d.ts",
       "import": "./tools/searchapi.js",
@@ -1292,6 +1297,9 @@
     "tools/ifttt.cjs",
     "tools/ifttt.js",
     "tools/ifttt.d.ts",
+    "tools/outlook.cjs",
+    "tools/outlook.js",
+    "tools/outlook.d.ts",
     "tools/searchapi.cjs",
     "tools/searchapi.js",
     "tools/searchapi.d.ts",

libs/langchain-community/scripts/create-entrypoints.js

@@ -25,6 +25,7 @@ const entrypoints = {
   "tools/google_custom_search": "tools/google_custom_search",
   "tools/google_places": "tools/google_places",
   "tools/ifttt": "tools/ifttt",
+  "tools/outlook": "tools/outlook/index",
   "tools/searchapi": "tools/searchapi",
   "tools/searxng_search": "tools/searxng_search",
   "tools/serpapi": "tools/serpapi",
@@ -191,6 +192,7 @@ const requiresOptionalDependency = [
   "tools/aws_lambda",
   "tools/discord",
   "tools/gmail",
+  "tools/outlook",
   "agents/toolkits/aws_sfn",
   "callbacks/handlers/llmonitor",
   "embeddings/bedrock",

libs/langchain-community/src/load/import_constants.ts

@@ -5,6 +5,7 @@ export const optionalImportEntrypoints = [
   "langchain_community/tools/aws_sfn",
   "langchain_community/tools/discord",
   "langchain_community/tools/gmail",
+  "langchain_community/tools/outlook",
   "langchain_community/agents/toolkits/aws_sfn",
   "langchain_community/embeddings/bedrock",
   "langchain_community/embeddings/cloudflare_workersai",

libs/langchain-community/src/load/import_type.d.ts

@@ -13,6 +13,9 @@ export interface OptionalImportMap {
   "@langchain/community/tools/gmail"?:
     | typeof import("../tools/gmail/index.js")
     | Promise<typeof import("../tools/gmail/index.js")>;
+  "@langchain/community/tools/outlook"?:
+    | typeof import("../tools/outlook/index.js")
+    | Promise<typeof import("../tools/outlook/index.js")>;
   "@langchain/community/agents/toolkits/aws_sfn"?:
     | typeof import("../agents/toolkits/aws_sfn.js")
     | Promise<typeof import("../agents/toolkits/aws_sfn.js")>;

libs/langchain-community/src/tools/outlook/auth/base.ts

@@ -0,0 +1,52 @@
+/**
+ * Base class for handling authentication flows.
+ *
+ * @class AuthFlowBase
+ */
+export abstract class AuthFlowBase {
+  /**
+   * The client ID used for authentication.
+   *
+   * @protected
+   * @type {string}
+   * @memberof AuthFlowBase
+   */
+  protected clientId: string;
+
+  /**
+   * The access token obtained through authentication.
+   *
+   * @protected
+   * @type {string}
+   * @memberof AuthFlowBase
+   */
+  protected accessToken = "";
+
+  /**
+   * Creates an instance of AuthFlowBase.
+   *
+   * @param {string} clientId - The client ID for authentication.
+   * @memberof AuthFlowBase
+   */
+  constructor(clientId: string) {
+    this.clientId = clientId;
+  }
+
+  /**
+   * Abstract method to get the access token.
+   *
+   * @abstract
+   * @returns {Promise<string>} A promise that resolves to the access token.
+   * @memberof AuthFlowBase
+   */
+  public abstract getAccessToken(): Promise<string>;
+
+  /**
+   * Abstract method to refresh the access token.
+   *
+   * @abstract
+   * @returns {Promise<string>} A promise that resolves to the refreshed access token.
+   * @memberof AuthFlowBase
+   */
+  public abstract refreshAccessToken(): Promise<string>;
+}