SuperAPI AI 工具集

lumail

编程与开发

查看项目

更新于 10-16 00:24

技能介绍

用途:通过 CLI(pnpm lumail)或 TypeScript SDK(@/lib/lumail-sdk、npm 包 lumail)操作 Lumail 邮件营销 API,涵盖订阅者、营销活动、标签、事务邮件和事件管理。

主要能力:

  • 认证:auth set/show/remove/test,令牌存于 ~/.config/lumail/token。
  • 订阅者:创建或 upsert、按邮箱或 ID 获取、更新、删除、退订、增删标签、列出事件。
  • 营销活动:列表(可按状态、页码、query)、创建、获取、更新、删除、立即发送或按 scheduledAt 与 timezone 定时发送;更新与删除仅限草稿。
  • 标签:列表、创建、按名称或 ID 获取、更新。
  • 事务邮件:发送(contentType 支持 MARKDOWN、HTML、TIPTAP,可关闭跟踪)、验证邮箱。
  • 事件:创建事件,类型含 SUBSCRIBED、UNSUBSCRIBED、TAG_ADDED、TAG_REMOVED、EMAIL_OPENED、EMAIL_CLICKED、EMAIL_SENT、EMAIL_RECEIVED、WORKFLOW_STARTED、WORKFLOW_COMPLETED、WORKFLOW_CANCELED、FIELD_UPDATED、EMAIL_BOUNCED、EMAIL_COMPLAINED、WEBHOOK_EXECUTED、SUBSCRIBER_PAYMENT、SUBSCRIBER_REFUND。
  • V2 工具 API:提供 59+ 工具,可 list、get 获取 schema、run 执行,如 list_subscribers、create_campaign、send_campaign。

使用方式:先执行 pnpm lumail auth set <your-api-key> 并 auth test 验证。CLI 支持全局标志 --json、--format、--verbose、--no-color、--no-header。SDK 通过 new Lumail({ apiKey, baseUrl }) 初始化。

限制:GET/PUT/DELETE 在网络错误与 429 时最多重试 3 次(1s、2s、4s 退避,遵循 Retry-After),POST/PATCH 不重试以防重复;默认超时 30s。SDK 抛出类型化错误(认证、未找到、限流、校验、付费要求)。定价、配额与部署要求资料未提供。