protected function WebTestBase::assertMail in Zircon Profile 8

Same name and namespace in other branches

8.0 core/modules/simpletest/src/WebTestBase.php \Drupal\simpletest\WebTestBase::assertMail()

Asserts that the most recently sent email 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: (optional) A message to display with the assertion. Do not translate messages: use \Drupal\Component\Utility\SafeMarkup::format() to embed variables in the message text, not t(). If left blank, a default message will be displayed.

$group: (optional) The group this message is in, which is displayed in a column in test output. Use 'Debug' to indicate this is debugging output. Do not translate this string. Defaults to 'Email'; most tests do not override this default.

Return value

TRUE on pass, FALSE on fail.

3 calls to WebTestBase::assertMail()

MailCaptureTest::testMailSend in core/modules/simpletest/src/Tests/MailCaptureTest.php: Test to see if the wrapper function is executed correctly.
UserAdminTest::testUserAdmin in core/modules/user/src/Tests/UserAdminTest.php: Registers a user and deletes it.
UserPasswordResetTest::testUserPasswordReset in core/modules/user/src/Tests/UserPasswordResetTest.php: Tests password reset functionality.

File

core/modules/simpletest/src/WebTestBase.php, line 2803: Contains \Drupal\simpletest\WebTestBase.

Class

WebTestBase: Test case for typical Drupal tests.

Namespace

Drupal\simpletest

Code

protected function assertMail($name, $value = '', $message = '', $group = 'Email') {
  $captured_emails = \Drupal::state()
    ->get('system.test_mail_collector') ?: array();
  $email = end($captured_emails);
  return $this
    ->assertTrue($email && isset($email[$name]) && $email[$name] == $value, $message, $group);
}

You are here