https://github.com/piksail/strapi-provider-email-plunk
Plunk email provider for Strapi
https://github.com/piksail/strapi-provider-email-plunk
plunk strapi
Last synced: about 1 month ago
JSON representation
Plunk email provider for Strapi
- Host: GitHub
- URL: https://github.com/piksail/strapi-provider-email-plunk
- Owner: piksail
- License: mit
- Created: 2025-05-15T22:38:55.000Z (about 1 year ago)
- Default Branch: main
- Last Pushed: 2025-07-15T07:57:10.000Z (about 1 year ago)
- Last Synced: 2025-10-08T14:18:57.145Z (10 months ago)
- Topics: plunk, strapi
- Language: JavaScript
- Homepage:
- Size: 71.3 KB
- Stars: 0
- Watchers: 2
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
- Codeowners: .github/CODEOWNERS
Awesome Lists containing this project
README
# @piksail/strapi-provider-email-plunk
Strapi email provider for [Plunk](https://www.useplunk.com/)
## Installation
```bash
# using yarn
yarn add @piksail/strapi-provider-email-plunk
# using npm
npm install @piksail/strapi-provider-email-plunk --save
```
## Configuration
| Variable | Type | Description | Required | Default |
| ----------------------- | ------ | -------------------------------------------------------------------------------------------------------------- | -------- | --------- |
| provider | string | The name of the provider you use | yes | |
| providerOptions | object | Provider options | yes | |
| providerOptions.apiKey | object | Plunk api key. Please refer to [@plunk/node](https://www.npmjs.com/package/@plunk/node) | yes | |
| providerOptions.baseUrl | object | Plunk base url if self-hosting. Please refer to [@plunk/node](https://www.npmjs.com/package/@plunk/node) | no | |
| settings | object | Settings | no | {} |
| settings.defaultFrom | string | Default sender mail address | no | undefined |
| settings.verbose | string | Print detailled logs. Does not print Authorization header. Use with caution, might leak sensitive data in logs | no | false |
> :warning: The Shipper Email (or defaultfrom) may also need to be changed in the `Email Templates` tab on the admin panel for emails to send properly
### Example
**Path -** `config/plugins.js`
```js
module.exports = ({ env }) => ({
// ...
email: {
config: {
provider: "@piksail/strapi-provider-email-plunk",
providerOptions: {
apiKey: env("PLUNK_API_KEY"),
baseUrl: env("PLUNK_BASE_URL"), // Optional, use if self-hosting. Must not contain any path, ex: https://plunk.example.com
},
settings: {
defaultFrom: "john@example.com",
verbose: false, // Use with caution, might leak sensitive data in logs
},
},
},
// ...
});
```
## Troubleshoot
Turn on `verbose` for easier debugging.
`Couldn't send test email: Unknown route.` Check your baseUrl setting, it should look like this: .