Merge branch 'sw-26872/send-mail-message-id' into '5.7'

SW-26872 - Send 'Message-Id' header in mails

See merge request shopware/5/product/shopware!867

Author: mitelg

.phpstan-baseline.neon

@@ -51965,16 +51965,6 @@ parameters:
 			count: 1
 			path: tests/Unit/Components/LegacyRequestWrapper/PostWrapperTest.php
 
-		-
-			message: "#^Method Shopware\\\\Tests\\\\Unit\\\\Components\\\\MailTest\\:\\:testCodeInjectionInFromHeader\\(\\) has no return type specified\\.$#"
-			count: 1
-			path: tests/Unit/Components/MailTest.php
-
-		-
-			message: "#^Method Shopware\\\\Tests\\\\Unit\\\\Components\\\\MailTest\\:\\:testValidFromAddress\\(\\) has no return type specified\\.$#"
-			count: 1
-			path: tests/Unit/Components/MailTest.php
-
 		-
 			message: "#^Function Shopware\\\\Components\\\\ini_get\\(\\) has no return type specified\\.$#"
 			count: 1

engine/Library/Enlight/Components/Mail.php

@@ -393,6 +393,10 @@ public function send($transport = null)
             ]
         );
 
+        if (!$this->getMessageId()) {
+            $this->setMessageId();
+        }
+
         return parent::send($transport);
     }
 }

engine/Library/Zend/Mail.php

@@ -1049,7 +1049,7 @@ public function setMessageId($id = true)
     /**
      * Returns the Message-ID of the message
      *
-     * @return string
+     * @return string|null
      */
     public function getMessageId()
     {
@@ -1136,7 +1136,7 @@ public function addHeader($name, $value, $append = false)
     /**
      * Return mail headers
      *
-     * @return void
+     * @return array
      */
     public function getHeaders()
     {

tests/Functional/Components/MailTest.php

@@ -0,0 +1,53 @@
+<?php
+/**
+ * Shopware 5
+ * Copyright (c) shopware AG
+ *
+ * According to our dual licensing model, this program can be used either
+ * under the terms of the GNU Affero General Public License, version 3,
+ * or under a proprietary license.
+ *
+ * The texts of the GNU Affero General Public License with an additional
+ * permission and of our proprietary license can be found at and
+ * in the LICENSE file you have received along with this program.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+ * GNU Affero General Public License for more details.
+ *
+ * "Shopware" is a registered trademark of shopware AG.
+ * The licensing of the program under the AGPLv3 does not imply a
+ * trademark license. Therefore any rights, title and interest in
+ * our trademarks remain entirely with us.
+ */
+
+namespace Shopware\Tests\Functional\Components;
+
+use Enlight_Components_Mail;
+use PHPUnit\Framework\TestCase;
+use Shopware\Tests\Functional\Traits\ContainerTrait;
+
+class MailTest extends TestCase
+{
+    use ContainerTrait;
+
+    public function testMessageId(): void
+    {
+        $mailTransport = $this->getContainer()->get('mailtransport');
+
+        $mail = new Enlight_Components_Mail();
+        $mail->setBodyText('Test Hello');
+        $mail->addTo('[email protected]');
+
+        $mail->send($mailTransport);
+
+        $headers = $mail->getHeaders();
+        static::assertArrayHasKey('Message-Id', $headers);
+        $messageId = $headers['Message-Id'][0];
+        static::assertIsString($messageId);
+        static::assertStringContainsString('@', $messageId);
+        static::assertStringStartsWith('<', $messageId);
+        static::assertStringEndsWith('>', $messageId);
+    }
+}

tests/Functional/Regressions/Ticket5217Test.php

@@ -28,19 +28,21 @@
 
 use Enlight_Components_Mail;
 use PHPUnit\Framework\TestCase;
+use Shopware\Tests\Functional\Traits\ContainerTrait;
 
 class Ticket5217Test extends TestCase
 {
+    use ContainerTrait;
+
     /**
      * Test case method
      */
     public function testMailTransport(): void
     {
-        $mailTransport = Shopware()->Container()->get('mailtransport');
+        $mailTransport = $this->getContainer()->get('mailtransport');
 
         $mail = new Enlight_Components_Mail();
-
-        $mail->setBodyText('Test Hallo');
+        $mail->setBodyText('Test Hello');
         $mail->addTo('[email protected]');
 
         $mail = $mail->send($mailTransport);

tests/Unit/Components/MailTest.php

@@ -30,15 +30,15 @@
 
 class MailTest extends TestCase
 {
-    public function testValidFromAddress()
+    public function testValidFromAddress(): void
     {
         $mail = new Enlight_Components_Mail();
         $mail->setFrom('[email protected]', 'Sender\'s name');
 
         static::assertSame('[email protected]', $mail->getFrom());
     }
 
-    public function testCodeInjectionInFromHeader()
+    public function testCodeInjectionInFromHeader(): void
     {
         $mail = new Enlight_Components_Mail();