[Mailer] Allow manually start()/stop() of SmtpTransport

dvaeversted · dvaeversted · commit a998806d9de9 · 2022-02-04T09:11:03.000+01:00
diff --git a/src/Symfony/Component/Mailer/CHANGELOG.md b/src/Symfony/Component/Mailer/CHANGELOG.md
@@ -1,6 +1,11 @@
 CHANGELOG
 =========
 
+6.1
+---
+
+* Allow manually start()/stop() of `SmtpTransport`
+
 6.0
 ---
 
diff --git a/src/Symfony/Component/Mailer/Tests/Transport/Smtp/SmtpTransportTest.php b/src/Symfony/Component/Mailer/Tests/Transport/Smtp/SmtpTransportTest.php
@@ -133,6 +133,18 @@ public function testWriteEncodedRecipientAndSenderAddresses()
         $this->assertContains("RCPT TO:<recipient@xn--exmple-cua.org>\r\n", $stream->getCommands());
         $this->assertContains("RCPT TO:<recipient2@example.org>\r\n", $stream->getCommands());
     }
+
+    public function testStartStop() {
+        $stream = new DummyStream();
+
+        $transport = new SmtpTransport($stream);
+
+        $transport->start();
+        $this->assertFalse($stream->isClosed());
+
+        $transport->stop();
+        $this->assertTrue($stream->isClosed());
+    }
 }
 
 class DummyStream extends AbstractStream
diff --git a/src/Symfony/Component/Mailer/Transport/Smtp/SmtpTransport.php b/src/Symfony/Component/Mailer/Transport/Smtp/SmtpTransport.php
@@ -240,7 +240,12 @@ private function doRcptToCommand(string $address): void
         $this->executeCommand(sprintf("RCPT TO:<%s>\r\n", $address), [250, 251, 252]);
     }
 
-    private function start(): void
+    /**
+     * Manually connect to the SMTP server, will happen automatically when sending mails.
+     *
+     * @throws TransportException If the connection fails to be established
+     */
+    public function start(): void
     {
         if ($this->started) {
             return;
@@ -257,7 +262,10 @@ private function start(): void
         $this->getLogger()->debug(sprintf('Email transport "%s" started', __CLASS__));
     }
 
-    private function stop(): void
+    /**
+     * Manually disconnect from the SMTP server.
+     */
+    public function stop(): void
     {
         if (!$this->started) {
             return;

Original file line number	Diff line number	Diff line change
`@@ -240,7 +240,12 @@ private function doRcptToCommand(string $address): void`
`240`	`240`	`$this->executeCommand(sprintf("RCPT TO:<%s>\r\n", $address), [250, 251, 252]);`
`241`	`241`	`}`
`242`	`242`
`243`		`- private function start(): void`
	`243`	`+ /**`
	`244`	`+ * Manually connect to the SMTP server, will happen automatically when sending mails.`
	`245`	`+ *`
	`246`	`+ * @throws TransportException If the connection fails to be established`
	`247`	`+ */`
	`248`	`+ public function start(): void`
`244`	`249`	`{`
`245`	`250`	`if ($this->started) {`
`246`	`251`	`return;`
`@@ -257,7 +262,10 @@ private function start(): void`
`257`	`262`	`$this->getLogger()->debug(sprintf('Email transport "%s" started', __CLASS__));`
`258`	`263`	`}`
`259`	`264`
`260`		`- private function stop(): void`
	`265`	`+ /**`
	`266`	`+ * Manually disconnect from the SMTP server.`
	`267`	`+ */`
	`268`	`+ public function stop(): void`
`261`	`269`	`{`
`262`	`270`	`if (!$this->started) {`
`263`	`271`	`return;`