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

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\EventDispatcher\EventDispatcherInterface;
  15. use Psr\Log\LoggerInterface;
  16. use Symfony\Component\Mailer\Envelope;
  17. use Symfony\Component\Mailer\Exception\LogicException;
  18. use Symfony\Component\Mailer\Exception\TransportException;
  19. use Symfony\Component\Mailer\Exception\TransportExceptionInterface;
  20. use Symfony\Component\Mailer\SentMessage;
  21. use Symfony\Component\Mailer\Transport\AbstractTransport;
  22. use Symfony\Component\Mailer\Transport\Smtp\Stream\AbstractStream;
  23. use Symfony\Component\Mailer\Transport\Smtp\Stream\SocketStream;
  24. use Symfony\Component\Mime\RawMessage;
  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 bool $started = false;
  35.     private int $restartThreshold = 100;
  36.     private int $restartThresholdSleep = 0;
  37.     private int $restartCounter = 0;
  38.     private int $pingThreshold = 100;
  39.     private float $lastMessageTime = 0;
  40.     private AbstractStream $stream;
  41.     private string $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.      * @return $this
  64.      */
  65.     public function setRestartThreshold(int $threshold, int $sleep = 0): static
  66.     {
  67.         $this->restartThreshold = $threshold;
  68.         $this->restartThresholdSleep = $sleep;
  70.         return $this;
  71.     }
  73.     /**
  74.      * Sets the minimum number of seconds required between two messages, before the server is pinged.
  75.      * If the transport wants to send a message and the time since the last message exceeds the specified threshold,
  76.      * the transport will ping the server first (NOOP command) to check if the connection is still alive.
  77.      * Otherwise the message will be sent without pinging the server first.
  78.      *
  79.      * Do not set the threshold too low, as the SMTP server may drop the connection if there are too many
  80.      * non-mail commands (like pinging the server with NOOP).
  81.      *
  82.      * By default, the threshold is set to 100 seconds.
  83.      *
  84.      * @param int $seconds The minimum number of seconds between two messages required to ping the server
  85.      *
  86.      * @return $this
  87.      */
  88.     public function setPingThreshold(int $seconds): static
  89.     {
  90.         $this->pingThreshold = $seconds;
  92.         return $this;
  93.     }
  95.     /**
  96.      * Sets the name of the local domain that will be used in HELO.
  97.      *
  98.      * This should be a fully-qualified domain name and should be truly the domain
  99.      * you're using.
  100.      *
  101.      * If your server does not have a domain name, use the IP address. This will
  102.      * automatically be wrapped in square brackets as described in RFC 5321,
  103.      * section 4.1.3.
  104.      *
  105.      * @return $this
  106.      */
  107.     public function setLocalDomain(string $domain): static
  108.     {
  109.         if ('' !== $domain && '[' !== $domain[0]) {
  110.             if (filter_var($domain, \FILTER_VALIDATE_IP, \FILTER_FLAG_IPV4)) {
  111.                 $domain = '['.$domain.']';
  112.             } elseif (filter_var($domain, \FILTER_VALIDATE_IP, \FILTER_FLAG_IPV6)) {
  113.                 $domain = '[IPv6:'.$domain.']';
  114.             }
  115.         }
  117.         $this->domain = $domain;
  119.         return $this;
  120.     }
  122.     /**
  123.      * Gets the name of the domain that will be used in HELO.
  124.      *
  125.      * If an IP address was specified, this will be returned wrapped in square
  126.      * brackets as described in RFC 5321, section 4.1.3.
  127.      */
  128.     public function getLocalDomain(): string
  129.     {
  130.         return $this->domain;
  131.     }
  133.     public function send(RawMessage $message, Envelope $envelope = null): ?SentMessage
  134.     {
  135.         try {
  136.             $message = parent::send($message, $envelope);
  137.         } catch (TransportExceptionInterface $e) {
  138.             if ($this->started) {
  139.                 try {
  140.                     $this->executeCommand("RSET\r\n", [250]);
  141.                 } catch (TransportExceptionInterface) {
  142.                     // ignore this exception as it probably means that the server error was final
  143.                 }
  144.             }
  146.             throw $e;
  147.         }
  149.         $this->checkRestartThreshold();
  151.         return $message;
  152.     }
  154.     public function __toString(): string
  155.     {
  156.         if ($this->stream instanceof SocketStream) {
  157.             $name = sprintf('smtp%s://%s', ($tls = $this->stream->isTLS()) ? 's' : '', $this->stream->getHost());
  158.             $port = $this->stream->getPort();
  159.             if (!(25 === $port || ($tls && 465 === $port))) {
  160.                 $name .= ':'.$port;
  161.             }
  163.             return $name;
  164.         }
  166.         return 'smtp://sendmail';
  167.     }
  169.     /**
  170.      * Runs a command against the stream, expecting the given response codes.
  171.      *
  172.      * @param int[] $codes
  173.      *
  174.      * @throws TransportException when an invalid response if received
  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()->getEncodedAddress());
  198.             foreach ($envelope->getRecipients() as $recipient) {
  199.                 $this->doRcptToCommand($recipient->getEncodedAddress());
  200.             }
  202.             $this->executeCommand("DATA\r\n", [354]);
  203.             try {
  204.                 foreach (AbstractStream::replace("\r\n.", "\r\n..", $message->toIterable()) as $chunk) {
  205.                     $this->stream->write($chunk, false);
  206.                 }
  207.                 $this->stream->flush();
  208.             } catch (TransportExceptionInterface $e) {
  209.                 throw $e;
  210.             } catch (\Exception $e) {
  211.                 $this->stream->terminate();
  212.                 $this->started = false;
  213.                 $this->getLogger()->debug(sprintf('Email transport "%s" stopped', __CLASS__));
  214.                 throw $e;
  215.             }
  216.             $this->executeCommand("\r\n.\r\n", [250]);
  217.             $message->appendDebug($this->stream->getDebug());
  218.             $this->lastMessageTime = microtime(true);
  219.         } catch (TransportExceptionInterface $e) {
  220.             $e->appendDebug($this->stream->getDebug());
  221.             $this->lastMessageTime = 0;
  222.             throw $e;
  223.         }
  224.     }
  226.     /**
  227.      * @internal since version 6.1, to be made private in 7.0
  228.      * @final since version 6.1, to be made private in 7.0
  229.      */
  230.     protected function doHeloCommand(): void
  231.     {
  232.         $this->executeCommand(sprintf("HELO %s\r\n", $this->domain), [250]);
  233.     }
  235.     private function doMailFromCommand(string $address): void
  236.     {
  237.         $this->executeCommand(sprintf("MAIL FROM:<%s>\r\n", $address), [250]);
  238.     }
  240.     private function doRcptToCommand(string $address): void
  241.     {
  242.         $this->executeCommand(sprintf("RCPT TO:<%s>\r\n", $address), [250, 251, 252]);
  243.     }
  245.     public function start(): void
  246.     {
  247.         if ($this->started) {
  248.             return;
  249.         }
  251.         $this->getLogger()->debug(sprintf('Email transport "%s" starting', __CLASS__));
  253.         $this->stream->initialize();
  254.         $this->assertResponseCode($this->getFullResponse(), [220]);
  255.         $this->doHeloCommand();
  256.         $this->started = true;
  257.         $this->lastMessageTime = 0;
  259.         $this->getLogger()->debug(sprintf('Email transport "%s" started', __CLASS__));
  260.     }
  262.     /**
  263.      * Manually disconnect from the SMTP server.
  264.      *
  265.      * In most cases this is not necessary since the disconnect happens automatically on termination.
  266.      * In cases of long-running scripts, this might however make sense to avoid keeping an open
  267.      * connection to the SMTP server in between sending emails.
  268.      */
  269.     public function stop(): void
  270.     {
  271.         if (!$this->started) {
  272.             return;
  273.         }
  275.         $this->getLogger()->debug(sprintf('Email transport "%s" stopping', __CLASS__));
  277.         try {
  278.             $this->executeCommand("QUIT\r\n", [221]);
  279.         } catch (TransportExceptionInterface) {
  280.         } finally {
  281.             $this->stream->terminate();
  282.             $this->started = false;
  283.             $this->getLogger()->debug(sprintf('Email transport "%s" stopped', __CLASS__));
  284.         }
  285.     }
  287.     private function ping(): void
  288.     {
  289.         if (!$this->started) {
  290.             return;
  291.         }
  293.         try {
  294.             $this->executeCommand("NOOP\r\n", [250]);
  295.         } catch (TransportExceptionInterface) {
  296.             $this->stop();
  297.         }
  298.     }
  300.     /**
  301.      * @throws TransportException if a response code is incorrect
  302.      */
  303.     private function assertResponseCode(string $response, array $codes): void
  304.     {
  305.         if (!$codes) {
  306.             throw new LogicException('You must set the expected response code.');
  307.         }
  309.         [$code] = sscanf($response, '%3d');
  310.         $valid = \in_array($code, $codes);
  312.         if (!$valid || !$response) {
  313.             $codeStr = $code ? sprintf('code "%s"', $code) : 'empty code';
  314.             $responseStr = $response ? sprintf(', with message "%s"', trim($response)) : '';
  315.             throw new TransportException(sprintf('Expected response code "%s" but got ', implode('/', $codes), $codeStr).$codeStr.$responseStr.'.', $code);
  316.         }
  317.     }
  319.     private function getFullResponse(): string
  320.     {
  321.         $response = '';
  322.         do {
  323.             $line = $this->stream->readLine();
  324.             $response .= $line;
  325.         } while ($line && isset($line[3]) && ' ' !== $line[3]);
  327.         return $response;
  328.     }
  330.     private function checkRestartThreshold(): void
  331.     {
  332.         // when using sendmail via non-interactive mode, the transport is never "started"
  333.         if (!$this->started) {
  334.             return;
  335.         }
  337.         ++$this->restartCounter;
  338.         if ($this->restartCounter < $this->restartThreshold) {
  339.             return;
  340.         }
  342.         $this->stop();
  343.         if (0 < $sleep = $this->restartThresholdSleep) {
  344.             $this->getLogger()->debug(sprintf('Email transport "%s" sleeps for %d seconds after stopping', __CLASS__, $sleep));
  346.             sleep($sleep);
  347.         }
  348.         $this->start();
  349.         $this->restartCounter = 0;
  350.     }
  352.     public function __sleep(): array
  353.     {
  354.         throw new \BadMethodCallException('Cannot serialize '.__CLASS__);
  355.     }
  357.     public function __wakeup()
  358.     {
  359.         throw new \BadMethodCallException('Cannot unserialize '.__CLASS__);
  360.     }
  362.     public function __destruct()
  363.     {
  364.         $this->stop();
  365.     }
  366. }