class TestPhpMailFailure

Defines a mail sending implementation that always fails.

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

\Drupal::configFactory()->getEditable('system.mail')
  ->set('interface.default', 'test_php_mail_failure')
  ->save();

Plugin annotation

@Mail(
  id = "test_php_mail_failure",
  label = @Translation("Malfunctioning mail backend"),
  description = @Translation("An intentionally broken mail backend, used for tests.")
)

Hierarchy

• class \Drupal\Core\Mail\Plugin\Mail\PhpMail extends \Drupal\Core\Mail\MailInterface
  • class \Drupal\system_mail_failure_test\Plugin\Mail\TestPhpMailFailure extends \Drupal\Core\Mail\MailInterface implements \Drupal\Core\Mail\Plugin\Mail\PhpMail

Expanded class hierarchy of TestPhpMailFailure

File

core/modules/system/tests/modules/system_mail_failure_test/src/Plugin/Mail/TestPhpMailFailure.php, line 23

Namespace

class TestPhpMailFailure extends PhpMail implements MailInterface {
  
  /**
   * {@inheritdoc}
   */
  public function mail(array $message) {
    // Simulate a failed mail send by returning FALSE.
    return FALSE;
  }

}