added sparkpost.php

.github/workflows/tests.yml

@@ -40,6 +40,9 @@ jobs:
         VONAGE_API_SECRET: ${{ secrets.VONAGE_API_SECRET }}
         VONAGE_TO: ${{ secrets.VONAGE_TO }}
         VONAGE_FROM: ${{ secrets.VONAGE_FROM }}
+        SPARKPOST_API_KEY: ${{ secrets.SPARKPOST_API_KEY }}
+        SPARKPOST_TO: ${{ secrets.SPARKPOST_TO }}
+        SPARKPOST_FROM: ${{ secrets.SPARKPOST_FROM }}
       run: |
         docker compose up -d --build
         sleep 5

docker-compose.yml

@@ -29,6 +29,9 @@ services:
     - VONAGE_API_SECRET
     - VONAGE_TO
     - VONAGE_FROM
+    - SPARKPOST_API_KEY
+    - SPARKPOST_TO
+    - SPARKPOST_FROM
     build:
       context: .
     volumes:

src/Utopia/Messaging/Adapters/Email/SparkPost.php

@@ -0,0 +1,71 @@
+<?php
+
+namespace Utopia\Messaging\Adapters\Email;
+
+use Utopia\Messaging\Adapters\Email as EmailAdapter;
+use Utopia\Messaging\Messages\Email;
+
+class SparkPost extends EmailAdapter{
+
+    public function __construct(private string $apiKey,
+    private bool $isEu = false){
+    }
+
+    public function getName() :string{
+        return 'SparkPost';
+    } 
+
+    public function getMaxMessagesPerRequest(): int{
+        //TODO: real value for this
+        return 1000;
+    }
+    protected function process(Email $message) : string{
+
+        $usDomain = 'api.sparkpost.com';
+        $euDomain = 'api.eu.sparkpost.com';
+
+        $domain = $this->isEu ? $euDomain : $usDomain;
+
+        $requestBody = [
+            'options' =>[
+                //for testing without domain set sandbox option to true(for more information, visit sparkpost.com)
+                'sandbox' => false,
+            ],
+            'recipients' => [
+                [
+                    'address' => [
+                        'email' => $message->getTo()[0], // Assuming you have only one recipient
+                    ],
+                ],
+            ],
+            'content' => [
+                // for testing with sandbox template id should be 'my-first-email' , so uncomment below line
+                // 'template_id' => 'my-first-email', 
+                'from' => [
+                    //sender domain should be registered and verified at sparkpost
+                    'email' => $message->getFrom(),
+                ],
+                //when testing with sandbox comment out below three lines
+                'subject' => $message->getSubject(),
+                'html' => $message->isHtml() ? $message->getContent() : null,
+                'text' => $message->isHtml() ? null : $message->getContent(),
+            ],
+        ];
+
+        $json_body = json_encode($requestBody);
+
+        $response = $this->request(
+            method: 'POST',
+            url: "https://$domain/api/v1/transmissions",
+            headers :[
+                'Authorization: '.$this->apiKey,
+                'Content-Type: application/json',
+            ],
+            body: $json_body,
+        );
+
+        return $response;
+    }
+}
+
+?>

tests/e2e/Email/SparkPostTest.php

@@ -0,0 +1,35 @@
+<?php
+
+namespace Tests\E2E;
+
+
+use Utopia\Messaging\Adapters\Email\SparkPost;
+use Utopia\Messaging\Messages\Email;
+
+class SparkPostTest extends Base{
+    /**
+     * @throws \Exception
+     */
+
+     public function testSendEmail(){
+
+        $apiKey = getenv('SPARKPOST_API_KEY');
+
+        $to = getenv('SPARKPOST_TO');
+        $subject = 'Test Subject';
+        $content = 'Test Content';
+        $from = getenv('SPARKPOST_FROM');
+
+        $sparkPost = new SparkPost($apiKey);
+        $message = new Email(
+            to: [$to],
+            from: $from,
+            subject: $subject,
+            content: $content ,
+        );
+
+        $response = $sparkPost->send($message);
+        $this->assertNotEmpty($response);
+    }
+}
+?>