inbox zero

收件箱清零

开源电子邮件应用程序可快速实现收件箱为零。
网站 · Discord · 问题 · 看板

关于

Inbox Zero 是一款开源电子邮件应用程序，其目标是通过 AI 辅助帮助您快速实现收件箱清零。

演示视频

主要特点

• 新闻通讯清理器：轻松管理和取消订阅新闻通讯。
• AI助手：根据纯文本提示规则自动回复、归档、标签、转发邮件。
• 冷电子邮件拦截器：自动阻止冷电子邮件。
• 电子邮件分析：通过每日、每周和每月的统计数据跟踪您的电子邮件活动。
• 新发件人：识别并阻止新的垃圾邮件发件人。
• 未回复的电子邮件：跟踪等待回复的电子邮件。
• 大型电子邮件查找器：通过查找和删除大型电子邮件来释放空间。

内置

• Next.js
• 顺风CSS
• shadcn/ui
• 棱镜
• 小鸟
• 乌普斯塔什
• 涡轮

功能请求

要请求功能，请打开 GitHub 问题。如果您没有 GitHub 帐户，您可以在此处请求功能。或者加入我们的 Discord。

开发人员入门

为项目做出贡献

我们这里有一个公共看板。加入我们的 Discord 讨论任务并检查正在进行的工作。

要求

• Node.js >= 18.0.0
• pnpm >= 8.6.12
• Docker 桌面（可选）

设置

这是有关如何设置项目的视频。它涵盖了本文档中提到的相同步骤。但更详细地介绍了如何设置外部服务。

所需的外部服务有：

• 开放人工智能
• 谷歌OAuth
• Google PubSub - 请参阅下面的设置说明
• Upstash Redis - 您还可以将常规 Redis 与 Docker Compose 结合使用。
• Tinybird - 您可以在没有这个的情况下运行该应用程序，但某些功能将被禁用。

我们使用 Postgres 作为数据库。

您可以使用docker-compose在本地运行 Postgres 和 Redis

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

创建您自己的.env文件：

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

在新创建的.env中设置环境变量。您可以在以下位置查看所需变量的列表： apps/web/env.ts 。

所需的环境变量：

• NEXTAUTH_SECRET - 可以是任何随机字符串（尝试使用openssl rand -hex 32获得快速安全的随机字符串）
• GOOGLE_CLIENT_ID ——Google OAuth 客户端 ID。更多信息请点击此处
• GOOGLE_CLIENT_SECRET -- Google OAuth 客户端密钥。更多信息请点击此处
• OPENAI_API_KEY ——OpenAI API 密钥。
• UPSTASH_REDIS_URL -- 来自 Upstash 的 Redis URL。
• UPSTASH_REDIS_TOKEN -- 来自 Upstash 的 Redis 令牌。
• TINYBIRD_TOKEN - Tinybird 工作区的管理令牌（请务必在 GCP us-east4区域中创建一个实例。如果您喜欢不同的区域，也可以通过.env进行更改）。您还可以决定禁用 Tinybird，然后分析和批量取消订阅功能将被禁用。如果您决定禁用 Tinybird，请设置NEXT_PUBLIC_DISABLE_TINYBIRD=true 。

要运行迁移：

pnpm prisma migrate dev

要在本地运行应用程序：

pnpm run dev

或者从项目根目录：

turbo dev

打开 http://localhost:3000 在浏览器中查看。要将自己升级为管理员，请访问：http://localhost:3000/admin。

设置 Google OAuth 和 Gmail API

您需要在 Google Cloud Console 中启用这些范围：

 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

设置 Tinybird

按照此处的说明设置pipes和datasources 。

可选：如果您也想在 Tinybird 中存储 AI 使用统计信息，请在/packages/tinybird-ai-analytics中执行相同操作。

通过 Google PubSub 设置推送通知以实时处理电子邮件

请按照此处的说明进行操作。

1. 创建主题
2. 创建订阅
3. 授予您主题的发布权

设置环境变量GOOGLE_PUBSUB_TOPIC_NAME 。创建订阅时，选择“推送”，URL 应类似于： https://www.getinboxzero.com/api/google/webhook?token=TOKEN ?token=TOKEN 或https://abc.ngrok-free.app/api/google/webhook?token=TOKEN其中的域是您的域。将.env文件中的GOOGLE_PUBSUB_VERIFICATION_TOKEN设置为TOKEN的值。

在开发中运行 ngrok 会很有帮助：

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

然后更新 Google PubSub 订阅仪表板中的 Webhook 端点。

要开始观看电子邮件，请访问： /api/google/watch/all