Merge pull request #10 from VETiSearch/feature/add-sandbox-mode

Add sandbox mode (and Laravel 11 support)

Author: dtangdev

README.md

@@ -26,6 +26,7 @@ MAIL_FROM_ADDRESS=
 MAIL_FROM_NAME=
 MAILJET_SMS_SENDER=
 MAILJET_DRY=true|false
+MAILJET_SANDBOX=true|false
 ```
 
 Make sure that MAIL_FROM_ADDRESS is an authenticated email on Mailjet, otherwise your emails will not be sent by the Mailjet API.
@@ -34,6 +35,8 @@ MAILJET_SMS_SENDER should be between 3 and 11 characters in length, only alphanu
 
 When the dry mode is enabled, Mailjet API isn't called.
 
+When the sandbox mode is enabled, Mailjet API is called but the mail is not send by Mailjet (requires Send API v3.1).
+
 You can publish the configuration file with:
 
 ```shell

composer.json

@@ -23,8 +23,8 @@
     ],
     "require": {
         "php": "^8.0",
-        "illuminate/support": "^9|^10",
-        "illuminate/database": "^9|^10",
+        "illuminate/support": "^9|^10|^11|^12",
+        "illuminate/database": "^9|^10|^11|^12",
         "mailjet/mailjet-apiv3-php": "^1.5"
     },
     "require-dev": {

config/mailjet.php

@@ -10,6 +10,7 @@
     ],
     'smsFrom' => env('MAILJET_SMS_SENDER'),
     'dry' => (bool) env('MAILJET_DRY', false),
+    'sandbox' => (bool) env('MAILJET_SANDBOX', false),
     'options' => [
         'version' => 'v3.1',
     ],

src/MailjetEmailMessage.php

@@ -30,6 +30,13 @@ class MailjetEmailMessage
 
     public array $attachments = [];
 
+    public bool $sandboxMode = false;
+
+    public function __construct()
+    {
+        $this->sandboxMode = (bool) config('mailjet.sandbox', false);
+    }
+
     public function templateId(int $templateId): static
     {
         $this->templateId = $templateId;
@@ -177,6 +184,7 @@ public function toArray(): array
             'Messages' => [
                 $messagesData,
             ],
+            'SandboxMode' => $this->sandboxMode,
         ];
     }
 }

tests/MailjetEmailMessageTest.php

@@ -0,0 +1,18 @@
+<?php
+
+use YieldStudio\LaravelMailjetNotifier\MailjetEmailMessage;
+
+test('SandboxMode is default false', function (): void {
+    $message = (new MailjetEmailMessage())->templateId(123);
+
+    expect($message->toArray()['SandboxMode'])->toBe(false);
+});
+
+test('SandboxMode is true when config is set', function (): void {
+    // Set sandbox value in config to true
+    config(['mailjet.sandbox' => true]);
+
+    $message = (new MailjetEmailMessage())->templateId(123);
+
+    expect($message->toArray()['SandboxMode'])->toBe(true);
+});