agentmail-cli
/install agentmail-cli
CLI for AgentMail — create inboxes, send messages, and read email.
API Key Setup
The API key MUST be configured before any command will work. Two methods:
- Config file (preferred for persistent agents):
agentmail config set-key YOUR_API_KEY
This stores the key at ~/.agentmail/config.json and persists across sessions.
- Environment variable:
export AGENTMAIL_API_KEY=YOUR_API_KEY
Verify configuration:
agentmail config show
If commands fail with auth errors, re-run agentmail config set-key — the env var alone may not persist between shell sessions.
Always Use --json
Always pass --json to every command for machine-readable output. Parse with jq when needed.
Inbox Commands
Create an inbox:
agentmail inbox create --json
agentmail inbox create --domain example.com --json
agentmail inbox create --username support --domain example.com --display-name "Support Team" --json
List inboxes:
agentmail inbox list --json
agentmail inbox list --limit 10 --json
Get inbox details:
agentmail inbox get \x3Cinbox-id> --json
Delete an inbox:
agentmail inbox delete \x3Cinbox-id>
Message Commands
Send a message:
agentmail message send --from \x3Cinbox-id> --to [email protected] --subject "Subject" --text "Body text" --json
Send with HTML:
agentmail message send --from \x3Cinbox-id> --to [email protected] --subject "Subject" --html "\x3Ch1>Hello\x3C/h1>" --json
Multiple recipients, CC, BCC:
agentmail message send --from \x3Cinbox-id> --to "[email protected],[email protected]" --cc "[email protected]" --bcc "[email protected]" --subject "Subject" --text "Body" --json
List messages in an inbox:
agentmail message list \x3Cinbox-id> --json
agentmail message list \x3Cinbox-id> --limit 20 --json
Get a specific message:
agentmail message get \x3Cinbox-id> \x3Cmessage-id> --json
Delete a message (deletes entire thread):
agentmail message delete \x3Cinbox-id> \x3Cmessage-id>
Common Workflow
# 1. Create inbox, capture ID
INBOX_ID=$(agentmail inbox create --json | jq -r '.inboxId')
# 2. Send email
agentmail message send --from "$INBOX_ID" --to [email protected] --subject "Hello" --text "Message body" --json
# 3. Check for replies
agentmail message list "$INBOX_ID" --json
Notes
- Get an API key at https://agentmail.to
- Config file location:
~/.agentmail/config.json - Env var
AGENTMAIL_API_KEYtakes precedence over config file - Deleting a message deletes the entire thread containing it
- 确保已安装 OpenClaw(本地或 Docker 部署)
- 在对话框中输入安装命令:
/install agentmail-cli - 安装完成后,直接呼叫该 Skill 的名称或使用
/agentmail-cli触发 - 根据 Skill 的参数说明提供必要输入,即可获得结构化输出
agentmail-cli 是什么?
Manage email inboxes and messages via AgentMail API. Create disposable inboxes, send/receive emails, and list messages. Use when the agent needs to send or receive email, create temporary inboxes, or check for incoming messages. 它是一个面向 Claude Code / OpenClaw 的 AI Agent Skill 插件,目前累计下载 1973 次。
如何安装 agentmail-cli?
在 OpenClaw 或 Claude Code 对话框中运行命令「/install agentmail-cli」即可一键安装,无需额外配置。
agentmail-cli 是免费的吗?
是的,agentmail-cli 完全免费(开源免费),可自由下载、安装和使用。
agentmail-cli 支持哪些平台?
agentmail-cli 跨平台运行,可在任意部署了 OpenClaw / Claude Code 的环境中使用(cross-platform)。
谁开发了 agentmail-cli?
由 Stepan Arsentjev(@stepandel)开发并维护,当前版本 v1.0.0。