update_auto_forwarding
Modify automatic email forwarding settings by enabling or disabling forwarding, specifying the destination email address, and setting the message disposition (leaveInInbox, archive, trash, markRead).
Instructions
Updates automatic forwarding settings
Input Schema
TableJSON Schema
| Name | Required | Description | Default |
|---|---|---|---|
| disposition | Yes | The state in which messages should be left after being forwarded | |
| emailAddress | Yes | Email address to which messages should be automatically forwarded | |
| enabled | Yes | Whether all incoming mail is automatically forwarded to another address |
Implementation Reference
- src/index.ts:886-898 (registration)Registration of the 'update_auto_forwarding' tool, including input schema validation and the handler function that calls the Gmail API to update auto-forwarding settings.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-898 (handler)Handler function for update_auto_forwarding tool that uses handleTool wrapper to authenticate and call Gmail's updateAutoForwarding API method.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 for validation of enabled, emailAddress, and disposition parameters.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 update_auto_forwarding (and other tools) for 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}` }); } }