DrupalWebTestCase::assertMail

  1. drupal
    1. 8
    2. 7
Versions
7 protected DrupalWebTestCase::assertMail($name, $value = '', $message = '')

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.

Code

modules/simpletest/drupal_web_test_case.php, line 3313

<?php
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'));
}
?>