https://github.com/rubix-studios-pty-ltd/payload-unsend
This email adapter allows PayloadCMS to utilise Unsend both hosted and selfhosted instances to send emails.
https://github.com/rubix-studios-pty-ltd/payload-unsend
adapter cms email payload-plugin payloadcms payloadcms-3 payloadcms-v3 plugin unsend
Last synced: 11 months ago
JSON representation
This email adapter allows PayloadCMS to utilise Unsend both hosted and selfhosted instances to send emails.
- Host: GitHub
- URL: https://github.com/rubix-studios-pty-ltd/payload-unsend
- Owner: rubix-studios-pty-ltd
- License: mit
- Created: 2025-06-08T11:31:46.000Z (12 months ago)
- Default Branch: master
- Last Pushed: 2025-07-15T17:43:42.000Z (11 months ago)
- Last Synced: 2025-07-16T13:39:12.411Z (11 months ago)
- Topics: adapter, cms, email, payload-plugin, payloadcms, payloadcms-3, payloadcms-v3, plugin, unsend
- Language: TypeScript
- Homepage: https://rubixstudios.com.au
- Size: 439 KB
- Stars: 2
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Funding: .github/FUNDING.yml
- License: LICENSE.md
Awesome Lists containing this project
README
# Unsend REST Email Adapter
This adapter allows PayloadCMS to send emails using the [Unsend](https://unsend.dev) REST API.
[](https://www.npmjs.com/package/@rubixstudios/payload-unsend)
## Installation
```sh
pnpm add @rubixstudios/payload-unsend
```
## Usage
- Sign up for a [Unsend](https://unsend.dev) account
- Set up a domain
- Create an API key
- Set API key as UNSEND_API_KEY environment variable
- Set your Unsend base url as UNSEND_URL environment variable
- Configure your Payload config
```ts
// payload.config.js
import { unsendAdapter } from '@rubixstudios/payload-unsend'
export default buildConfig({
email: unsendAdapter({
defaultFromAddress: 'hello@rubixstudios.com.au',
defaultFromName: 'Rubix Studios',
apiKey: process.env.UNSEND_API_KEY || '',
unsendurl: process.env.UNSEND_URL || 'https://rubixstudios.com.au'
}),
})
```