Skip to content

Email adapter for PayloadCMS that integrates with useSend, supporting both hosted and self-hosted instances for sending emails.

License

Notifications You must be signed in to change notification settings

rubix-studios-pty-ltd/payload-usesend

Repository files navigation

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 with the useSend REST API for transactional and marketing emails.

npm version Release

Documentation

See the full documentation for comprehensive guides, features, comparisons, and configuration examples.

Installation

pnpm add @rubixstudios/payload-usesend

Usage

  • Sign up for a useSend 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

// 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 file for details.

Support

For support or inquiries:

Author

Rubix Studios Pty. Ltd.
https://rubixstudios.com.au

About

Email adapter for PayloadCMS that integrates with useSend, supporting both hosted and self-hosted instances for sending emails.

Topics

Resources

License

Security policy

Stars

Watchers

Forks

Sponsor this project

  •  

Packages

No packages published

Contributors 2

  •  
  •