Merge pull request #3 from modernmcguire/feature/tags

Feature/tags

README.md

@@ -52,6 +52,42 @@ MailSpy::sent(function (MessageSent $event, Email $email) {
 ```
 
 
+## Tags
+
+If you want to tag your emails, you can do so by adding the `MailspyTags` concern to any of your mailable classes.
+
+```php
+use ModernMcGuire\MailSpy\Facades\MailSpy;
+use ModernMcGuire\MailSpy\Traits\MailspyTags;
+
+class MarketingPlan extends Mailable implements ShouldQueue
+{
+    use Queueable;
+    use SerializesModels;
+    use MailspyTags;
+
+    /**
+     * Create a new message instance.
+     *
+     * @return void
+     */
+    public function __construct(
+        public Client $client,
+    ) {
+        //
+    }
+
+
+    public function tags(): array
+    {
+        return [
+            'client' => $this->client->id,
+        ];
+    }
+
+}
+
+```
 
 ## Testing
 

src/Listeners/LogSendingEmailListener.php

@@ -4,6 +4,7 @@
 
 use Illuminate\Mail\Events\MessageSending;
 use ModernMcGuire\MailSpy\Models\Email;
+use Symfony\Component\Mailer\Header\TagHeader;
 use Symfony\Component\Mime\Address;
 
 class LogSendingEmailListener
@@ -26,6 +27,7 @@ public function handle(MessageSending $event)
                 $this->saveSenders($email, $message);
                 $this->saveRecipients($email, $message);
                 $this->saveContent($email, $message);
+                $this->saveTags($email, $message);
             });
         } catch (\Exception $e) {
             report($e);
@@ -97,4 +99,22 @@ private function saveContent($email, $message)
             'text' => $text,
         ]);
     }
+
+    private function saveTags(Email $email, \Symfony\Component\Mime\Email $message): void
+    {
+        /** @var TagHeader $header */
+        $header = $message->getHeaders()->get('X-Tag');
+
+        // if method tags exists
+        foreach (json_decode($header->getValue(), true) as $tag => $value) {
+            if (is_array($value)) {
+                $value = json_encode($value);
+            }
+
+            $email->tags()->create([
+                'tag' => $tag,
+                'value' => $value,
+            ]);
+        }
+    }
 }

src/Traits/MailspyTags.php

@@ -0,0 +1,15 @@
+<?php
+
+namespace ModernMcGuire\MailSpy\Traits;
+
+trait MailspyTags
+{
+    abstract public function tags(): array;
+
+    protected function prepareMailableForDelivery()
+    {
+        $this->tag(json_encode($this->tags()));
+
+        parent::prepareMailableForDelivery();
+    }
+}