Skip to main content
Drupal API
User account menu
  • Log in

Breadcrumb

  1. Drupal Core 11.1.x
  2. AssertMailTrait.php

function AssertMailTrait::getMails

Gets an array containing all emails sent during this test case.

Parameters

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

Return value

array An array containing email messages captured during the current test.

2 calls to AssertMailTrait::getMails()
AssertMailTrait::assertMailPattern in core/lib/Drupal/Core/Test/AssertMailTrait.php
Asserts that the most recently sent email message has the pattern in it.
AssertMailTrait::assertMailString in core/lib/Drupal/Core/Test/AssertMailTrait.php
Asserts that the most recently sent email message has the string in it.

File

core/lib/Drupal/Core/Test/AssertMailTrait.php, line 22

Class

AssertMailTrait
Provides methods for testing emails sent during test runs.

Namespace

Drupal\Core\Test

Code

protected function getMails(array $filter = []) {
    $captured_emails = $this->container
        ->get('state')
        ->get('system.test_mail_collector', []);
    $filtered_emails = [];
    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;
}

API Navigation

  • Drupal Core 11.1.x
  • Topics
  • Classes
  • Functions
  • Constants
  • Globals
  • Files
  • Namespaces
  • Deprecated
  • Services
RSS feed
Powered by Drupal