Payload Email Test Plugin

A example plugin for Payload CMS that allows you to test email functionality directly from the admin panel.

Installation

Install the plugin from NPM:

npm install payload-plugin-email-test

# or with yarn
yarn add payload-plugin-email-test

# or with pnpm
pnpm add payload-plugin-email-test

Building

git clone https://github.com/marpstar/payload-plugin-email-test.git
pnpm i

# to build
pnpm build:all

# to run the dev app
pnpm dev

Usage

Add the plugin to your Payload configuration:

import { buildConfig } from 'payload/config'
import emailTestPlugin from 'payload-email-test'

export default buildConfig({
  plugins: [
    EmailTestPlugin({
      baseUrl: 'http://localhost:3000',
      apiPath: '/api'
      // enabled: false   // disable the plugin by passing `enabled: false`
    })
  ],
  // ... rest of your payload config
})