strapi/packages/providers/email-mailgun

@strapi/provider-email-mailgun

Resources

• LICENSE

Links

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

Installation

# using yarn
yarn add @strapi/provider-email-mailgun

# using npm
npm install @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

⚠️ 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

module.exports = ({ env }) => ({
  // ...
  email: {
    config: {
      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',
      },
    },
  },
  // ...
});