vendor/symfony/mailer/Transport/Smtp/SmtpTransport.php line 43

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\Smtp;
  14. use Psr\Log\LoggerInterface;
  15. use Symfony\Component\Mailer\Envelope;
  16. use Symfony\Component\Mailer\Exception\LogicException;
  17. use Symfony\Component\Mailer\Exception\TransportException;
  18. use Symfony\Component\Mailer\Exception\TransportExceptionInterface;
  19. use Symfony\Component\Mailer\SentMessage;
  20. use Symfony\Component\Mailer\Transport\AbstractTransport;
  21. use Symfony\Component\Mailer\Transport\Smtp\Stream\AbstractStream;
  22. use Symfony\Component\Mailer\Transport\Smtp\Stream\SocketStream;
  23. use Symfony\Component\Mime\RawMessage;
  24. use Symfony\Contracts\EventDispatcher\EventDispatcherInterface;
  26. /**
  27.  * Sends emails over SMTP.
  28.  *
  29.  * @author Fabien Potencier <fabien@symfony.com>
  30.  * @author Chris Corbyn
  31.  */
  32. class SmtpTransport extends AbstractTransport
  33. {
  34.     private $started = false;
  35.     private $restartThreshold = 100;
  36.     private $restartThresholdSleep = 0;
  37.     private $restartCounter;
  38.     private $pingThreshold = 100;
  39.     private $lastMessageTime = 0;
  40.     private $stream;
  41.     private $domain = '[127.0.0.1]';
  43.     public function __construct(AbstractStream $stream = null, EventDispatcherInterface $dispatcher = null, LoggerInterface $logger = null)
  44.     {
  45.         parent::__construct($dispatcher, $logger);
  47.         $this->stream = $stream ?: new SocketStream();
  48.     }
  50.     public function getStream(): AbstractStream
  51.     {
  52.         return $this->stream;
  53.     }
  55.     /**
  56.      * Sets the maximum number of messages to send before re-starting the transport.
  57.      *
  58.      * By default, the threshold is set to 100 (and no sleep at restart).
  59.      *
  60.      * @param int $threshold The maximum number of messages (0 to disable)
  61.      * @param int $sleep     The number of seconds to sleep between stopping and re-starting the transport
  62.      */
  63.     public function setRestartThreshold(int $threshold, int $sleep = 0): self
  64.     {
  65.         $this->restartThreshold = $threshold;
  66.         $this->restartThresholdSleep = $sleep;
  68.         return $this;
  69.     }
  71.     /**
  72.      * Sets the minimum number of seconds required between two messages, before the server is pinged.
  73.      * If the transport wants to send a message and the time since the last message exceeds the specified threshold,
  74.      * the transport will ping the server first (NOOP command) to check if the connection is still alive.
  75.      * Otherwise the message will be sent without pinging the server first.
  76.      *
  77.      * Do not set the threshold too low, as the SMTP server may drop the connection if there are too many
  78.      * non-mail commands (like pinging the server with NOOP).
  79.      *
  80.      * By default, the threshold is set to 100 seconds.
  81.      *
  82.      * @param int $seconds The minimum number of seconds between two messages required to ping the server
  83.      *
  84.      * @return $this
  85.      */
  86.     public function setPingThreshold(int $seconds): self
  87.     {
  88.         $this->pingThreshold = $seconds;
  90.         return $this;
  91.     }
  93.     /**
  94.      * Sets the name of the local domain that will be used in HELO.
  95.      *
  96.      * This should be a fully-qualified domain name and should be truly the domain
  97.      * you're using.
  98.      *
  99.      * If your server does not have a domain name, use the IP address. This will
  100.      * automatically be wrapped in square brackets as described in RFC 5321,
  101.      * section 4.1.3.
  102.      */
  103.     public function setLocalDomain(string $domain): self
  104.     {
  105.         if ('' !== $domain && '[' !== $domain[0]) {
  106.             if (filter_var($domain, FILTER_VALIDATE_IP, FILTER_FLAG_IPV4)) {
  107.                 $domain = '['.$domain.']';
  108.             } elseif (filter_var($domain, FILTER_VALIDATE_IP, FILTER_FLAG_IPV6)) {
  109.                 $domain = '[IPv6:'.$domain.']';
  110.             }
  111.         }
  113.         $this->domain = $domain;
  115.         return $this;
  116.     }
  118.     /**
  119.      * Gets the name of the domain that will be used in HELO.
  120.      *
  121.      * If an IP address was specified, this will be returned wrapped in square
  122.      * brackets as described in RFC 5321, section 4.1.3.
  123.      */
  124.     public function getLocalDomain(): string
  125.     {
  126.         return $this->domain;
  127.     }
  129.     public function send(RawMessage $message, Envelope $envelope = null): ?SentMessage
  130.     {
  131.         try {
  132.             $message = parent::send($message, $envelope);
  133.         } catch (TransportExceptionInterface $e) {
  134.             if ($this->started) {
  135.                 try {
  136.                     $this->executeCommand("RSET\r\n", [250]);
  137.                 } catch (TransportExceptionInterface $_) {
  138.                     // ignore this exception as it probably means that the server error was final
  139.                 }
  140.             }
  142.             throw $e;
  143.         }
  145.         $this->checkRestartThreshold();
  147.         return $message;
  148.     }
  150.     public function __toString(): string
  151.     {
  152.         if ($this->stream instanceof SocketStream) {
  153.             $name = sprintf('smtp%s://%s', ($tls = $this->stream->isTLS()) ? 's' : '', $this->stream->getHost());
  154.             $port = $this->stream->getPort();
  155.             if (!(25 === $port || ($tls && 465 === $port))) {
  156.                 $name .= ':'.$port;
  157.             }
  159.             return $name;
  160.         }
  162.         return sprintf('smtp://sendmail');
  163.     }
  165.     /**
  166.      * Runs a command against the stream, expecting the given response codes.
  167.      *
  168.      * @param int[] $codes
  169.      *
  170.      * @return string The server response
  171.      *
  172.      * @throws TransportException when an invalid response if received
  173.      *
  174.      * @internal
  175.      */
  176.     public function executeCommand(string $command, array $codes): string
  177.     {
  178.         $this->stream->write($command);
  179.         $response = $this->getFullResponse();
  180.         $this->assertResponseCode($response, $codes);
  182.         return $response;
  183.     }
  185.     protected function doSend(SentMessage $message): void
  186.     {
  187.         if (microtime(true) - $this->lastMessageTime > $this->pingThreshold) {
  188.             $this->ping();
  189.         }
  191.         if (!$this->started) {
  192.             $this->start();
  193.         }
  195.         try {
  196.             $envelope = $message->getEnvelope();
  197.             $this->doMailFromCommand($envelope->getSender()->getAddress());
  198.             foreach ($envelope->getRecipients() as $recipient) {
  199.                 $this->doRcptToCommand($recipient->getAddress());
  200.             }
  202.             $this->executeCommand("DATA\r\n", [354]);
  203.             foreach (AbstractStream::replace("\r\n.", "\r\n..", $message->toIterable()) as $chunk) {
  204.                 $this->stream->write($chunk, false);
  205.             }
  206.             $this->stream->flush();
  207.             $this->executeCommand("\r\n.\r\n", [250]);
  208.             $message->appendDebug($this->stream->getDebug());
  209.             $this->lastMessageTime = microtime(true);
  210.         } catch (TransportExceptionInterface $e) {
  211.             $e->appendDebug($this->stream->getDebug());
  212.             $this->lastMessageTime = 0;
  213.             throw $e;
  214.         }
  215.     }
  217.     protected function doHeloCommand(): void
  218.     {
  219.         $this->executeCommand(sprintf("HELO %s\r\n", $this->domain), [250]);
  220.     }
  222.     private function doMailFromCommand(string $address): void
  223.     {
  224.         $this->executeCommand(sprintf("MAIL FROM:<%s>\r\n", $address), [250]);
  225.     }
  227.     private function doRcptToCommand(string $address): void
  228.     {
  229.         $this->executeCommand(sprintf("RCPT TO:<%s>\r\n", $address), [250, 251, 252]);
  230.     }
  232.     private function start(): void
  233.     {
  234.         if ($this->started) {
  235.             return;
  236.         }
  238.         $this->getLogger()->debug(sprintf('Email transport "%s" starting', __CLASS__));
  240.         $this->stream->initialize();
  241.         $this->assertResponseCode($this->getFullResponse(), [220]);
  242.         $this->doHeloCommand();
  243.         $this->started = true;
  244.         $this->lastMessageTime = 0;
  246.         $this->getLogger()->debug(sprintf('Email transport "%s" started', __CLASS__));
  247.     }
  249.     private function stop(): void
  250.     {
  251.         if (!$this->started) {
  252.             return;
  253.         }
  255.         $this->getLogger()->debug(sprintf('Email transport "%s" stopping', __CLASS__));
  257.         try {
  258.             $this->executeCommand("QUIT\r\n", [221]);
  259.         } catch (TransportExceptionInterface $e) {
  260.         } finally {
  261.             $this->stream->terminate();
  262.             $this->started = false;
  263.             $this->getLogger()->debug(sprintf('Email transport "%s" stopped', __CLASS__));
  264.         }
  265.     }
  267.     private function ping(): void
  268.     {
  269.         if (!$this->started) {
  270.             return;
  271.         }
  273.         try {
  274.             $this->executeCommand("NOOP\r\n", [250]);
  275.         } catch (TransportExceptionInterface $e) {
  276.             $this->stop();
  277.         }
  278.     }
  280.     /**
  281.      * @throws TransportException if a response code is incorrect
  282.      */
  283.     private function assertResponseCode(string $response, array $codes): void
  284.     {
  285.         if (!$codes) {
  286.             throw new LogicException('You must set the expected response code.');
  287.         }
  289.         if (!$response) {
  290.             throw new TransportException(sprintf('Expected response code "%s" but got an empty response.', implode('/', $codes)));
  291.         }
  293.         list($code) = sscanf($response, '%3d');
  294.         $valid = \in_array($code, $codes);
  296.         if (!$valid) {
  297.             throw new TransportException(sprintf('Expected response code "%s" but got code "%s", with message "%s".', implode('/', $codes), $code, trim($response)), $code);
  298.         }
  299.     }
  301.     private function getFullResponse(): string
  302.     {
  303.         $response = '';
  304.         do {
  305.             $line = $this->stream->readLine();
  306.             $response .= $line;
  307.         } while ($line && isset($line[3]) && ' ' !== $line[3]);
  309.         return $response;
  310.     }
  312.     private function checkRestartThreshold(): void
  313.     {
  314.         // when using sendmail via non-interactive mode, the transport is never "started"
  315.         if (!$this->started) {
  316.             return;
  317.         }
  319.         ++$this->restartCounter;
  320.         if ($this->restartCounter < $this->restartThreshold) {
  321.             return;
  322.         }
  324.         $this->stop();
  325.         if (0 < $sleep = $this->restartThresholdSleep) {
  326.             $this->getLogger()->debug(sprintf('Email transport "%s" sleeps for %d seconds after stopping', __CLASS__, $sleep));
  328.             sleep($sleep);
  329.         }
  330.         $this->start();
  331.         $this->restartCounter = 0;
  332.     }
  334.     public function __destruct()
  335.     {
  336.         $this->stop();
  337.     }
  338. }