From c6c962d5d6b3bbf9ac9fe921dc4c3b182dc51063 Mon Sep 17 00:00:00 2001
From: "Fabien \"egg\" O'Carroll" <fabien@allou.is>
Date: Wed, 30 Nov 2022 12:52:11 +0700
Subject: [PATCH] Added methods for removing suppressions from Mailgun

refs https://github.com/TryGhost/Team/issues/2255

These methods will be used by the Mailgun implementation of EmailSuppressionList
so that emails are removed from both our internal list and Mailguns.
---
 ghost/mailgun-client/lib/mailgun-client.js | 32 ++++++++++++++++++++++
 1 file changed, 32 insertions(+)

diff --git a/ghost/mailgun-client/lib/mailgun-client.js b/ghost/mailgun-client/lib/mailgun-client.js
index c43b649dad..ca0ee5b7f1 100644
--- a/ghost/mailgun-client/lib/mailgun-client.js
+++ b/ghost/mailgun-client/lib/mailgun-client.js
@@ -168,6 +168,38 @@ module.exports = class MailgunClient {
         }
     }
 
+    async removeSuppression(type, email) {
+        if (!this.isConfigured()) {
+            return false;
+        }
+        const instance = this.getInstance();
+        const config = this.#getConfig();
+
+        try {
+            await instance.suppressions.destroy(
+                config.domain,
+                type,
+                email
+            );
+            return true;
+        } catch (err) {
+            logging.error(err);
+            return false;
+        }
+    }
+
+    async removeBounce(email) {
+        return this.removeSuppression('bounces', email);
+    }
+
+    async removeComplaint(email) {
+        return this.removeSuppression('complaints', email);
+    }
+
+    async removeUnsubscribe(email) {
+        return this.removeSuppression('unsubscribes', email);
+    }
+
     normalizeEvent(event) {
         const providerId = event?.message?.headers['message-id'];