agentmail-cli

AgentMail CLI

CLI をインストールし、環境変数を通じて API キーを指定します。

npm install -g agentmail-cli
export AGENTMAIL_API_KEY="am_..."

別のリソースの下にあるリソースは、ネストされたサブコマンドです。例：inboxes messages、inboxes threads、pods inboxes、pods threads（CLI 1.x では、コロン形式の inboxes:messages は拒否されます）。リソースで利用できる操作を一覧表示するには、agentmail <resource> --help を実行してください。

Inboxes

agentmail inboxes list
agentmail inboxes get --inbox-id <inbox_id>
agentmail inboxes create --display-name "Support Agent" --username support
agentmail inboxes delete --inbox-id <inbox_id>

削除コマンドを実行する前に、対象の受信箱が正確に合っていることを確認してください。

Messages and threads

agentmail inboxes messages list --inbox-id <inbox_id>
agentmail inboxes messages get --inbox-id <inbox_id> --message-id <message_id>

agentmail inboxes messages send --inbox-id <inbox_id> \
  --to "[email protected]" \
  --subject "Hello" \
  --text "Message body"

# HTML body instead of plain text
agentmail inboxes messages send --inbox-id <inbox_id> \
  --to "[email protected]" \
  --subject "Hello" \
  --html "<h1>Hello</h1>"

agentmail inboxes messages reply --inbox-id <inbox_id> \
  --message-id <message_id> \
  --text "Reply body"

agentmail inboxes messages forward --inbox-id <inbox_id> \
  --message-id <message_id> \
  --to "[email protected]"

agentmail inboxes threads list --inbox-id <inbox_id>
agentmail inboxes threads get --inbox-id <inbox_id> --thread-id <thread_id>

返信にはメッセージ ID を使用してください。本文の内容を根拠にする前に、メッセージ全体を取得してください。

Drafts

agentmail inboxes drafts create --inbox-id <inbox_id> \
  --to "[email protected]" \
  --subject "Pending approval" \
  --text "Draft body"

agentmail inboxes drafts list --inbox-id <inbox_id>
agentmail inboxes drafts get --inbox-id <inbox_id> --draft-id <draft_id>
agentmail inboxes drafts send --inbox-id <inbox_id> --draft-id <draft_id>

Pods

Pod は受信箱をまとめます。

agentmail pods create --name "My Pod"
agentmail pods list

agentmail pods inboxes create --pod-id <pod_id> --display-name "Pod Inbox"
agentmail pods inboxes list --pod-id <pod_id>

agentmail pods threads list --pod-id <pod_id>
agentmail pods threads get --pod-id <pod_id> --thread-id <thread_id>

Webhooks

agentmail webhooks create --url "https://example.com/webhook" --event-type message.received
agentmail webhooks list

Domains

agentmail domains create --domain example.com

# Optional: route bounce/complaint notifications to your inboxes.
agentmail domains create --domain example.com --feedback-enabled

agentmail domains verify --domain-id <domain_id>
agentmail domains get-zone-file --domain-id <domain_id>

Global flags

フラグ	用途
--api-key	この呼び出しに限り AGENTMAIL_API_KEY を上書きします
--base-url	デフォルト以外の API ホストを指定します
--environment	名前付き環境を選択します
--format	出力形式（下記参照）
--format-error	構造化エラー出力を制御します
--transform	成功レスポンスに対する GJSON 投影
--transform-error	エラーレスポンスに対する GJSON 投影
--debug	リクエスト／レスポンスの詳細ログ

Output formats

--format で指定できる値：auto（デフォルト）、pretty、json、jsonl、yaml、raw、explore。

ここに記載のない管理コマンドを使用する前に、agentmail --help と該当するリソースの --help を実行してください。