DrupalWebTestCase::drupalGetMails

Gets an array containing all e-mails sent during this test case.

Parameters

$filter: An array containing key/value pairs used to filter the e-mails that are returned.

Return value

An array containing e-mail messages captured during the current test.

File

modules/simpletest/drupal_web_test_case.php, line 2684

Code

protected function drupalGetMails($filter = array()) {
  $captured_emails = variable_get('drupal_test_email_collector', array());
  $filtered_emails = array();

  foreach ($captured_emails as $message) {
    foreach ($filter as $key => $value) {
      if (!isset($message[$key]) || $message[$key] != $value) {
        continue 2;
      }
    }
    $filtered_emails[] = $message;
  }

  return $filtered_emails;
}