function DrupalWebTestCase::assertMail

Asserts that the most recently sent e-mail message has the given value.

The field in $name must have the content described in $value.

Parameters

$name: Name of field or message property to assert. Examples: subject, body, id, ...

$value: Value of the field to assert.

$message: Message to display.

Return value

TRUE on pass, FALSE on fail.

3 calls to DrupalWebTestCase::assertMail()
SimpleTestMailCaptureTestCase::testMailSend in modules/simpletest/simpletest.test
Test to see if the wrapper function is executed correctly.
TriggerActionTestCase::assertSystemEmailTokenReplacement in modules/trigger/trigger.test
Asserts correct token replacement for the given trigger and account.
UserAdminTestCase::testUserAdmin in modules/user/user.test
Registers a user and deletes it.

File

modules/simpletest/drupal_web_test_case.php, line 3981

Class

DrupalWebTestCase
Test case for typical Drupal tests.

Code

protected function assertMail($name, $value = '', $message = '') {
    $captured_emails = variable_get('drupal_test_email_collector', array());
    $email = end($captured_emails);
    return $this->assertTrue($email && isset($email[$name]) && $email[$name] == $value, $message, t('E-mail'));
}

Buggy or inaccurate documentation? Please file an issue. Need support? Need help programming? Connect with the Drupal community.