feature #54939 [Mailer] Add retry_period option for email transport (Sébastien Despont, fabpot)

fabpot · fabpot · commit 41bee39f215d · 2025-01-04T18:31:29.000+01:00
This PR was merged into the 7.3 branch. Discussion ---------- [Mailer] Add `retry_period` option for email transport | Q | A | ------------- | --- | Branch? | 7.2 | Bug fix? | no | New feature? | yes | Deprecations? | no | Issues | Fix #50981 #52551 | License | MIT RoundRobinTransport constructor has retryPeriod set to 60 seconds. This cannot be configured right now. Let's say all the transports fail (e.g. email address with domain that does not exist). Problems: 1. When sending more than one email synchronously we can't send emails following the one that failed. We have to sleep(x) where x >= 60sec. (of course we have to handle the TransportException thrown by invalid email but this is another topic) 2. When using Messenger and async emails we don't have to worry about handling TransportException because invalid message will be sent back to the queue however the worker cannot consume another messages for the next 60 seconds. Also logs will be flooded with exceptions because in this 60s window a lot of messages could be tried. This PR permits to specify a retry period using a new DNS option `retry_period` like `MAILER_DSN="roundrobin(postmark+api://ID@default sendgrid+smtp://KEY@default)?retry_period=15"` Commits ------- 9716a89 Simplify code c5703ae Add retry_period option for email transport
diff --git a/src/Symfony/Component/Mailer/Tests/TransportTest.php b/src/Symfony/Component/Mailer/Tests/TransportTest.php
@@ -58,6 +58,11 @@ public static function fromStringProvider(): iterable
             'roundrobin(dummy://a failover(dummy://b dummy://a) dummy://b)',
             new RoundRobinTransport([$transportA, new FailoverTransport([$transportB, $transportA]), $transportB]),
         ];
+
+        yield 'round robin transport with retry period' => [
+            'roundrobin(dummy://a dummy://b)?retry_period=15',
+            new RoundRobinTransport([$transportA, $transportB], 15),
+        ];
     }
 
     /**
diff --git a/src/Symfony/Component/Mailer/Transport.php b/src/Symfony/Component/Mailer/Transport.php
@@ -145,6 +145,11 @@ private function parseDsn(#[\SensitiveParameter] string $dsn, int $offset = 0):
                         }
                     }
 
+                    parse_str(substr($dsn, $offset + 1), $query);
+                    if ($period = $query['retry_period'] ?? 0) {
+                        return [new $class($args, (int) $period), $offset + \strlen('retry_period='.$period) + 1];
+                    }
+
                     return [new $class($args), $offset];
                 }
             }

Original file line number	Diff line number	Diff line change
`@@ -145,6 +145,11 @@ private function parseDsn(#[\SensitiveParameter] string $dsn, int $offset = 0):`
`145`	`145`	`}`
`146`	`146`	`}`
`147`	`147`
	`148`	`+ parse_str(substr($dsn, $offset + 1), $query);`
	`149`	`+ if ($period = $query['retry_period'] ?? 0) {`
	`150`	`+ return [new $class($args, (int) $period), $offset + \strlen('retry_period='.$period) + 1];`
	`151`	`+ }`
	`152`	`+`
`148`	`153`	`return [new $class($args), $offset];`
`149`	`154`	`}`
`150`	`155`	`}`