rareform / craft-plunk
Plunk mail adapter for Craft CMS
Package info
github.com/RareFormLabs/craft-plunk
Type:craft-plugin
pkg:composer/rareform/craft-plunk
Requires
- php: ^8.0.2
- craftcms/cms: ^4.0.0|^5.0.0
- symfony/http-client: ^6.0|^7.0
- symfony/mailer: ^6.0|^7.0
Requires (Dev)
- craftcms/ecs: dev-main
- craftcms/phpstan: dev-main
- phpunit/phpunit: ^9.6
README
Plunk for Craft CMS
This plugin provides a Plunk mail transport adapter for Craft CMS.
Requirements
This plugin requires Craft CMS 4.0.0+ or 5.0.0+.
Installation
Install the plugin with Composer:
composer require rareform/craft-plunk php craft plugin/install plunk
Setup
Once Plunk is installed:
- Go to Settings -> Email in the Craft control panel.
- Change Transport Type to Plunk.
- Enter your Secret API Key. Plunk's
/v1/sendendpoint requires a secret key (sk_*). - Leave API Base URL blank to use hosted Plunk, or set it to your self-hosted Plunk API origin.
- Confirm your Craft system email address uses a domain that is verified in Plunk.
- Click Save and send Craft's test email.
Environment Variables
Both settings support Craft environment aliases and environment variables.
PLUNK_SECRET_KEY=sk_your_secret_key PLUNK_API_BASE_URL=https://next-api.useplunk.com
Use $PLUNK_SECRET_KEY for the Secret API Key setting and $PLUNK_API_BASE_URL for the API Base URL setting.
For self-hosted Plunk installs, set API Base URL to the API root, without /v1/send. The transport appends /v1/send automatically.
Notes
This adapter is intentionally focused on Craft mail delivery. It sends the subject, HTML/text body, sender, recipients, reply-to address, custom headers, and attachments from Craft through Plunk's transactional send API. Plunk templates, contact data, subscription state, workflows, and event tracking are not exposed as plugin settings in this release.
Plunk's transactional API does not provide separate CC or BCC fields. Messages with CC or BCC recipients are rejected by the transport so those recipients are not silently dropped.