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

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\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;
  23. /**
  24. * @author Fabien Potencier <fabien@symfony.com>
  25. */
  26. abstract class AbstractTransport implements TransportInterface
  27. {
  28. private ?EventDispatcherInterface $dispatcher;
  29. private LoggerInterface $logger;
  30. private float $rate = 0;
  31. private float $lastSent = 0;
  33. public function __construct(EventDispatcherInterface $dispatcher = null, LoggerInterface $logger = null)
  34. {
  35. $this->dispatcher = $dispatcher;
  36. $this->logger = $logger ?? new NullLogger();
  37. }
  39. /**
  40. * Sets the maximum number of messages to send per second (0 to disable).
  41. *
  42. * @return $this
  43. */
  44. public function setMaxPerSecond(float $rate): static
  45. {
  46. if (0 >= $rate) {
  47. $rate = 0;
  48. }
  50. $this->rate = $rate;
  51. $this->lastSent = 0;
  53. return $this;
  54. }
  56. public function send(RawMessage $message, Envelope $envelope = null): ?SentMessage
  57. {
  58. $message = clone $message;
  59. $envelope = null !== $envelope ? clone $envelope : Envelope::create($message);
  61. if (null !== $this->dispatcher) {
  62. $event = new MessageEvent($message, $envelope, (string) $this);
  63. $this->dispatcher->dispatch($event);
  64. $envelope = $event->getEnvelope();
  65. $message = $event->getMessage();
  66. }
  68. $message = new SentMessage($message, $envelope);
  69. $this->doSend($message);
  71. $this->checkThrottling();
  73. return $message;
  74. }
  76. abstract protected function doSend(SentMessage $message): void;
  78. /**
  79. * @param Address[] $addresses
  80. *
  81. * @return string[]
  82. */
  83. protected function stringifyAddresses(array $addresses): array
  84. {
  85. return array_map(function (Address $a) {
  86. return $a->toString();
  87. }, $addresses);
  88. }
  90. protected function getLogger(): LoggerInterface
  91. {
  92. return $this->logger;
  93. }
  95. private function checkThrottling()
  96. {
  97. if (0 == $this->rate) {
  98. return;
  99. }
  101. $sleep = (1 / $this->rate) - (microtime(true) - $this->lastSent);
  102. if (0 < $sleep) {
  103. $this->logger->debug(sprintf('Email transport "%s" sleeps for %.2f seconds', __CLASS__, $sleep));
  104. usleep($sleep * 1000000);
  105. }
  106. $this->lastSent = microtime(true);
  107. }
  108. }