strapi/packages/strapi-provider-email-mailgun
Alexandre Bodin 3065d72a4b v3.5.4
2021-03-25 14:34:45 +01:00
..
2018-10-19 09:26:09 +02:00
2019-04-16 09:05:47 +02:00
2021-01-28 16:57:29 +01:00
2018-12-05 15:42:58 +01:00
2020-07-08 09:45:28 +02:00
2021-03-25 14:34:45 +01:00

strapi-provider-email-mailgun

Resources

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

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.us.mailgun.net'), //Optional. If domain region is Europe use 'api.eu.mailgun.net'
    },
    settings: {
      defaultFrom: 'myemail@protonmail.com',
      defaultReplyTo: 'myemail@protonmail.com',
    },
  },
  // ...
});