ナレッジベース
コマンドライン
メールボックスとすべての API オペレーションを、ターミナルやスクリプトから。
詳細
openemailコマンドは、npm から@openemail/cliとしてインストールします。依存関係のない単一のファイルで、Node.js 20.12 以降が必要です。npm i -g @openemail/cliでインストールでき、npx @openemail/cli <command>ならインストールせずに実行できます。- サインインの方法は 2 つあります。
openemail loginはブラウザを開き、そこでワークスペース、権限、アクセスの期間を選びます。ブラウザでのサインインはそれぞれ接続済みアプリになり、アカウント → 接続済みアプリで削除できます。openemail login --with-tokenで保存するかOPENEMAIL_API_KEYに設定した API キーは、ブラウザを開くことも、コードを求めることもないため、スクリプトや CI に向いています。 - ブラウザでのサインインはあなたとして動くため、Webhook の追加やドメインの削除のような重要な変更では、Web アプリと同じ確認コードを求められます。1 つのコードでそのサインインは 60 分間有効になり、
openemail verifyを使えばスクリプトの実行前にコードを入力できます。 inbox、search、read、reply、sendは、アプリと同じようにメールボックスを操作し、同じ検索構文、添付ファイル、予約送信、取り消し、翻訳が使えます。archive、star、snoozeなどのスレッド操作は、複数のスレッド ID をまとめて受け取ります。- SDK のすべてのメソッドが
openemail <resource> <verb>というコマンドになっているので、REST API にできることはコマンドラインにもできます。openemail apiを使えば、同じサインインで任意のパスを直接呼び出せます。 ai translate、ai compose、ai summarizeで AI 機能をターミナルから使えます。openemail mcp configは Claude Code、Claude Desktop、Cursor、VS Code、Windsurf、Codex 向けの設定を出力し、openemail mcp serveを使うとそうしたクライアントがコマンドラインのサインインを再利用できます。- スクリプトのために作られています。データは stdout に、それ以外はすべて stderr に出力され、
--jsonは JSON だけを出力し、--allはリストの全ページをたどり、失敗の種類ごとに終了コードがあり、CI やターミナルがない環境では何も尋ねません。openemail tempはアカウントもキーもなしで使い捨ての受信箱を作り、temp watch --firstは最初のメッセージを待ちます。 - まだできないこと: 請求、ワークスペースの作成と切り替え、アカウントのセキュリティ、データのエクスポート、カレンダーの予定の書き込み、転送、DNS プロバイダーの連携にはブラウザのセッションが必要なため、コマンドラインではまだできず、代わりに
openemail openが Web アプリの適切なページを開きます。SDK と同じくリリースのワークフローはないため、新しいバージョンは誰かが公開したときに npm に届きます。
