Explaining the stopFollowingRedirects() restriction for email (#118)

Author: ThomasLandauer

src/Codeception/Module/Symfony/MailerAssertionsTrait.php

@@ -13,17 +13,18 @@ trait MailerAssertionsTrait
 {
     /**
      * Checks that no email was sent.
+     * The check is based on `\Symfony\Component\Mailer\EventListener\MessageLoggerListener`, which means:
+     * If your app performs a HTTP redirect, you need to suppress it using [stopFollowingRedirects()](https://codeception.com/docs/modules/Symfony#stopFollowingRedirects) first; otherwise this check will *always* pass.
      */
     public function dontSeeEmailIsSent(): void
     {
         $this->assertThat($this->getMessageMailerEvents(), new MailerConstraint\EmailCount(0));
     }
 
     /**
-     * Checks if the desired number of emails was sent.
-     * Asserts that 1 email was sent by default, specify the `expectedCount` parameter to modify it.
-     * The email is checked using Symfony message logger, which means:
-     * * If your app performs a redirect after sending the email, you need to suppress it using [stopFollowingRedirects](https://codeception.com/docs/modules/Symfony#stopFollowingRedirects).
+     * Checks if the given number of emails was sent (default `$expectedCount`: 1).
+     * The check is based on `\Symfony\Component\Mailer\EventListener\MessageLoggerListener`, which means:
+     * If your app performs a HTTP redirect after sending the email, you need to suppress it using [stopFollowingRedirects()](https://codeception.com/docs/modules/Symfony#stopFollowingRedirects) first.
      *
      * ```php
      * <?php
@@ -39,6 +40,8 @@ public function seeEmailIsSent(int $expectedCount = 1): void
 
     /**
      * Returns the last sent email.
+     * The function is based on `\Symfony\Component\Mailer\EventListener\MessageLoggerListener`, which means:
+     * If your app performs a HTTP redirect after sending the email, you need to suppress it using [stopFollowingRedirects()](https://codeception.com/docs/modules/Symfony#stopFollowingRedirects) first.
      *
      * ```php
      * <?php
@@ -61,6 +64,8 @@ public function grabLastSentEmail(): ?Email
 
     /**
      * Returns an array of all sent emails.
+     * The function is based on `\Symfony\Component\Mailer\EventListener\MessageLoggerListener`, which means:
+     * If your app performs a HTTP redirect after sending the email, you need to suppress it using [stopFollowingRedirects()](https://codeception.com/docs/modules/Symfony#stopFollowingRedirects) first.
      *
      * ```php
      * <?php
@@ -90,4 +95,4 @@ protected function getMessageMailerEvents(): MessageEvents
 
         $this->fail("Emails can't be tested without Symfony Mailer service.");
     }
-}
+}