BeforeMailerSentMessageEventTest.php

Go to the documentation of this file.

<?php
 
declare(strict_types=1);
 
/*
 * This file is part of the TYPO3 CMS project.
 *
 * It is free software; you can redistribute it and/or modify it under
 * the terms of the GNU General Public License, either version 2
 * of the License, or any later version.
 *
 * For the full copyright and license information, please read the
 * LICENSE.txt file that was distributed with this source code.
 *
 * The TYPO3 project - inspiring people to share!
 */
 
namespace ‪TYPO3\CMS\Core\Tests\Unit\Mail\Event;
 
use PHPUnit\Framework\Attributes\Test;
use Symfony\Component\Mailer\Envelope;
use Symfony\Component\Mailer\Transport\SendmailTransport;
use Symfony\Component\Mime\Address;
use Symfony\Component\Mime\Email;
use ‪TYPO3\CMS\Core\Mail\Event\BeforeMailerSentMessageEvent;
use ‪TYPO3\CMS\Core\Mail\Mailer;
use ‪TYPO3\CMS\Core\Mail\TransportFactory;
use ‪TYPO3\CMS\Core\Utility\GeneralUtility;
use TYPO3\TestingFramework\Core\Unit\UnitTestCase;
 
final class ‪BeforeMailerSentMessageEventTest extends UnitTestCase
{
    protected bool ‪$resetSingletonInstances = true;
 
    protected function ‪setUp(): void
    {
        parent::setUp();
 
        $transportFactory = $this->createMock(TransportFactory::class);
        $transportFactory->method('get')->with(self::anything())->willReturn($this->createMock(SendmailTransport::class));
        GeneralUtility::setSingletonInstance(TransportFactory::class, $transportFactory);
    }
 
    #[Test]
    public function ‪gettersReturnInitializedObjects(): void
    {
        $mailer = (new ‪Mailer());
        $rawMessage = (new Email())->subject('some subject');
        $envelope = (new Envelope(new Address('kasperYYYY@typo3.org'), [new Address('acme@example.com')]));
 
        $event = new ‪BeforeMailerSentMessageEvent($mailer, $rawMessage, $envelope);
 
        self::assertEquals($mailer, $event->getMailer());
        self::assertEquals($rawMessage, $event->getMessage());
        self::assertEquals($envelope, $event->getEnvelope());
    }
    #[Test]
    public function ‪modifyingInitializedObjects(): void
    {
        $mailer = (new ‪Mailer());
        $rawMessage = (new Email())->subject('some subject');
        $envelope = (new Envelope(new Address('kasperYYYY@typo3.org'), [new Address('acme@example.com')]));
 
        $event = new ‪BeforeMailerSentMessageEvent($mailer, $rawMessage, $envelope);
 
        // can modify message
        $modifiedMessage = $rawMessage->subject('modified subject');
        $event->setMessage($modifiedMessage);
        self::assertEquals($modifiedMessage, $event->getMessage());
 
        // can modify envelope
        $envelope->setSender(new Address('modified.sender@typo3.org'));
        $event->setEnvelope($envelope);
        self::assertEquals($envelope, $event->getEnvelope());
 
        // can unset envelope
        $event->setEnvelope();
        self::assertNull($event->getEnvelope());
    }
}