The Notifier project provides extra API features on top of the core Symfony Notifier component to allow developers to create notifications and send them to objects, such as users, other entities, or custom PHP objects.

This allows developers to focus on the notification needing to be sent, and not need to concern themselves with how recipient phone numbers, emails, etc are produced.

Mapping

The mapping of objects to a recipient type is collected by the \Drupal\notifier\Recipients\Event\Recipients event, in most cases though, Notifier can do this for you with entity field mapping, implementing an interface on a bundle class or PHP object, or the user entity email field. Otherwise, an API is available for advanced use cases.

Sender service

Autowiring

The recipient service is autowired with \Drupal\notifier\Sender\SenderInterface.

Service example

services:
  _defaults:
    autowire: true
    
  my_service:
    class: Drupal\my_module\MyService

namespace Drupal\my_module;

final class MyService {

  public function __construct(
    private readonly \Drupal\notifier\Sender\SenderInterface $sender,
  ) {}

  public function myMethod(){
    $user = User::load(1);
    $notification = (new \Symfony\Component\Notifier\Notification\Notification())
      ->subject('Test subject!')
      ->content('Test message');
    $this->notifier->send(for: $user, notification: $notification);
  }

}

Controller example

my_module.my_controller:
  path: '/my_controller'
  defaults:
    _controller: '\Drupal\my_module\Controller\MyController'

namespace Drupal\my_module\Controller;

final class MyController {

  use \Drupal\Core\DependencyInjection\AutowireTrait;

  public function __construct(
    private readonly \Drupal\notifier\Sender\SenderInterface $sender,
  ) {}

  public function __invoke(){
    $user = User::load(1);
    $notification = (new \Symfony\Component\Notifier\Notification\Notification())
      ->subject('Test subject!')
      ->content('Test message');
    $this->notifier->send(for: $user, notification: $notification);
  }

}

Drupal locator

The \Drupal class or manually injected variant is not recommended as it may be removed as an unused public dependency from the service container. It also makes unit testing difficult.

namespace Drupal\my_module\Controller;

final class MyThing {

  public function myMethod(){
    /** @var \Drupal\notifier\Sender\SenderInterface $sender */
    $sender = \Drupal::service(\Drupal\notifier\Sender\SenderInterface::class);
    
    $user = User::load(1);
    $notification = (new \Symfony\Component\Notifier\Notification\Notification())
      ->subject('Test subject!')
      ->content('Test message');
    $sender->send(for: $user, notification: $notification);
  }

}