update_auto_forwarding
Configure automatic email forwarding in Gmail by setting the forwarding address, enabling/disabling the feature, and choosing what happens to original messages after forwarding.
Instructions
Updates automatic forwarding settings
Input Schema
TableJSON Schema
| Name | Required | Description | Default |
|---|---|---|---|
| enabled | Yes | Whether all incoming mail is automatically forwarded to another address | |
| emailAddress | Yes | Email address to which messages should be automatically forwarded | |
| disposition | Yes | The state in which messages should be left after being forwarded |
Implementation Reference
- src/index.ts:886-898 (registration)Registration of the 'update_auto_forwarding' tool. Includes the tool name, description, input schema (enabled, emailAddress, disposition), and the handler function that uses handleTool to call the Gmail API's users.settings.updateAutoForwarding method.server.tool("update_auto_forwarding", "Updates automatic forwarding settings", { enabled: z.boolean().describe("Whether all incoming mail is automatically forwarded to another address"), emailAddress: z.string().describe("Email address to which messages should be automatically forwarded"), disposition: z.enum(['leaveInInbox', 'archive', 'trash', 'markRead']).describe("The state in which messages should be left after being forwarded") }, async (params) => { return handleTool(config, async (gmail: gmail_v1.Gmail) => { const { data } = await gmail.users.settings.updateAutoForwarding({ userId: 'me', requestBody: params }) return formatResponse(data) }) }
- src/index.ts:893-897 (handler)The handler function for 'update_auto_forwarding' tool. It invokes handleTool with the Gmail client to execute gmail.users.settings.updateAutoForwarding, passing the params as requestBody, and formats the response.async (params) => { return handleTool(config, async (gmail: gmail_v1.Gmail) => { const { data } = await gmail.users.settings.updateAutoForwarding({ userId: 'me', requestBody: params }) return formatResponse(data) })
- src/index.ts:889-892 (schema)Input schema for the 'update_auto_forwarding' tool using Zod: enabled (boolean), emailAddress (string), disposition (enum: leaveInInbox, archive, trash, markRead).enabled: z.boolean().describe("Whether all incoming mail is automatically forwarded to another address"), emailAddress: z.string().describe("Email address to which messages should be automatically forwarded"), disposition: z.enum(['leaveInInbox', 'archive', 'trash', 'markRead']).describe("The state in which messages should be left after being forwarded") },
- src/index.ts:50-80 (helper)Shared helper function 'handleTool' used by all tools, including update_auto_forwarding. Handles OAuth2 client creation, credential validation, Gmail client setup, API call execution, error handling (especially auth errors), and response formatting.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}` }); } }