Merge pull request #29 from vormkracht10/feature/suppressions-list

Suppressions list

database/migrations/3_add_unsuppressed_at_to_mail_events.php.stub

@@ -0,0 +1,29 @@
+<?php
+
+use Illuminate\Database\Migrations\Migration;
+use Illuminate\Database\Schema\Blueprint;
+use Illuminate\Support\Facades\Schema;
+
+return new class extends Migration
+{
+    /**
+     * Run the migrations.
+     */
+    public function up(): void
+    {
+        Schema::table('mail_events', function (Blueprint $table): void {
+            $table->timestamp('unsuppressed_at')
+                ->nullable()
+                ->after('occurred_at');
+        });
+
+        Schema::table('mails', function (Blueprint $table): void {
+            $table->string('mailer')
+                ->after('uuid');
+
+            $table->string('stream_id')
+                ->nullable()
+                ->after('mailer');
+        });
+    }
+};

src/Actions/LogMail.php

@@ -74,12 +74,27 @@ public function getDefaultLogAttributes(MessageSending|MessageSent $event): arra
         ];
     }
 
+    protected function getStreamId(MessageSending|MessageSent $event): ?string
+    {
+        if ($event->data['mailer'] !== 'postmark') {
+            return null;
+        }
+
+        if (null !== $messageStream = $event->message->getHeaders()->get('x-pm-message-stream')) {
+            return $messageStream;
+        }
+
+        return config('mail.mailers.postmark.message_stream_id', 'outbound');
+    }
+
     public function getMandatoryAttributes(MessageSending|MessageSent $event): array
     {
         return [
             'uuid' => $this->getCustomUuid($event),
             // 'mail_class' => $this->getMailClassHeaderValue($event),
             'sent_at' => $event instanceof MessageSent ? now() : null,
+            'mailer' => $event->data['mailer'],
+            'stream_id' => $this->getStreamId($event),
         ];
     }
 
@@ -101,7 +116,7 @@ protected function getCustomUuid(MessageSending|MessageSent $event): ?string
     protected function getAddressesValue(array $address): ?Collection
     {
         $addresses = collect($address)
-            ->flatMap(fn(Address $address) => [$address->getAddress() => $address->getName() === '' ? null : $address->getName()]);
+            ->flatMap(fn (Address $address) => [$address->getAddress() => $address->getName() === '' ? null : $address->getName()]);
 
         return $addresses->count() > 0 ? $addresses : null;
     }

src/Drivers/MailgunDriver.php

@@ -2,6 +2,7 @@
 
 namespace Vormkracht10\Mails\Drivers;
 
+use Illuminate\Http\Client\Response;
 use Illuminate\Support\Facades\Http;
 use Illuminate\Support\Facades\URL;
 use Vormkracht10\Mails\Contracts\MailDriverContract;
@@ -78,7 +79,7 @@ public function verifyWebhookSignature(array $payload): bool
             return false;
         }
 
-        $hmac = hash_hmac('sha256', $payload['signature']['timestamp'] . $payload['signature']['token'], config('services.mailgun.webhook_signing_key'));
+        $hmac = hash_hmac('sha256', $payload['signature']['timestamp'].$payload['signature']['token'], config('services.mailgun.webhook_signing_key'));
 
         if (function_exists('hash_equals')) {
             return hash_equals($hmac, $payload['signature']['signature']);
@@ -127,4 +128,13 @@ public function dataMapping(): array
             'tag' => 'tags',
         ];
     }
+
+    public function unsuppressEmailAddress(string $address): Response
+    {
+        $client = Http::asJson()
+            ->withBasicAuth('api', config('services.mailgun.secret'))
+            ->baseUrl(config('services.mailgun.endpoint').'/v3/');
+
+        return $client->delete(config('services.mailgun.domain').'/unsubscribes/'.$address);
+    }
 }

src/Drivers/PostmarkDriver.php

@@ -2,6 +2,7 @@
 
 namespace Vormkracht10\Mails\Drivers;
 
+use Illuminate\Http\Client\Response;
 use Illuminate\Support\Facades\Http;
 use Illuminate\Support\Facades\URL;
 use Vormkracht10\Mails\Contracts\MailDriverContract;
@@ -139,4 +140,22 @@ public function dataMapping(): array
             'user_agent' => 'UserAgent',
         ];
     }
+
+    public function unsuppressEmailAddress(string $address, $stream_id): Response
+    {
+        $client = Http::asJson()
+            ->withHeaders([
+                'X-Postmark-Server-Token' => config('services.postmark.token'),
+            ])
+            ->baseUrl('https://api.postmarkapp.com/');
+
+        return $client->post('message-streams/'.$stream_id.'/suppressions/delete', [
+            'Suppressions' => [
+                [
+                    'emailAddress' => $address,
+                ],
+            ],
+        ]);
+
+    }
 }

