\Cake\TestSuiteEmailAssertTrait

Email and mailer assertions.

Summary

Methods

Properties

Constants

send()
email()
getMockForMailer()
assertEmailMessageContains()
assertEmailHtmlMessageContains()
assertEmailTextMessageContains()
assertEmailSubject()
assertEmailFrom()
assertEmailCc()
assertEmailCcContains()
assertEmailBcc()
assertEmailBccContains()
assertEmailTo()
assertEmailToContains()
assertEmailAttachmentsContains()
any()
assertSame()
assertTextContains()
getMockBuilder()

No public properties found

No constants found

No protected methods found

$_email

N/A

No private methods found

No private properties found

N/A

File: vendor/cakephp/cakephp/src/TestSuite/EmailAssertTrait.php
Package: Default
Class hierarchy: \Cake\TestSuite\EmailAssertTrait

Properties

$_email

$_email : \Cake\Mailer\Email

Type

\Cake\Mailer\Email

Methods

send()

send(array|string|null  $content = null) : void

Sends email using the test email instance.

Parameters

array|string|null

$content

The email's content to send.

email()

email(boolean  $new = false) : \Cake\Mailer\Email

Creates an email instance overriding its transport for testing purposes.

Parameters

boolean

$new

Tells if new instance should forcibly be created.

Returns

\Cake\Mailer\Email

getMockForMailer()

getMockForMailer(string  $className, array  $methods = array()) : \Cake\Mailer\Mailer|\PHPUnit_Framework_MockObject_MockObject

Generates mock for given mailer class.

Parameters

string	$className	The mailer's FQCN.
array	$methods	The methods to mock on the mailer.

Returns

\Cake\Mailer\Mailer|\PHPUnit_Framework_MockObject_MockObject

assertEmailMessageContains()

assertEmailMessageContains(string  $needle, string|null  $message = null) : void

Asserts email content (both text and HTML) contains `$needle`.

Parameters

string	$needle	Text to look for.
string\|null	$message	The failure message to define.

assertEmailHtmlMessageContains()

assertEmailHtmlMessageContains(string  $needle, string|null  $message = null) : void

Asserts HTML email content contains `$needle`.

Parameters

string	$needle	Text to look for.
string\|null	$message	The failure message to define.

assertEmailTextMessageContains()

assertEmailTextMessageContains(string  $needle, string|null  $message = null) : void

Asserts text email content contains `$needle`.

Parameters

string	$needle	Text to look for.
string\|null	$message	The failure message to define.

assertEmailSubject()

assertEmailSubject(string  $expected, string|null  $message = null) : void

Asserts email's subject contains `$expected`.

Parameters

string	$expected	Email's subject.
string\|null	$message	The failure message to define.

assertEmailFrom()

assertEmailFrom(string  $email, string|null  $name = null, string|null  $message = null) : void

Asserts email's sender email address and optionally name.

Parameters

string	$email	Sender's email address.
string\|null	$name	Sender's name.
string\|null	$message	The failure message to define.

assertEmailCc()

assertEmailCc(string  $email, string|null  $name = null, string|null  $message = null) : void

Asserts email is CC'd to only one email address (and optionally name).

Parameters

string	$email	CC'd email address.
string\|null	$name	CC'd person name.
string\|null	$message	The failure message to define.

assertEmailCcContains()

assertEmailCcContains(string  $email, string|null  $name = null, string|null  $message = null) : void

Asserts email CC'd addresses contain given email address (and optionally name).

Parameters

string	$email	CC'd email address.
string\|null	$name	CC'd person name.
string\|null	$message	The failure message to define.

assertEmailBcc()

assertEmailBcc(string  $email, string|null  $name = null, string|null  $message = null) : void

Asserts email is BCC'd to only one email address (and optionally name).

Parameters

string	$email	BCC'd email address.
string\|null	$name	BCC'd person name.
string\|null	$message	The failure message to define.

assertEmailBccContains()

assertEmailBccContains(string  $email, string|null  $name = null, string|null  $message = null) : void

Asserts email BCC'd addresses contain given email address (and optionally name).

Parameters

string	$email	BCC'd email address.
string\|null	$name	BCC'd person name.
string\|null	$message	The failure message to define.

assertEmailTo()

assertEmailTo(string  $email, string|null  $name = null, string|null  $message = null) : void

Asserts email is sent to only the given recipient's address (and optionally name).

Parameters

string	$email	Recipient's email address.
string\|null	$name	Recipient's name.
string\|null	$message	The failure message to define.

assertEmailToContains()

assertEmailToContains(string  $email, string|null  $name = null, string|null  $message = null) : void

Asserts email recipients' list contains given email address (and optionally name).

Parameters

string	$email	Recipient's email address.
string\|null	$name	Recipient's name.
string\|null	$message	The failure message to define.

assertEmailAttachmentsContains()

assertEmailAttachmentsContains(string  $filename, array|null  $file = null, string|null  $message = null) : void

Asserts the email attachments contain the given filename (and optionally file info).

Parameters

string	$filename	Expected attachment's filename.
array\|null	$file	Expected attachment's file info.
string\|null	$message	The failure message to define.

any()

any()

assertSame()

assertSame()

assertTextContains()

assertTextContains()

getMockBuilder()

getMockBuilder()