update_auto_forwarding
Configure automatic email forwarding in Gmail by setting forwarding address, enabling/disabling the feature, and specifying 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:879-884 (handler)Handler function that executes the tool logic by calling the Gmail API's updateAutoForwarding method, wrapped in handleTool for auth and formatting.
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:874-878 (schema)Input schema defined using Zod for validating parameters: enabled (boolean), emailAddress (string), disposition (enum).
{ 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:872-885 (registration)MCP server.tool registration for 'update_auto_forwarding' including name, description, schema, and handler function.
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:50-66 (helper)Shared helper function that handles OAuth2 client creation, credential validation, Gmail client initialization, and error handling for all Gmail API tool calls.
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}` } }