class TestPhpMailFailure

Defines a mail sending implementation that returns false.

This class is for running tests or for development. To use set the configuration:

config('system.mail')
  ->set('interface.default', 'Drupal\\system_mail_failure_test\\TestPhpMailFailure')
  ->save();

Hierarchy

Expanded class hierarchy of TestPhpMailFailure

File

drupal/core/modules/system/tests/modules/system_mail_failure_test/lib/Drupal/system_mail_failure_test/TestPhpMailFailure.php, line 22

Contains \Drupal\system_mail_failure_test\TestPhpMailFailure.

Namespace

class TestPhpMailFailure extends PhpMail implements MailInterface {

  /**
   * Overrides Drupal\Core\Mail\PhpMail::mail().
   */
  public function mail(array $message) {

    // Instead of attempting to send a message, just return failure.
    return FALSE;
  }

}

Members

Name contains

Name does not contain

Type

Name	Modifiers	Type	Description	Overrides
PhpMail::format	public	function	Concatenates and wraps the e-mail body for plain-text mails. Overrides MailInterface::format
TestPhpMailFailure::mail	public	function	Overrides Drupal\Core\Mail\PhpMail::mail(). Overrides PhpMail::mail