SendEmailCommand.php

Go to the documentation of this file.

<?php
declare(strict_types = 1);
namespace ‪TYPO3\CMS\Core\Command;
 
/*
 * 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!
 */
 
use Symfony\Component\Console\Command\Command;
use Symfony\Component\Console\Input\InputInterface;
use Symfony\Component\Console\Input\InputOption;
use Symfony\Component\Console\Output\OutputInterface;
use Symfony\Component\Console\Style\SymfonyStyle;
use ‪TYPO3\CMS\Core\Mail\Mailer;
use ‪TYPO3\CMS\Core\Utility\GeneralUtility;
 
class ‪SendEmailCommand extends Command
{
    protected function ‪configure()
    {
        $this
            ->setDescription('Sends emails from the spool')
            ->addOption('message-limit', null, InputOption::VALUE_REQUIRED, 'The maximum number of messages to send.')
            ->addOption('time-limit', null, InputOption::VALUE_REQUIRED, 'The time limit for sending messages (in seconds).')
            ->addOption('recover-timeout', null, InputOption::VALUE_REQUIRED, 'The timeout for recovering messages that have taken too long to send (in seconds).');
    }
 
    protected function ‪execute(InputInterface $input, OutputInterface ‪$output)
    {
        $io = new SymfonyStyle($input, ‪$output);
 
        $mailer = $this->‪getMailer();
 
        $transport = $mailer->getTransport();
        if ($transport instanceof \Swift_Transport_SpoolTransport) {
            $spool = $transport->getSpool();
            if ($spool instanceof \Swift_ConfigurableSpool) {
                $spool->setMessageLimit((int)$input->getOption('message-limit'));
                $spool->setTimeLimit((int)$input->getOption('time-limit'));
            }
            if ($spool instanceof \Swift_FileSpool) {
                $recoverTimeout = (int)$input->getOption('recover-timeout');
                if ($recoverTimeout) {
                    $spool->recover($recoverTimeout);
                } else {
                    $spool->recover();
                }
            }
            $sent = $spool->flushQueue($mailer->getRealTransport());
            $io->comment($sent . ' emails sent');
        } else {
            $io->error('The Mailer Transport is not set to "spool".');
        }
    }
 
    protected function ‪getMailer(): ‪Mailer
    {
        return GeneralUtility::makeInstance(Mailer::class);
    }
}