You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
"Initiate OAuth flow to connect user's email inbox.\n\nReturns an `oauth_url` that you should redirect the user to. After authorization,\nthey are redirected back to your `redirect_uri` with the following query parameters:\n\n**On success:**\n- `inbox_token` - Encrypted token to store client-side\n- `email` - Email address of the connected account\n- `state` - Your original state parameter (for CSRF verification)\n\n**On error:**\n- `error` - Error code (e.g., `access_denied`, `token_exchange_failed`)\n- `state` - Your original state parameter\n\n**Store the `inbox_token` client-side** and use it for all subsequent inbox API calls.\n",
569
+
"Initiate OAuth flow to connect user's email inbox.\n\nReturns an `oauth_url` that you should redirect the user to. After authorization,\nthey are redirected back to your `redirect_uri` with the following query parameters:\n\n**On success:**\n- `inbox_token` - Encrypted token to store client-side\n- `email` - Email address of the connected account\n- `state` - Your original state parameter (for CSRF verification)\n\n**On error:**\n- `error` - Error code (e.g., `access_denied`, `token_exchange_failed`)\n- `state` - Your original state parameter\n\n**Store the `inbox_token` client-side** and use it for all subsequent inbox API calls.\nThe token is long-lived (it stores an encrypted refresh token), so a single OAuth\nconnect gives ongoing access to both historical and future CAS statements in the\nuser's inbox. Reuse the same token until the user revokes access via\n`/v4/inbox/disconnect` or their provider's account settings.\n",
"## connect_email\n\n`client.inbox.connectEmail(redirect_uri: string, provider?: 'gmail' | 'outlook', state?: string): { expires_in?: number; oauth_url?: string; provider?: 'gmail' | 'outlook'; status?: string; }`\n\n**post** `/v4/inbox/connect`\n\nInitiate OAuth flow to connect user's email inbox.\n\nReturns an `oauth_url` that you should redirect the user to. After authorization,\nthey are redirected back to your `redirect_uri` with the following query parameters:\n\n**On success:**\n- `inbox_token` - Encrypted token to store client-side\n- `email` - Email address of the connected account\n- `state` - Your original state parameter (for CSRF verification)\n\n**On error:**\n- `error` - Error code (e.g., `access_denied`, `token_exchange_failed`)\n- `state` - Your original state parameter\n\n**Store the `inbox_token` client-side** and use it for all subsequent inbox API calls.\n\n\n### Parameters\n\n- `redirect_uri: string`\n Your callback URL to receive the inbox_token (must be http or https)\n\n- `provider?: 'gmail' | 'outlook'`\n Mail provider to connect. Defaults to `gmail`.\n\n- `gmail` - Google accounts\n- `outlook` - Microsoft accounts\n\nAny value other than `outlook` is treated as `gmail`. The\nresolved provider is returned in the response.\n\n- `state?: string`\n State parameter for CSRF protection (returned in redirect)\n\n### Returns\n\n- `{ expires_in?: number; oauth_url?: string; provider?: 'gmail' | 'outlook'; status?: string; }`\n\n - `expires_in?: number`\n - `oauth_url?: string`\n - `provider?: 'gmail' | 'outlook'`\n - `status?: string`\n\n### Example\n\n```typescript\nimport CasParser from 'cas-parser-node';\n\nconst client = new CasParser();\n\nconst response = await client.inbox.connectEmail({ redirect_uri: 'https://yourapp.com/oauth-callback' });\n\nconsole.log(response);\n```",
576
+
"## connect_email\n\n`client.inbox.connectEmail(redirect_uri: string, provider?: 'gmail' | 'outlook' | 'zoho', state?: string): { expires_in?: number; oauth_url?: string; provider?: 'gmail' | 'outlook' | 'zoho'; status?: string; }`\n\n**post** `/v4/inbox/connect`\n\nInitiate OAuth flow to connect user's email inbox.\n\nReturns an `oauth_url` that you should redirect the user to. After authorization,\nthey are redirected back to your `redirect_uri` with the following query parameters:\n\n**On success:**\n- `inbox_token` - Encrypted token to store client-side\n- `email` - Email address of the connected account\n- `state` - Your original state parameter (for CSRF verification)\n\n**On error:**\n- `error` - Error code (e.g., `access_denied`, `token_exchange_failed`)\n- `state` - Your original state parameter\n\n**Store the `inbox_token` client-side** and use it for all subsequent inbox API calls.\nThe token is long-lived (it stores an encrypted refresh token), so a single OAuth\nconnect gives ongoing access to both historical and future CAS statements in the\nuser's inbox. Reuse the same token until the user revokes access via\n`/v4/inbox/disconnect` or their provider's account settings.\n\n\n### Parameters\n\n- `redirect_uri: string`\n Your callback URL to receive the inbox_token (must be http or https)\n\n- `provider?: 'gmail' | 'outlook' | 'zoho'`\n Mail provider to connect. Defaults to `gmail`.\n\n- `gmail` - Google accounts: `@gmail.com` and Google\n Workspace domains.\n- `outlook` - personal Microsoft accounts: `@outlook.com`,\n `@hotmail.com`, `@live.com`, `@msn.com` and localised\n variants (`@hotmail.co.uk`, `@live.in`, `@hotmail.fr`).\n Any other address registered as a personal Microsoft\n account also works, including custom domains.\n- `zoho` - Zoho Mail accounts, including custom domains\n hosted on Zoho.\n\nAny unrecognised value is treated as `gmail`. The resolved\nprovider is returned in the response.\n\n- `state?: string`\n State parameter for CSRF protection (returned in redirect)\n\n### Returns\n\n- `{ expires_in?: number; oauth_url?: string; provider?: 'gmail' | 'outlook' | 'zoho'; status?: string; }`\n\n - `expires_in?: number`\n - `oauth_url?: string`\n - `provider?: 'gmail' | 'outlook' | 'zoho'`\n - `status?: string`\n\n### Example\n\n```typescript\nimport CasParser from 'cas-parser-node';\n\nconst client = new CasParser();\n\nconst response = await client.inbox.connectEmail({ redirect_uri: 'https://yourapp.com/oauth-callback' });\n\nconsole.log(response);\n```",
0 commit comments