Email: log message-id out to a separate column

Author: dpslwk

app/HMS/Entities/Email.php

@@ -47,26 +47,34 @@ class Email
      */
     protected $role;
 
+    /**
+     * @var string
+     */
+    protected $messageId;
+
     /**
      * Create a new email record.
      *
      * @param array $toAddress Array of to adddress in format [ email => name]
      * @param string $subject
      * @param string $body
      * @param string $fullString
+     * @param string $messageId
      */
     public function __construct(
         array $toAddress,
         string $subject,
         string $body,
-        string $fullString
+        string $fullString,
+        string $messageId
     ) {
         $this->toAddress = $toAddress;
         $this->subject = $subject;
         $this->body = $body;
         $this->fullString = $fullString;
         $this->users = new ArrayCollection();
         $this->sentAt = Carbon::now();
+        $this->messageId = $messageId;
     }
 
     /**
@@ -232,4 +240,24 @@ public function setRole(?Role $role): self
 
         return $this;
     }
+
+    /**
+     * @return string
+     */
+    public function getMessageId()
+    {
+        return $this->messageId;
+    }
+
+    /**
+     * @param string $messageId
+     *
+     * @return self
+     */
+    public function setMessageId($messageId)
+    {
+        $this->messageId = $messageId;
+
+        return $this;
+    }
 }

app/HMS/Mappings/HMS.Entities.Email.dcm.yml

@@ -24,6 +24,8 @@ HMS\Entities\Email:
       gedmo:
         timestampable:
           on: create
+    messageId:
+      type: string
   manyToOne:
     role:
       targetEntity: Role

app/Listeners/LogSentMessage.php

@@ -51,12 +51,13 @@ public function __construct(
     public function handle(MessageSending $event)
     {
         // grab the various bits of info from the Swift_Message
+        $messageId = $event->message->getHeaders()->get('message-id')->getId();
         $toAddresses = $event->message->getHeaders()->get('to')->getNameAddresses();
         $subject = $event->message->getHeaders()->get('subject')->getValue();
         $body = $event->message->getBody();
         $fullString = $event->message->toString();
 
-        $email = new Email($toAddresses, $subject, $body, $fullString);
+        $email = new Email($toAddresses, $subject, $body, $fullString, $messageId);
 
         // now work out the asscications for the users / roles
         foreach ($toAddresses as $address => $name) {

database/migrations_doctrine/Version20190712235148_alter_email_add_message_id.php

@@ -0,0 +1,29 @@
+<?php
+
+namespace Database\Migrations;
+
+use Doctrine\Migrations\AbstractMigration;
+use Doctrine\DBAL\Schema\Schema as Schema;
+
+class Version20190712235148_alter_email_add_message_id extends AbstractMigration
+{
+    /**
+     * @param Schema $schema
+     */
+    public function up(Schema $schema)
+    {
+        $this->abortIf($this->connection->getDatabasePlatform()->getName() != 'mysql', 'Migration can only be executed safely on \'mysql\'.');
+
+        $this->addSql('ALTER TABLE emails ADD message_id VARCHAR(255) NOT NULL');
+    }
+
+    /**
+     * @param Schema $schema
+     */
+    public function down(Schema $schema)
+    {
+        $this->abortIf($this->connection->getDatabasePlatform()->getName() != 'mysql', 'Migration can only be executed safely on \'mysql\'.');
+
+        $this->addSql('ALTER TABLE emails DROP message_id');
+    }
+}