batch_delete_messages
Delete multiple Gmail messages simultaneously by specifying their IDs to manage inbox clutter efficiently.
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:539-544 (handler)The handler function for batch_delete_messages tool that calls the Gmail API's users.messages.batchDelete method via the shared handleTool function.
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:536-538 (schema)Input schema for the batch_delete_messages tool, requiring an array of message IDs.
{ ids: z.array(z.string()).describe("The IDs of the messages to delete") }, - src/index.ts:534-545 (registration)Registration of the batch_delete_messages tool using McpServer.tool() including description, input schema, and handler function.
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:50-80 (helper)Shared helper function handleTool used by batch_delete_messages (and other tools) to handle OAuth2 authentication, Gmail client creation, 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) { // Check for specific authentication errors if ( error.message?.includes("invalid_grant") || error.message?.includes("refresh_token") || error.message?.includes("invalid_client") || error.message?.includes("unauthorized_client") || error.code === 401 || error.code === 403 ) { return formatResponse({ error: `Authentication failed: ${error.message}. Please re-authenticate by running: npx @shinzolabs/gmail-mcp auth`, }); } return formatResponse({ error: `Tool execution failed: ${error.message}` }); } }