JSPM

  • ESM via JSPM
  • ES Module Entrypoint
  • Export Map
  • Keywords
  • License
  • Repository URL
  • TypeScript Types
  • README
  • Created
  • Published
  • Downloads 36
  • Score
    100M100P100Q95529F
  • License MIT

PayloadCMS adapter for sending emails via the useSend API (previously Unsend).

Package Exports

  • @rubixstudios/payload-usesend

Readme

PayloadCMS + useSend Email Adapter

This adapter integrates PayloadCMS with the useSend REST API for transactional and marketing emails.

npm version Release

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