Merge branch 'MC-38337' of https://github.com/magento-tango/magento2ce into TANGO-PR-10-21-2020-24

Author: thiaramus

dev/tests/integration/testsuite/Magento/Framework/Mail/TransportBuilderTest.php

@@ -116,4 +116,84 @@ public function emailDataProvider(): array
             ]
         ];
     }
+
+    /**
+     * Test if invalid email in the queue will not fail the entire queue from being sent
+     *
+     * @magentoDataFixture Magento/Email/Model/_files/email_template.php
+     * @magentoDbIsolation enabled
+     *
+     * @param string|array $emails
+     * @dataProvider invalidEmailDataProvider
+     * @throws LocalizedException
+     */
+    public function testAddToInvalidEmailInTheQueue($emails)
+    {
+        $template = $this->template->load('email_exception_fixture', 'template_code');
+        $templateId = $template->getId();
+
+        switch ($template->getType()) {
+            case TemplateTypesInterface::TYPE_TEXT:
+                $templateType = MimeInterface::TYPE_TEXT;
+                break;
+
+            case TemplateTypesInterface::TYPE_HTML:
+                $templateType = MimeInterface::TYPE_HTML;
+                break;
+
+            default:
+                $templateType = '';
+                $this->fail('Unsupported Mime Type');
+        }
+
+        $this->builder->setTemplateModel(BackendTemplate::class);
+
+        $vars = ['reason' => 'Reason', 'customer' => 'Customer'];
+        $options = ['area' => 'frontend', 'store' => 1];
+        $this->builder->setTemplateIdentifier($templateId)->setTemplateVars($vars)->setTemplateOptions($options);
+
+        $allEmails = $emails[0];
+        $validOnlyEmails = $emails[1];
+
+        foreach ($allEmails as $email) {
+            $this->builder->addTo($email);
+        }
+
+        /** @var EmailMessage $emailMessage */
+        $emailMessage = $this->builder->getTransport()->getMessage();
+        $this->assertStringContainsStringIgnoringCase($templateType, $emailMessage->getHeaders()['Content-Type']);
+
+        $resultEmails = [];
+        /** @var Address $toAddress */
+        foreach ($emailMessage->getTo() as $address) {
+            $resultEmails[] = $address->getEmail();
+        }
+
+        $this->assertEquals($validOnlyEmails, $resultEmails);
+    }
+
+    /**
+     * @return array
+     */
+    public function invalidEmailDataProvider(): array
+    {
+        return [
+            [
+                [
+                    [
+                        'billy.everything@someserver.com',
+                        'billy.everythingsomeserver.com',
+                        'billy.everything2@someserver.com',
+                        'billy.everythin2gsomeserver.com',
+                        'billy.everything3@someserver.com'
+                    ],
+                    [
+                        'billy.everything@someserver.com',
+                        'billy.everything2@someserver.com',
+                        'billy.everything3@someserver.com'
+                    ]
+                ]
+            ]
+        ];
+    }
 }

lib/internal/Magento/Framework/Mail/EmailMessage.php

@@ -7,13 +7,18 @@
 
 namespace Magento\Framework\Mail;
 
+use Laminas\Mail\Exception\InvalidArgumentException as LaminasInvalidArgumentException;
+use Magento\Framework\App\ObjectManager;
 use Magento\Framework\Mail\Exception\InvalidArgumentException;
 use Laminas\Mail\Address as LaminasAddress;
 use Laminas\Mail\AddressList;
 use Laminas\Mime\Message as LaminasMimeMessage;
+use Psr\Log\LoggerInterface;
 
 /**
  * Magento Framework Email message
+ *
+ * @SuppressWarnings(PHPMD.CouplingBetweenObjects)
  */
 class EmailMessage extends Message implements EmailMessageInterface
 {
@@ -27,6 +32,11 @@ class EmailMessage extends Message implements EmailMessageInterface
      */
     private $addressFactory;
 
+    /**
+     * @var LoggerInterface|null
+     */
+    private $logger;
+
     /**
      * @param MimeMessageInterface $body
      * @param array $to
@@ -39,8 +49,8 @@ class EmailMessage extends Message implements EmailMessageInterface
      * @param Address|null $sender
      * @param string|null $subject
      * @param string|null $encoding
+     * @param LoggerInterface|null $logger
      * @throws InvalidArgumentException
-     *
      * @SuppressWarnings(PHPMD.ExcessiveParameterList)
      * @SuppressWarnings(PHPMD.NPathComplexity)
      * @SuppressWarnings(PHPMD.CyclomaticComplexity)
@@ -56,10 +66,12 @@ public function __construct(
         ?array $replyTo = null,
         ?Address $sender = null,
         ?string $subject = '',
-        ?string $encoding = 'utf-8'
+        ?string $encoding = 'utf-8',
+        ?LoggerInterface $logger = null
     ) {
         parent::__construct($encoding);
         $mimeMessage = new LaminasMimeMessage();
+        $this->logger = $logger ?: ObjectManager::getInstance()->get(LoggerInterface::class);
         $mimeMessage->setParts($body->getParts());
         $this->zendMessage->setBody($mimeMessage);
         if ($subject) {
@@ -222,7 +234,15 @@ private function convertAddressArrayToAddressList(array $arrayList): AddressList
     {
         $laminasAddressList = new AddressList();
         foreach ($arrayList as $address) {
-            $laminasAddressList->add($address->getEmail(), $address->getName());
+            try {
+                $laminasAddressList->add($address->getEmail(), $address->getName());
+            } catch (LaminasInvalidArgumentException $e) {
+                $this->logger->warning(
+                    'Could not add an invalid email address to the mailing queue',
+                    ['exception' => $e]
+                );
+                continue;
+            }
         }
 
         return $laminasAddressList;