收件箱零的 AI 電子郵件助手

什麼是 Inbox Zero？

Inbox Zero 是一個創新的開源應用程式，旨在幫助用戶有效管理電子郵件，實現「收件箱零」的狀態。這一概念指的是保持收件箱空白或儘可能接近空白的做法，讓用戶能夠專注於重要任務，而不會受到未讀郵件的干擾。該應用程式提供了簡化電子郵件管理的工具和功能，使得用戶更容易優先處理和及時回覆信息。

Inbox Zero 的功能

• 用戶友好的介面：該應用程式擁有乾淨且直觀的設計，簡化了導航並提升了用戶體驗。
• 電子郵件分類：根據優先級、發件人或主題自動將電子郵件分類到不同的文件夾，幫助用戶快速識別重要信息。
• 任務管理整合：與任務管理工具無縫整合，將電子郵件轉換為可執行的任務，確保沒有任何事情被忽略。
• 可自定義通知：設置個性化的通知偏好，以便在不被不斷提醒所困擾的情況下，及時獲取重要郵件的更新。
• 搜索功能：先進的搜索選項使得用戶能夠快速找到特定的電子郵件，節省時間和精力。
• 開源：作為一個開源項目，用戶可以參與其開發，自定義功能，並確保應用程式隨著需求的變化而發展。

如何使用 Inbox Zero

1. 下載和安裝：訪問 getinboxzero.com 下載應用程式並按照安裝說明進行操作。
2. 連接您的電子郵件：安裝完成後，將您的電子郵件帳戶連接到應用程式，以實現無縫整合。
3. 設置分類：根據您的偏好自定義電子郵件分類，例如工作、個人或緊急。
4. 管理通知：調整通知設置，以便在減少干擾的情況下接收重要郵件的提醒。
5. 開始整理：開始篩選您的電子郵件，對其進行分類，並將重要信息轉換為任務。
6. 維持 Inbox Zero：定期檢查您的收件箱，及時回覆電子郵件，並保持收件箱的整潔，以實現和維持收件箱零的狀態。

常見問題解答

問：Inbox Zero 是免費使用的嗎？

答：是的，Inbox Zero 是一個開源應用程式，這意味著它是免費下載和使用的。

問：我可以自定義 Inbox Zero 的功能嗎？

答：當然可以！作為開源項目，用戶可以根據自己的具體需求和偏好修改應用程式。

問：Inbox Zero 支持多個電子郵件帳戶嗎？

答：是的，您可以將多個電子郵件帳戶連接到 Inbox Zero，讓您在一個地方管理所有電子郵件。

問：Inbox Zero 如何幫助提高生產力？

答：通過組織電子郵件並將其轉換為任務，Inbox Zero 幫助用戶專注於最重要的事情，減少壓力並提高生產力。

問：我可以在哪裡找到 Inbox Zero 的支持？

答：您可以在官方 GitHub 倉庫 或應用程式的網站上找到支持和社區討論。

<p align="center"> <a href="https://www.getinboxzero.com"> <h1 align="center">Inbox Zero - Your AI Email Assistant</h1> </a> <p align="center"> Open source email app to reach inbox zero fast. <br /> <a href="https://www.getinboxzero.com">Website</a> · <a href="https://www.getinboxzero.com/discord">Discord</a> · <a href="https://github.com/elie222/inbox-zero/issues">Issues</a> </p> </p>

About

There are two parts to Inbox Zero:

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

If you're looking to contribute 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

• Next.js
• Tailwind CSS
• shadcn/ui
• Prisma
• Upstash
• Turborepo

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.

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.

Requirements

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

Make sure you have the above installed before starting.

The external services that are required are (detailed setup instructions below):

• Google OAuth
• Google PubSub

Updating .env file: secrets

Create your own .env file from the example supplied:

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.ts.

The required environment variables:

Secrets:

• NEXTAUTH_SECRET -- can be any random string (try using openssl rand -hex 32 for a quick secure random string)
• 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)

Redis:

• 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.

Updating .env file with Google OAuth credentials:

• GOOGLE_CLIENT_ID -- Google OAuth client ID. More info here
• GOOGLE_CLIENT_SECRET -- Google OAuth client secret. More info here

Go to Google Cloud. Create a new project if necessary.

Create new credentials:

1. If the banner shows up, configure consent screen (if not, you can do this later)

   1. Click the banner, then Click Get Started.
   2. Choose a name for your app, and enter your email.
   3. In Audience, choose External
   4. Enter your contact information
   5. Agree to the User Data policy and then click Create.
   6. Return to APIs and Services using the left sidebar.

2. Create new credentials:

   1. Click the +Create Credentials button. Choose OAuth Client ID.
   2. In Application Type, Choose Web application
   3. Choose a name for your web client
   4. In Authorized JavaScript origins, add a URI and enter http://localhost:3000
   5. In Authorized redirect URIs enter http://localhost:3000/api/auth/callback/google
   6. Click Create.
   7. A popup will show up with the new credentials, including the Client ID and secret.

3. Update .env file:

   1. Copy the Client ID to GOOGLE_CLIENT_ID
   2. Copy the Client secret to GOOGLE_CLIENT_SECRET

4. Update scopes

   1. Go to Data Access in the left sidebar (or click link above)
   2. Click Add or remove scopes
   3. Copy paste the below into the Manually add scopes box:

   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
   

   4. Click Update
   5. Click Save in the Data Access page.

5. Add yourself as a test user

   1. Go to Audience
   2. In the Test users section, click +Add users
   3. Enter your email and press Save

Updating .env file with LLM parameters

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

• Anthropic
• OpenAI
• AWS Bedrock Anthropic
• Google Gemini
• Groq Llama 3.3 70B
• Ollama (local)

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

OLLAMA_BASE_URL=http://localhost:11434/api
NEXT_PUBLIC_OLLAMA_MODEL=phi3

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.

If you are using local ollama, you can set it to be default:

DEFAULT_LLM_PROVIDER=ollama

If this is the case you must also set the ECONOMY_LLM_PROVIDER environment variable.

Redis and Postgres

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

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

Running the app

To run the migrations:

pnpm prisma migrate dev

To run the app locally for development (slower):

pnpm run dev

Or from the project root:

turbo dev

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

pnpm run build
pnpm start

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

Premium

Many features are available only to premium users. To upgrade yourself, make yourself an admin in the .env: ADMINS=hello@gmail.com Then upgrade yourself at: http://localhost:3000/admin.

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?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:

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.

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).