class TestingMailSystem | Documentation

A mail sending implementation that captures sent messages to a variable.

This class is for running tests or for development.

Hierarchy

class DefaultMailSystem implements MailSystemInterface
- class TestingMailSystem implements MailSystemInterface

Expanded class hierarchy of TestingMailSystem

2 string references to 'TestingMailSystem'

BackdropWebTestCase::setUp in core/modules/simpletest/backdrop_web_test_case.php: Sets up a Backdrop site for running functional and integration tests.
system_autoload_info in core/modules/system/system.module: Implements hook_autoload_info().

File

core/modules/system/system.mail.inc, line 140: Backdrop core implementations of MailSystemInterface.

View source

class TestingMailSystem extends DefaultMailSystem implements MailSystemInterface {
  /**
   * Accept an email message and store it in a variable.
   *
   * @param $message
   *   An email message.
   */
  public function mail(array $message) {
    $captured_emails = state_get('test_email_collector', array());
    $captured_emails[] = $message;
    state_set('test_email_collector', $captured_emails);
    return TRUE;
  }
}

Members

Name	Modifiers	Type	Description
DefaultMailSystem::format	public	function	Concatenate and wrap the email body for plain-text mails. Overrides MailSystemInterface::format
DefaultMailSystem::_isShellSafe	protected static	function	Disallows potentially unsafe shell characters.
TestingMailSystem::mail	public	function	Accept an email message and store it in a variable. Overrides DefaultMailSystem::mail