Files

84 lines
3.0 KiB
PHP

<?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\Command;
use Symfony\Component\Console\Attribute\AsCommand;
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\DelayedTransportInterface;
use TYPO3\CMS\Core\Mail\FileSpool;
use TYPO3\CMS\Core\Mail\MailerInterface;
/**
* Command for sending spooled messages.
*
* Inspired and partially taken from symfony's swiftmailer package, adapted for Symfony/Mailer.
*
* @link https://github.com/symfony/swiftmailer-bundle/blob/master/Command/SendEmailCommand.php
*/
#[AsCommand('mailer:spool:send', 'Sends emails from the spool.', ['swiftmailer:spool:send'])]
class SendEmailCommand extends Command
{
public function __construct(protected readonly MailerInterface $mailer)
{
parent::__construct('mailer:spool:send');
}
/**
* Defines the allowed options for this command
*/
protected function configure(): void
{
$this
->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).');
}
/**
* Executes the mailer command
*/
protected function execute(InputInterface $input, OutputInterface $output): int
{
$io = new SymfonyStyle($input, $output);
$transport = $this->mailer->getTransport();
if ($transport instanceof DelayedTransportInterface) {
if ($transport instanceof FileSpool) {
$transport->setMessageLimit((int)$input->getOption('message-limit'));
$transport->setTimeLimit((int)$input->getOption('time-limit'));
$recoverTimeout = (int)$input->getOption('recover-timeout');
if ($recoverTimeout) {
$transport->recover($recoverTimeout);
} else {
$transport->recover();
}
}
$sent = $transport->flushQueue($this->mailer->getRealTransport());
$io->comment($sent . ' emails sent');
return Command::SUCCESS;
}
$io->error('The Mailer Transport is not set to "spool".');
return Command::FAILURE;
}
}