Implement QueueTransport to enqueue emails automatically Fixes #64

Author: ajibarra

src/Job/SendMailJob.php

@@ -0,0 +1,44 @@
+<?php
+declare(strict_types=1);
+
+/**
+ * CakePHP(tm) : Rapid Development Framework (https://cakephp.org)
+ * Copyright (c) Cake Software Foundation, Inc. (https://cakefoundation.org/)
+ *
+ * Licensed under The MIT License
+ * For full copyright and license information, please see the LICENSE.txt
+ * Redistributions of files must retain the above copyright notice.
+ *
+ * @copyright     Copyright (c) Cake Software Foundation, Inc. (https://cakefoundation.org/)
+ * @link          https://cakephp.org CakePHP(tm) Project
+ * @since         0.1.9
+ * @license       https://opensource.org/licenses/MIT MIT License
+ */
+namespace Cake\Queue\Job;
+
+use Cake\Queue\Queue\Processor;
+
+/**
+ * SendMailJob class to be used by QueueTransport to enqueue emails
+ */
+class SendMailJob implements JobInterface
+{
+    /**
+     * @inheritDoc
+     */
+    public function execute(Message $message): ?string
+    {
+        $transportClassName = $message->getArgument('transport');
+        $config = $message->getArgument('config');
+        $emailMessage = unserialize($message->getArgument('emailMessage'));
+        try {
+            /** @var \Cake\Mailer\AbstractTransport $transport */
+            $transport = new $transportClassName($config);
+            $result = $transport->send($emailMessage);
+        } catch (\Exception $e) {
+            return Processor::REJECT;
+        }
+
+        return Processor::ACK;
+    }
+}

src/Mailer/Transport/QueueTransport.php

@@ -0,0 +1,67 @@
+<?php
+declare(strict_types=1);
+
+/**
+ * CakePHP(tm) : Rapid Development Framework (https://cakephp.org)
+ * Copyright (c) Cake Software Foundation, Inc. (https://cakefoundation.org/)
+ *
+ * Licensed under The MIT License
+ * For full copyright and license information, please see the LICENSE.txt
+ * Redistributions of files must retain the above copyright notice.
+ *
+ * @copyright     Copyright (c) Cake Software Foundation, Inc. (https://cakefoundation.org/)
+ * @link          https://cakephp.org CakePHP(tm) Project
+ * @since         0.1.9
+ * @license       https://opensource.org/licenses/MIT MIT License
+ */
+namespace Cake\Queue\Mailer\Transport;
+
+use Cake\Mailer\Message;
+use Cake\Mailer\Transport\MailTransport;
+use Cake\Queue\Job\SendMailJob;
+use Cake\Queue\QueueManager;
+
+class QueueTransport extends \Cake\Mailer\AbstractTransport
+{
+    /**
+     * Default config for this class
+     *
+     * @var array<string, mixed>
+     */
+    protected $_defaultConfig = [
+        'options' => [],
+        'transport' => MailTransport::class,
+    ];
+
+    /**
+     * @inheritDoc
+     */
+    public function send(Message $message): array
+    {
+        QueueManager::push(
+            [SendMailJob::class, 'execute'],
+            [
+                'transport' => $this->getConfig('transport'),
+                'config' => $this->getConfig(),
+                'emailMessage' => serialize($message),
+            ],
+            $this->getConfig('options')
+        );
+
+        $headers = $message->getHeadersString(
+            [
+                'from',
+                'to',
+                'subject',
+                'sender',
+                'replyTo',
+                'readReceipt',
+                'returnPath',
+                'cc',
+                'bcc',
+            ],
+        );
+
+        return ['headers' => $headers, 'message' => 'Message has been enqueued'];
+    }
+}