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

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\Log\LoggerInterface;
  15. use Psr\Log\NullLogger;
  16. use Symfony\Component\EventDispatcher\LegacyEventDispatcherProxy;
  17. use Symfony\Component\Mailer\Envelope;
  18. use Symfony\Component\Mailer\Event\MessageEvent;
  19. use Symfony\Component\Mailer\SentMessage;
  20. use Symfony\Component\Mime\Address;
  21. use Symfony\Component\Mime\RawMessage;
  22. use Symfony\Contracts\EventDispatcher\EventDispatcherInterface;
  24. /**
  25.  * @author Fabien Potencier <fabien@symfony.com>
  26.  */
  27. abstract class AbstractTransport implements TransportInterface
  28. {
  29.     private $dispatcher;
  30.     private $logger;
  31.     private $rate = 0;
  32.     private $lastSent = 0;
  34.     public function __construct(EventDispatcherInterface $dispatcher = null, LoggerInterface $logger = null)
  35.     {
  36.         $this->dispatcher = LegacyEventDispatcherProxy::decorate($dispatcher);
  37.         $this->logger = $logger ?: new NullLogger();
  38.     }
  40.     /**
  41.      * Sets the maximum number of messages to send per second (0 to disable).
  42.      */
  43.     public function setMaxPerSecond(float $rate): self
  44.     {
  45.         if (0 >= $rate) {
  46.             $rate = 0;
  47.         }
  49.         $this->rate = $rate;
  50.         $this->lastSent = 0;
  52.         return $this;
  53.     }
  55.     public function send(RawMessage $message, Envelope $envelope = null): ?SentMessage
  56.     {
  57.         $message = clone $message;
  58.         $envelope = null !== $envelope ? clone $envelope : Envelope::create($message);
  60.         if (null !== $this->dispatcher) {
  61.             $event = new MessageEvent($message, $envelope, (string) $this);
  62.             $this->dispatcher->dispatch($event);
  63.             $envelope = $event->getEnvelope();
  64.         }
  66.         $message = new SentMessage($message, $envelope);
  67.         $this->doSend($message);
  69.         $this->checkThrottling();
  71.         return $message;
  72.     }
  74.     abstract protected function doSend(SentMessage $message): void;
  76.     /**
  77.      * @param Address[] $addresses
  78.      *
  79.      * @return string[]
  80.      */
  81.     protected function stringifyAddresses(array $addresses): array
  82.     {
  83.         return array_map(function (Address $a) {
  84.             return $a->toString();
  85.         }, $addresses);
  86.     }
  88.     protected function getLogger(): LoggerInterface
  89.     {
  90.         return $this->logger;
  91.     }
  93.     private function checkThrottling()
  94.     {
  95.         if (0 == $this->rate) {
  96.             return;
  97.         }
  99.         $sleep = (1 / $this->rate) - (microtime(true) - $this->lastSent);
  100.         if (0 < $sleep) {
  101.             $this->logger->debug(sprintf('Email transport "%s" sleeps for %.2f seconds', __CLASS__, $sleep));
  102.             usleep($sleep * 1000000);
  103.         }
  104.         $this->lastSent = microtime(true);
  105.     }
  106. }