create_forwarding_address
Set up email forwarding in Gmail by specifying a destination address to automatically redirect incoming 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:1082-1087 (handler)The handler function for the 'create_forwarding_address' tool. It uses the shared 'handleTool' helper to manage authentication and executes the Gmail API call to create a new forwarding address.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:1079-1081 (schema)Input schema for the 'create_forwarding_address' tool, defining the required 'forwardingEmail' parameter using Zod.{ forwardingEmail: z.string().describe("An email address to which messages can be forwarded") },
- src/index.ts:1077-1088 (registration)Registration of the 'create_forwarding_address' tool on the MCP server, specifying name, description, input schema, and handler.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-80 (helper)Shared 'handleTool' helper function used by all Gmail API tools, including create_forwarding_address. Handles OAuth2 client setup, credential validation, Gmail client creation, API execution, and specialized error handling for authentication issues.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}` }); } }