3.13.0 • Published 10 months ago
@toanz/strapi-provider-email-mailgun v3.13.0
strapi-provider-email-mailgun
Maintenance release by toanz
Resources
Links
Prerequisites
You need to have the plugin strapi-plugin-email installed in you Strapi project.
Installation
# using yarn
yarn add strapi-provider-email-mailgun
# using npm
npm install strapi-provider-email-mailgun --saveConfiguration
| Variable | Type | Description | Required | Default |
|---|---|---|---|---|
| provider | string | The name of the provider you use | yes | |
| providerOptions | object | Will be directly given to the require('mailgun-js'). Please refer to mailgun-js doc. | yes | |
| settings | object | Settings | no | {} |
| settings.defaultFrom | string | Default sender mail address | no | undefined |
| settings.defaultReplyTo | string | array | Default address or addresses the receiver is asked to reply to | no | undefined |
:warning: The Shipper Email (or defaultfrom) may also need to be changed in the
Email Templatestab on the admin panel for emails to send properly
Example
Path - config/plugins.js
module.exports = ({ env }) => ({
// ...
email: {
provider: 'mailgun',
providerOptions: {
apiKey: env('MAILGUN_API_KEY'),
domain: env('MAILGUN_DOMAIN'), //Required if you have an account with multiple domains
host: env('MAILGUN_HOST', 'api.mailgun.net'), //Optional. If domain region is Europe use 'api.eu.mailgun.net'
},
settings: {
defaultFrom: 'myemail@protonmail.com',
defaultReplyTo: 'myemail@protonmail.com',
},
},
// ...
});