@strapi/provider-email-mailgun 4.2.0-beta.2 → 4.2.0

package/README.md

@@ -26,13 +26,15 @@ npm install @strapi/provider-email-mailgun --save
 | 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](https://www.npmjs.com/package/mailgun-js) doc. | yes      |           |
+| providerOptions         | object                  | Will be directly given to the `require('mailgun.js')`. Please refer to [mailgun.js](https://www.npmjs.com/package/mailgun.js) doc. | yes      |           |
 | settings                | object                  | Settings                                                                                                                           | no       | {}        |
 | settings.defaultFrom    | string                  | Default sender mail address                                                                                                        | no       | undefined |
 | settings.defaultReplyTo | string \| array<string> | 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](https://www.npmjs.com/package/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`
@@ -44,9 +46,9 @@ module.exports = ({ env }) => ({
     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'
+        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',

package/lib/index.js

@@ -1,40 +1,53 @@
 'use strict';
 
-const mailgunFactory = require('mailgun-js');
+const formData = require('form-data');
+const Mailgun = require('mailgun.js');
 const { removeUndefined } = require('@strapi/utils');
 
+const optionsMap = {
+  apiKey: { field: 'key', fn: value => value },
+  host: { field: 'url', fn: value => `https://${value || 'api.mailgun.net'}` },
+};
+
 module.exports = {
+  convertProviderOptions(providerOptions = {}) {
+    const newOptions = {};
+    if (typeof providerOptions === 'object') {
+      Object.keys(providerOptions).forEach(key => {
+        if (Object.keys(optionsMap).includes(key)) {
+          newOptions[optionsMap[key].field] = optionsMap[key].fn(providerOptions[key]);
+        } else {
+          newOptions[key] = providerOptions[key];
+        }
+      });
+    }
+    return newOptions;
+  },
+
   init(providerOptions = {}, settings = {}) {
-    const mailgun = mailgunFactory({
-      mute: false,
-      ...providerOptions,
-    });
+    const defaults = {
+      username: 'api',
+    };
+    const mailgun = new Mailgun(formData);
+    const mg = mailgun.client({ ...defaults, ...this.convertProviderOptions(providerOptions) });
 
     return {
       send(options) {
-        return new Promise((resolve, reject) => {
-          const { from, to, cc, bcc, replyTo, subject, text, html, ...rest } = options;
+        const { from, to, cc, bcc, replyTo, subject, text, html, ...rest } = options;
 
-          let msg = {
-            from: from || settings.defaultFrom,
-            to,
-            cc,
-            bcc,
-            'h:Reply-To': replyTo || settings.defaultReplyTo,
-            subject,
-            text,
-            html,
-            ...rest,
-          };
+        let data = {
+          from: from || settings.defaultFrom,
+          to,
+          cc,
+          bcc,
+          'h:Reply-To': replyTo || settings.defaultReplyTo,
+          subject,
+          text,
+          html,
+          ...rest,
+        };
 
-          mailgun.messages().send(removeUndefined(msg), function(err) {
-            if (err) {
-              reject(err);
-            } else {
-              resolve();
-            }
-          });
-        });
+        return mg.messages.create(providerOptions.domain, removeUndefined(data));
       },
     };
   },

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@strapi/provider-email-mailgun",
-  "version": "4.2.0-beta.2",
+  "version": "4.2.0",
   "description": "Mailgun provider for strapi email plugin",
   "keywords": [
     "email",
@@ -36,12 +36,13 @@
     "test": "echo \"no tests yet\""
   },
   "dependencies": {
-    "@strapi/utils": "4.2.0-beta.2",
-    "mailgun-js": "0.22.0"
+    "@strapi/utils": "4.2.0",
+    "form-data": "^4.0.0",
+    "mailgun.js": "5.0.2"
   },
   "engines": {
-    "node": ">=12.22.0 <=16.x.x",
+    "node": ">=14.19.1 <=16.x.x",
     "npm": ">=6.0.0"
   },
-  "gitHead": "bff73257e7695d6f361c91dda8cc810a2bb70b6e"
+  "gitHead": "12c8ee3b2d95fe417de4d939db0311a0513bd8da"
 }