@codeparticle/strapi-provider-email-mailgun

Resources

Links

- Strapi website
- Strapi documentation
- Strapi community on Discord
- Strapi news on Twitter

Installation

``bash

`using yarn`


yarn add @codeparticle/strapi-provider-email-mailgun
using npm

npm install @codeparticle/strapi-provider-email-mailgun --save


Configuration

| Variable | Type | Description | Required | Default | | ----------------------- | ----------------------- | ---------------------------------------------------------------------------------------------------------------------------------- | -------- | --------- | | provider | string | The name of the provider you use | yes | | | providerOptions | object | Will be directly given to therequire('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 Templates tab on the admin panel for emails to send properly

Since mailgun-js has been deprecated, this package now uses mailgun.js instead. In an effort to avoid breaking changes methods were added to convert existing configuration objects to work with the new package.

`$3`

Path - config/plugins.js

`js module.exports = ({ env }) => ({ // ... email: { config: { provider: 'mailgun', providerOptions: { key: env('MAILGUN_API_KEY'), // Required domain: env('MAILGUN_DOMAIN'), // Required url: env('MAILGUN_URL', 'https://api.mailgun.net'), //Optional. If domain region is Europe use 'https://api.eu.mailgun.net' }, settings: { defaultFrom: 'myemail@protonmail.com', defaultReplyTo: 'myemail@protonmail.com', }, }, }, // ... });``

using yarn

yarn add @codeparticle/strapi-provider-email-mailgun

using npm

npm install @codeparticle/strapi-provider-email-mailgun --save

Configuration

| 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 Templates tab on the admin panel for emails to send properly

Since mailgun-js has been deprecated, this package now uses mailgun.js

 instead. In an effort to avoid breaking changes methods were added to convert existing configuration objects to work with the new package.

$3

Path - config/plugins.js

js
module.exports = ({ env }) => ({
  // ...
  email: {
    config: {
      provider: 'mailgun',
      providerOptions: {
        key: env('MAILGUN_API_KEY'), // Required
        domain: env('MAILGUN_DOMAIN'), // Required
        url: env('MAILGUN_URL', 'https://api.mailgun.net'), //Optional. If domain region is Europe use 'https://api.eu.mailgun.net'
      },
      settings: {
        defaultFrom: 'myemail@protonmail.com',
        defaultReplyTo: 'myemail@protonmail.com',
      },
    },
  },
  // ...
});