Skip to content

rubix-studios-pty-ltd/payload-unsend

Repository files navigation

Unsend REST Email Adapter

This adapter allows PayloadCMS to send emails using the Unsend REST API.

npm version

Installation

pnpm add @rubixstudios/payload-unsend

Usage

  • Sign up for a Unsend 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
// 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'
    // Optional:
    // templateId: 'template-uuid',
    // scheduledAt: '2025-08-01T10:00:00Z',
    // variables: { firstName: 'Vincent' }
  }),
})

About

This email adapter allows PayloadCMS to utilise Unsend both hosted and selfhosted instances to send emails.

Topics

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Sponsor this project

  •  

Packages

No packages published