MemorySpool.php

Go to the documentation of this file.

<?php
 
declare(strict_types=1);
 
/*
 * This file is part of the TYPO3 CMS project.
 *
 * It is free software; you can redistribute it and/or modify it under
 * the terms of the GNU General Public License, either version 2
 * of the License, or any later version.
 *
 * For the full copyright and license information, please read the
 * LICENSE.txt file that was distributed with this source code.
 *
 * The TYPO3 project - inspiring people to share!
 */
 
namespace ‪TYPO3\CMS\Core\Mail;
 
use Psr\Log\LoggerInterface;
use Symfony\Component\Mailer\Exception\TransportExceptionInterface;
use Symfony\Component\Mailer\SentMessage;
use Symfony\Component\Mailer\Transport\AbstractTransport;
use Symfony\Component\Mailer\Transport\TransportInterface;
use Symfony\Contracts\EventDispatcher\EventDispatcherInterface;
use ‪TYPO3\CMS\Core\Security\BlockSerializationTrait;
use ‪TYPO3\CMS\Core\SingletonInterface;
use ‪TYPO3\CMS\Core\Utility\GeneralUtility;
 
class ‪MemorySpool extends AbstractTransport implements ‪SingletonInterface, ‪DelayedTransportInterface
{
    use ‪BlockSerializationTrait;
 
    protected array ‪$queuedMessages = [];
 
    protected int ‪$retries = 3;
 
    public function ‪__construct(
        ?EventDispatcherInterface $dispatcher = null,
        protected readonly ?LoggerInterface $logger = null
    ) {
        parent::__construct($dispatcher, $logger);
 
        $this->setMaxPerSecond(0);
    }
 
    public function ‪__destruct()
    {
        // TODO: DI should be used to inject the MailerInterface
        $mailer = GeneralUtility::makeInstance(MailerInterface::class);
        try {
            $this->‪flushQueue($mailer->getRealTransport());
        } catch (TransportExceptionInterface $exception) {
            if ($this->logger instanceof LoggerInterface) {
                $this->logger->error('An Exception occurred while flushing email queue: {message}', ['exception' => $exception, 'message' => $exception->getMessage()]);
            }
        }
    }
 
    public function ‪flushQueue(TransportInterface $transport): int
    {
        if ($this->queuedMessages === []) {
            return 0;
        }
 
        ‪$retries = ‪$this->retries;
        $message = null;
        $count = 0;
        while (‪$retries--) {
            try {
                while ($message = array_pop($this->queuedMessages)) {
                    $transport->send($message->getMessage(), $message->getEnvelope());
                    $count++;
                }
            } catch (TransportExceptionInterface $exception) {
                if (‪$retries) {
                    // re-queue the message at the end of the queue to give a chance
                    // to the other messages to be sent, in case the failure was due to
                    // this message and not just the transport failing
                    array_unshift($this->queuedMessages, $message);
 
                    // wait half a second before we try again
                    usleep(500000);
                } else {
                    throw $exception;
                }
            }
        }
        return $count;
    }
 
    protected function ‪doSend(SentMessage $message): void
    {
        $this->queuedMessages[] = $message;
    }
 
    public function ‪__toString(): string
    {
        return 'MemorySpool';
    }
}