batch_delete_messages
Delete multiple Gmail messages simultaneously by specifying their IDs to clear inbox clutter or remove unwanted emails in bulk.
Instructions
Delete multiple messages
Input Schema
TableJSON Schema
| Name | Required | Description | Default |
|---|---|---|---|
| ids | Yes | The IDs of the messages to delete |
Implementation Reference
- src/index.ts:506-511 (handler)The core handler function for the 'batch_delete_messages' tool. It invokes the Gmail API's users.messages.batchDelete method with the provided message IDs, wrapped in the shared handleTool for authentication and client management.
async (params) => { return handleTool(config, async (gmail: gmail_v1.Gmail) => { const { data } = await gmail.users.messages.batchDelete({ userId: 'me', requestBody: { ids: params.ids } }) return formatResponse(data) }) } - src/index.ts:503-505 (schema)Input schema using Zod, requiring an array of string message IDs.
{ ids: z.array(z.string()).describe("The IDs of the messages to delete") }, - src/index.ts:501-512 (registration)MCP server tool registration call, defining name, description, input schema, and handler for batch_delete_messages.
server.tool("batch_delete_messages", "Delete multiple messages", { ids: z.array(z.string()).describe("The IDs of the messages to delete") }, async (params) => { return handleTool(config, async (gmail: gmail_v1.Gmail) => { const { data } = await gmail.users.messages.batchDelete({ userId: 'me', requestBody: { ids: params.ids } }) return formatResponse(data) }) } ) - src/index.ts:49-65 (helper)Utility function shared across all tools for handling OAuth2 setup, credential validation, Gmail client initialization, API call execution, and error handling.
const handleTool = async (queryConfig: Record<string, any> | undefined, apiCall: (gmail: gmail_v1.Gmail) => Promise<any>) => { try { const oauth2Client = queryConfig ? createOAuth2Client(queryConfig) : defaultOAuth2Client if (!oauth2Client) throw new Error('OAuth2 client could not be created, please check your credentials') const credentialsAreValid = await validateCredentials(oauth2Client) if (!credentialsAreValid) throw new Error('OAuth2 credentials are invalid, please re-authenticate') const gmailClient = queryConfig ? google.gmail({ version: 'v1', auth: oauth2Client }) : defaultGmailClient if (!gmailClient) throw new Error('Gmail client could not be created, please check your credentials') const result = await apiCall(gmailClient) return result } catch (error: any) { return `Tool execution failed: ${error.message}` } } - src/index.ts:47-47 (helper)Utility to format API responses into MCP-standard content structure with JSON-stringified data.
const formatResponse = (response: any) => ({ content: [{ type: "text", text: JSON.stringify(response) }] })