vendor/symfony/mailer/EventListener/MessageListener.php line 66

Open in your IDE?
  1. <?php
  3. /*
  4.  * This file is part of the Symfony package.
  5.  *
  6.  * (c) Fabien Potencier <fabien@symfony.com>
  7.  *
  8.  * For the full copyright and license information, please view the LICENSE
  9.  * file that was distributed with this source code.
  10.  */
  12. namespace Symfony\Component\Mailer\EventListener;
  14. use Symfony\Bridge\Twig\Mime\TemplatedEmail;
  15. use Symfony\Component\EventDispatcher\EventSubscriberInterface;
  16. use Symfony\Component\Mailer\Event\MessageEvent;
  17. use Symfony\Component\Mailer\Exception\InvalidArgumentException;
  18. use Symfony\Component\Mailer\Exception\LogicException;
  19. use Symfony\Component\Mailer\Exception\RuntimeException;
  20. use Symfony\Component\Mime\BodyRendererInterface;
  21. use Symfony\Component\Mime\Header\Headers;
  22. use Symfony\Component\Mime\Header\MailboxListHeader;
  23. use Symfony\Component\Mime\Message;
  25. /**
  26.  * Manipulates the headers and the body of a Message.
  27.  *
  28.  * @author Fabien Potencier <fabien@symfony.com>
  29.  */
  30. class MessageListener implements EventSubscriberInterface
  31. {
  32.     public const HEADER_SET_IF_EMPTY = 1;
  33.     public const HEADER_ADD = 2;
  34.     public const HEADER_REPLACE = 3;
  35.     public const DEFAULT_RULES = [
  36.         'from' => self::HEADER_SET_IF_EMPTY,
  37.         'return-path' => self::HEADER_SET_IF_EMPTY,
  38.         'reply-to' => self::HEADER_ADD,
  39.         'to' => self::HEADER_SET_IF_EMPTY,
  40.         'cc' => self::HEADER_ADD,
  41.         'bcc' => self::HEADER_ADD,
  42.     ];
  44.     private ?Headers $headers;
  45.     private array $headerRules = [];
  46.     private ?BodyRendererInterface $renderer;
  48.     public function __construct(Headers $headers = null, BodyRendererInterface $renderer = null, array $headerRules = self::DEFAULT_RULES)
  49.     {
  50.         $this->headers = $headers;
  51.         $this->renderer = $renderer;
  52.         foreach ($headerRules as $headerName => $rule) {
  53.             $this->addHeaderRule($headerName, $rule);
  54.         }
  55.     }
  57.     public function addHeaderRule(string $headerName, int $rule): void
  58.     {
  59.         if ($rule < 1 || $rule > 3) {
  60.             throw new InvalidArgumentException(sprintf('The "%d" rule is not supported.', $rule));
  61.         }
  63.         $this->headerRules[strtolower($headerName)] = $rule;
  64.     }
  66.     public function onMessage(MessageEvent $event): void
  67.     {
  68.         $message = $event->getMessage();
  69.         if (!$message instanceof Message) {
  70.             return;
  71.         }
  73.         $this->setHeaders($message);
  74.         $this->renderMessage($message);
  75.     }
  77.     private function setHeaders(Message $message): void
  78.     {
  79.         if (!$this->headers) {
  80.             return;
  81.         }
  83.         $headers = $message->getHeaders();
  84.         foreach ($this->headers->all() as $name => $header) {
  85.             if (!$headers->has($name)) {
  86.                 $headers->add($header);
  88.                 continue;
  89.             }
  91.             switch ($this->headerRules[$name] ?? self::HEADER_SET_IF_EMPTY) {
  92.                 case self::HEADER_SET_IF_EMPTY:
  93.                     break;
  95.                 case self::HEADER_REPLACE:
  96.                     $headers->remove($name);
  97.                     $headers->add($header);
  99.                     break;
  101.                 case self::HEADER_ADD:
  102.                     if (!Headers::isUniqueHeader($name)) {
  103.                         $headers->add($header);
  105.                         break;
  106.                     }
  108.                     $h = $headers->get($name);
  109.                     if (!$h instanceof MailboxListHeader) {
  110.                         throw new RuntimeException(sprintf('Unable to set header "%s".', $name));
  111.                     }
  113.                     Headers::checkHeaderClass($header);
  114.                     foreach ($header->getAddresses() as $address) {
  115.                         $h->addAddress($address);
  116.                     }
  117.             }
  118.         }
  119.     }
  121.     private function renderMessage(Message $message): void
  122.     {
  123.         if (!$this->renderer) {
  124.             if ($message instanceof TemplatedEmail && ($message->getTextTemplate() || $message->getHtmlTemplate())) {
  125.                 throw new LogicException(sprintf('You must configure a "%s" when a "%s" instance has a text or HTML template set.', BodyRendererInterface::class, get_debug_type($message)));
  126.             }
  128.             return;
  129.         }
  131.         $this->renderer->render($message);
  132.     }
  134.     public static function getSubscribedEvents(): array
  135.     {
  136.         return [
  137.             MessageEvent::class => 'onMessage',
  138.         ];
  139.     }
  140. }