chore: add ability to exclude emails

Author: UVLabs

includes/Contacts/Create.php

@@ -102,6 +102,23 @@ private function mapWebHookData(array $user_data) : array
         return $hold;
     }
 
+    /**
+     * Stop adding a contact if they're in our exlcuded list.
+     * 
+     * @param  mixed $user_data 
+     * @return array 
+     * @since  1.0.1
+     */
+    private function dropExcludedEmails($user_data, $excluded_emails): array
+    {
+        $user_email = $user_data['email'] ?? '';
+        if(in_array($user_email, $excluded_emails) || empty($user_email)) {
+            return array();
+        }
+        
+        return $user_data;
+    }
+
     /**
      * Adds the contact to Mautic.
      * 
@@ -204,15 +221,19 @@ public function setCustomMappings(array $mapping): object
      * @return void 
      * @since  1.0.0
      */
-    public function add(array $user_data, array $custom_mappings = array()): ?int
+    public function add(array $user_data, array $excluded_emails = array()): ?int
     {
 
         if(empty($user_data['is_marketing_allowed']) ) {
             return null; // Only opted in contacts please...
         }
 
-        $id = $this->addContactToMautic($user_data);
+        $user_data = $this->dropExcludedEmails($user_data, $excluded_emails);
+        if(empty($user_data)) {
+            return null;
+        }
 
+        $id = $this->addContactToMautic($user_data);
         if(empty($id)) {
             return null;
         }

index.php

@@ -10,7 +10,7 @@
  * Created on:      29/03/2023 (d/m/y)
  *
  * @link    https://uriahsvictor.com
- * @since   1.0.0
+ * @since   1.0.1
  * @license GPLv2
  */
 
@@ -53,12 +53,13 @@ function init(ServerRequestInterface $request): string
         $custom_mappings = customContactDataMappings();
         $segments = contactSegments();
         $tags = contactTags();
+        $excluded_emails = excludedEmails();
 
         $contactCreate = new CreateContact($plugin_id);
         $id = $contactCreate->setCustomMappings($custom_mappings)
             ->setSegments($segments)
             ->setTags($tags)
-            ->add($user_data);
+            ->add($user_data, $excluded_emails);
 
         break;
     case 'install.deactivated':
@@ -68,8 +69,14 @@ function init(ServerRequestInterface $request): string
         break;
     }
 
-    // In production you might probably just want to send back an empty string...
-    return ($id) ?: "The username and password set for the Client is probably wrong. Or the URL you set for the Mautic API is wrong.";
+    /**
+     * This will return null if: 
+     * 
+     * The username and password set for the Client is wrong. 
+     * The URL you set for the Mautic API is wrong.
+     * The contact email is in the excluded list.
+     */
+    return json_encode($id);
 }
 
 // ------ 
@@ -100,7 +107,7 @@ function customContactDataMappings(): array
         '11538' => array( // Add other plugins you own.
             'id' => 'freemius_id',
             'gross' => 'dps_gross',
-        )
+        ),
         // You can add further plugin IDs and their mappings.
     );
 
@@ -125,7 +132,8 @@ function contactSegments(): array
         ),
         '11538' => array( // Add other plugins you own.
             3
-        )
+        ),
+        // You can add further plugin IDs and their mappings.
     );
 
 }
@@ -156,7 +164,20 @@ function contactTags(): array
                 'dps-pro-user'
             ),
             'dps-user'
-        )
+        ),
+        // You can add further plugin IDs and their mappings.
+    );
+}
+
+/**
+ * Email addresses that should be excluded from being added to mautic.
+ * 
+ * @return array 
+ * @since  1.0.1
+ */
+function excludedEmails(): array
+{
+    return array(
     );
 }