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 at a specific index contains expected html contents
Asserts an email at a specific index contains expected text contents
Asserts an email at a specific index contains the expected value within an Email getter
assertMailContains(string $contents, string $message)
Asserts an email contains expected contents
string $contents Contents
string $message optional Message
assertMailContainsAt(int $at, string $contents, string $message)
Asserts an email at a specific index contains expected contents
int $at Email index
string $contents Contents
string $message optional Message
assertMailContainsAttachment(string $filename, array $file, string $message)
Asserts an email contains expected attachment
string $filename Filename
array $file optional Additional file properties
string $message optional Message
assertMailContainsHtml(string $contents, string $message)
Asserts an email contains expected html contents
string $contents Contents
string $message optional Message
assertMailContainsHtmlAt(int $at, string $contents, string $message)
Asserts an email at a specific index contains expected html contents
int $at Email index
string $contents Contents
string $message optional Message
assertMailContainsText(string $expected, string $message)
Asserts an email contains an expected text content
string $expected Expected text.
string $message optional Message to display if assertion fails.
assertMailContainsTextAt(int $at, string $contents, string $message)
Asserts an email at a specific index contains expected text contents
int $at Email index
string $contents Contents
string $message optional Message
assertMailCount(int $count, string $message)
Asserts an expected number of emails were sent
int $count Email count
string $message optional Message
assertMailSentFrom(string $address, string $message)
Asserts an email was sent from an address
string $address Email address
string $message optional Message
assertMailSentFromAt(int $at, string $address, string $message)
Asserts an email at a specific index was sent from an address
int $at Email index
string $address Email address
string $message optional Message
assertMailSentTo(string $address, string $message)
Asserts an email was sent to an address
string $address Email address
string $message optional Message
assertMailSentToAt(int $at, string $address, string $message)
Asserts an email at a specific index was sent to an address
int $at Email index
string $address Email address
string $message optional Message
assertMailSentWith(string $expected, string $parameter, string $message)
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
assertMailSentWithAt(int $at, string $expected, string $parameter, string $message)
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", "subject")
string $message optional Message
assertNoMailSent(string $message)
Asserts that no emails were sent
string $message optional Message
cleanupEmailTrait()
Resets transport state
setupTransports()
Replaces all transports with the test transport during test setup
© 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.1/trait-Cake.TestSuite.EmailTrait.html