Class GmailGetMessage

Hierarchy

GmailBaseTool
- GmailGetMessage

Index

Constructors

constructor

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

Properties

description

description: string = GET_MESSAGE_DESCRIPTION

`Protected` `Optional`gmail

gmail?: Gmail

name

name: string = "gmail_get_message"

`Protected`params

params: GmailBaseToolParams

schema

schema: ZodObject<
    { messageId: ZodString },
    "strip",
    ZodTypeAny,
    { messageId: string },
    { messageId: string },
> = getMessageSchema

Methods

_call

_call(arg: InferInteropZodOutput<{ messageId: string }>): Promise<string>
Parameters
- arg: InferInteropZodOutput<{ messageId: string }>
Returns Promise<string>
- Defined in remotes/langchain-ai/langchainjs/v1/libs/langchain-community/src/tools/gmail/get_message.ts:22

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

Class GmailGetMessage

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Returns GmailGetMessage

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;
    }

Settings

On This Page

Class GmailGetMessage

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Returns GmailGetMessage

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; }

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;
}