Overview
Summary generated from the READMEProvides an email adapter for Payload that delivers transactional email through the Groundmail HTTP API. It is set as the email option in the Payload config, with a default from address and name. It handles authentication mail and calls to payload.sendEmail(). It requires the groundmail package and an API key, which can be supplied through an environment variable.
Features
- Email adapter configured through the Payload email option
- Sends auth emails and payload.sendEmail() messages via HTTP API
- Configurable default from address and from name
- API key read from an environment variable or passed explicitly
- Also exposed through a payload entry point in the groundmail package
Use cases
- Send Payload password reset and verification emails through Groundmail
- Deliver transactional email from Payload without SMTP or Nodemailer
From the author
Payload CMS email adapter for Groundmail transactional email
Installation
npm i groundmail-payload0
Stars
0
Forks
0
Open Issues
3 days ago
Last Updated
2.6k
Weekly Downloads
v0.15.12
npm Version
2.3 KB
Unpacked Size
0
Dependencies
Trends (last 90 days)
Trends appear after 7 days of data. Daily snapshots have not started yet.
Trends appear after 7 days of data. Daily snapshots have not started yet.
Each point is npm's rolling 7-day download count.
Health Score
Composite score based on GitHub activity, stars, npm downloads, publish recency, dependency count, and package size.
Badge for your README
[](https://payloaddirectory.dev/plugins/1423954331-root)<a href="https://payloaddirectory.dev/plugins/1423954331-root"><img src="https://payloaddirectory.dev/badge/1423954331-root.svg" alt="Payload Directory"></a>README
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
Tags
Similar plugins
payload usesend
Email adapter that sends Payload emails through the open-source, self-hostable useSend API
84511/wk8v3
payload cloudflare email adapter
Send Payload transactional email through the Cloudflare Email Service Workers binding
762.7k/wk3v3
payload order emails
Transactional emails on Payload order creation and status changes with overridable templates
570/wk1v3
payload plugin
Email advocacy and contact management with broadcasts, letter campaigns and delivery tracking inside Payload
560/wk1v3
eusend payload
Email adapter that sends Payload emails through the eusend EU-hosted transactional email REST API
520/wk1v3 v4
payload plugin easyemail
Visual EasyEmail Pro template editor and starter library inside the Payload admin
374/wk2v3