# Inbox Zero Documentation

- [Introduction](https://docs.getinboxzero.com/introduction.md): Your AI email assistant for Gmail and Outlook
- [Getting Started](https://docs.getinboxzero.com/essentials/getting-started.md): Connect your inbox and complete your first Inbox Zero workflow.
- [AI Chat](https://docs.getinboxzero.com/essentials/ai-chat.md): Manage your inbox through a natural-language conversation.
- [AI Personal Assistant](https://docs.getinboxzero.com/essentials/email-ai-personal-assistant.md): Create rules that automatically manage incoming email.
- [Assistant Settings](https://docs.getinboxzero.com/essentials/assistant-settings.md): Control drafting, reminders, writing style, knowledge, and safety settings for your AI assistant.
- [Email Digest](https://docs.getinboxzero.com/essentials/email-digest.md): Combine email from selected rules into a scheduled summary.
- [Delayed Actions](https://docs.getinboxzero.com/essentials/delayed-actions.md): Run supported rule actions after a configurable delay.
- [Call Webhook](https://docs.getinboxzero.com/essentials/call-webhook.md): Send rule and email metadata to an external HTTP endpoint.
- [Bulk Unsubscribe](https://docs.getinboxzero.com/essentials/bulk-email-unsubscriber.md): Review newsletter senders and unsubscribe, archive, or delete in bulk.
- [Bulk Archive](https://docs.getinboxzero.com/essentials/bulk-archiver.md): Archive, mark as read, or delete email in bulk by category.
- [Analytics](https://docs.getinboxzero.com/essentials/email-analytics.md): Understand email volume, response time, and assistant activity.
- [Calendar Integration](https://docs.getinboxzero.com/essentials/calendar-integration.md): Connect calendars for AI scheduling, availability, booking links, and meeting briefs.
- [Booking Links](https://docs.getinboxzero.com/essentials/booking-links.md): Share your availability and let guests schedule directly on your calendar.
- [Meeting Briefs](https://docs.getinboxzero.com/essentials/meeting-briefs.md): Get AI-generated context before meetings with external guests.
- [Channels](https://docs.getinboxzero.com/essentials/channels.md): Connect Slack, Microsoft Teams, or Telegram and control what Inbox Zero delivers to chat.
- [Slack Integration](https://docs.getinboxzero.com/essentials/slack-integration.md): Chat with your assistant and deliver rules, drafts, and updates to Slack.
- [Telegram Integration](https://docs.getinboxzero.com/essentials/telegram-integration.md): Chat with your assistant and receive Inbox Zero updates in Telegram.
- [Connect MCP](https://docs.getinboxzero.com/essentials/mcp.md): Let ChatGPT, Claude, or Cursor search your inbox, create drafts, and manage rules.
- [Auto-File Attachments](https://docs.getinboxzero.com/essentials/auto-file-attachments.md): Automatically organize email attachments in Google Drive or OneDrive.
- [Cold Email Blocker](https://docs.getinboxzero.com/essentials/cold-email-blocker.md): Block cold emails and protect your inbox from spam using AI filters.
- [Mobile Apps](https://docs.getinboxzero.com/essentials/mobile-apps.md): Use Inbox Zero on iOS or Android to triage email and manage your assistant on the go.
- [Inbox Zero Tabs Extension](https://docs.getinboxzero.com/essentials/inbox-zero-tabs-extension.md): Add custom tabs to Gmail for email organization
- [Organizations](https://docs.getinboxzero.com/essentials/organizations.md): Invite teammates, manage roles, share assistant rules, and view consented team analytics.
- [Use Your Own AI API Key](https://docs.getinboxzero.com/essentials/api-keys.md): Choose an AI provider, model, and provider API key for Inbox Zero features.
- [Security, Permissions, and AI](https://docs.getinboxzero.com/essentials/security-and-data.md): Understand account access, confirmations, sensitive-data controls, and recovery.
- [Using Outlook](https://docs.getinboxzero.com/essentials/outlook-guide.md): Terminology, tips, and troubleshooting for Outlook and Microsoft 365 accounts.
- [Troubleshooting](https://docs.getinboxzero.com/essentials/troubleshooting.md): Resolve common mailbox, rule, draft, calendar, and channel problems.
- [FAQ](https://docs.getinboxzero.com/essentials/faq.md): Frequently Asked Questions
- [Meeting Recorder](https://docs.getinboxzero.com/essentials/meeting-recorder.md): Record calls with a visible notetaker and receive transcripts, notes, action items, and follow-up drafts.
- [Deep Clean](https://docs.getinboxzero.com/essentials/deep-clean.md): Preview an AI-assisted cleanup of older Gmail messages before applying it to the rest of your inbox.
- [Reply Zero](https://docs.getinboxzero.com/essentials/reply-zero.md): Track conversations that need a reply or a follow-up.
- [Context Integrations](https://docs.getinboxzero.com/essentials/context-integrations.md): Connect read-oriented business tools so drafts and meeting briefs can use relevant external context.
- [Quick Start](https://docs.getinboxzero.com/hosting/quick-start.md): Self-host Inbox Zero in under 5 minutes
- [Self-Hosting Setup CLI](https://docs.getinboxzero.com/hosting/setup-cli-reference.md): Use the Inbox Zero setup CLI for local, cloud, and automated deployments.
- [Overview](https://docs.getinboxzero.com/hosting/setup-guides.md): Manual setup for OAuth, PubSub, and your AI provider
- [Google OAuth](https://docs.getinboxzero.com/hosting/google-oauth.md): Configure Google OAuth credentials, scopes, and required APIs
- [Google PubSub](https://docs.getinboxzero.com/hosting/google-pubsub.md): Configure Gmail push notifications with Google PubSub
- [Microsoft OAuth](https://docs.getinboxzero.com/hosting/microsoft-oauth.md): Configure Azure app registration and Microsoft Graph permissions
- [Enterprise SSO and SCIM](https://docs.getinboxzero.com/hosting/sso.md): Configure SAML SSO and SCIM user provisioning for organization deployments.
- [LLM](https://docs.getinboxzero.com/hosting/llm-setup.md): Configure your AI provider via environment variables
- [Docker/VPS Deployment Guide](https://docs.getinboxzero.com/hosting/self-hosting.md): Production deployment on your own VPS with Docker and Docker Compose
- [Environment Variables](https://docs.getinboxzero.com/hosting/environment-variables.md): Reference for self-hosting environment variables used in Inbox Zero
- [Production Operations](https://docs.getinboxzero.com/hosting/production-operations.md): Operate, update, back up, and recover a self-hosted Inbox Zero deployment.
- [Security Hardening](https://docs.getinboxzero.com/hosting/security-hardening.md): Recommended steps for locking down a self-hosted Inbox Zero deployment.
- [Vercel Deployment](https://docs.getinboxzero.com/hosting/vercel.md): Deploy Inbox Zero on Vercel using Neon and Upstash integrations
- [Kubernetes Deployment](https://docs.getinboxzero.com/hosting/kubernetes.md): Run Inbox Zero on Kubernetes with the Helm chart
- [Troubleshooting](https://docs.getinboxzero.com/hosting/troubleshooting.md): Solutions for common issues when running Inbox Zero
- [Image Proxy](https://docs.getinboxzero.com/hosting/image-proxy.md): Deploy the optional email image proxy for stronger privacy in web and desktop clients
- [AWS Deployment](https://docs.getinboxzero.com/hosting/aws.md): Choose the right AWS deployment method for Inbox Zero
- [EC2 Deployment](https://docs.getinboxzero.com/hosting/ec2-deployment.md): Deploy Inbox Zero on AWS EC2 with ALB
- [Terraform Deployment](https://docs.getinboxzero.com/hosting/terraform.md): Deploy Inbox Zero to AWS using Terraform
- [Copilot Deployment](https://docs.getinboxzero.com/hosting/aws-copilot.md): Deploy Inbox Zero to AWS using AWS Copilot and ECS Fargate
- [GCP + Cloudflare Tunnel](https://docs.getinboxzero.com/hosting/gcp-cloudflare-tunnel.md): Deploy Inbox Zero on Google Cloud Compute Engine with Cloudflare Tunnel for HTTPS — no reverse proxy or SSL certificates required
- [Contributing](https://docs.getinboxzero.com/contributing.md): Set up Inbox Zero for local development
- [Slack Integration Setup](https://docs.getinboxzero.com/slack/setup.md): Set up the Slack bot for meeting briefs and AI assistant
- [Microsoft Teams Integration Setup](https://docs.getinboxzero.com/teams/setup.md): Set up the Teams bot for Inbox Zero assistant chat.
- [Telegram Integration Setup](https://docs.getinboxzero.com/telegram/setup.md): Set up the Telegram bot for Inbox Zero assistant chat.
- [Introduction](https://docs.getinboxzero.com/api-reference/introduction.md)
- [CLI](https://docs.getinboxzero.com/api-reference/cli.md): Use the Inbox Zero API CLI from npm or npx.
- [MCP server](https://docs.getinboxzero.com/api-reference/mcp.md): Connect ChatGPT, Claude, Cursor, or another assistant to Inbox Zero mail, drafts, rules, and statistics with OAuth.
- [Get stats by period](https://docs.getinboxzero.com/api-reference/endpoint/get-statsby-period.md): Get email statistics grouped by time period. Returns counts of emails by status (all, sent, read, unread, archived, unarchived) for each period.
- [Get stats response time](https://docs.getinboxzero.com/api-reference/endpoint/get-statsresponse-time.md): Get email response time statistics. Returns summary stats, distribution, and trend data showing how quickly you respond to emails.
- [List rules](https://docs.getinboxzero.com/api-reference/endpoint/get-rules.md): List automation rules for the scoped inbox account.
- [Create rule](https://docs.getinboxzero.com/api-reference/endpoint/post-rules.md): Create an automation rule for the scoped inbox account.
- [Get rule](https://docs.getinboxzero.com/api-reference/endpoint/get-rules-id.md): Get a single automation rule for the scoped inbox account.
- [Update rule](https://docs.getinboxzero.com/api-reference/endpoint/put-rules-id.md): Replace an automation rule for the scoped inbox account.
- [Delete rule](https://docs.getinboxzero.com/api-reference/endpoint/delete-rules-id.md): Delete an automation rule for the scoped inbox account.
- [Unsubscribe sender](https://docs.getinboxzero.com/api-reference/endpoint/post-senders-unsubscribe.md): Unsubscribe from a sender for the scoped inbox. Looks up List-Unsubscribe from that sender's mail when a link is not provided. Check unsubscribe.success: when it is false the sender was left unchanged.

## OpenAPI Specs

- [openapi](/openapi.json)

## Optional

- [Community](https://getinboxzero.com/discord)
- [Blog](https://www.getinboxzero.com/blog)


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.