用途:AgentMail CLI 是 AgentMail 的官方命令行工具,让用户在 shell 中操作 AgentMail,适合编写脚本或在终端完成邮箱管理任务。
安装与认证:运行 npm install -g agentmail-cli 安装,然后通过环境变量提供密钥:export AGENTMAIL_API_KEY="am_..."。
用法约定:嵌套资源的子命令用冒号连接,例如 inboxes:messages、inboxes:threads、pods:inboxes、pods:threads。
主要能力:
- 收件箱:list、get、create(支持 --display-name、--username)、delete。删除属破坏性操作,执行前需确认目标收件箱。
- 消息与会话:inboxes:messages 支持 list、get、send(--to、--subject、--text 或 --html)、reply、forward;inboxes:threads 支持 list、get。回复需使用消息 ID,依赖正文内容前应先获取完整消息。
- 草稿:inboxes:drafts 支持 create、list、get、send。
- Pod:用于将收件箱分组,支持 pods create、pods list,以及 pods:inboxes 与 pods:threads 的查询。
- Webhook:webhooks create(--url、--event-type,如 message.received)、webhooks list。
- 域名:domains create、domains verify、domains get-zone-file;可加 --feedback-enabled 将退信/投诉通知路由到收件箱。
全局参数:--api-key 覆盖本次调用的密钥,--base-url 指向非默认 API 主机,--environment 选择命名环境,--format 控制输出格式,--format-error、--transform、--transform-error 控制结构化输出与 GJSON 投影,--debug 输出详细请求/响应日志。
输出格式:--format 可取 auto(默认)、pretty、json、jsonl、yaml、raw、explore。
限制与注意:执行资料未覆盖的管理命令前,先查看 agentmail --help 及对应资源的 --help;删除等破坏性命令需先核对对象。资料未提供定价、速率限制、平台支持等细节。