Inbox Zero

Open source email management tools to reach inbox zero fast.
Website · Discord · Issues · Roadmap

About

Inbox Zero is a powerful open-source tool designed for Gmail and Gsuite users. It streamlines your email management, helping you achieve 'Inbox Zero' swiftly with features like email analytics, newsletter management, and AI assistance. Enhance your email experience without replacing your client!

Demo Video

Key Features

• Email Analytics: Track your email activity with daily, weekly, and monthly stats.
• Newsletter Management: Easily manage and unsubscribe from newsletters.
• New Senders: Identify and block new spam senders.
• Unreplied Emails: Keep track of emails awaiting responses.
• Large Email Finder: Free up space by locating and deleting large emails.
• AI Auto-Responder: Automate responses for common queries.
• AI Email Assistant: Auto-archive, label, and forward emails based on set rules.

Built with

• Next.js
• Tailwind CSS
• shadcn/ui
• Prisma
• Tinybird
• Upstash
• Turbo

Roadmap

Explore our upcoming features and improvements on our Roadmap. Your feedback and feature requests are always welcome!

Getting Started for Developers

Requirements

• Node.js >= 18.0.0
• pnpm >= 8.6.12
• Docker desktop

The external services that are required are:

• OpenAI
• Google OAuth
• Google PubSub - see set up instructions below
• Upstash Redis
• Tinybird

We use Postgres for the database.

You can run Postgres & Redis locally using docker-compose

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

Create your own .env file:

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

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

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
• TINYBIRD_TOKEN -- Admin token for your Tinybird workspace (be sure to create an instance in the GCP us-east4 region. This can also be changed via your .env if you prefer a different region).
• OPENAI_API_KEY -- Standard OpenAI API key.

To run the migrations:

pnpm prisma migrate dev

Now run:

pnpm run dev

Or from the project root:

turbo dev

Open http://localhost:3000 to view it in your browser. To upgrade yourself to admin visit: http://localhost:3000/admin.

Setting up Tinybird

Follow the instructions here to setup the pipes and datasources.

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

Follow instructions here.

1. Create a topic
2. Create a subscription
3. Grant publish rights on your topic

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 or https://abc.ngrok-free.app/api/google/webhook where the domain is your domain.

To run in development ngrok can be helpful:

ngrok http 3000

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

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