inbox-zero

Tue, 22 Apr 2025 15:28:29 +0800

elie222/inbox-zero

Inbox Zero - Your AI Email Assistant

Open source email app to reach inbox zero fast.
Website · Discord · Issues

About

There are two parts to Inbox Zero:

An AI email assistant that helps you spend less time on email.
Open source AI email client.

If you’re looking to contribue to the project, the email client is the best place to do this.

Thanks to Vercel for sponsoring Inbox Zero in support of open-source software.

Features

AI Personal Assistant: Manages your email for you based on a plain text prompt file. It can take any action a human assistant can take on your behalf (Draft reply, Label, Archive, Reply, Forward, Mark Spam, and even call a webhook).
Reply Zero: Track emails that need your reply and those awaiting responses.
Smart Categories: Categorize everyone that’s ever emailed you.
Bulk Unsubscriber: Quickly unsubscribe from emails you never read in one-click.
Cold Email Blocker: Automatically block cold emails.
Email Analytics: Track your email activity with daily, weekly, and monthly stats.

Learn more in our docs.

Feature Screenshots


AI Assistant	Reply Zero

Gmail client	Bulk Unsubscriber

Demo Video

Built with

Star History

Feature Requests

To request a feature open a GitHub issue, or join our Discord.

Getting Started for Developers

We offer a hosted version of Inbox Zero at https://getinboxzero.com. To self-host follow the steps below.

Contributing to the project

You can view open tasks in our GitHub Issues. Join our Discord to discuss tasks and check what’s being worked on.

ARCHITECTURE.md explains the architecture of the project (LLM generated).

Requirements

Node.js >= 18.0.0
pnpm >= 8.6.12
Docker desktop (optional)

Setup

Here’s a video on how to set up the project. It covers the same steps mentioned in this document. But goes into greater detail on setting up the external services.

The external services that are required are:

Google OAuth
Google PubSub - see set up instructions below

You also need to set an LLM, but you can use a local one too:

Anthropic
OpenAI
AWS Bedrock Anthropic
Google Gemini
OpenRouter (any model)
Groq (Llama 3.3 70B)
Ollama (local)

We use Postgres for the database. For Redis, you can use Upstash Redis or set up your own Redis instance.

You can run Postgres & Redis locally using docker-compose

`1`	`docker-compose up -d # -d will run the services in the background`

Create your own .env file:

1
2
3

cp apps/web/.env.example apps/web/.env
cd apps/web
pnpm install

For self-hosting, you may also need to copy the .env file to both the root directory AND the apps/web directory (PRs welcome to improve this):

`1`	`cp apps/web/.env .env`

Set the environment variables in the newly created .env. You can see a list of required variables in: apps/web/env.ts.

The required environment variables:

NEXTAUTH_SECRET – can be any random string (try using openssl rand -hex 32 for a quick secure random string)
GOOGLE_CLIENT_ID – Google OAuth client ID. More info here
GOOGLE_CLIENT_SECRET – Google OAuth client secret. More info here
GOOGLE_ENCRYPT_SECRET – Secret key for encrypting OAuth tokens (try using openssl rand -hex 32 for a secure key)
GOOGLE_ENCRYPT_SALT – Salt for encrypting OAuth tokens (try using openssl rand -hex 16 for a secure salt)
UPSTASH_REDIS_URL – Redis URL from Upstash. (can be empty if you are using Docker Compose)
UPSTASH_REDIS_TOKEN – Redis token from Upstash. (or specify your own random string if you are using Docker Compose)

When using Vercel with Fluid Compute turned off, you should set MAX_DURATION=300 or lower. See Vercel limits for different plans here.

To run the migrations:

`1`	`pnpm prisma migrate dev`

To run the app locally for development (slower):

`1`	`pnpm run dev`

Or from the project root:

`1`	`turbo dev`

To build and run the app locally in production mode (faster):

1
2

pnpm run build
pnpm start

Open http://localhost:3000 to view the app in your browser.

To upgrade yourself, make yourself an admin in the .env: ADMINS=hello@gmail.com Then upgrade yourself at: http://localhost:3000/admin.

Supported LLMs

For the LLM, you can use Anthropic, OpenAI, or Anthropic on AWS Bedrock. You can also use Ollama by setting the following enviroment variables:

1
2
3

DEFAULT_LLM_PROVIDER=ollama
OLLAMA_BASE_URL=http://localhost:11434/api
NEXT_PUBLIC_OLLAMA_MODEL=gemma3  # or whatever available model you want to use

Note: If you need to access Ollama hosted locally and the application is running on Docker setup, you can use http://host.docker.internal:11434/api as the base URL. You might also need to set OLLAMA_HOST to 0.0.0.0 in the Ollama configuration file.

You can select the model you wish to use in the app on the /settings page of the app.

Setting up Google OAuth and Gmail API

Create a Project in Google Cloud Console
- Go to Google Cloud Console
- Create a new project
Enable Required APIs
- Enable the Gmail API
- Enable the People API

Configure the OAuth Consent Screen

Go to ‘APIs & Services’ > ‘OAuth consent screen’
Choose ‘External’ user type (or ‘Internal’ if you have Google Workspace)
Fill in required app information

Add the following scopes:

https://www.googleapis.com/auth/userinfo.profile
https://www.googleapis.com/auth/userinfo.email
https://www.googleapis.com/auth/gmail.modify
https://www.googleapis.com/auth/gmail.settings.basic
https://www.googleapis.com/auth/contacts

Add yourself as a test user under ‘Test users’ section

Create OAuth 2.0 Credentials
- Go to ‘APIs & Services’ > ‘Credentials’
- Click ‘Create Credentials’ > ‘OAuth client ID’
- Select ‘Web application’ type
- Add authorized JavaScript origins:
  - Development: http://localhost:3000
  - Production: https://your-production-url.com
- Add authorized redirect URIs:
  - Development:
    1
    
    http://localhost:3000/api/auth/callback/google
  - Production:
    1
    
    https://your-production-url.com/api/auth/callback/google

Configure Environment Variables

Add to your .env file:

1
2

GOOGLE_CLIENT_ID=your_client_id
GOOGLE_CLIENT_SECRET=your_client_secret

Set up push notifications via Google PubSub to handle emails in real time

Follow instructions here.

Set env var GOOGLE_PUBSUB_TOPIC_NAME. When creating the subscription select Push and the url should look something like: https://www.getinboxzero.com/api/google/webhook?token=TOKEN or https://abc.ngrok-free.app/api/google/webhook?token=TOKEN where the domain is your domain. Set GOOGLE_PUBSUB_VERIFICATION_TOKEN in your .env file to be the value of TOKEN.

To run in development ngrok can be helpful:

1
2
3

ngrok http 3000
# or with an ngrok domain to keep your endpoint stable (set `XYZ`):
ngrok http --domain=XYZ.ngrok-free.app 3000

And then update the webhook endpoint in the Google PubSub subscriptions dashboard.

To start watching emails visit: /api/google/watch/all

Watching for email updates

Set a cron job to run these: The Google watch is necessary. Others are optional.

  "crons": [
    {
      "path": "/api/google/watch/all",
      "schedule": "0 1 * * *"
    },
    {
      "path": "/api/resend/summary/all",
      "schedule": "0 16 * * 1"
    },
    {
      "path": "/api/reply-tracker/disable-unused-auto-draft",
      "schedule": "0 3 * * *"
    }
  ]

Here are some easy ways to run cron jobs. Upstash is a free, easy option. I could never get the Vercel vercel.json. Open to PRs if you find a fix for that.

Reply Zero on Producthunt daily