class TestHtmlMailCollector

Defines a mail backend that captures sent HTML messages in the state system.

This class is for running tests or for development and does not convert HTML to plaintext.

Plugin annotation

@Mail(
  id = "test_html_mail_collector",
  label = @Translation("HTML mail collector"),
  description = @Translation("Does not send the message, but stores its HTML in Drupal within the state system. Used for testing.")
)

Hierarchy

• class \Drupal\Core\Mail\Plugin\Mail\PhpMail implements \Drupal\Core\Mail\MailInterface
  • class \Drupal\Core\Mail\Plugin\Mail\TestMailCollector extends \Drupal\Core\Mail\Plugin\Mail\PhpMail implements \Drupal\Core\Mail\MailInterface
    • class \Drupal\mail_html_test\Plugin\Mail\TestHtmlMailCollector extends \Drupal\Core\Mail\Plugin\Mail\TestMailCollector

Expanded class hierarchy of TestHtmlMailCollector

File

core/modules/system/tests/modules/mail_html_test/src/Plugin/Mail/TestHtmlMailCollector.php, line 20

Namespace

class TestHtmlMailCollector extends TestMailCollector {
    
    /**
     * {@inheritdoc}
     */
    public function format(array $message) {
        // Join the body array into one string.
        $message['body'] = implode(PHP_EOL, $message['body']);
        // Wrap the mail body for sending.
        $message['body'] = MailFormatHelper::wrapMail($message['body']);
        return $message;
    }

}

Members