vendor/symfony/mailer/EventListener/EnvelopeListener.php line 43

  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\Mime\Address;
  17. use Symfony\Component\Mime\Message;
  19. /**
  20.  * Manipulates the Envelope of a Message.
  21.  *
  22.  * @author Fabien Potencier <fabien@symfony.com>
  23.  */
  24. class EnvelopeListener implements EventSubscriberInterface
  25. {
  26.     private ?Address $sender = null;
  28.     /**
  29.      * @var Address[]|null
  30.      */
  31.     private ?array $recipients = null;
  33.     /**
  34.      * @param array<Address|string> $recipients
  35.      */
  36.     public function __construct(Address|string|null $sender = null, ?array $recipients = null)
  37.     {
  38.         if (null !== $sender) {
  39.             $this->sender = Address::create($sender);
  40.         }
  41.         if (null !== $recipients) {
  42.             $this->recipients = Address::createArray($recipients);
  43.         }
  44.     }
  46.     public function onMessage(MessageEvent $event): void
  47.     {
  48.         if ($this->sender) {
  49.             $event->getEnvelope()->setSender($this->sender);
  51.             $message = $event->getMessage();
  52.             if ($message instanceof Message) {
  53.                 if (!$message->getHeaders()->has('Sender') && !$message->getHeaders()->has('From')) {
  54.                     $message->getHeaders()->addMailboxHeader('Sender', $this->sender);
  55.                 }
  56.             }
  57.         }
  59.         if ($this->recipients) {
  60.             $event->getEnvelope()->setRecipients($this->recipients);
  61.         }
  62.     }
  64.     public static function getSubscribedEvents(): array
  65.     {
  66.         return [
  67.             // should be the last one to allow header changes by other listeners first
  68.             MessageEvent::class => ['onMessage', -255],
  69.         ];
  70.     }
  71. }