Skip to content

Commit bfc25c7

Browse files
Mentioning Symfony Mailer requirement in v2.0.0 (#126)
1 parent c2f8518 commit bfc25c7

File tree

1 file changed

+4
-0
lines changed

1 file changed

+4
-0
lines changed

src/Codeception/Module/Symfony/MailerAssertionsTrait.php

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -15,6 +15,7 @@ trait MailerAssertionsTrait
1515
* Checks that no email was sent.
1616
* The check is based on `\Symfony\Component\Mailer\EventListener\MessageLoggerListener`, which means:
1717
* 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.
18+
* Starting with version 2.0.0, `codeception/module-symfony` requires your app to use [Symfony Mailer](https://symfony.com/doc/current/mailer.html). If your app still uses [Swift Mailer](https://symfony.com/doc/current/email.html), set your version constraint to `^1.6`.
1819
*/
1920
public function dontSeeEmailIsSent(): void
2021
{
@@ -25,6 +26,7 @@ public function dontSeeEmailIsSent(): void
2526
* Checks if the given number of emails was sent (default `$expectedCount`: 1).
2627
* The check is based on `\Symfony\Component\Mailer\EventListener\MessageLoggerListener`, which means:
2728
* 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.
29+
* Starting with version 2.0.0, `codeception/module-symfony` requires your app to use [Symfony Mailer](https://symfony.com/doc/current/mailer.html). If your app still uses [Swift Mailer](https://symfony.com/doc/current/email.html), set your version constraint to `^1.6`.
2830
*
2931
* ```php
3032
* <?php
@@ -42,6 +44,7 @@ public function seeEmailIsSent(int $expectedCount = 1): void
4244
* Returns the last sent email.
4345
* The function is based on `\Symfony\Component\Mailer\EventListener\MessageLoggerListener`, which means:
4446
* 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.
47+
* Starting with version 2.0.0, `codeception/module-symfony` requires your app to use [Symfony Mailer](https://symfony.com/doc/current/mailer.html). If your app still uses [Swift Mailer](https://symfony.com/doc/current/email.html), set your version constraint to `^1.6`.
4548
* See also: [grabSentEmails()](https://codeception.com/docs/modules/Symfony#grabSentEmails)
4649
*
4750
* ```php
@@ -67,6 +70,7 @@ public function grabLastSentEmail(): ?Email
6770
* Returns an array of all sent emails.
6871
* The function is based on `\Symfony\Component\Mailer\EventListener\MessageLoggerListener`, which means:
6972
* 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.
73+
* Starting with version 2.0.0, `codeception/module-symfony` requires your app to use [Symfony Mailer](https://symfony.com/doc/current/mailer.html). If your app still uses [Swift Mailer](https://symfony.com/doc/current/email.html), set your version constraint to `^1.6`.
7074
* See also: [grabLastSentEmail()](https://codeception.com/docs/modules/Symfony#grabLastSentEmail)
7175
*
7276
* ```php

0 commit comments

Comments
 (0)