0.4.0 • Published 3 years ago
@sancsoft/strapi-provider-email-mailgunjs v0.4.0
strapi-provider-email-mailgunjs
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-mailgunjs@npm:@sancsoft/strapi-provider-email-mailgunjs
# using npm
npm install strapi-provider-email-mailgunjs@npm:@sancsoft/strapi-provider-email-mailgunjs --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 | yes | {} |
| settings.domain | string | Mailgun sending domain | yes | |
| 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 |
Example
Path - config/plugins.js
module.exports = ({ env }) => ({
// ...
email: {
provider: 'mailgunjs',
providerOptions: {
key: env('MAILGUN_API_KEY')
},
settings: {
domain: env('MAILGUN_DOMAIN'), // Required
defaultFrom: 'myemail@protonmail.com',
defaultReplyTo: 'myemail@protonmail.com',
},
},
// ...
});