用途:通过 Mailcoach CLI 管理自托管 Mailcoach 实例的邮件营销资源,包括邮件列表、订阅者、活动、事务邮件、模板、自动化、标签、分组与抑制名单。
前置条件:CLI 需已安装并完成认证。若命令返回 401,需先认证: mailcoach login mailcoach list-email-lists
命令由 Mailcoach OpenAPI 规范自动生成,应动态发现而非猜测名称: mailcoach list mailcoach <command-name> --help
命名规则:命令为 kebab-case,源自 API operation ID,如 list-email-lists、create-email-list、send-campaign、list-transactional-mails、trigger-automation。路径参数变为必需选项(--email-list=<uuid>);查询参数变为可选选项(--filter-search=<value>);snake_case 与 camelCase 参数统一转为 --kebab-case。
发送数据:可用 --input '{"name": "Newsletter", "default_from_email": "hi@example.com"}' 传 JSON,或用可重复的 --field name="Newsletter" 传表单字段;文件上传用 @ 前缀,如 --field csv=@/path/to/subscribers.csv,含文件时切换为 multipart/form-data。--field 与 --input 不可同时使用。
输出与查询:默认人类可读表格,--json 输出原始 JSON,另有 --yaml、--minify、--H、--output-html。需要提取 UUID 时用 --json。过滤排序分页示例:mailcoach list-subscribers --email-list=<uuid> --filter-search="john" --sort=email --filter-per-page=50 --filter-page=2;--filter-per-page 最大 100,默认 15,--sort 前缀 - 表示降序。
错误处理:401 认证失败需重新登录;422 校验错误,响应体含字段详情;404 资源不存在;缺少路径参数时 CLI 会提示所需 --option。错误均以非零码退出,可用 && 串联命令;HTML 错误响应默认隐藏正文,加 --output-html 查看。
注意:Mailcoach 为自托管,登录时配置实例 URL;OpenAPI 规范缓存 24 小时,可用 mailcoach clear-cache 强制刷新;资源标识使用 UUID;串联命令时用 --json 提取 UUID。
限制:具体可用命令与选项以实例 OpenAPI 规范为准;资料未提供价格、平台支持范围与速率限制等信息。