Merge branch '2.4-develop' into ACQE-functional-mainline-deployment-ver2

Author: magento-devops-queue-mgr-svc

app/code/Magento/Email/Model/Transport.php

@@ -1,29 +1,33 @@
 <?php
 /**
- * Copyright © Magento, Inc. All rights reserved.
- * See COPYING.txt for license details.
+ * Copyright 2015 Adobe
+ * All Rights Reserved.
  */
 declare(strict_types=1);
 
 namespace Magento\Email\Model;
 
-use Laminas\Mail\Transport\Smtp;
-use Laminas\Mail\Transport\SmtpOptions;
+use Magento\Framework\Mail\EmailMessageInterface;
+use Symfony\Component\Mailer\Exception\TransportExceptionInterface;
+use Symfony\Component\Mailer\Mailer;
+use Symfony\Component\Mailer\Transport\NativeTransportFactory;
+use Symfony\Component\Mailer\Transport\Dsn;
+use Symfony\Component\Mailer\Transport\TransportInterface as SymfonyTransportInterface;
+use Symfony\Component\Mailer\Transport\Smtp\EsmtpTransport;
+use Symfony\Component\Mailer\Transport\Smtp\Auth\LoginAuthenticator;
+use Symfony\Component\Mailer\Transport\Smtp\Auth\PlainAuthenticator;
 use Magento\Framework\App\Config\ScopeConfigInterface;
 use Magento\Framework\App\ObjectManager;
 use Magento\Framework\Exception\MailException;
-use Magento\Framework\Mail\MessageInterface;
 use Magento\Framework\Mail\TransportInterface;
 use Magento\Framework\Phrase;
+use Symfony\Component\Mime\Message as SymfonyMessage;
 use Magento\Store\Model\ScopeInterface;
-use Laminas\Mail\Message;
-use Laminas\Mail\Transport\Sendmail;
-use Laminas\Mail\Transport\TransportInterface as LaminasTransportInterface;
 use Psr\Log\LoggerInterface;
 
 /**
  * Class that responsible for filling some message data before transporting it.
- * @see \Laminas\Mail\Transport\Sendmail is used for transport
+ * @see \Symfony\Component\Mailer\Transport is used for transport
  * @SuppressWarnings(PHPMD.CouplingBetweenObjects)
  */
 class Transport implements TransportInterface
@@ -84,48 +88,41 @@ class Transport implements TransportInterface
      *
      * @var int
      */
-    private $isSetReturnPath;
+    private int $isSetReturnPath;
 
     /**
      * @var string|null
      */
-    private $returnPathValue;
+    private ?string $returnPathValue;
 
     /**
      * @var ScopeConfigInterface
      */
-    private $scopeConfig;
+    private ScopeConfigInterface $scopeConfig;
 
     /**
-     * @var LaminasTransportInterface|null
+     * @var SymfonyTransportInterface
      */
-    private $laminasTransport;
+    private SymfonyTransportInterface $symfonyTransport;
 
     /**
-     * @var null|string|array|\Traversable
+     * @var EmailMessageInterface
      */
-    private $parameters;
-
-    /**
-     * @var MessageInterface
-     */
-    private $message;
+    private EmailMessageInterface $message;
 
     /**
      * @var LoggerInterface|null
      */
