Skip to content

[Notifier] Misc. minor tweaks #20170

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Aug 28, 2024
Merged

[Notifier] Misc. minor tweaks #20170

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
30 changes: 16 additions & 14 deletions notifier.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -15,12 +15,14 @@ Get the Notifier installed using:
$ composer require symfony/notifier

.. _channels-chatters-texters-email-and-browser:
.. _channels-chatters-texters-email-browser-and-push:

Channels: Chatters, Texters, Email, Browser and Push
----------------------------------------------------
Channels
--------

The notifier component can send notifications to different channels. Each
channel can integrate with different providers (e.g. Slack or Twilio SMS)
Channels refer to the different mediums through which notifications can be delivered.
These channels can include email, SMS, chat services, push notifications, etc.
Each channel can integrate with different providers (e.g. Slack or Twilio SMS)
by using transports.

The notifier component supports the following channels:
Expand All @@ -33,28 +35,23 @@ The notifier component supports the following channels:
* Browser channel uses :ref:`flash messages <flash-messages>`.
* :ref:`Push channel <notifier-push-channel>` sends notifications to phones and browsers via push notifications.

.. tip::

Use :doc:`secrets </configuration/secrets>` to securely store your
API tokens.

.. _notifier-sms-channel:

SMS Channel
~~~~~~~~~~~

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
with a couple popular SMS services:

.. 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
with a couple popular SMS services:

================== ====================================================================================================================================
Service
================== ====================================================================================================================================
Expand Down Expand Up @@ -213,6 +210,11 @@ Service
The `Sendinblue`_ integration is deprecated since
Symfony 6.4, use the `Brevo`_ integration instead.

.. tip::

Use :doc:`Symfony configuration secrets </configuration/secrets>` to securely
store your API tokens.

.. tip::

Some third party transports, when using the API, support status callbacks
Expand Down
Loading