added tests for sending message objects and ensure mailer and mime assertions can handle Message objects as well

Author: Rico Kritz

config/routes.php

@@ -88,4 +88,8 @@
     $routes->add('send_email', '/send-email')
         ->controller(App\Controller\SendEmailController::class)
         ->methods(['GET']);
+
+    $routes->add('send_message', '/send-message')
+        ->controller(App\Controller\SendMessageController::class)
+        ->methods(['GET']);
 };

src/Controller/SendMessageController.php

@@ -0,0 +1,25 @@
+<?php
+
+declare(strict_types=1);
+
+namespace App\Controller;
+
+use App\Entity\User;
+use App\Utils\Mailer;
+use Symfony\Bundle\FrameworkBundle\Controller\AbstractController;
+use Symfony\Component\HttpFoundation\Response;
+
+final class SendMessageController extends AbstractController
+{
+    public function __construct(
+        private readonly Mailer $mailer,
+    ) {
+    }
+
+    public function __invoke(): Response
+    {
+        $this->mailer->sendMessage((new User())->setEmail('jane_doe@example.com'));
+
+        return $this->json(['message' => 'Message sent successfully']);
+    }
+}

src/Utils/Mailer.php

@@ -8,6 +8,9 @@
 use Symfony\Bridge\Twig\Mime\TemplatedEmail;
 use Symfony\Component\Mailer\MailerInterface;
 use Symfony\Component\Mime\Address;
+use Symfony\Component\Mime\Header\Headers;
+use Symfony\Component\Mime\Message;
+use Symfony\Component\Mime\Part\TextPart;
 
 final readonly class Mailer
 {
@@ -30,4 +33,19 @@ public function sendConfirmationEmail(User $user): TemplatedEmail
 
         return $email;
     }
+
+    public function sendMessage(User $user): Message
+    {
+        $message = new Message(
+            (new Headers())
+                ->addMailboxListHeader('From', [new Address('jeison_doe@gmail.com', 'No Reply')])
+                ->addMailboxListHeader('To', [new Address($user->getEmail())])
+                ->addTextHeader('Subject', 'Text message'),
+            new TextPart('Message body content'),
+        );
+
+        $this->mailer->send($message);
+
+        return $message;
+    }
 }

tests/Functional/IssuesCest.php

@@ -7,6 +7,7 @@
 use App\Entity\User;
 use App\Tests\Support\FunctionalTester;
 use Doctrine\DBAL\Connection;
+use Symfony\Component\Mime\Message;
 
 final class IssuesCest
 {
@@ -53,4 +54,17 @@ public function runSymfonyConsoleCommandIgnoresSpecificOptions(FunctionalTester
         $numRecords = $I->grabNumRecords(User::class);
         $I->assertSame(1, $numRecords);
     }
+
+    /**
+     * @see https://github.com/Codeception/module-symfony/pull/232
+     */
+    public function ensureMessageObjectsCanBeFetched(FunctionalTester $I)
+    {
+        $I->amOnPage('/send-message');
+        $I->seeEmailIsSent(1);
+        $I->assertEmailAddressContains('To', 'jane_doe@example.com');
+        $I->assertEmailHeaderSame('To', 'jane_doe@example.com');
+        $I->assertEmailHeaderSame('Subject', 'Text message');
+        $I->assertInstanceOf(Message::class, $I->grabLastSentEmail());
+    }
 }