create_forwarding_address
Set up email forwarding in Gmail by adding a destination address to receive forwarded messages.
Instructions
Creates a forwarding address
Input Schema
TableJSON Schema
| Name | Required | Description | Default |
|---|---|---|---|
| forwardingEmail | Yes | An email address to which messages can be forwarded |
Implementation Reference
- src/index.ts:1068-1073 (handler)Handler function that executes the create_forwarding_address tool logic. It uses the shared handleTool to authenticate, create Gmail client, call the forwardingAddresses.create API with the provided params, and format the response.async (params) => { return handleTool(config, async (gmail: gmail_v1.Gmail) => { const { data } = await gmail.users.settings.forwardingAddresses.create({ userId: 'me', requestBody: params }) return formatResponse(data) }) }
- src/index.ts:1065-1067 (schema)Zod input schema definition for the create_forwarding_address tool, requiring a 'forwardingEmail' string parameter.{ forwardingEmail: z.string().describe("An email address to which messages can be forwarded") },
- src/index.ts:1063-1074 (registration)MCP server tool registration for 'create_forwarding_address', including description, schema, and handler function.server.tool("create_forwarding_address", "Creates a forwarding address", { forwardingEmail: z.string().describe("An email address to which messages can be forwarded") }, async (params) => { return handleTool(config, async (gmail: gmail_v1.Gmail) => { const { data } = await gmail.users.settings.forwardingAddresses.create({ userId: 'me', requestBody: params }) return formatResponse(data) }) } )
- src/index.ts:50-66 (helper)Shared utility function 'handleTool' that manages OAuth2 authentication, credential validation, Gmail client creation, executes the provided API callback, and handles errors. Used by create_forwarding_address and other tools.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}` } }