[Mailer] [Smtp] Add source_ip option

quilius · quilius · commit 64841c2677d6 · 2025-01-17T15:41:36.000+01:00
diff --git a/mailer.rst b/mailer.rst
@@ -128,7 +128,7 @@ Service               Install with                                    Webhook su
 
     The Mailomat, Mailtrap, Postal and Sweego integrations were introduced in Symfony 7.2.
 
-.. versionadded:: 7.3
+.. deprecated:: 7.3
 
     The AhaSend integration was introduced in Symfony 7.3.
 
@@ -347,7 +347,7 @@ the retry period by setting the ``retry_period`` option in the DSN:
 
     MAILER_DSN="failover(postmark+api://ID@default sendgrid+smtp://KEY@default)?retry_period=15"
 
-.. versionadded:: 7.3
+.. deprecated:: 7.3
 
     The ``retry_period`` option was introduced in Symfony 7.3.
 
@@ -378,7 +378,7 @@ the retry period by setting the ``retry_period`` option in the DSN:
 
     MAILER_DSN="roundrobin(postmark+api://ID@default sendgrid+smtp://KEY@default)?retry_period=15"
 
-.. versionadded:: 7.3
+.. deprecated:: 7.3
 
     The ``retry_period`` option was introduced in Symfony 7.3.
 
@@ -426,6 +426,27 @@ setting the ``auto_tls`` option to ``false`` in the DSN::
 
     This setting only works when the ``smtp://`` protocol is used.
 
+Binding to IPv4 or IPv6
+~~~~~~~~~~~~~~~~~~~~~~~
+
+.. deprecated:: 7.3
+
+    The option to bind to IPv4 or IPv6 or a specific IP address was introduced in Symfony 7.3.
+
+By default, the underlying SocketStream will bind to IPv4 or IPv6 depending on the available
+interfaces. By specifying the ``source_ip`` option, binding to either IPv4 or IPv6 can be enforced,
+or even to a specific address. To bind to IPv4, use::
+
+    $dsn = 'smtp://smtp.example.com?source_ip=0.0.0.0';
+
+As per RFC2732, IPv6 addresses must be surrounded by square brackets. To bind to IPv6, use::
+
+    $dsn = 'smtp://smtp.example.com?source_ip=[::]';
+
+.. note::
+
+    This setting only works when the ``smtp://`` protocol is used.
+
 Overriding default SMTP authenticators
 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 
