Trait EmailAssertTrait
Email and mailer assertions.
Properties summary
- $_email protected
\Cake\Mailer\Email
Method Summary
- any() public
- assertEmailAttachmentsContains() public
Asserts the email attachments contain the given filename (and optionally file info).
- assertEmailBccContains() public
Asserts email BCC'd addresses contain given email address (and optionally name).
- assertEmailCcContains() public
Asserts email CC'd addresses contain given email address (and optionally name).
- assertEmailTo() public
Asserts email is sent to only the given recipient's address (and optionally name).
- assertEmailToContains() public
Asserts email recipients' list contains given email address (and optionally name).
- assertSame() public
- assertTextContains() public
- getMockBuilder() public
Method Detail
any() public
any()
assertEmailAttachmentsContains() public
assertEmailAttachmentsContains(mixed $filename, array $file, mixed $message)
Asserts the email attachments contain the given filename (and optionally file info).
Parameters
-
string$filename Expected attachment's filename.
-
array|null$file optional Expected attachment's file info.
-
string|null$message optional The failure message to define.
assertEmailBcc() public
assertEmailBcc(mixed $email, mixed $name, mixed $message)
Asserts email is BCC'd to only one email address (and optionally name).
Parameters
-
string$email BCC'd email address.
-
string|null$name optional BCC'd person name.
-
string|null$message optional The failure message to define.
assertEmailBccContains() public
assertEmailBccContains(mixed $email, mixed $name, mixed $message)
Asserts email BCC'd addresses contain given email address (and optionally name).
Parameters
-
string$email BCC'd email address.
-
string|null$name optional BCC'd person name.
-
string|null$message optional The failure message to define.
assertEmailCc() public
assertEmailCc(mixed $email, mixed $name, mixed $message)
Asserts email is CC'd to only one email address (and optionally name).
Parameters
-
string$email CC'd email address.
-
string|null$name optional CC'd person name.
-
string|null$message optional The failure message to define.
assertEmailCcContains() public
assertEmailCcContains(mixed $email, mixed $name, mixed $message)
Asserts email CC'd addresses contain given email address (and optionally name).
Parameters
-
string$email CC'd email address.
-
string|null$name optional CC'd person name.
-
string|null$message optional The failure message to define.
assertEmailFrom() public
assertEmailFrom(mixed $email, mixed $name, mixed $message)
Asserts email's sender email address and optionally name.
Parameters
-
string$email Sender's email address.
-
string|null$name optional Sender's name.
-
string|null$message optional The failure message to define.
assertEmailHtmlMessageContains() public
assertEmailHtmlMessageContains(mixed $needle, mixed $message)
Asserts HTML email content contains $needle.
Parameters
-
string$needle Text to look for.
-
string|null$message optional The failure message to define.
assertEmailMessageContains() public
assertEmailMessageContains(mixed $needle, mixed $message)
Asserts email content (both text and HTML) contains $needle.
Parameters
-
string$needle Text to look for.
-
string|null$message optional The failure message to define.
assertEmailSubject() public
assertEmailSubject(mixed $expected, mixed $message)
Asserts email's subject contains $expected.
Parameters
-
string$expected Email's subject.
-
string|null$message optional The failure message to define.
assertEmailTextMessageContains() public
assertEmailTextMessageContains(mixed $needle, mixed $message)
Asserts text email content contains $needle.
Parameters
-
string$needle Text to look for.
-
string|null$message optional The failure message to define.
assertEmailTo() public
assertEmailTo(mixed $email, mixed $name, mixed $message)
Asserts email is sent to only the given recipient's address (and optionally name).
Parameters
-
string$email Recipient's email address.
-
string|null$name optional Recipient's name.
-
string|null$message optional The failure message to define.
assertEmailToContains() public
assertEmailToContains(mixed $email, mixed $name, mixed $message)
Asserts email recipients' list contains given email address (and optionally name).
Parameters
-
string$email Recipient's email address.
-
string|null$name optional Recipient's name.
-
string|null$message optional The failure message to define.
assertSame() public
assertSame(mixed $expected, mixed $result, mixed $message)
Parameters
-
mixed$expected -
mixed$result -
mixed$message
assertTextContains() public
assertTextContains(mixed $needle, mixed $haystack, mixed $message)
Parameters
-
mixed$needle -
mixed$haystack -
mixed$message
email() public
email(mixed $new)
Creates an email instance overriding its transport for testing purposes.
Parameters
-
bool$new optional Tells if new instance should forcibly be created.
Returns
\Cake\Mailer\EmailgetMockBuilder() public
getMockBuilder(mixed $className)
Parameters
-
mixed$className
getMockForMailer() public
getMockForMailer(mixed $className, array $methods)
Generates mock for given mailer class.
Parameters
-
string$className The mailer's FQCN.
-
array$methods optional The methods to mock on the mailer.
Returns
\Cake\Mailer\Mailer|\PHPUnit_Framework_MockObject_MockObjectsend() public
send(mixed $content)
Sends email using the test email instance.
Parameters
-
array|string|null$content optional The email's content to send.
Property Detail
$_email protected
Type
\Cake\Mailer\Email
© 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/3.9/trait-Cake.TestSuite.EmailAssertTrait.html