Class GmailSearch

Hierarchy

GmailBaseTool
- GmailSearch

Index

Constructors

constructor

new GmailSearch(fields?: GmailBaseToolParams): GmailSearch
Parameters
- Optionalfields: GmailBaseToolParams
Returns GmailSearch
Overrides GmailBaseTool.constructor
- Defined in remotes/langchain-ai/langchainjs/v1/libs/langchain-community/src/tools/gmail/search.ts:21

Properties

description

description: string = SEARCH_DESCRIPTION

`Protected` `Optional`gmail

gmail?: Gmail

name

name: string = "search_gmail"

`Protected`params

params: GmailBaseToolParams

schema

schema: ZodObject<
    {
        maxResults: ZodOptional<ZodNumber>;
        query: ZodString;
        resource: ZodOptional<ZodEnum<["messages", "threads"]>>;
    },
    "strip",
    ZodTypeAny,
    { maxResults?: number; query: string; resource?: "messages"
    | "threads" },
    { maxResults?: number; query: string; resource?: "messages" | "threads" },
> = searchSchema

Methods

_call

_call(
    arg: InferInteropZodOutput<
        {
            maxResults?: number;
            query: string;
            resource?: "messages"
            | "threads";
        },
    >,
): Promise<string>
Parameters
- arg: InferInteropZodOutput<
      {
          maxResults?: number;
          query: string;
          resource?: "messages"
          | "threads";
      },
  >
Returns Promise<string>
- Defined in remotes/langchain-ai/langchainjs/v1/libs/langchain-community/src/tools/gmail/search.ts:25

decodeBody

decodeBody(body: string): string
Parameters
- body: string
Returns string
Inherited from GmailBaseTool.decodeBody
- Defined in remotes/langchain-ai/langchainjs/v1/libs/langchain-community/src/tools/gmail/base.ts:119

getGmailClient

getGmailClient(): Promise<Gmail>
Returns Promise<Gmail>
Inherited from GmailBaseTool.getGmailClient
- Defined in remotes/langchain-ai/langchainjs/v1/libs/langchain-community/src/tools/gmail/base.ts:58

parseHeaderAndBody

parseHeaderAndBody(
    payload: undefined | Schema$MessagePart,
):
    | { body: string; sender?: undefined; subject?: undefined }
    | {
        body: string;
        sender: undefined | Schema$MessagePartHeader;
        subject: undefined | Schema$MessagePartHeader;
    }
Parameters
- payload: undefined | Schema$MessagePart
Returns
    | { body: string; sender?: undefined; subject?: undefined }
    | {
        body: string;
        sender: undefined | Schema$MessagePartHeader;
        subject: undefined | Schema$MessagePartHeader;
    }
Inherited from GmailBaseTool.parseHeaderAndBody
- Defined in remotes/langchain-ai/langchainjs/v1/libs/langchain-community/src/tools/gmail/base.ts:93

parseMessages

parseMessages(
gmail: Gmail,
messages: Schema$Message[],
): Promise<Schema$Message[]>
Parameters
- gmail: Gmail
- messages: Schema$Message[]
Returns Promise<Schema$Message[]>
- Defined in remotes/langchain-ai/langchainjs/v1/libs/langchain-community/src/tools/gmail/search.ts:67

parseThreads

parseThreads(gmail: Gmail, messages: Schema$Message[]): Promise<Schema$Thread[]>
Parameters
- gmail: Gmail
- messages: Schema$Message[]
Returns Promise<Schema$Thread[]>
- Defined in remotes/langchain-ai/langchainjs/v1/libs/langchain-community/src/tools/gmail/search.ts:100

Class GmailSearch

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Returns GmailSearch

Properties

description

`Protected` `Optional`gmail

name

`Protected`params

schema

Methods

_call

Parameters

Returns Promise<string>

decodeBody

Parameters

Returns string

getGmailClient

Returns Promise<Gmail>

parseHeaderAndBody

Parameters

Returns
    | { body: string; sender?: undefined; subject?: undefined }
    | {
        body: string;
        sender: undefined | Schema$MessagePartHeader;
        subject: undefined | Schema$MessagePartHeader;
    }

parseMessages

Parameters

Returns Promise<Schema$Message[]>

parseThreads

Parameters

Returns Promise<Schema$Thread[]>

Settings

On This Page

Class GmailSearch

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Returns GmailSearch

Properties

description

Protected Optionalgmail

name

Protectedparams

schema

Methods

_call

Parameters

Returns Promise<string>

decodeBody

Parameters

Returns string

getGmailClient

Returns Promise<Gmail>

parseHeaderAndBody

Parameters

Returns | { body: string; sender?: undefined; subject?: undefined } | { body: string; sender: undefined | Schema$MessagePartHeader; subject: undefined | Schema$MessagePartHeader; }

parseMessages

Parameters

Returns Promise<Schema$Message[]>

parseThreads

Parameters

Returns Promise<Schema$Thread[]>

Settings

On This Page

`Protected` `Optional`gmail

`Protected`params

Returns
| { body: string; sender?: undefined; subject?: undefined }
| {
body: string;
sender: undefined | Schema$MessagePartHeader;
subject: undefined | Schema$MessagePartHeader;
}