Merge branch 'pr-32241' into 2.4-develop-prs

ishakhsuvarov · ishakhsuvarov · commit e0f083ea1cfc · 2022-06-28T18:30:01.000-05:00
diff --git a/app/code/Magento/Backend/etc/adminhtml/system.xml b/app/code/Magento/Backend/etc/adminhtml/system.xml
@@ -317,14 +317,18 @@
                     <label>Disable Email Communications</label>
                     <source_model>Magento\Config\Model\Config\Source\Yesno</source_model>
                 </field>
-                <field id="host" translate="label comment" type="text" sortOrder="20" showInDefault="1" showInWebsite="1" showInStore="1" canRestore="1">
+                <field id="transport" translate="label" type="select" sortOrder="20" showInDefault="1" showInWebsite="1" showInStore="1" canRestore="1">
+                    <label>Transport</label>
+                    <source_model>Magento\Email\Model\Config\Source\SmtpTransportType</source_model>
+                </field>
+                <field id="host" translate="label comment" type="text" sortOrder="30" showInDefault="1" showInWebsite="1" showInStore="1" canRestore="1">
                     <label>Host</label>
-                    <comment>For Windows server only.</comment>
+                    <comment>For SMTP and Windows server only.</comment>
                 </field>
-                <field id="port" translate="label comment" type="text" sortOrder="30" showInDefault="1" showInWebsite="1" showInStore="1" canRestore="1">
+                <field id="port" translate="label comment" type="text" sortOrder="40" showInDefault="1" showInWebsite="1" showInStore="1" canRestore="1">
                     <label>Port (25)</label>
                     <validate>validate-digits validate-digits-range digits-range-0-65535</validate>
-                    <comment>Please enter at least 0 and at most 65535 (For Windows server only).</comment>
+                    <comment>Please enter at least 0 and at most 65535 (For SMTP and Windows server only).</comment>
                 </field>
                 <field id="set_return_path" translate="label" type="select" sortOrder="70" showInDefault="1" showInWebsite="1" showInStore="1" canRestore="1">
                     <label>Set Return-Path</label>
@@ -338,6 +342,34 @@
                         <field id="set_return_path">2</field>
                     </depends>
                 </field>
+                <field id="username" translate="label comment" type="text" sortOrder="90" showInDefault="1" showInWebsite="1" showInStore="1">
+                    <label>Username</label>
+                    <comment>Username</comment>
+                    <depends>
+                        <field id="transport">smtp</field>
+                    </depends>
+                </field>
+                <field id="password" translate="label comment" type="password" sortOrder="100" showInDefault="1" showInWebsite="1" showInStore="1">
+                    <label>Password</label>
+                    <comment>Username</comment>
+                    <depends>
+                        <field id="transport">smtp</field>
+                    </depends>
+                </field>
+                <field id="auth" translate="label" type="select" sortOrder="110" showInDefault="1" showInWebsite="1" showInStore="1" canRestore="1">
+                    <label>Auth</label>
+                    <source_model>Magento\Email\Model\Config\Source\SmtpAuthType</source_model>
+                    <depends>
+                        <field id="transport">smtp</field>
+                    </depends>
+                </field>
+                <field id="ssl" translate="label" type="select" sortOrder="120" showInDefault="1" showInWebsite="1" showInStore="1" canRestore="1">
+                    <label>SSL</label>
+                    <source_model>Magento\Email\Model\Config\Source\SmtpSslType</source_model>
+                    <depends>
+                        <field id="transport">smtp</field>
+                    </depends>
+                </field>
             </group>
             <group id="upload_configuration" translate="label" type="text" sortOrder="1000" showInDefault="1" showInWebsite="1" showInStore="1">
                 <label>Images Upload Configuration</label>
