Strapi plugin logo for Mailgun

Mailgun
Made by Strapi badge
Made by Strapi

Mailgun provider for Strapi

@strapi/provider-email-mailgun

Resources

Links

Installation

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

# using npm
npm install @strapi/provider-email-mailgun --save

Configuration

VariableTypeDescriptionRequiredDefault
providerstringThe name of the provider you useyes
providerOptionsobjectWill be directly given to the require('mailgun.js'). Please refer to mailgun.js doc.yes
settingsobjectSettingsno{}
settings.defaultFromstringDefault sender mail addressnoundefined
settings.defaultReplyTostring | arrayDefault address or addresses the receiver is asked to reply tonoundefined

: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.

Example

Path - config/plugins.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',
      },
    },
  },
  // ...
});

Install now

npm install @strapi/provider-email-mailgun

Last updated

2 days ago

Strapi Version

Supports V3

Author

github profile image for Strapi Solutions SAS
Strapi Solutions SAS

Related plugin

Email

Useful links

Create your own plugin

Check out the available plugin resources that will help you to develop your plugin or provider and get it listed on the marketplace.