Payload CMS

Replace Payload's default email system with Keplars. Password resets, email verification, and any custom emails sent via payload.sendEmail() are automatically routed through Keplars' priority-queue API.

@keplars-hq/payload-emailnpmjs.com/package/@keplars-hq/payload-email

Install

bun add @keplars-hq/payload-email

Setup

Add the adapter to your Payload config

import { buildConfig } from 'payload'
import { keplarsAdapter } from '@keplars-hq/payload-email'

export default buildConfig({
  email: keplarsAdapter({
    apiKey: process.env.KEPLARS_API_KEY,
    defaultFromAddress: '[email protected]',
    defaultFromName: 'Your App',
  }),
})

Set your environment variable

KEPLARS_API_KEY=kms_your_key_here

That's it. All Payload system emails now route through Keplars.

Options

Option	Required	Default	Description
`apiKey`	Yes	-	Your Keplars API key (`kms_...`)
`defaultFromAddress`	Yes	-	Sender email address
`defaultFromName`	Yes	-	Sender display name
`defaultPriority`	No	`high`	Queue priority: `instant`, `high`, `async`, `bulk`
`overrideRecipientAddress`	No	-	Redirect all emails to this address (useful for testing)

Priority Reference

Use case	Priority
OTP, magic links	`instant`
Password reset, verification	`high` (default)
Welcome, notifications	`async`
Newsletters	`bulk`

Covered Emails

All Payload system emails are handled automatically:

Password reset
Email verification
Custom emails via payload.sendEmail()