diff --git a/app/code/Magento/Email/Model/Config/Source/SmtpAuthType.php b/app/code/Magento/Email/Model/Config/Source/SmtpAuthType.php
@@ -0,0 +1,30 @@
+<?php
+/**
+ * Copyright © Magento, Inc. All rights reserved.
+ * See COPYING.txt for license details.
+ */
+declare(strict_types=1);
+
+namespace Magento\Email\Model\Config\Source;
+
+/**
+ * Option provider for the SMTP Auth type
+ */
+class SmtpAuthType implements \Magento\Framework\Data\OptionSourceInterface
+{
+    /**
+     * The possible Auth types
+     *
+     * @codeCoverageIgnore
+     * @return array
+     */
+    public function toOptionArray(): array
+    {
+        return [
+            ['value' => 'none', 'label' => __('NONE')],
+            ['value' => 'plain', 'label' => __('PLAIN')],
+            ['value' => 'login', 'label' => __('LOGIN')],
+//            ['value' => 'crammd5', 'label' => __('CRAM-MD5) '],  // Requires laminas/laminas-crypt
+        ];
+    }
+}
diff --git a/app/code/Magento/Email/Model/Config/Source/SmtpSslType.php b/app/code/Magento/Email/Model/Config/Source/SmtpSslType.php
@@ -0,0 +1,29 @@
+<?php
+/**
+ * Copyright © Magento, Inc. All rights reserved.
+ * See COPYING.txt for license details.
+ */
+declare(strict_types=1);
+
+namespace Magento\Email\Model\Config\Source;
+
+/**
+ * Option provider for SMTP SSL Type
+ */
+class SmtpSslType implements \Magento\Framework\Data\OptionSourceInterface
+{
+    /**
+     * The possible SSL types
+     *
+     * @codeCoverageIgnore
+     * @return array
+     */
+    public function toOptionArray(): array
+    {
+        return [
+            ['value' => 'none', 'label' => __('None')],
+            ['value' => 'ssl', 'label' => __('SSL')],
+            ['value' => 'tls', 'label' => __('TLS')],
+        ];
+    }
+}
diff --git a/app/code/Magento/Email/Model/Config/Source/SmtpTransportType.php b/app/code/Magento/Email/Model/Config/Source/SmtpTransportType.php
@@ -0,0 +1,29 @@
+<?php
+/**
+ * Copyright © Magento, Inc. All rights reserved.
+ * See COPYING.txt for license details.
+ */
+declare(strict_types=1);
+
+namespace Magento\Email\Model\Config\Source;
+
+/**
+ * Option provider for the SMTP Transport Type
+ */
+class SmtpTransportType implements \Magento\Framework\Data\OptionSourceInterface
+{
+
+    /**
+     * The possible Transport types
+     *
+     * @codeCoverageIgnore
+     * @return array
+     */
+    public function toOptionArray(): array
+    {
+        return [
+            ['value' => 'sendmail', 'label' => __('Sendmail')],
+            ['value' => 'smtp', 'label' => __('SMTP')],
+        ];
+    }
+}
diff --git a/app/code/Magento/Email/Model/Transport.php b/app/code/Magento/Email/Model/Transport.php
@@ -7,6 +7,8 @@
 
 namespace Magento\Email\Model;
 
+use Laminas\Mail\Transport\Smtp;
+use Laminas\Mail\Transport\SmtpOptions;
 use Magento\Framework\App\Config\ScopeConfigInterface;
 use Magento\Framework\App\ObjectManager;
 use Magento\Framework\Exception\MailException;
@@ -16,24 +18,61 @@
 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
