@keplars-hq/payload-email
v2.2.2
Published
Keplars email adapter for Payload CMS
Maintainers
debojyoti452Readme
@keplars-hq/payload-email
Keplars email adapter for Payload CMS. Routes all Payload system emails through Keplars' priority-queue API.
Install
bun add @keplars-hq/payload-emailUsage
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',
}),
})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 |
License
MIT