groundmail-payload

Payload CMS email adapter for Groundmail — auth mail and payload.sendEmail() over the HTTP API.

Install

npm install groundmail-payload groundmail

GROUNDMAIL_API_KEY=gm_your_key_here

Usage

import { buildConfig } from 'payload'
import { groundmailAdapter } from 'groundmail-payload'

export default buildConfig({
  email: groundmailAdapter({
    defaultFromAddress: '[email protected]',
    defaultFromName: 'Acme',
    // apiKey: process.env.GROUNDMAIL_API_KEY,
  }),
  // ...collections, etc.
})

Also available as import { groundmailAdapter } from 'groundmail/payload'.

Prefer Nodemailer? Use groundmail-nodemailer with @payloadcms/email-nodemailer instead.

Docs

https://docs.groundmail.dev/guides/payload

License

MIT