inbox zero

受信箱ゼロ

オープンソースの電子メール アプリで、受信トレイを迅速にゼロに到達します。
ウェブサイト · Discord · 問題 · カンバン

について

Inbox Zero はオープンソースの電子メール アプリであり、その目標は、AI 支援により受信トレイを迅速にゼロに到達できるようにすることです。

デモビデオ

主な特長

• ニュースレター クリーナー:ニュースレターの管理と購読解除が簡単に行えます。
• AI アシスタント:プレーン テキスト プロンプト ルールに基づいて、メールの自動応答、アーカイブ、ラベル付け、転送を行います。
• コールドメール ブロッカー:コールドメールを自動的にブロックします。
• 電子メール分析:日次、週次、月次の統計情報を使用して電子メール アクティビティを追跡します。
• 新しい送信者:新しいスパム送信者を特定してブロックします。
• 未返信のメール:返信を待っているメールを追跡します。
• サイズの大きいメール ファインダー:サイズの大きいメールを見つけて削除し、スペースを解放します。

で構築

• Next.js
• 追い風 CSS
• シャドン/UI
• プリズマ
• タイニーバード
• アップスタッシュ
• ターボ

機能リクエスト

機能をリクエストするには、GitHub のイシューを開きます。 GitHub アカウントをお持ちでない場合は、ここで機能をリクエストできます。または、Discord に参加してください。

開発者向けのスタートガイド

プロジェクトに貢献する

こちらで公開カンバンをご利用いただけます。 Discord に参加してタスクについて話し合い、現在取り組んでいることを確認してください。

要件

• Node.js >= 18.0.0
• pnpm >= 8.6.12
• Docker デスクトップ (オプション)

設定

プロジェクトのセットアップ方法に関するビデオは次のとおりです。このドキュメントで説明されているのと同じ手順が説明されています。ただし、外部サービスの設定についてはさらに詳しく説明します。

必要な外部サービスは次のとおりです。

• OpenAI
• Google OAuth
• Google PubSub - 以下のセットアップ手順を参照してください
• Upstash Redis - Docker Compose で通常の Redis を使用することもできます。
• 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を設定します。

オプション: AI 使用状況統計を Tinybird にも保存したい場合は、 /packages/tinybird-ai-analyticsで同じことを行います。

Google PubSub 経由でプッシュ通知を設定し、メールをリアルタイムで処理する

ここの指示に従ってください。

1. トピックを作成する
2. サブスクリプションを作成する
3. トピックに対する公開権限を付与する

環境変数GOOGLE_PUBSUB_TOPIC_NAMEを設定します。サブスクリプションを作成するときに [プッシュ] を選択すると、URL は次のようになります: https://www.getinboxzero.com/api/google/webhook?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アクセスしてください。