rubix-studios-pty-ltd/payload-usesend
GitHub: rubix-studios-pty-ltd/payload-usesend
这是一个用于将 PayloadCMS 内容管理系统与 useSend 邮件平台集成的适配器，支持发送交易性及营销邮件。
Stars: 8 | Forks: 0
# PayloadCMS + useSend 邮件适配器
useSend 是一个以 API 为优先的邮件投递平台，专为交易性和营销邮件工作流而构建。它采用了与 Resend 类似的架构模型，同时保持完全开源和可自托管。这种组合使团队能够标准化邮件投递，而无需放弃对基础设施、部署拓扑或数据位置的控制权。
该平台公开了用于邮件投递的基于 REST 的接口，并支持提供商原生功能，例如模板、动态变量和定时发送。通过抽象底层投递基础设施，useSend 简化了应用程序集成，同时允许组织保留运营和监管控制权。
此适配器将 [PayloadCMS](https://payloadcms.com) 与 [useSend](https://usesend.com) REST API 集成，用于交易性和营销邮件。
[](https://www.npmjs.com/package/@rubixstudios/payload-usesend)
## 文档
请参阅[完整文档](https://rubixstudios.com.au/documents/usesend)以获取综合指南、功能、比较和配置示例。
## 安装
```
pnpm add @rubixstudios/payload-usesend
```
## 使用方法
- 注册 [useSend](https://usesend.com) 账户
- 设置域名
- 创建 API 密钥
- 将 API 密钥设置为 USESEND_API_KEY 环境变量
- 将您的 useSend 基础 URL 设置为 USESEND_URL 环境变量
- 配置您的 Payload 配置
## 配置
```
// payload.config.js
import { sendAdapter } from '@rubixstudios/payload-usesend'
export default buildConfig({
email: sendAdapter({
apiKey: process.env.USESEND_API_KEY!,
useSendUrl: process.env.USESEND_URL!,
defaultFromName: 'Rubix Studios',
defaultFromAddress: 'example@mail.com',
// Optional:
// scheduledAt: '2025-08-01T10:00:00Z',
// templateId: 'template-uuid',
// variables: { firstName: 'Vincent' }
}),
})
```
| 选项 | 类型 | 必填 | 默认值 | 描述 |
|--------------------|--------|----------|---------|----------------------|
| apiKey | string | 是 | - | useSend API 密钥 |
| useSendUrl | string | 是 | - | useSend 基础 URL |
| defaultFromAddress | string | 是 | - | 默认发件人邮箱 |
| defaultFromName | string | 是 | - | 默认发件人名称 |
| scheduledAt | string | 否 | - | ISO 日期字符串 |
| templateId | string | 否 | - | 邮件模板 ID |
| variables | object | 否 | - | 模板变量 |
## 许可证
本项目根据 MIT 许可证获得许可 - 有关详细信息，请参阅 [LICENSE](LICENSE) 文件。
## 支持
如需支持或咨询：
- LinkedIn: [rubixvi](https://www.linkedin.com/in/rubixvi/)
- 网站: [Rubix Studios](https://rubixstudios.com.au)
## 作者
Rubix Studios Pty. Ltd.
[https://rubixstudios.com.au](https://rubixstudios.com.au)
标签：API集成, CMS, GNU通用公共许可证, MITM代理, Node.js, npm, PayloadCMS, pnpm, REST API, useSend, 事务性邮件, 动态变量, 可观测性, 后端开发, 开源, 插件, 自托管, 营销邮件, 邮件发送, 邮件服务商, 邮件模板, 邮件适配器