-    private $logger;
+    private ?LoggerInterface $logger;
 
     /**
-     * @param MessageInterface $message Email message object
+     * @param EmailMessageInterface $message Email message object
      * @param ScopeConfigInterface $scopeConfig Core store config
-     * @param null|string|array|\Traversable $parameters Config options for sendmail parameters
      * @param LoggerInterface|null $logger
      */
     public function __construct(
-        MessageInterface $message,
+        EmailMessageInterface $message,
         ScopeConfigInterface $scopeConfig,
-        $parameters = null,
         ?LoggerInterface $logger = null
     ) {
         $this->isSetReturnPath = (int) $scopeConfig->getValue(
@@ -138,131 +135,126 @@ public function __construct(
         );
         $this->message = $message;
         $this->scopeConfig = $scopeConfig;
-        $this->parameters = $parameters;
         $this->logger = $logger ?: ObjectManager::getInstance()->get(LoggerInterface::class);
     }
 
     /**
-     * Get the LaminasTransport based on the configuration.
+     * Get the SymfonyTransport based on the configuration.
      *
-     * @return LaminasTransportInterface
+     * @return SymfonyTransportInterface
      */
-    public function getTransport(): LaminasTransportInterface
+    public function getTransport(): SymfonyTransportInterface
     {
-        if ($this->laminasTransport === null) {
-            $transport = $this->scopeConfig->getValue(
-                self::XML_PATH_TRANSPORT,
-                ScopeInterface::SCOPE_STORE
-            );
-
-            if ($transport === 'smtp') {
-                $this->laminasTransport = $this->createSmtpTransport();
+        if (!isset($this->symfonyTransport)) {
+            $transportType = $this->scopeConfig->getValue(self::XML_PATH_TRANSPORT);
+            if ($transportType === 'smtp') {
+                $this->symfonyTransport = $this->createSmtpTransport();
             } else {
-                $this->laminasTransport = $this->createSendmailTransport();
+                $this->symfonyTransport = $this->createSendmailTransport();
             }
         }
 
-        return $this->laminasTransport;
+        return $this->symfonyTransport;
     }
 
     /**
-     * @inheritdoc
+     * Build the DSN string for Symfony transport based on configuration.
+     *
+     * @return SymfonyTransportInterface
      */
-    public function sendMessage()
+    private function createSmtpTransport(): SymfonyTransportInterface
     {
-        try {
-            $laminasMessage = Message::fromString($this->message->getRawMessage())->setEncoding('utf-8');
-            if (2 === $this->isSetReturnPath && $this->returnPathValue) {
-                $laminasMessage->setSender($this->returnPathValue);
-            } elseif (1 === $this->isSetReturnPath && $laminasMessage->getFrom()->count()) {
-                $fromAddressList = $laminasMessage->getFrom();
-                $fromAddressList->rewind();
-                $laminasMessage->setSender($fromAddressList->current()->getEmail());
-            }
+        $host = $this->scopeConfig->getValue(self::XML_PATH_HOST, ScopeInterface::SCOPE_STORE);
+        $port = (int) $this->scopeConfig->getValue(self::XML_PATH_PORT, ScopeInterface::SCOPE_STORE);
+        $username = $this->scopeConfig->getValue(self::XML_PATH_USERNAME, ScopeInterface::SCOPE_STORE);
+        $password = $this->scopeConfig->getValue(self::XML_PATH_PASSWORD, ScopeInterface::SCOPE_STORE);
+        $auth = $this->scopeConfig->getValue(self::XML_PATH_AUTH, ScopeInterface::SCOPE_STORE);
+        $ssl = $this->scopeConfig->getValue(self::XML_PATH_SSL, ScopeInterface::SCOPE_STORE);
+        $tls = false;
+
+        if ($ssl === 'tls') {
+            $tls = true;
+        }
 
-            $this->getTransport()->send($laminasMessage);
-        } catch (\Exception $e) {
-            $this->logger->error($e);
-            throw new MailException(new Phrase('Unable to send mail. Please try again later.'), $e);
+        $transport = new EsmtpTransport($host, $port, $tls);
+        if ($username) {
+            $transport->setUsername($username);
+        }
+        if ($password) {
+            $transport->setPassword($password);
         }
+
+        switch ($auth) {
+            case 'plain':
+                $transport->setAuthenticators([new PlainAuthenticator()]);
+                break;
+            case 'login':
+                $transport->setAuthenticators([new LoginAuthenticator()]);
+                break;
+            case 'none':
+                break;
+            default:
+                throw new \InvalidArgumentException('Invalid authentication type: ' . $auth);
+        }
+
+        return $transport;
     }
 
     /**
-     * @inheritdoc
+     * Create a Sendmail transport for Symfony Mailer.
+     *
+     * @return SymfonyTransportInterface
      */
-    public function getMessage()
+    private function createSendmailTransport(): SymfonyTransportInterface
     {
-        return $this->message;
+        $dsn = new Dsn('native', 'default');
+        $nativeTransportFactory = new NativeTransportFactory();
+        return $nativeTransportFactory->create($dsn);
     }
 
     /**
-     * Create a Smtp LaminasTransport.
-     *
-     * @return Smtp
+     * @inheritdoc
      */
-    private function createSmtpTransport(): Smtp
+    public function sendMessage(): void
     {
-        $host = $this->scopeConfig->getValue(
-            self::XML_PATH_HOST,
-            ScopeInterface::SCOPE_STORE
-        );
-
-        $port = $this->scopeConfig->getValue(
-            self::XML_PATH_PORT,
-            ScopeInterface::SCOPE_STORE
-        );
-
-        $username = $this->scopeConfig->getValue(
-            self::XML_PATH_USERNAME,
-            ScopeInterface::SCOPE_STORE
-        );
-
-        $password = $this->scopeConfig->getValue(
-            self::XML_PATH_PASSWORD,
-            ScopeInterface::SCOPE_STORE
-        );
-
-        $auth = $this->scopeConfig->getValue(
-            self::XML_PATH_AUTH,
-            ScopeInterface::SCOPE_STORE
-        );
-
-        $ssl = $this->scopeConfig->getValue(
-            self::XML_PATH_SSL,
-            ScopeInterface::SCOPE_STORE
-        );
-
-        $options  = [
-            'name' => 'localhost',
-            'host' => $host,
-            'port' => $port,
-            'connection_config' => [
-                'username' => $username,
-                'password' => $password,
-            ]
-        ];
-
-        if ($auth && $auth !== 'none') {
-            $options['connection_class'] = $auth;
+        try {
+            $email = $this->message->getSymfonyMessage();
+            $this->setReturnPath($email);
+            $mailer = new Mailer($this->getTransport());
+            $mailer->send($email);
+        } catch (TransportExceptionInterface $transportException) {
+            $this->logger->error('Transport error while sending email: ' . $transportException->getMessage());
+            throw new MailException(
+                new Phrase('Transport error: Unable to send mail at this time.'),
+                $transportException
+            );
+        } catch (\Exception $e) {
+            $this->logger->error($e);
+            throw new MailException(new Phrase('Unable to send mail. Please try again later.'), $e);
         }
+    }
 
-        if ($ssl && $ssl !== 'none') {
-            $options['connection_config']['ssl'] = $ssl;
+    /**
+     * Set the return path if configured.
+     *
+     * @param SymfonyMessage $email
+     */
+    private function setReturnPath(SymfonyMessage $email): void
+    {
+        if ($this->isSetReturnPath === 2 && $this->returnPathValue) {
+            $email->getHeaders()->addMailboxListHeader('Sender', [$this->returnPathValue]);
+        } elseif ($this->isSetReturnPath === 1 &&
+            !empty($fromAddresses = $email->getHeaders()->get('From')?->getAddresses())) {
+            reset($fromAddresses);
+            $email->getHeaders()->addMailboxListHeader('Sender', [current($fromAddresses)->getAddress()]);
         }
-
-        $transport = new Smtp();
-        $transport->setOptions(new SmtpOptions($options));
-
-        return $transport;
     }
 
     /**
-     * Create a Sendmail Laminas Transport
-     *
-     * @return Sendmail
+     * @inheritdoc
      */
-    private function createSendmailTransport(): Sendmail
+    public function getMessage(): EmailMessageInterface
     {
-        return new Sendmail($this->parameters);
+        return $this->message;
     }
 }

app/code/Magento/Email/Test/Fixture/FileTransport.php

@@ -1,7 +1,7 @@
 <?php
 /**
- * Copyright © Magento, Inc. All rights reserved.
- * See COPYING.txt for license details.
+ * Copyright 2015 Adobe
+ * All Rights Reserved.
  */
 declare(strict_types=1);
 
@@ -18,8 +18,9 @@
 class FileTransport implements RevertibleDataFixtureInterface
 {
     private const DEFAULT_DATA = [
-        'directory' => DirectoryList::TMP,
+        'directory' => DirectoryList::VAR_DIR,
         'path' => 'mail/%uniqid%',
+        'data' => 'Bienvenue sur Le Site de Paris.'
     ];
 
     private const CONFIG_FILE = 'mail-transport-config.json';