Agentmail Cli

agentmail-to/agentmail-skills/agentmail-cli

作者 agentmail-tocde357ff31d4无许可证23 个星标收录于 2026年10月8日更新于 2026年10月8日仓库2天前更新

Operate AgentMail from a shell with the official CLI. Use when the user wants commands for listing or creating inboxes, reading or searching mail, sending or replying, managing drafts, or scripting JSON/YAML output; do not use for SDK code, MCP setup, or framework adapters.

仅含说明Communication

AI 生成的概览

通过官方 CLI 在命令行中操作 AgentMail 的收件箱、邮件、草稿、Pod、Webhook 和域名。

功能: 提供官方 AgentMail CLI 的命令行操作说明，涵盖安装、API 密钥配置以及各类资源命令。内容包括列出和创建收件箱，读取、搜索、发送、回复和转发邮件，管理草稿、Pod、Webhook 和域名，以及全局标志和输出格式。产出的是 shell 命令和 JSON、JSONL、YAML 或原始格式的结构化输出，而非 SDK 代码。
适用场景: 当用户需要针对 AgentMail 收件箱、邮件、草稿、Pod、Webhook 或域名操作的 shell 命令，或需要脚本化的 JSON/YAML 输出时使用。不适用于 SDK 代码、MCP 配置或框架适配器。
运行要求: 需要通过 npm 全局安装 agentmail-cli 包，具备 Node.js/npm 运行环境，并通过 AGENTMAIL_API_KEY 环境变量或 --api-key 标志提供 AgentMail API 密钥。需要访问 AgentMail API 的网络连接。不附带脚本，仅为说明文档。

AgentMail CLI

Install the CLI and provide the API key through the environment.

A resource nested under another is a nested subcommand, e.g. inboxes messages, inboxes threads, pods inboxes, pods threads (CLI 1.x; the colon form inboxes:messages is rejected). Run agentmail <resource> --help to list what a resource supports.

Inboxes

bash

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

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

Confirm the exact inbox before running the destructive delete command.

Messages and threads

bash

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 textagentmail 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>

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 textagentmail 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>

Use a message ID for replies. Fetch the full message before relying on body content.

Drafts

bash

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>

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

Pods group inboxes together.

bash

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>

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

bash

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

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

Domains

bash

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>

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

Flag	Purpose
`--api-key`	Override `AGENTMAIL_API_KEY` for this call
`--base-url`	Point at a non-default API host
`--environment`	Select a named environment
`--format`	Output format (see below)
`--format-error`	Control structured error output
`--transform`	GJSON projection of a successful response
`--transform-error`	GJSON projection of an error response
`--debug`	Verbose request/response logging

Output formats

--format accepts: auto (default), pretty, json, jsonl, yaml, raw, explore.

Run agentmail --help and the relevant resource's --help before using an administrative command not covered here.

来源与署名

来源：agentmail-to/agentmail-skills位于agentmail-cli提交cde357f

许可证：无许可证

内容归原作者所有。SourceWeft 从公开仓库中收录这些内容。

举报或申请下架

Agentmail Cli

AgentMail CLI

Inboxes

Messages and threads

Drafts

Pods

Webhooks

Domains

Global flags

Output formats

来源与署名

更多来自 agentmail-to/agentmail-skills 的技能

Agentmail Mcp

更多Communication技能

Internal Comms

Stakeholder Update

Call Summary

Draft Outreach

Status Report

Compose Outreach