vendor/symfony/mailer/Transport/Smtp/EsmtpTransport.php line 195

Open in your IDE?
  1. <?php
  2. /*
  3.  * This file is part of the Symfony package.
  4.  *
  5.  * (c) Fabien Potencier <fabien@symfony.com>
  6.  *
  7.  * For the full copyright and license information, please view the LICENSE
  8.  * file that was distributed with this source code.
  9.  */
  10. namespace Symfony\Component\Mailer\Transport\Smtp;
  11. use Psr\EventDispatcher\EventDispatcherInterface;
  12. use Psr\Log\LoggerInterface;
  13. use Symfony\Component\Mailer\Exception\TransportException;
  14. use Symfony\Component\Mailer\Exception\TransportExceptionInterface;
  15. use Symfony\Component\Mailer\Transport\Smtp\Auth\AuthenticatorInterface;
  16. use Symfony\Component\Mailer\Transport\Smtp\Stream\SocketStream;
  17. /**
  18.  * Sends Emails over SMTP with ESMTP support.
  19.  *
  20.  * @author Fabien Potencier <fabien@symfony.com>
  21.  * @author Chris Corbyn
  22.  */
  23. class EsmtpTransport extends SmtpTransport
  24. {
  25.     private $authenticators = [];
  26.     private $username '';
  27.     private $password '';
  28.     public function __construct(string $host 'localhost'int $port 0bool $tls nullEventDispatcherInterface $dispatcher nullLoggerInterface $logger null)
  29.     {
  30.         parent::__construct(null$dispatcher$logger);
  31.         // order is important here (roughly most secure and popular first)
  32.         $this->authenticators = [
  33.             new Auth\CramMd5Authenticator(),
  34.             new Auth\LoginAuthenticator(),
  35.             new Auth\PlainAuthenticator(),
  36.             new Auth\XOAuth2Authenticator(),
  37.         ];
  38.         /** @var SocketStream $stream */
  39.         $stream $this->getStream();
  40.         if (null === $tls) {
  41.             if (465 === $port) {
  42.                 $tls true;
  43.             } else {
  44.                 $tls = \defined('OPENSSL_VERSION_NUMBER') && === $port && 'localhost' !== $host;
  45.             }
  46.         }
  47.         if (!$tls) {
  48.             $stream->disableTls();
  49.         }
  50.         if (=== $port) {
  51.             $port $tls 465 25;
  52.         }
  53.         $stream->setHost($host);
  54.         $stream->setPort($port);
  55.     }
  56.     /**
  57.      * @return $this
  58.      */
  59.     public function setUsername(string $username): self
  60.     {
  61.         $this->username $username;
  62.         return $this;
  63.     }
  64.     public function getUsername(): string
  65.     {
  66.         return $this->username;
  67.     }
  68.     /**
  69.      * @return $this
  70.      */
  71.     public function setPassword(string $password): self
  72.     {
  73.         $this->password $password;
  74.         return $this;
  75.     }
  76.     public function getPassword(): string
  77.     {
  78.         return $this->password;
  79.     }
  80.     public function addAuthenticator(AuthenticatorInterface $authenticator): void
  81.     {
  82.         $this->authenticators[] = $authenticator;
  83.     }
  84.     protected function doHeloCommand(): void
  85.     {
  86.         try {
  87.             $response $this->executeCommand(sprintf("EHLO %s\r\n"$this->getLocalDomain()), [250]);
  88.         } catch (TransportExceptionInterface $e) {
  89.             parent::doHeloCommand();
  90.             return;
  91.         }
  92.         $capabilities $this->getCapabilities($response);
  93.         /** @var SocketStream $stream */
  94.         $stream $this->getStream();
  95.         // WARNING: !$stream->isTLS() is right, 100% sure :)
  96.         // if you think that the ! should be removed, read the code again
  97.         // if doing so "fixes" your issue then it probably means your SMTP server behaves incorrectly or is wrongly configured
  98.         if (!$stream->isTLS() && \defined('OPENSSL_VERSION_NUMBER') && \array_key_exists('STARTTLS'$capabilities)) {
  99.             $this->executeCommand("STARTTLS\r\n", [220]);
  100.             if (!$stream->startTLS()) {
  101.                 throw new TransportException('Unable to connect with STARTTLS.');
  102.             }
  103.             try {
  104.                 $response $this->executeCommand(sprintf("EHLO %s\r\n"$this->getLocalDomain()), [250]);
  105.                 $capabilities $this->getCapabilities($response);
  106.             } catch (TransportExceptionInterface $e) {
  107.                 parent::doHeloCommand();
  108.                 return;
  109.             }
  110.         }
  111.         if (\array_key_exists('AUTH'$capabilities)) {
  112.             $this->handleAuth($capabilities['AUTH']);
  113.         }
  114.     }
  115.     private function getCapabilities(string $ehloResponse): array
  116.     {
  117.         $capabilities = [];
  118.         $lines explode("\r\n"trim($ehloResponse));
  119.         array_shift($lines);
  120.         foreach ($lines as $line) {
  121.             if (preg_match('/^[0-9]{3}[ -]([A-Z0-9-]+)((?:[ =].*)?)$/Di'$line$matches)) {
  122.                 $value strtoupper(ltrim($matches[2], ' ='));
  123.                 $capabilities[strtoupper($matches[1])] = $value explode(' '$value) : [];
  124.             }
  125.         }
  126.         return $capabilities;
  127.     }
  128.     private function handleAuth(array $modes): void
  129.     {
  130.         if (!$this->username) {
  131.             return;
  132.         }
  133.         $authNames = [];
  134.         $errors = [];
  135.         $modes array_map('strtolower'$modes);
  136.         foreach ($this->authenticators as $authenticator) {
  137.             if (!\in_array(strtolower($authenticator->getAuthKeyword()), $modestrue)) {
  138.                 continue;
  139.             }
  140.             $authNames[] = $authenticator->getAuthKeyword();
  141.             try {
  142.                 $authenticator->authenticate($this);
  143.                 return;
  144.             } catch (TransportExceptionInterface $e) {
  145.                 try {
  146.                     $this->executeCommand("RSET\r\n", [250]);
  147.                 } catch (TransportExceptionInterface $_) {
  148.                     // ignore this exception as it probably means that the server error was final
  149.                 }
  150.                 // keep the error message, but tries the other authenticators
  151.                 $errors[$authenticator->getAuthKeyword()] = $e;
  152.             }
  153.         }
  154.         if (!$authNames) {
  155.             throw new TransportException(sprintf('Failed to find an authenticator supported by the SMTP server, which currently supports: "%s".'implode('", "'$modes)));
  156.         }
  157.         $message sprintf('Failed to authenticate on SMTP server with username "%s" using the following authenticators: "%s".'$this->usernameimplode('", "'$authNames));
  158.         foreach ($errors as $name => $error) {
  159.             $message .= sprintf(' Authenticator "%s" returned "%s".'$name$error);
  160.         }
  161.         throw new TransportException($message);
  162.     }
  163. }