+ * @SuppressWarnings(PHPMD.CouplingBetweenObjects)
  */
 class Transport implements TransportInterface
 {
     /**
      * Configuration path to source of Return-Path and whether it should be set at all
      * @see \Magento\Config\Model\Config\Source\Yesnocustom to possible values
      */
-    const XML_PATH_SENDING_SET_RETURN_PATH = 'system/smtp/set_return_path';
+    public const XML_PATH_SENDING_SET_RETURN_PATH = 'system/smtp/set_return_path';
 
     /**
      * Configuration path for custom Return-Path email
      */
-    const XML_PATH_SENDING_RETURN_PATH_EMAIL = 'system/smtp/return_path_email';
+    public const XML_PATH_SENDING_RETURN_PATH_EMAIL = 'system/smtp/return_path_email';
+
+    /**
+     * Configuration path for custom Transport
+     */
+    private const XML_PATH_TRANSPORT = 'system/smtp/transport';
+
+    /**
+     * Configuration path for SMTP Host
+     */
+    private const XML_PATH_HOST = 'system/smtp/host';
+
+    /**
+     * Configuration path for SMTP Port
+     */
+    private const XML_PATH_PORT = 'system/smtp/port';
+
+    /**
+     * Configuration path for SMTP Username
+     */
+    private const XML_PATH_USERNAME = 'system/smtp/username';
+
+    /**
+     * Configuration path for SMTP Password
+     */
+    private const XML_PATH_PASSWORD = 'system/smtp/password';
+
+    /**
+     * Configuration path for SMTP Auth type
+     */
+    private const XML_PATH_AUTH = 'system/smtp/auth';
+
+    /**
+     * Configuration path for SMTP SSL value
+     */
+    private const XML_PATH_SSL = 'system/smtp/ssl';
 
     /**
      * Whether return path should be set or no.
@@ -53,10 +92,20 @@ class Transport implements TransportInterface
     private $returnPathValue;
 
     /**
-     * @var Sendmail
+     * @var ScopeConfigInterface
+     */
+    private $scopeConfig;
+
+    /**
+     * @var LaminasTransportInterface|null
      */
     private $laminasTransport;
 
+    /**
+     * @var null|string|array|\Traversable
+     */
+    private $parameters;
+
     /**
      * @var MessageInterface
      */
@@ -87,12 +136,35 @@ public function __construct(
             self::XML_PATH_SENDING_RETURN_PATH_EMAIL,
             ScopeInterface::SCOPE_STORE
         );
-
-        $this->laminasTransport = new Sendmail($parameters);
         $this->message = $message;
+        $this->scopeConfig = $scopeConfig;
+        $this->parameters = $parameters;
         $this->logger = $logger ?: ObjectManager::getInstance()->get(LoggerInterface::class);
     }
 
+    /**
+     * Get the LaminasTransport based on the configuration.
+     *
+     * @return LaminasTransportInterface
+     */
+    public function getTransport(): LaminasTransportInterface
+    {
+        if ($this->laminasTransport === null) {
+            $transport = $this->scopeConfig->getValue(
+                self::XML_PATH_TRANSPORT,
+                ScopeInterface::SCOPE_STORE
+            );
+
+            if ($transport === 'smtp') {
+                $this->laminasTransport = $this->createSmtpTransport();
+            } else {
+                $this->laminasTransport = $this->createSendmailTransport();
+            }
+        }
+
+        return $this->laminasTransport;
+    }
+
     /**
      * @inheritdoc
      */
@@ -108,7 +180,7 @@ public function sendMessage()
                 $laminasMessage->setSender($fromAddressList->current()->getEmail());
             }
 
-            $this->laminasTransport->send($laminasMessage);
+            $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);
@@ -122,4 +194,75 @@ public function getMessage()
     {
         return $this->message;
     }
+
+    /**
+     * Create a Smtp LaminasTransport.
+     *
+     * @return Smtp
+     */
+    private function createSmtpTransport(): Smtp
+    {
+        $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;
+        }
+
+        if ($ssl && $ssl !== 'none') {
+            $options['connection_config']['ssl'] = $ssl;
+        }
+
+        $transport = new Smtp();
+        $transport->setOptions(new SmtpOptions($options));
+
+        return $transport;
+    }
+
+    /**
+     * Create a Sendmail Laminas Transport
+     *
+     * @return Sendmail
+     */
+    private function createSendmailTransport(): Sendmail
+    {
+        return new Sendmail($this->parameters);
+    }
 }
diff --git a/app/code/Magento/Email/etc/config.xml b/app/code/Magento/Email/etc/config.xml
@@ -28,6 +28,8 @@
                 <host>localhost</host>
                 <port>25</port>
                 <set_return_path>0</set_return_path>
+                <transport>sendmail</transport>
+                <auth>none</auth>
             </smtp>
         </system>
         <trans_email>
