CLI
コマンド
コマンドの読み方、グローバルフラグ、手書きのすべてのコマンド、すべてのリソース名前空間。
コマンドの読み方
openemail <command> [subcommand] [arguments] [flags]- フラグはコマンドの後ならどこにでも置けます。引数の前でも後でもかまいません。
--profileや--jsonなどのグローバルフラグはコマンドの前にも置けますが、それ以外のフラグをそこに置くと、コマンド名の後へ移すよう促して止まります。 - 値はフラグの後にスペースか等号を挟んで続けるので、
--limit 50と--limit=50は同じです。短いフラグも値を取れます（例：-n 50）。 - ダッシュで始まる値には、
--subject=-draft-のように等号が必要です。スペースの後に置くと次のフラグとして読まれ、最初のフラグの値がないと報告されるためです。負の数はどちらの書き方でも使えます。空の値は、黙って既定値を使うのではなく、使い方のエラーになります。 - スイッチは
--flagでオン、--no-flagでオフになり、--flag=trueと--flag=falseも使えます。 - リストはカンマ区切りか繰り返しで指定します：
--to [email protected],[email protected]、または--toを 2 回。 --の後はすべて引数で、フラグにはなりません。-from:adaの検索はこうして通します。- 不明なコマンドやフラグは終了コード
2で停止し、最も近い候補を提案します。
グローバルフラグ
| フラグ | 機能 |
|---|---|
| -h, --help | コマンドまたはグループのヘルプ |
| -v, --version | CLI のバージョンを表示 |
| --json | stdout には JSON のみ、エラーは stderr に JSON で、プロンプトは一切なし |
| -y, --yes | 破壊的な操作を確認なしで承認します。確認コードは省略しません |
| --profile <name> | この保存済みプロファイルを使う（OPENEMAIL_PROFILE と同様） |
| --api-key <key> | プロファイルを無視して、この API キーをこのコマンドだけに使う |
| --base-url <url> | API キー、または認証情報を送らないコマンドのための API のオリジン（OPENEMAIL_BASE_URL と同様）。保存されたサインインは常に自分のオリジンを使います |
| --no-input | プロンプトを出さない。値が足りない場合は終了コード 2 で停止 |
| --no-color | 色なし（NO_COLOR や FORCE_COLOR=0 と同様） |
| --debug | リクエスト ID、失敗したリクエスト、スタックトレースを表示 |
手書きのコマンド
これらは人のために書かれています。足りないものを尋ね、出力を整形し、役立つ場面では複数の API 呼び出しをまとめます。
| コマンド | 機能 |
|---|---|
| login | ブラウザでサインインするか、API キーを保存する |
| whoami | 誰としてサインインしているか。ワークスペース、スコープ、有効期限つき |
| status | whoami の内容に加え、送信元アドレスと各ドメインの状態 |
| verify | 今すぐ確認コードを入力し、重要なコマンドを 60 分間実行できるようにする |
| logout | サインアウトしてプロファイルを消去する |
| profile list, use, current, remove | 保存済みサインインの一覧、切り替え、削除 |
| send | メールを送信、予約、または翻訳して送信する |
| inbox [folder] | フォルダー内のスレッドを一覧表示する |
| search <query> | アプリと同じ構文でメールを検索する |
| read <thread-id> | スレッドをメッセージごとに読む |
| reply <thread-id> | スレッドの最後のメッセージに返信する |
| archive, unarchive, trash, star, unstar | 1 つ以上のスレッドを整理する |
| mark read, mark unread | スレッドを既読または未読にする |
| snooze, unsnooze | スレッドを後まで非表示にする、または今すぐ戻す |
| label add, label remove | スレッドにラベルを付ける、または外す |
| temp new, list, read, watch, delete | 使い捨て受信トレイ。サインイン不要 |
| ai translate, languages, compose, summarize | AI でメールを翻訳、作成、要約する |
| mcp config, tools, call, serve | AI クライアントを接続する、または MCP ツールを自分で呼び出す |
| docs ask, open, read | このドキュメントに質問する、開く、読む |
| open [page] | Web アプリのページを開く |
| api <method> <path> | サインインを使って任意の REST エンドポイントを呼び出す |
| update | npm で新しいリリースを確認する |
| completion <shell> | bash、zsh、fish 用の補完スクリプトを出力する |
| version | CLI、SDK、ランタイムのバージョンを表示する |
| help [command] | 任意のコマンドのヘルプを表示する |
リソースコマンド
SDK のすべてのメソッドは、openemail <namespace> <verb> というコマンドでもあります。名前空間は SDK の名前空間をケバブケースにしたもの、動詞はメソッド名をケバブケースにしたものなので、keys.listRequests は openemail keys list-requests になります。これらを合わせて REST API 全体をカバーします。
openemail domains listopenemail domains create --domain acme.comopenemail rules create --data @rule.jsonopenemail keys list-requests 9f2c1a4b7e05d3862c1f0a44 --failed-only --allopenemail files download file_6bb640f5b99e47deb758f1f5 --out report.pdf- メソッドが受け取る ID は引数です（例：
openemail domains get <id>）。リクエストボディの各フィールドは、その名前をケバブケースにしたフラグです。replyToは--reply-to、color.backgroundColorは--color-background-colorになります。 - グローバルフラグと衝突するフラグ名を持つ 3 つのフィールドは、名前が変わっています：
--template-version、--label-color、--resend-key。 --dataはボディ全体を JSON で受け取ります。インライン、@pathでファイルから、または-で stdin から渡せ、一緒に渡したフラグは対応するキーを上書きします。オブジェクトを受け取るフラグも同じ方法で JSON を読みます。- 数値とスイッチはそのまま解釈され、リストはカンマ区切りか繰り返しで指定します。
- 必須の値が足りない場合、ターミナルでは入力を求め、それ以外では使い方のエラー（終了コード
2）になります。 - リストの動詞は 1 ページを読みます。
--limitでサイズを指定し、--cursorで表示されたカーソルから続けます。--allはすべてのページを読んで項目をストリームし、--max <n>はその件数で停止し、--ndjsonは 1 行に 1 つの JSON オブジェクトを出力します。 - 削除、取り消し、ローテーション、キャンセル、空にするなどの破壊的な操作は、
--yesを渡さない限り確認を求めます。 - ダウンロードは
--outのファイルに書き込まれ、stdout がターミナルでない場合に限り stdout に出力されます。
openemail <namespace> <verb> --help は、各引数とフラグの型、呼び出しに必要なスコープ、メソッドとパス、戻り値、API リファレンスの注記を表示します。
すべての名前空間
「別名」列には、その名前空間が応答する他の名前を示しています。
| 名前空間 | 別名 | 動詞 |
|---|---|---|
| me | get, ping, rotate | |
| keys | key | list, get, create, update, delete, rotate, revoke, list-requests, list-activity, list-workspace-requests, list-workspace-activity |
| addresses | address | list |
| languages | language | list |
| emails | email | send, send-batch, translate, list, get, list-events, get-tracking, cancel, reschedule |
| templates | template | list, get, create, update, duplicate, replace-content, delete, list-versions, get-version, publish, restore-version, delete-version, list-starters, get-starter, list-fonts, render, preview, get-analytics, list-sends, send |
| tracking | list, get-stats, get, list-opens, list-clicks | |
| threads | thread | list, get, update, trash, snooze, unsnooze, list-attachments |
| drafts | draft | list, get, create, update, delete |
| labels | list, list-colors, get, create, update, delete | |
| contacts | contact | list, get, create, update, delete, set-audiences, list-people, save, delete-many, set-photo, remove-photo, block, unblock, list-threads, activity |
| audiences | audience | list, growth, get, create, update, delete, empty, list-contacts, add-contact, remove-contact, add-contacts, remove-contacts, import-contacts |
| broadcasts | broadcast | preview, send, list, get, stats, list-recipients, get-recipient, cancel |
| domains | domain | list, get, create, verify, update, delete, list-addresses, create-address, get-address, update-address, delete-address |
| rules | rule | list, get, create, update, delete, reorder, test, list-runs |
| webhooks | webhook | list, get, create, update, delete, rotate-secret, test, list-deliveries, get-delivery, replay-delivery, list-workspace-deliveries, list-activity, list-workspace-activity |
| imports | import | list, get, create, upload-state, upload-chunk, start, cancel, list-failures, delete-upload, import-files |
| provider-imports | provider-import, providerImports | inspect, create, list, get, cancel |
| calendar | list-events, get-event, get-event-ics | |
| settings | setting | get, update |
| roles | role | list, get, create, update, delete, list-permissions |
| members | member | list, get, add, update, remove, grant-address, revoke-address, list-invitations, revoke-invitation, resend-invitation |
| suppressions | suppression | list, get, add, remove |
| files | file | list, get, stats, download, list-links, create-link, revoke-link, upload, delete, delete-many |
| temp-mail | tempMail | list-domains, create, get, extend, delete, list-messages, get-message, delete-message, list-attachments |
エイリアス
| エイリアス | 対象 |
|---|---|
| ls | list |
| show, view | get |
| new, add | create |
| edit | update |
| rm, del, remove | delete |
| openemail ls | openemail inbox |
| openemail show | openemail read |
動詞が add と remove の members と suppressions では、new と create は add に、rm、del、delete は remove に対応します。手書きのサブコマンドの一部には独自のエイリアスがあり、それぞれのヘルプに記載されています。
任意の REST 呼び出し
openemail api <method> <path> は、ほかのすべてのコマンドと同じトランスポートを通じて REST API に 1 つのリクエストを送ります。そのため、プロファイルやキー、トークンの更新、確認コードがすべて適用されます。パスだけを指定すると GET になります。JSON の応答は整形して表示され、失敗したリクエストは API のエラーを表示して、対応するコードで終了します。
openemail api /keys/selfopenemail api GET /threads --query folder=inbox --query limit=5openemail api POST /labels --data '{"name":"Receipts"}'openemail api PATCH /threads/CAHk7pQ2x9LmZ4 --data @patch.jsonopenemail api GET /files/file_6bb640f5b99e47deb758f1f5/content --out report.pdf-d、--dataは本文を、インラインの JSON、@pathによるファイル、または-による stdin から受け取ります。-q、--queryと-H、--headerはkey=valueを受け取り、繰り返し指定できます。-o、--outは応答を受け取ったままファイルに保存します。- パスは API のオリジンからの相対パスです。完全な URL、オリジンの外に出てしまうパス、
Authorizationヘッダーは、何も送らないうちに終了コード2で拒否されます。認証情報は CLI 自身が設定するためです。
ヘルプ
openemail --helpopenemail help sendopenemail domains --helpopenemail domains create --helpopenemail --help はすべてのコマンドを用途別に一覧表示します。グループはサブコマンドを例とともに一覧表示し、コマンドは受け取るものをすべて表示します。openemail docs open cli でこのページが開きます。
