MkSaaS文档邮件订阅
学习如何设置和使用 Resend 或 Beehiiv 进行邮件订阅管理
MkSaaS 支持多种邮件订阅服务提供商来管理邮件订阅。目前支持 Resend 和 Beehiiv，为您的用户提供灵活的邮件订阅管理选项。
提供商选项
使用 Resend 设置
- 在 resend.com 创建 Resend 账户
- 点击
API Keys>Create API Key，设置权限为Send emails或Full access - 复制
API Key，并添加到.env文件：
RESEND_API_KEY=YOUR-RESEND-API-KEY- 更新网站配置以使用 Resend 进行邮件订阅管理：
export const websiteConfig = {
// ...其他配置
newsletter: {
provider: 'resend', // 要使用的邮件订阅服务提供商
autoSubscribeAfterSignUp: false, // 是否在用户注册后自动订阅
},
// ...其他配置
}使用 Beehiiv 设置
- 在 beehiiv.com 创建 Beehiiv 账户
- 进入
Settings>API生成 API 密钥 - 从 URL 或设置页面获取您的
Publication ID - 将凭据添加到
.env文件：
BEEHIIV_API_KEY=YOUR-BEEHIIV-API-KEY
BEEHIIV_PUBLICATION_ID=YOUR-BEEHIIV-PUBLICATION-ID- 更新网站配置以使用 Beehiiv 进行邮件订阅管理：
export const websiteConfig = {
// ...其他配置
newsletter: {
provider: 'beehiiv', // 要使用的邮件订阅服务提供商
autoSubscribeAfterSignUp: false, // 是否在用户注册后自动订阅
},
// ...其他配置
}如果您正在设置环境，现在可以回到环境配置文档并继续。本文档的其余部分可以稍后阅读。
环境配置
设置环境变量
邮件订阅系统架构
MkSaaS 中的邮件订阅系统设计包含以下组件：
resend.ts
beehiiv.ts
index.ts
types.ts
README.md
这种模块化结构使得为邮件订阅系统扩展新的服务提供商变得容易。
核心功能
- 用户订阅和取消订阅邮件列表
- 多提供商支持（Resend 和 Beehiiv）
- 检查用户订阅状态
- 新用户可选是否自动订阅邮件列表
- 易于扩展和切换的模块化架构
- 提供商无关的统一 API 接口
使用方法
基本用法
MkSaaS 为邮件订阅管理提供简单的实用函数：
import { subscribe, unsubscribe, isSubscribed } from '@/newsletter';
// 为用户订阅邮件列表
const success = await subscribe('user@example.com');
// 为用户取消订阅邮件列表
const success = await unsubscribe('user@example.com');
// 检查用户是否已订阅邮件列表
const subscribed = await isSubscribed('user@example.com');与邮件模板一起使用
您可以将邮件订阅功能与邮件系统结合使用来发送确认邮件：
import { subscribe } from '@/newsletter';
import { sendEmail } from '@/mail';
export async function subscribeWithConfirmation(email: string) {
// 订阅用户
const success = await subscribe(email);
if (success) {
// 发送确认邮件
await sendEmail({
to: email,
template: 'subscribeNewsletter',
context: {
name: email.split('@')[0], // 简单的名称提取
unsubscribeUrl: `https://example.com/unsubscribe?email=${encodeURIComponent(email)}`,
},
});
}
return success;
}自定义
创建自定义提供商
如果您需要使用不同的邮件订阅服务，您可以创建自定义邮件订阅服务提供商：
- 在
src/newsletter/provider目录中创建新的文件 - 实现
NewsletterProvider接口
import type {
CheckSubscribeStatusParams,
NewsletterProvider,
SubscribeNewsletterParams,
UnsubscribeNewsletterParams,
} from '@/newsletter/types';
export class CustomNewsletterProvider implements NewsletterProvider {
constructor() {
// 初始化您的邮件订阅服务提供商
}
public getProviderName(): string {
return 'CustomProvider';
}
async subscribe({ email }: SubscribeNewsletterParams): Promise<boolean> {
// 订阅用户的实现
return true;
}
async unsubscribe({ email }: UnsubscribeNewsletterParams): Promise<boolean> {
// 取消订阅用户的实现
return true;
}
async checkSubscribeStatus({ email }: CheckSubscribeStatusParams): Promise<boolean> {
// 检查订阅状态的实现
return true;
}
}- 在
index.ts中更新邮件订阅服务提供商选择逻辑：
import { CustomNewsletterProvider } from './provider/custom-provider';
export const initializeNewsletterProvider = (): NewsletterProvider => {
if (!newsletterProvider) {
switch (websiteConfig.newsletter.provider) {
case 'resend':
newsletterProvider = new ResendNewsletterProvider();
break;
case 'beehiiv':
newsletterProvider = new BeehiivNewsletterProvider();
break;
case 'custom':
newsletterProvider = new CustomNewsletterProvider();
break;
default:
throw new Error(
`不支持的邮件订阅服务提供商: ${websiteConfig.newsletter.provider}`
);
}
}
return newsletterProvider;
};常见问题
应该选择哪个提供商？
- 选择 Resend：如果您已经使用 Resend 发送事务性邮件，并希望有一个简单统一的解决方案来处理邮件发送和订阅管理。
- 选择 Beehiiv：如果您需要高级订阅功能，如数据分析、变现、推荐计划和增长工具，适合专业内容创作者。
环境变量RESEND_AUDIENCE_ID
从2025年11月15日起，RESEND_AUDIENCE_ID 环境变量已从模板中移除，邮件订阅功能已不再需要该环境变量。
具体详情参考文档：Migrating from Audiences to Segments
最佳实践
- 验证邮箱地址：订阅用户前始终验证邮箱地址
- 确认订阅邮件：用户订阅时发送确认邮件列表
- 取消订阅链接：在您的邮件中始终包含取消订阅链接
- 隐私政策：确保您的网站有隐私政策，解释您如何使用用户订阅数据
视频教程
下一步
现在您了解了如何在 MkSaaS 中使用邮件订阅，您可能想要探索这些相关功能：