vendor/symfony/mailer/Transport/AbstractTransport.php line 59

Open in your IDE?
  1. <?php
  3. /*
  4.  * This file is part of the Symfony package.
  5.  *
  6.  * (c) Fabien Potencier <fabien@symfony.com>
  7.  *
  8.  * For the full copyright and license information, please view the LICENSE
  9.  * file that was distributed with this source code.
  10.  */
  12. namespace Symfony\Component\Mailer\Transport;
  14. use Psr\EventDispatcher\EventDispatcherInterface;
  15. use Psr\Log\LoggerInterface;
  16. use Psr\Log\NullLogger;
  17. use Symfony\Component\EventDispatcher\Event;
  18. use Symfony\Component\EventDispatcher\LegacyEventDispatcherProxy;
  19. use Symfony\Component\Mailer\Envelope;
  20. use Symfony\Component\Mailer\Event\MessageEvent;
  21. use Symfony\Component\Mailer\SentMessage;
  22. use Symfony\Component\Mime\Address;
  23. use Symfony\Component\Mime\RawMessage;
  24. use Symfony\Contracts\EventDispatcher\EventDispatcherInterface as SymfonyEventDispatcherInterface;
  26. /**
  27.  * @author Fabien Potencier <fabien@symfony.com>
  28.  */
  29. abstract class AbstractTransport implements TransportInterface
  30. {
  31.     private $dispatcher;
  32.     private $logger;
  33.     private $rate = 0;
  34.     private $lastSent = 0;
  36.     public function __construct(?EventDispatcherInterface $dispatcher = null, ?LoggerInterface $logger = null)
  37.     {
  38.         $this->dispatcher = class_exists(Event::class) && $dispatcher instanceof SymfonyEventDispatcherInterface ? LegacyEventDispatcherProxy::decorate($dispatcher) : $dispatcher;
  39.         $this->logger = $logger ?? new NullLogger();
  40.     }
  42.     /**
  43.      * Sets the maximum number of messages to send per second (0 to disable).
  44.      *
  45.      * @return $this
  46.      */
  47.     public function setMaxPerSecond(float $rate): self
  48.     {
  49.         if (0 >= $rate) {
  50.             $rate = 0;
  51.         }
  53.         $this->rate = $rate;
  54.         $this->lastSent = 0;
  56.         return $this;
  57.     }
  59.     public function send(RawMessage $message, ?Envelope $envelope = null): ?SentMessage
  60.     {
  61.         $message = clone $message;
  62.         $envelope = null !== $envelope ? clone $envelope : Envelope::create($message);
  64.         if (null !== $this->dispatcher) {
  65.             $event = new MessageEvent($message, $envelope, (string) $this);
  66.             $this->dispatcher->dispatch($event);
  67.             $envelope = $event->getEnvelope();
  68.             $message = $event->getMessage();
  69.         }
  71.         $message = new SentMessage($message, $envelope);
  72.         $this->doSend($message);
  74.         $this->checkThrottling();
  76.         return $message;
  77.     }
  79.     abstract protected function doSend(SentMessage $message): void;
  81.     /**
  82.      * @param Address[] $addresses
  83.      *
  84.      * @return string[]
  85.      */
  86.     protected function stringifyAddresses(array $addresses): array
  87.     {
  88.         return array_map(function (Address $a) {
  89.             return $a->toString();
  90.         }, $addresses);
  91.     }
  93.     protected function getLogger(): LoggerInterface
  94.     {
  95.         return $this->logger;
  96.     }
  98.     private function checkThrottling()
  99.     {
  100.         if (0 == $this->rate) {
  101.             return;
  102.         }
  104.         $sleep = (1 / $this->rate) - (microtime(true) - $this->lastSent);
  105.         if (0 < $sleep) {
  106.             $this->logger->debug(sprintf('Email transport "%s" sleeps for %.2f seconds', __CLASS__, $sleep));
  107.             usleep((int) ($sleep * 1000000));
  108.         }
  109.         $this->lastSent = microtime(true);
  110.     }
  111. }