list_forwarding_addresses
Retrieve all forwarding addresses configured for your Gmail account to review or manage email forwarding rules.
Instructions
Lists the forwarding addresses for the specified account
Input Schema
TableJSON Schema
| Name | Required | Description | Default |
|---|---|---|---|
No arguments | |||
Implementation Reference
- src/index.ts:1116-1125 (registration)Registration of the 'list_forwarding_addresses' tool via server.tool() with no required schema params. Handler calls gmail.users.settings.forwardingAddresses.list().
server.tool("list_forwarding_addresses", "Lists the forwarding addresses for the specified account", {}, async () => { return handleTool(config, async (gmail: gmail_v1.Gmail) => { const { data } = await gmail.users.settings.forwardingAddresses.list({ userId: 'me' }) return formatResponse(data) }) } ) - src/index.ts:1119-1125 (handler)The handler function for list_forwarding_addresses. It delegates to handleTool, which creates/validates OAuth2 client, then calls the Gmail API's forwardingAddresses.list method.
async () => { return handleTool(config, async (gmail: gmail_v1.Gmail) => { const { data } = await gmail.users.settings.forwardingAddresses.list({ userId: 'me' }) return formatResponse(data) }) } ) - src/index.ts:50-80 (helper)Helper function that wraps all tool handlers, providing OAuth2 client creation, credential validation, 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}` }); } }