Make assertions on emails sent through the Cake\TestSuite\TestEmailTransport
After adding the trait to your test case, all mail transports will be replaced with TestEmailTransport which is used for making assertions and will not actually send emails.
Asserts an email contains expected contents
Asserts an email at a specific index contains expected contents
Asserts an email contains expected attachment
Asserts an email contains expected html contents
Asserts an email at a specific index contains expected html contents
Asserts an email contains an expected text content
Asserts an email at a specific index contains expected text contents
Asserts an expected number of emails were sent
Asserts an email was sent from an address
Asserts an email at a specific index was sent from an address
Asserts an email was sent to an address
Asserts an email at a specific index was sent to an address
Asserts an email contains the expected value within an Email getter
Asserts an email at a specific index contains the expected value within an Email getter
Asserts an email subject contains expected contents
Asserts an email at a specific index contains expected html contents
Asserts that no emails were sent
Resets transport state
Replaces all transports with the test transport during test setup
assertMailContains(string $contents, string $message = ''): void
Asserts an email contains expected contents
string $contents Contents
string $message optional Message
voidassertMailContainsAt(int $at, string $contents, string $message = ''): void
Asserts an email at a specific index contains expected contents
int $at Email index
string $contents Contents
string $message optional Message
voidassertMailContainsAttachment(string $filename, array $file = [], string $message = ''): void
Asserts an email contains expected attachment
string $filename Filename
array $file optional Additional file properties
string $message optional Message
voidassertMailContainsHtml(string $contents, string $message = ''): void
Asserts an email contains expected html contents
string $contents Contents
string $message optional Message
voidassertMailContainsHtmlAt(int $at, string $contents, string $message = ''): void
Asserts an email at a specific index contains expected html contents
int $at Email index
string $contents Contents
string $message optional Message
voidassertMailContainsText(string $expected, string $message = ''): void
Asserts an email contains an expected text content
string $expected Expected text.
string $message optional Message to display if assertion fails.
voidassertMailContainsTextAt(int $at, string $contents, string $message = ''): void
Asserts an email at a specific index contains expected text contents
int $at Email index
string $contents Contents
string $message optional Message
voidassertMailCount(int $count, string $message = ''): void
Asserts an expected number of emails were sent
int $count Email count
string $message optional Message
voidassertMailSentFrom(string $address, string $message = ''): void
Asserts an email was sent from an address
string $address Email address
string $message optional Message
voidassertMailSentFromAt(int $at, string $address, string $message = ''): void
Asserts an email at a specific index was sent from an address
int $at Email index
string $address Email address
string $message optional Message
voidassertMailSentTo(string $address, string $message = ''): void
Asserts an email was sent to an address
string $address Email address
string $message optional Message
voidassertMailSentToAt(int $at, string $address, string $message = ''): void
Asserts an email at a specific index was sent to an address
int $at Email index
string $address Email address
string $message optional Message
voidassertMailSentWith(string $expected, string $parameter, string $message = ''): void
Asserts an email contains the expected value within an Email getter
string $expected Contents
string $parameter Email getter parameter (e.g. "cc", "subject")
string $message optional Message
voidassertMailSentWithAt(int $at, string $expected, string $parameter, string $message = ''): void
Asserts an email at a specific index contains the expected value within an Email getter
int $at Email index
string $expected Contents
string $parameter Email getter parameter (e.g. "cc", "bcc")
string $message optional Message
voidassertMailSubjectContains(string $contents, string $message = ''): void
Asserts an email subject contains expected contents
string $contents Contents
string $message optional Message
voidassertMailSubjectContainsAt(int $at, string $contents, string $message = ''): void
Asserts an email at a specific index contains expected html contents
int $at Email index
string $contents Contents
string $message optional Message
voidassertNoMailSent(string $message = ''): void
Asserts that no emails were sent
string $message optional Message
voidcleanupEmailTrait(): void
Resets transport state
voidsetupTransports(): void
Replaces all transports with the test transport during test setup
void
© 2005–present The Cake Software Foundation, Inc.
Licensed under the MIT License.
CakePHP is a registered trademark of Cake Software Foundation, Inc.
We are not endorsed by or affiliated with CakePHP.
https://api.cakephp.org/4.4/trait-Cake.TestSuite.EmailTrait.html