Sendmux CLI
使用 Sendmux CLI,您可以从终端运行管理、邮箱和发送 API 命令,而无需手动编写 HTTP 请求。通过 Homebrew、Snap 或 npm 安装,保存作用域 API 密钥为本地配置文件,并在需要快速从 shell 控制邮箱或发送时调用冒号分隔的命令,如 sending:send 或 mailbox:messages:list。
大多数电子邮件 CLI 仅封装一个 SMTP 端点。Sendmux CLI 将三种凭证类型映射到三个 API 界面:smx_root_ 密钥用于团队管理,smx_mbx_ 密钥用于邮箱操作,smx_agent_ 令牌用于所有者批准的代理发送。它在每次请求前验证密钥前缀,因此如果传入邮箱密钥,管理命令会快速失败。
该工具适合后端开发人员、DevOps 工程师和希望在 CI、定时任务或本地终端中脚本化电子邮件的 AI 代理构建者。请求体可内联或来自文件,输出可在可读 JSON 和机器可读的 --json 模式间切换,安全标志涵盖幂等键和条件头。
通过 Homebrew、Linux Snap 或 npm install -g @sendmux/cli 进行安装
三种 API 接口:管理、邮箱和带冒号分隔名称的发送命令
本地配置文件存储 smx_root_、smx_mbx_ 和 smx_agent_ 密钥,具有受限的文件权限
通过 --body 或 --body-file 传递请求体,查询参数作为 name=value 标志
默认输出格式化的 JSON 或添加 --json 以用于自动化流程
安全标志包括每个 API 操作的 --idempotency-key、--if-match 和 --if-none-match
将三种作用域密钥类型映射到管理、邮箱和发送命令,并进行前缀验证
在常用开发者机器上通过 Homebrew、Snap 或 npm 安装
支持幂等密钥和条件头,确保脚本请求更安全
配置文件避免在每个命令中传递 API 密钥
需要熟悉终端工作流程和 JSON 请求体
没有图形界面;所有操作通过 CLI 命令执行
通过托管的 Amazon SES 发送仅限于事务性邮件,不支持批量营销
如何安装Sendmux CLI?
Sendmux CLI可通过sudo snap install sendmux在Linux上安装,通过brew install sendmux/tap/sendmux在macOS或Linux上安装,或通过npm作为@sendmux/cli全局安装。安装后运行sendmux --version确认二进制文件已添加到PATH。
Sendmux CLI接受哪些API密钥?
Sendmux CLI在每次调用前检查密钥前缀。管理命令需要团队范围的smx_root_密钥,邮箱和发送命令接受smx_mbx_密钥或范围限定的smx_agent_令牌,发送还支持经过人工批准的拥有者授权的smx_agent_发送资源令牌。
Sendmux CLI如何存储凭据?
Sendmux CLI通过sendmux profiles:set将密钥保存为命名配置文件,本地存储配置并限制文件权限。命令按顺序从--api-key、SENDMUX_API_KEY、--profile、SENDMUX_PROFILE或默认配置文件解析凭据。
Sendmux CLI能否从脚本发送邮件?
可以。Sendmux CLI使用sendmux sending:send发送邮件,通过--body或--body-file传递JSON正文,并使用--idempotency-key实现安全重试。该命令需要具备发送权限的smx_mbx_密钥或经过拥有者批准的smx_agent_发送资源令牌。
使用Sendmux CLI需要付费吗?
Sendmux CLI本身免费安装。Sendmux按事件计费团队余额,新团队注册时赠送1美元。通过您自己的提供商发送外发邮件,每个接受的收件人收费0.000150美元,使用托管的Amazon SES发送每个收件人收费0.000250美元。
Sendmux CLI如何格式化命令输出?
Sendmux CLI默认打印人类可读的格式化JSON作为API响应。当其他进程需要严格的机器可读输出时,添加--json标志,包括带有byte_length元数据的base64编码二进制响应。

