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

  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\Component\EventDispatcher\EventSubscriberInterface;
  15. use Symfony\Component\Mailer\Event\MessageEvent;
  16. use Symfony\Component\Mailer\Exception\InvalidArgumentException;
  17. use Symfony\Component\Mailer\Exception\RuntimeException;
  18. use Symfony\Component\Mime\BodyRendererInterface;
  19. use Symfony\Component\Mime\Header\Headers;
  20. use Symfony\Component\Mime\Header\MailboxListHeader;
  21. use Symfony\Component\Mime\Message;
  23. /**
  24.  * Manipulates the headers and the body of a Message.
  25.  *
  26.  * @author Fabien Potencier <fabien@symfony.com>
  27.  */
  28. class MessageListener implements EventSubscriberInterface
  29. {
  30.     public const HEADER_SET_IF_EMPTY = 1;
  31.     public const HEADER_ADD = 2;
  32.     public const HEADER_REPLACE = 3;
  33.     public const DEFAULT_RULES = [
  34.         'from' => self::HEADER_SET_IF_EMPTY,
  35.         'return-path' => self::HEADER_SET_IF_EMPTY,
  36.         'reply-to' => self::HEADER_ADD,
  37.         'to' => self::HEADER_SET_IF_EMPTY,
  38.         'cc' => self::HEADER_ADD,
  39.         'bcc' => self::HEADER_ADD,
  40.     ];
  42.     private ?Headers $headers;
  43.     private array $headerRules = [];
  44.     private ?BodyRendererInterface $renderer;
  46.     public function __construct(Headers $headers = null, BodyRendererInterface $renderer = null, array $headerRules = self::DEFAULT_RULES)
  47.     {
  48.         $this->headers = $headers;
  49.         $this->renderer = $renderer;
  50.         foreach ($headerRules as $headerName => $rule) {
  51.             $this->addHeaderRule($headerName, $rule);
  52.         }
  53.     }
  55.     public function addHeaderRule(string $headerName, int $rule): void
  56.     {
  57.         if ($rule < 1 || $rule > 3) {
  58.             throw new InvalidArgumentException(sprintf('The "%d" rule is not supported.', $rule));
  59.         }
  61.         $this->headerRules[strtolower($headerName)] = $rule;
  62.     }
  64.     public function onMessage(MessageEvent $event): void
  65.     {
  66.         $message = $event->getMessage();
  67.         if (!$message instanceof Message) {
  68.             return;
  69.         }
  71.         $this->setHeaders($message);
  72.         $this->renderMessage($message);
  73.     }
  75.     private function setHeaders(Message $message): void
  76.     {
  77.         if (!$this->headers) {
  78.             return;
  79.         }
  81.         $headers = $message->getHeaders();
  82.         foreach ($this->headers->all() as $name => $header) {
  83.             if (!$headers->has($name)) {
  84.                 $headers->add($header);
  86.                 continue;
  87.             }
  89.             switch ($this->headerRules[$name] ?? self::HEADER_SET_IF_EMPTY) {
  90.                 case self::HEADER_SET_IF_EMPTY:
  91.                     break;
  93.                 case self::HEADER_REPLACE:
  94.                     $headers->remove($name);
  95.                     $headers->add($header);
  97.                     break;
  99.                 case self::HEADER_ADD:
  100.                     if (!Headers::isUniqueHeader($name)) {
  101.                         $headers->add($header);
  103.                         break;
  104.                     }
  106.                     $h = $headers->get($name);
  107.                     if (!$h instanceof MailboxListHeader) {
  108.                         throw new RuntimeException(sprintf('Unable to set header "%s".', $name));
  109.                     }
  111.                     Headers::checkHeaderClass($header);
  112.                     foreach ($header->getAddresses() as $address) {
  113.                         $h->addAddress($address);
  114.                     }
  115.             }
  116.         }
  117.     }
  119.     private function renderMessage(Message $message): void
  120.     {
  121.         if (!$this->renderer) {
  122.             return;
  123.         }
  125.         $this->renderer->render($message);
  126.     }
  128.     public static function getSubscribedEvents(): array
  129.     {
  130.         return [
  131.             MessageEvent::class => 'onMessage',
  132.         ];
  133.     }
  134. }