bug #51568 [Mailer] bug - fix EsmtpTransport variable $code definition (kgnblg)

fabpot · fabpot · commit 29f427fcbd78 · 2023-09-06T10:46:23.000+02:00
This PR was merged into the 6.3 branch. Discussion ---------- [Mailer] bug - fix EsmtpTransport variable $code definition | Q | A | ------------- | --- | Branch? | 6.3 | Bug fix? | yes | New feature? | no | Deprecations? | no | Tickets | --- | License | MIT | Doc PR | --- This PR contains a basic fix of a bug in SymfonyMailer component (`Symfony\Component\Mailer\Transport\Smtp\EsmtpTransport` class). If we use `EsmtpTransport` like the given example, it needs to throw TransportException which has been defined in the `handleAuth()` of `EsmtpTransport` class. (Because we called `setAuthenticators()` with empty array and the function emptied the authenticators. We can imagine that we forget to set authenticators.) ``` $stream = new DummyStream(); $transport = new EsmtpTransport(stream: $stream); $transport->setUsername('testuser'); $transport->setPassword('p4ssw0rd'); $transport->setAuthenticators([]); .. .. $transport->send(...); ``` This code piece needs to throw following TransportException with code 504; ``` Failed to find an authenticator supported by the SMTP server, which currently supports: "plain", "login", "cram-md5", "xoauth2". ``` However it shows a PHP Error; ``` Undefined variable $code ``` I included a unit test function `testConstructorWithEmptyAuthenticator()` inside of the `EsmtpTransportTest` class with a fix of the problem. Commits ------- 772050b bug [mailer] fix EsmtpTransport variable $code definition
diff --git a/src/Symfony/Component/Mailer/Tests/Transport/Smtp/EsmtpTransportTest.php b/src/Symfony/Component/Mailer/Tests/Transport/Smtp/EsmtpTransportTest.php
@@ -192,6 +192,28 @@ public function testSetAuthenticators()
             $stream->getCommands()
         );
     }
+
+    public function testConstructorWithEmptyAuthenticator()
+    {
+        $stream = new DummyStream();
+        $transport = new EsmtpTransport(stream: $stream);
+        $transport->setUsername('testuser');
+        $transport->setPassword('p4ssw0rd');
+        $transport->setAuthenticators([]); // if no authenticators defined, then there needs to be a TransportException
+
+        $message = new Email();
+        $message->from('sender@example.org');
+        $message->addTo('recipient@example.org');
+        $message->text('.');
+
+        try {
+            $transport->send($message);
+            $this->fail('Symfony\Component\Mailer\Exception\TransportException to be thrown');
+        } catch (TransportException $e) {
+            $this->assertStringStartsWith('Failed to find an authenticator supported by the SMTP server, which currently supports: "plain", "login", "cram-md5", "xoauth2".', $e->getMessage());
+            $this->assertEquals(504, $e->getCode());
+        }
+    }
 }
 
 class CustomEsmtpTransport extends EsmtpTransport
diff --git a/src/Symfony/Component/Mailer/Transport/Smtp/EsmtpTransport.php b/src/Symfony/Component/Mailer/Transport/Smtp/EsmtpTransport.php
@@ -184,6 +184,7 @@ private function handleAuth(array $modes): void
             return;
         }
 
+        $code = null;
         $authNames = [];
         $errors = [];
         $modes = array_map('strtolower', $modes);
@@ -192,7 +193,6 @@ private function handleAuth(array $modes): void
                 continue;
             }
 
-            $code = null;
             $authNames[] = $authenticator->getAuthKeyword();
             try {
                 $authenticator->authenticate($this);

Original file line number	Diff line number	Diff line change
`@@ -184,6 +184,7 @@ private function handleAuth(array $modes): void`
`184`	`184`	`return;`
`185`	`185`	`}`
`186`	`186`
	`187`	`+ $code = null;`
`187`	`188`	`$authNames = [];`
`188`	`189`	`$errors = [];`
`189`	`190`	`$modes = array_map('strtolower', $modes);`
`@@ -192,7 +193,6 @@ private function handleAuth(array $modes): void`
`192`	`193`	`continue;`
`193`	`194< 5CD3 /code>`	`}`
`194`	`195`
`195`		`- $code = null;`
`196`	`196`	`$authNames[] = $authenticator->getAuthKeyword();`
`197`	`197`	`try {`
`198`	`198`	`$authenticator->authenticate($this);`