\Cake\TestSuiteEmailTrait

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.

Summary

Methods

Properties

Constants

setupTransports()
cleanupEmailTrait()
assertMailCount()
assertNoMailSent()
assertMailSentToAt()
assertMailSentFromAt()
assertMailContainsAt()
assertMailContainsHtmlAt()
assertMailContainsTextAt()
assertMailSentWithAt()
assertMailSentTo()
assertMailSentFrom()
assertMailContains()
assertMailContainsHtml()
assertMailContainsText()
assertMailSentWith()

No public properties found

No constants found

No protected methods found

No protected properties found

N/A

No private methods found

No private properties found

N/A

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

Methods

setupTransports()

setupTransports() : void

Replaces all transports with the test transport during test setup

Inherited from: \Cake\TestSuite\EmailTrait

Tags

after

assertMailCount()

assertMailCount(integer  $count, string  $message = null) : void

Asserts an expected number of emails were sent

Parameters

integer	$count	Email count
string	$message	Message

assertNoMailSent()

assertNoMailSent(string  $message = null) : void

Asserts that no emails were sent

Parameters

string

$message

Message

assertMailSentToAt()

assertMailSentToAt(integer  $at, integer  $address, string  $message = null) : void

Asserts an email at a specific index was sent to an address

Parameters

integer	$at	Email index
integer	$address	Email address
string	$message	Message

assertMailSentFromAt()

assertMailSentFromAt(integer  $at, integer  $address, string  $message = null) : void

Asserts an email at a specific index was sent from an address

Parameters

integer	$at	Email index
integer	$address	Email address
string	$message	Message

assertMailContainsAt()

assertMailContainsAt(integer  $at, integer  $contents, string  $message = null) : void

Asserts an email at a specific index contains expected contents

Parameters

integer	$at	Email index
integer	$contents	Contents
string	$message	Message

assertMailContainsHtmlAt()

assertMailContainsHtmlAt(integer  $at, integer  $contents, string  $message = null) : void

Asserts an email at a specific index contains expected html contents

Parameters

integer	$at	Email index
integer	$contents	Contents
string	$message	Message

assertMailContainsTextAt()

assertMailContainsTextAt(integer  $at, integer  $contents, string  $message = null) : void

Asserts an email at a specific index contains expected text contents

Parameters

integer	$at	Email index
integer	$contents	Contents
string	$message	Message

assertMailSentWithAt()

assertMailSentWithAt(integer  $at, integer  $expected, integer  $parameter, string  $message = null) : void

Asserts an email at a specific index contains the expected value within an Email getter

Parameters

integer	$at	Email index
integer	$expected	Contents
integer	$parameter	Email getter parameter (e.g. "cc", "subject")
string	$message	Message

assertMailSentTo()

assertMailSentTo(integer  $address, string  $message = null) : void

Asserts an email was sent to an address

Parameters

integer	$address	Email address
string	$message	Message

assertMailSentFrom()

assertMailSentFrom(integer  $address, string  $message = null) : void

Asserts an email was sent from an address

Parameters

integer	$address	Email address
string	$message	Message

assertMailContains()

assertMailContains(integer  $contents, string  $message = null) : void

Asserts an email contains expected contents

Parameters

integer	$contents	Contents
string	$message	Message

assertMailContainsHtml()

assertMailContainsHtml(integer  $contents, string  $message = null) : void

Asserts an email contains expected html contents

Parameters

integer	$contents	Contents
string	$message	Message

assertMailContainsText()

assertMailContainsText(integer  $contents, string  $message = null) : void

Asserts an email contains expected text contents

Parameters

integer	$contents	Contents
string	$message	Message

assertMailSentWith()

assertMailSentWith(integer  $expected, integer  $parameter, string  $message = null) : void

Asserts an email contains the expected value within an Email getter

Parameters

integer	$expected	Contents
integer	$parameter	Email getter parameter (e.g. "cc", "subject")
string	$message	Message