标签

bash
pnpm lumail tags list
pnpm lumail tags create --name premium
pnpm lumail tags get premium # 按名称或ID
pnpm lumail tags update --name gold

邮件（事务性）

bash

发送事务性邮件

禁用追踪

验证邮箱地址

事件

bash
pnpm lumail events create \
--type SUBSCRIBER_PAYMENT \
--subscriber user@example.com \
--data {amount: 99, plan: pro}

事件类型：SUBSCRIBED、UNSUBSCRIBED、TAGADDED、TAGREMOVED、EMAILOPENED、EMAILCLICKED、EMAILSENT、EMAILRECEIVED、WORKFLOWSTARTED、WORKFLOWCOMPLETED、WORKFLOWCANCELED、FIELDUPDATED、EMAILBOUNCED、EMAILCOMPLAINED、WEBHOOKEXECUTED、SUBSCRIBERPAYMENT、SUBSCRIBER_REFUND

工具（V2 API）

V2工具API为AI代理和高级操作提供59+个工具。

bash

列出所有可用工具

获取工具架构

运行工具

SDK参考

SDK位于src/lib/lumail-sdk/，可通过@/lib/lumail-sdk导入。

设置

typescript
import { Lumail } from @/lib/lumail-sdk;

const lumail = new Lumail({
apiKey: lm_...,
baseUrl: https://lumail.io/api, // 可选，默认为此值
});

订阅者

typescript
// 创建/更新
const { subscriber } = await lumail.subscribers.create({
email: user@example.com,
name: John,
tags: [vip, beta],
fields: { company: Acme },
triggerWorkflows: true,
});

// 通过邮箱或ID获取
const { subscriber } = await lumail.subscribers.get(user@example.com);

// 更新
await lumail.subscribers.update(user@example.com, { name: John Doe });

// 删除
await lumail.subscribers.delete(user@example.com);

// 取消订阅
await lumail.subscribers.unsubscribe(user@example.com);

// 标签
await lumail.subscribers.addTags(user@example.com, [premium]);
await lumail.subscribers.removeTags(user@example.com, [old-tag]);

// 事件（基于游标的分页）
const { events, nextCursor } = await lumail.subscribers.listEvents(user@example.com, {
take: 20,
order: desc,
eventTypes: [EMAILOPENED, EMAILCLICKED],
});

营销活动

typescript
// 带分页的列表
const { campaigns, total, pageCount } = await lumail.campaigns.list({
status: DRAFT,
page: 1,
limit: 20,
query: welcome,
});

// 创建
const { campaign, campaignId } = await lumail.campaigns.create({
subject: Welcome!,
name: Welcome Campaign,
contentType: MARKDOWN,
});

// 获取
const { campaign } = await lumail.campaigns.get(campaignId);

// 更新（仅草稿状态）
await lumail.campaigns.update(campaignId, { subject: Updated Subject });

// 删除（仅草稿状态）
await lumail.campaigns.delete(campaignId);

// 立即发送
await lumail.campaigns.send(campaignId);

// 定时发送
await lumail.campaigns.send(campaignId, {
scheduledAt: 2025-12-25T10:00:00Z,
timezone: UTC,
});

邮件（事务性）

typescript
const { qstashMessageId } = await lumail.emails.send({
to: user@example.com,
from: noreply@yourdomain.com,
subject: Order Confirmation,
content: Your order is confirmed.,
contentType: MARKDOWN, // MARKDOWN | HTML | TIPTAP
tracking: { links: true, open: true },
});

// 验证邮箱
const { isValid } = await lumail.emails.verify({ email: test@example.com });

标签

typescript
const { tags } = await lumail.tags.list();
const { tag } = await lumail.tags.create({ name: premium });
const { tag } = await lumail.tags.get(premium); // 按名称或ID
await lumail.tags.update(premium, { name: gold });