diff --git a/notifier.rst b/notifier.rst index 79b4480a096..9adcb3cead2 100644 --- a/notifier.rst +++ b/notifier.rst @@ -51,6 +51,13 @@ The notifier component supports the following channels: SMS Channel ~~~~~~~~~~~ +.. caution:: + + If any of the DSN values contains any character considered special in a + URI (such as ``+``, ``@``, ``$``, ``#``, ``/``, ``:``, ``*``, ``!``), you must + encode them. See `RFC 3986`_ for the full list of reserved characters or use the + :phpfunction:`urlencode` function to encode them. + The SMS channel uses :class:`Symfony\\Component\\Notifier\\Texter` classes to send SMS messages to mobile phones. This feature requires subscribing to a third-party service that sends SMS messages. Symfony provides integration @@ -168,6 +175,13 @@ configure the ``texter_transports``: Chat Channel ~~~~~~~~~~~~ +.. caution:: + + If any of the DSN values contains any character considered special in a + URI (such as ``+``, ``@``, ``$``, ``#``, ``/``, ``:``, ``*``, ``!``), you must + encode them. See `RFC 3986`_ for the full list of reserved characters or use the + :phpfunction:`urlencode` function to encode them. + The chat channel is used to send chat messages to users by using :class:`Symfony\\Component\\Notifier\\Chatter` classes. Symfony provides integration with these chat services: @@ -328,6 +342,13 @@ notification emails: Push Channel ~~~~~~~~~~~~ +.. caution:: + + If any of the DSN values contains any character considered special in a + URI (such as ``+``, ``@``, ``$``, ``#``, ``/``, ``:``, ``*``, ``!``), you must + encode them. See `RFC 3986`_ for the full list of reserved characters or use the + :phpfunction:`urlencode` function to encode them. + The push channel is used to send notifications to users by using :class:`Symfony\\Component\\Notifier\\Texter` classes. Symfony provides integration with these push services: @@ -739,3 +760,5 @@ Learn more :glob: notifier/* + +.. _`RFC 3986`: https://www.ietf.org/rfc/rfc3986.txt