feature #46326 SMTP Transport to provide the (final) Message-ID if available (Raphaël Droz)

fabpot · fabpot · commit 703596eacca0 · 2022-07-20T19:35:45.000+02:00
This PR was squashed before being merged into the 6.2 branch. Discussion ---------- SMTP Transport to provide the (final) Message-ID if available bug #46323 [Mailer] SMTP transport does not provide the (final) Message-ID | Q | A | ------------- | --- | Branch? | 6.1 | Bug fix? | yes | New feature? | no | Deprecations? | no | Tickets | Fix #46323 | License | MIT | Doc PR | symfony/symfony-docs# Questions / Answers: - **Q**: Why storing 250 inside **`$mtaResult`** instead of using the already available `$message->getDebug()`? - A: Because the later may be huge (especially in case of attachment) and running a regexp over it would be less than safe. Instead `$mtaResult` only contains one line - **Q**: Why a new **`public`** method? - A: Because child SMTP Transport may make other assumptions about the return `250 Ok` value and provide a custom logic / regexp. - **Q**: Why **regexp**? - A: Because there is no official standard for this line (other than the `250 Ok` prefix) Additionally (see https://symfony.com/releases): - [ ] Always add tests and ensure they pass. _I can't. Don't have the time. Left to maintainers / other contributors_ - [x] Bug fixes must be submitted against the lowest maintained branch where they apply (lowest branches are regularly merged to upper ones so they get the fixes too.) - [x] Features and deprecations must be submitted against the latest branch. - [x] Changelog entry should follow https://symfony.com/doc/current/contributing/code/conventions.html#writing-a-changelog-entry - [x] Never break backward compatibility (see https://symfony.com/bc). Commits ------- 441c9b0 SMTP Transport to provide the (final) Message-ID if available
diff --git a/src/Symfony/Component/Mailer/Transport/Smtp/SmtpTransport.php b/src/Symfony/Component/Mailer/Transport/Smtp/SmtpTransport.php
@@ -38,6 +38,7 @@ class SmtpTransport extends AbstractTransport
     private int $pingThreshold = 100;
     private float $lastMessageTime = 0;
     private AbstractStream $stream;
+    private string $mtaResult = '';
     private string $domain = '[127.0.0.1]';
 
     public function __construct(AbstractStream $stream = null, EventDispatcherInterface $dispatcher = null, LoggerInterface $logger = null)
@@ -146,11 +147,38 @@ public function send(RawMessage $message, Envelope $envelope = null): ?SentMessa
             throw $e;
         }
 
+        $messageId = $this->parseMessageId($this->mtaResult);
+        if ($messageId) {
+            $message->setMessageId($messageId);
+        }
+
         $this->checkRestartThreshold();
 
         return $message;
     }
 
+    protected function parseMessageId(string $mtaResult): ?string
+    {
+        $regexps = [
+            '/250 Ok (?P<id>[0-9a-f-]+)\r?$/mis',
+            '/250 Ok:? queued as (?P<id>[A-Z0-9]+)\r?$/mis'
+        ];
+
+        if ($mtaResult === '') {
+            return null;
+        }
+
+        $matches = [];
+        foreach ($regexps as $regexp) {
+            preg_match($regexp, $mtaResult, $matches);
+            if (!empty($matches['id'])) {
+                return $matches['id'];
+            }
+        }
+
+        return null;
+    }
+
     public function __toString(): string
     {
         if ($this->stream instanceof SocketStream) {
@@ -213,7 +241,7 @@ protected function doSend(SentMessage $message): void
                 $this->getLogger()->debug(sprintf('Email transport "%s" stopped', __CLASS__));
                 throw $e;
             }
-            $this->executeCommand("\r\n.\r\n", [250]);
+            $this->mtaResult = $this->executeCommand("\r\n.\r\n", [250]);
             $message->appendDebug($this->stream->getDebug());
             $this->lastMessageTime = microtime(true);
         } catch (TransportExceptionInterface $e) {
