AgentMail 的命令行工具（CLI）——用于创建收件箱、发送邮件和读取电子邮件。

API 密钥配置

在执行任何命令前，必须完成 API 密钥配置。支持两种方式：

1. 配置文件方式（推荐用于长期运行的 Agent）：

agentmail config set-key YOUR_API_KEY

该命令将密钥保存至 ~/.agentmail/config.json，并在所有会话中持久生效。

2. 环境变量方式：

export AGENTMAIL_API_KEY=YOUR_API_KEY

验证当前配置是否生效：

agentmail config show

若命令因认证失败而报错，请重新运行 agentmail config set-key —— 单独设置环境变量可能无法跨 Shell 会话持久生效。

始终使用 --json

为确保输出可被程序解析，请在每个命令中始终添加 --json 参数。如需进一步处理，可配合 jq 工具使用。

收件箱（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

列出所有收件箱：

agentmail inbox list --json
agentmail inbox list --limit 10 --json

获取指定收件箱详情：

agentmail inbox get  --json

删除收件箱：

agentmail inbox delete 

邮件（Message）命令

发送邮件：

agentmail message send --from  --to recipient@example.com --subject "Subject" --text "Body text" --json

发送含 HTML 内容的邮件：

agentmail message send --from  --to recipient@example.com --subject "Subject" --html "
Hello
" --json

支持多收件人、抄送（CC）、密送（BCC）：

agentmail message send --from  --to "a@example.com,b@example.com" --cc "cc@example.com" --bcc "bcc@example.com" --subject "Subject" --text "Body" --json

列出某收件箱中的邮件：

agentmail message list  --json
agentmail message list  --limit 20 --json

获取特定邮件详情：

agentmail message get   --json

删除一封邮件（将删除其所属的完整会话线程）：

agentmail message delete  

典型工作流示例

# 1. 创建收件箱，并捕获其 ID
INBOX_ID=$(agentmail inbox create --json | jq -r '.inboxId')

# 2. 发送邮件
agentmail message send --from "$INBOX_ID" --to user@example.com --subject "Hello" --text "Message body" --json

# 3. 检查是否有新回复
agentmail message list "$INBOX_ID" --json

注意事项

• 请访问 https://agentmail.to 获取 API 密钥
• 配置文件路径：~/.agentmail/config.json
• 环境变量 AGENTMAIL_API_KEY 的优先级高于配置文件中的设置
• 删除一封邮件将同时删除其所在的整个会话线程