src/Events/MailUnsuppressed.php

@@ -0,0 +1,17 @@
+<?php
+
+namespace Vormkracht10\Mails\Events;
+
+use Illuminate\Broadcasting\InteractsWithSockets;
+use Illuminate\Foundation\Events\Dispatchable;
+use Illuminate\Queue\SerializesModels;
+
+class MailUnsuppressed
+{
+    use Dispatchable, InteractsWithSockets, SerializesModels;
+
+    /**
+     * Create a new event instance.
+     */
+    public function __construct(public string $emailAddress, public string $mailer, public ?string $stream_id = null) {}
+}

src/Listeners/UnsuppressEmailAddress.php

@@ -0,0 +1,18 @@
+<?php
+
+namespace Vormkracht10\Mails\Listeners;
+
+use Vormkracht10\Mails\Events\MailUnsuppressed;
+use Vormkracht10\Mails\Facades\MailProvider;
+
+class UnsuppressEmailAddress
+{
+    public function handle(MailUnsuppressed $event): void
+    {
+        MailProvider::with(driver: $event->mailer)
+            ->unsuppressEmailAddress(
+                address: $event->emailAddress,
+                stream_id: $event->stream_id ?? null
+            );
+    }
+}

src/MailsServiceProvider.php

@@ -14,12 +14,14 @@
 use Vormkracht10\Mails\Contracts\MailProviderContract;
 use Vormkracht10\Mails\Events\MailEvent;
 use Vormkracht10\Mails\Events\MailHardBounced;
+use Vormkracht10\Mails\Events\MailUnsuppressed;
 use Vormkracht10\Mails\Listeners\AttachMailLogUuid;
 use Vormkracht10\Mails\Listeners\LogMailEvent;
 use Vormkracht10\Mails\Listeners\LogSendingMail;
 use Vormkracht10\Mails\Listeners\LogSentMail;
 use Vormkracht10\Mails\Listeners\NotifyOnBounce;
 use Vormkracht10\Mails\Listeners\StoreMailRelations;
+use Vormkracht10\Mails\Listeners\UnsuppressEmailAddress;
 use Vormkracht10\Mails\Managers\MailProviderManager;
 
 class MailsServiceProvider extends PackageServiceProvider
@@ -35,6 +37,8 @@ public function registeringPackage(): void
         $this->app['events']->listen(MailHardBounced::class, NotifyOnBounce::class);
 
         $this->app['events']->listen(MessageSending::class, StoreMailRelations::class);
+
+        $this->app['events']->listen(MailUnsuppressed::class, UnsuppressEmailAddress::class);
     }
 
     public function bootingPackage(): void
@@ -53,6 +57,7 @@ public function configurePackage(Package $package): void
                 '2_create_mail_attachments_table',
                 '2_create_mail_events_table',
                 '2_create_mailables_table',
+                '3_add_unsuppressed_at_to_mail_events',
             )
             ->hasRoutes('webhooks')
             ->hasCommands(

src/Models/Mail.php

@@ -51,6 +51,8 @@ class Mail extends Model
 
     protected $fillable = [
         'uuid',
+        'mailer',
+        'stream_id',
         'mail_class',
         'subject',
         'html',
@@ -75,6 +77,8 @@ class Mail extends Model
     protected $casts = [
         'id' => 'integer',
         'uuid' => 'string',
+        'mailer' => 'string',
+        'stream_id' => 'string',
         'subject' => 'string',
         'from' => 'json',
         'reply_to' => 'json',

src/Models/MailEvent.php

@@ -49,6 +49,7 @@ class MailEvent extends Model
         'tag',
         'payload',
         'occurred_at',
+        'unsuppressed_at',
     ];
 
     protected $casts = [
@@ -57,6 +58,7 @@ class MailEvent extends Model
         'created_at' => 'datetime',
         'updated_at' => 'datetime',
         'occurred_at' => 'datetime',
+        'unsuppressed_at' => 'datetime',
     ];
 
     public function getTable()

tests/TestCase.php

@@ -44,5 +44,8 @@ public function getEnvironmentSetUp($app)
 
         $migration = require __DIR__.'/../database/migrations/2_create_mailables_table.php.stub';
         $migration->up();
+
+        $migration = require __DIR__.'/../database/migrations/3_add_unsuppressed_at_to_mail_events.php.stub';
+        $migration->up();
     }
 }