Installation

Before you install PayloadCMS useSend Email Adapter, make sure you have the following in place:

• An existing PayloadCMS v3 project
• A reachable useSend instance (cloud or self-hosted)
• A verified sending domain configured in useSend
• A useSend API key with permission to send email

Package

Add the adapter as a dependency to the Payload project.

pnpm add @rubixstudios/payload-usesend

The package is published to npm under Rubix Studios. Installing the package does not change email behaviour until configuration is applied.

Environment

Define the required environment variables at runtime.

Values must not be committed to source control.

Payload

Register the adapter in the Payload configuration file.

// payload.config.ts
import { buildConfig } from 'payload/config'
import { sendAdapter } from '@rubixstudios/payload-usesend'
 
export default buildConfig({
  email: sendAdapter({
    apiKey: process.env.USESEND_API_KEY!,
    useSendUrl: process.env.USESEND_URL!,
    defaultFromName: 'Example',
    defaultFromAddress: 'no-reply@example.com',
  }),
})

Once registered, Payload routes all email through useSend while preserving payload.sendEmail() usage.

Validation

Trigger an email action such as a password reset or test notification. Successful delivery confirms API connectivity, domain verification, and adapter registration.

Delivery logs and status are available through the useSend interface.