!function(){function t(t){document.documentElement.setAttribute("data-theme",t)}var e=function(){var t=null;try{t=new URLSearchParams(window.location.search).get("docusaurus-theme")}catch(t){}return t}()||function(){var t=null;try{t=localStorage.getItem("theme")}catch(t){}return t}();t(null!==e?e:"light")}(),document.documentElement.setAttribute("data-announcement-bar-initially-dismissed",function(){try{return"true"===localStorage.getItem("docusaurus.announcement.dismiss")}catch(t){}return!1}())

[Skip to main content](#__docusaurus_skipToContent_fallback)

You are viewing the **preview** v0.2 docs. View the **stable** v0.1 docs [here](/v0.1/docs/get_started/introduction/). Leave feedback on the v0.2 docs [here](https://github.com/langchain-ai/langchainjs/discussions/5386).

[

![🦜️🔗 Langchain](/v0.2/img/brand/wordmark.png)![🦜️🔗 Langchain](/v0.2/img/brand/wordmark-dark.png)

](/v0.2/)[Integrations](/v0.2/docs/integrations/platforms/)[API Reference](https://v02.api.js.langchain.com)

[More](#)

*   [People](/v0.2/docs/people/)
*   [Community](/v0.2/docs/community)
*   [Tutorials](/v0.2/docs/additional_resources/tutorials)
*   [Contributing](/v0.2/docs/contributing)

[v0.2](#)

*   [v0.2](/v0.2/docs/introduction)
*   [v0.1](https://js.langchain.com/v0.1/docs/get_started/introduction)

[🦜🔗](#)

*   [LangSmith](https://smith.langchain.com)
*   [LangSmith Docs](https://docs.smith.langchain.com)
*   [LangChain Hub](https://smith.langchain.com/hub)
*   [LangServe](https://github.com/langchain-ai/langserve)
*   [Python Docs](https://python.langchain.com/)

[Chat](https://chatjs.langchain.com)[](https://github.com/langchain-ai/langchainjs)

Search

*   [Providers](/v0.2/docs/integrations/platforms/)
    
    *   [Providers](/v0.2/docs/integrations/platforms/)
    *   [Anthropic](/v0.2/docs/integrations/platforms/anthropic)
    *   [AWS](/v0.2/docs/integrations/platforms/aws)
    *   [Google](/v0.2/docs/integrations/platforms/google)
    *   [Microsoft](/v0.2/docs/integrations/platforms/microsoft)
    *   [OpenAI](/v0.2/docs/integrations/platforms/openai)
*   [Components](/v0.2/docs/integrations/components)
    
    *   [Chat models](/v0.2/docs/integrations/chat/)
        
    *   [LLMs](/v0.2/docs/integrations/llms/)
        
    *   [Embedding models](/v0.2/docs/integrations/text_embedding)
        
    *   [Document loaders](/v0.2/docs/integrations/document_loaders)
        
    *   [Document transformers](/v0.2/docs/integrations/document_transformers)
        
    *   [Vector stores](/v0.2/docs/integrations/vectorstores)
        
    *   [Retrievers](/v0.2/docs/integrations/retrievers)
        
    *   [Tools](/v0.2/docs/integrations/tools)
        
        *   [ChatGPT Plugins](/v0.2/docs/integrations/tools/aiplugin-tool)
        *   [Connery Action Tool](/v0.2/docs/integrations/tools/connery)
        *   [Dall-E Tool](/v0.2/docs/integrations/tools/dalle)
        *   [Discord Tool](/v0.2/docs/integrations/tools/discord)
        *   [DuckDuckGoSearch](/v0.2/docs/integrations/tools/duckduckgo_search)
        *   [Exa Search](/v0.2/docs/integrations/tools/exa_search)
        *   [Gmail Tool](/v0.2/docs/integrations/tools/gmail)
        *   [Google Calendar Tool](/v0.2/docs/integrations/tools/google_calendar)
        *   [Google Places Tool](/v0.2/docs/integrations/tools/google_places)
        *   [Agent with AWS Lambda](/v0.2/docs/integrations/tools/lambda_agent)
        *   [Python interpreter tool](/v0.2/docs/integrations/tools/pyinterpreter)
        *   [SearchApi tool](/v0.2/docs/integrations/tools/searchapi)
        *   [Searxng Search tool](/v0.2/docs/integrations/tools/searxng)
        *   [StackExchange Tool](/v0.2/docs/integrations/tools/stackexchange)
        *   [Tavily Search](/v0.2/docs/integrations/tools/tavily_search)
        *   [Web Browser Tool](/v0.2/docs/integrations/tools/webbrowser)
        *   [Wikipedia tool](/v0.2/docs/integrations/tools/wikipedia)
        *   [WolframAlpha Tool](/v0.2/docs/integrations/tools/wolframalpha)
        *   [Agent with Zapier NLA Integration](/v0.2/docs/integrations/tools/zapier_agent)
    *   [Toolkits](/v0.2/docs/integrations/toolkits)
        
    *   [Stores](/v0.2/docs/integrations/stores/)
        

*   [](/v0.2/)
*   [Components](/v0.2/docs/integrations/components)
*   [Tools](/v0.2/docs/integrations/tools)
*   Gmail Tool

Gmail Tool
==========

The Gmail Tool allows your agent to create and view messages from a linked email account.

Setup[​](#setup "Direct link to Setup")
---------------------------------------

You will need to get an API key from [Google here](https://developers.google.com/gmail/api/guides) and [enable the new Gmail API](https://console.cloud.google.com/apis/library/gmail.googleapis.com). Then, set the environment variables for `GMAIL_CLIENT_EMAIL`, and either `GMAIL_PRIVATE_KEY`, or `GMAIL_KEYFILE`.

To use the Gmail Tool you need to install the following official peer dependency:

tip

See [this section for general instructions on installing integration packages](/v0.2/docs/how_to/installation#installing-integration-packages).

*   npm
*   Yarn
*   pnpm

    npm install @langchain/openai googleapis @langchain/community

    yarn add @langchain/openai googleapis @langchain/community

    pnpm add @langchain/openai googleapis @langchain/community

Usage[​](#usage "Direct link to Usage")
---------------------------------------

    import { initializeAgentExecutorWithOptions } from "langchain/agents";import { OpenAI } from "@langchain/openai";import {  GmailCreateDraft,  GmailGetMessage,  GmailGetThread,  GmailSearch,  GmailSendMessage,} from "@langchain/community/tools/gmail";import { StructuredTool } from "@langchain/core/tools";export async function run() {  const model = new OpenAI({    temperature: 0,    apiKey: process.env.OPENAI_API_KEY,  });  // These are the default parameters for the Gmail tools  //   const gmailParams = {  //     credentials: {  //       clientEmail: process.env.GMAIL_CLIENT_EMAIL,  //       privateKey: process.env.GMAIL_PRIVATE_KEY,  //     },  //     scopes: ["https://mail.google.com/"],  //   };  // For custom parameters, uncomment the code above, replace the values with your own, and pass it to the tools below  const tools: StructuredTool[] = [    new GmailCreateDraft(),    new GmailGetMessage(),    new GmailGetThread(),    new GmailSearch(),    new GmailSendMessage(),  ];  const gmailAgent = await initializeAgentExecutorWithOptions(tools, model, {    agentType: "structured-chat-zero-shot-react-description",    verbose: true,  });  const createInput = `Create a gmail draft for me to edit of a letter from the perspective of a sentient parrot who is looking to collaborate on some research with her estranged friend, a cat. Under no circumstances may you send the message, however.`;  const createResult = await gmailAgent.invoke({ input: createInput });  //   Create Result {  //     output: 'I have created a draft email for you to edit. The draft Id is r5681294731961864018.'  //   }  console.log("Create Result", createResult);  const viewInput = `Could you search in my drafts for the latest email?`;  const viewResult = await gmailAgent.invoke({ input: viewInput });  //   View Result {  //     output: "The latest email in your drafts is from hopefulparrot@gmail.com with the subject 'Collaboration Opportunity'. The body of the email reads: 'Dear [Friend], I hope this letter finds you well. I am writing to you in the hopes of rekindling our friendship and to discuss the possibility of collaborating on some research together. I know that we have had our differences in the past, but I believe that we can put them aside and work together for the greater good. I look forward to hearing from you. Sincerely, [Parrot]'"  //   }  console.log("View Result", viewResult);}

#### API Reference:

*   [initializeAgentExecutorWithOptions](https://v02.api.js.langchain.com/functions/langchain_agents.initializeAgentExecutorWithOptions.html) from `langchain/agents`
*   [OpenAI](https://v02.api.js.langchain.com/classes/langchain_openai.OpenAI.html) from `@langchain/openai`
*   [GmailCreateDraft](https://v02.api.js.langchain.com/classes/langchain_community_tools_gmail.GmailCreateDraft.html) from `@langchain/community/tools/gmail`
*   [GmailGetMessage](https://v02.api.js.langchain.com/classes/langchain_community_tools_gmail.GmailGetMessage.html) from `@langchain/community/tools/gmail`
*   [GmailGetThread](https://v02.api.js.langchain.com/classes/langchain_community_tools_gmail.GmailGetThread.html) from `@langchain/community/tools/gmail`
*   [GmailSearch](https://v02.api.js.langchain.com/classes/langchain_community_tools_gmail.GmailSearch.html) from `@langchain/community/tools/gmail`
*   [GmailSendMessage](https://v02.api.js.langchain.com/classes/langchain_community_tools_gmail.GmailSendMessage.html) from `@langchain/community/tools/gmail`
*   [StructuredTool](https://v02.api.js.langchain.com/classes/langchain_core_tools.StructuredTool.html) from `@langchain/core/tools`

* * *

#### Was this page helpful?

  

#### You can leave detailed feedback [on GitHub](https://github.com/langchain-ai/langchainjs/issues/new?assignees=&labels=03+-+Documentation&projects=&template=documentation.yml&title=DOC%3A+%3CPlease+write+a+comprehensive+title+after+the+%27DOC%3A+%27+prefix%3E).

[

Previous

Exa Search

](/v0.2/docs/integrations/tools/exa_search)[

Next

Google Calendar Tool

](/v0.2/docs/integrations/tools/google_calendar)

Community

*   [Discord](https://discord.gg/cU2adEyC7w)
*   [Twitter](https://twitter.com/LangChainAI)

GitHub

*   [Python](https://github.com/langchain-ai/langchain)
*   [JS/TS](https://github.com/langchain-ai/langchainjs)

More

*   [Homepage](https://langchain.com)
*   [Blog](https://blog.langchain.dev)

Copyright © 2024 LangChain, Inc.