https://github.com/rubix-studios-pty-ltd/payload-usesend
Email adapter for PayloadCMS that integrates with useSend, supporting both hosted and self-hosted instances for sending emails.
https://github.com/rubix-studios-pty-ltd/payload-usesend
adapter cms email payload payload-plugin payloadcms payloadcms-3 payloadcms-v3 plugin plugins unsend usesend
Last synced: 4 months ago
JSON representation
Email adapter for PayloadCMS that integrates with useSend, supporting both hosted and self-hosted instances for sending emails.
- Host: GitHub
- URL: https://github.com/rubix-studios-pty-ltd/payload-usesend
- Owner: rubix-studios-pty-ltd
- License: mit
- Created: 2025-09-09T05:09:57.000Z (9 months ago)
- Default Branch: main
- Last Pushed: 2026-02-04T21:45:58.000Z (4 months ago)
- Last Synced: 2026-02-05T09:47:09.932Z (4 months ago)
- Topics: adapter, cms, email, payload, payload-plugin, payloadcms, payloadcms-3, payloadcms-v3, plugin, plugins, unsend, usesend
- Language: TypeScript
- Homepage: https://rubixstudios.com.au/documents/usesend
- Size: 1020 KB
- Stars: 8
- Watchers: 0
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Funding: .github/FUNDING.yml
- License: LICENSE.md
- Security: SECURITY.md
Awesome Lists containing this project
README
# PayloadCMS + useSend Email Adapter
useSend is an API-first email delivery platform built for transactional and marketing email workflows. It adopts an architectural model comparable to Resend while remaining fully open source and self-hostable. This combination enables teams to standardise email delivery without surrendering control over infrastructure, deployment topology, or data locality.
The platform exposes a REST-based interface for email delivery and supports provider-native capabilities such as templates, dynamic variables, and scheduled sends. By abstracting the underlying delivery infrastructure, useSend simplifies application integration while allowing organisations to retain operational and regulatory control.
This adapter integrates [PayloadCMS](https://payloadcms.com) with the [useSend](https://usesend.com) REST API for transactional and marketing emails.
[](https://www.npmjs.com/package/@rubixstudios/payload-usesend)
## Documentation
See the [full documentation](https://rubixstudios.com.au/documents/usesend) for comprehensive guides, features, comparisons, and configuration examples.
## Installation
```sh
pnpm add @rubixstudios/payload-usesend
```
## Usage
- Sign up for a [useSend](https://usesend.com) account
- Set up a domain
- Create an API key
- Set API key as USESEND_API_KEY environment variable
- Set your useSend base url as USESEND_URL environment variable
- Configure your Payload config
## Configuration
```ts
// 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' }
}),
})
```
| Option | Type | Required | Default | Description |
|--------------------|--------|----------|---------|----------------------|
| apiKey | string | Yes | - | useSend API key |
| useSendUrl | string | Yes | - | useSend base URL |
| defaultFromAddress | string | Yes | - | Default sender email |
| defaultFromName | string | Yes | - | Default sender name |
| scheduledAt | string | No | - | ISO date string |
| templateId | string | No | - | Email template ID |
| variables | object | No | - | Template variables |
## License
This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.
## Support
For support or inquiries:
- LinkedIn: [rubixvi](https://www.linkedin.com/in/rubixvi/)
- Website: [Rubix Studios](https://rubixstudios.com.au)
## Author
Rubix Studios Pty. Ltd.
[https://rubixstudios.com.au](https://rubixstudios.com.au)