google_gmail_get_email_by_index
Retrieve a specific email by its index from recent Gmail search results, with options to fetch it in full, metadata, minimal, or raw format.
Instructions
Get email by its index from the most recent search results
Input Schema
TableJSON Schema
| Name | Required | Description | Default |
|---|---|---|---|
| format | No | Format to return the email in (full, metadata, minimal, raw) | |
| index | Yes | Index of the email from search results (starting from 1) |
Implementation Reference
- handlers/gmail.ts:65-93 (handler)The handler function that validates input arguments, retrieves the message ID by index from recent emails, fetches the email content, and returns formatted text response or error.
export async function handleGmailGetEmailByIndex( args: any, googleGmailInstance: GoogleGmail ) { if (!isGetEmailByIndexArgs(args)) { throw new Error("Invalid arguments for google_gmail_get_email_by_index"); } const { index, format } = args; try { const messageId = googleGmailInstance.getMessageIdByIndex(index); const result = await googleGmailInstance.getEmail(messageId, format); return { content: [{ type: "text", text: result }], isError: false, }; } catch (error) { return { content: [ { type: "text", text: `Error: ${ error instanceof Error ? error.message : String(error) }`, }, ], isError: true, }; } } - tools/gmail/index.ts:55-73 (schema)Tool schema definition including name, description, and input schema with required 'index' and optional 'format' parameters.
export const GET_EMAIL_BY_INDEX_TOOL: Tool = { name: "google_gmail_get_email_by_index", description: "Get email by its index from the most recent search results", inputSchema: { type: "object", properties: { index: { type: "number", description: "Index of the email from search results (starting from 1)", }, format: { type: "string", description: "Format to return the email in (full, metadata, minimal, raw)", }, }, required: ["index"], }, }; - server-setup.ts:149-153 (registration)Dispatch registration in the main server request handler switch statement that routes the tool call to the specific Gmail handler function.
case "google_gmail_get_email_by_index": return await gmailHandlers.handleGmailGetEmailByIndex( args, googleGmailInstance ); - utils/helper.ts:150-159 (schema)Type guard function for input validation matching the tool's input schema.
export function isGetEmailByIndexArgs(args: any): args is { index: number; format?: string; } { return ( args && typeof args.index === "number" && (args.format === undefined || typeof args.format === "string") ); } - utils/gmail.ts:116-123 (helper)Helper method in GoogleGmail class that retrieves the message ID from the cached recentEmails list based on the provided index.
getMessageIdByIndex(index: number): string { if (index < 1 || index > this.recentEmails.length) { throw new Error( `Invalid email index: ${index}. Available range: 1-${this.recentEmails.length}` ); } return this.recentEmails[index - 1].id; }