class LoggerMail in Helper 8

Defines a mail backend that captures sent messages to the logger.

To enable, save a variable in settings.php (or otherwise) whose value can be as simple as:

$config['system.mail']['interface']['default'] = 'helper_logger';

Plugin annotation

@Mail(
  id = "helper_logger",
  label = @Translation("Helper Logging Mailer"),
  description = @Translation("Does not send the message, but sends it to the logger. Used for testing.")
)

Hierarchy

• class \Drupal\helper\Plugin\Mail\LoggerMail implements MailInterface, ContainerFactoryPluginInterface

File

src/Plugin/Mail/LoggerMail.php, line 28

Namespace

Drupal\helper\Plugin\Mail

class LoggerMail implements MailInterface, ContainerFactoryPluginInterface {

  /**
   * The logger.
   *
   * @var \Psr\Log\LoggerInterface
   */
  protected $logger;

  /**
   * Constructs a new LoggerMail object.
   *
   * @param array $configuration
   *   A configuration array containing information about the plugin instance.
   * @param string $plugin_id
   *   The plugin_id for the plugin instance.
   * @param mixed $plugin_definition
   *   The plugin implementation definition.
   * @param \Psr\Log\LoggerInterface $logger
   *   The logger.
   */
  public function __construct(array $configuration, $plugin_id, $plugin_definition, LoggerInterface $logger) {
    $this->logger = $logger;
  }

  /**
   * {@inheritdoc}
   */
  public static function create(ContainerInterface $container, array $configuration, $plugin_id, $plugin_definition) {
    return new static($configuration, $plugin_id, $plugin_definition, $container
      ->get('logger.factory')
      ->get('mail'));
  }

  /**
   * {@inheritdoc}
   */
  public function mail(array $message) {
    $this->logger
      ->info('Mail sent to @to with subject %subject: <pre>@mail</pre>', [
      '@to' => $message['to'],
      '%subject' => $message['subject'],
      '@mail' => $this
        ->formatMessage($message),
    ]);
    return TRUE;
  }

  /**
   * {@inheritdoc}
   */
  public function format(array $message) {

    // Join the body array into one string.
    $message['body'] = implode("\n\n", $message['body']);

    // Convert any HTML to plain-text.
    $message['body'] = MailFormatHelper::htmlToText($message['body']);

    // Wrap the mail body for sending.
    $message['body'] = MailFormatHelper::wrapMail($message['body']);
    return $message;
  }

  /**
   * Formats the mail message for display.
   *
   * @param array $message
   *   The mail message.
   *
   * @return string
   *   The mail output.
   */
  protected function formatMessage(array $message) {
    $mimeheaders = [];
    $message['headers']['To'] = $message['to'];
    foreach ($message['headers'] as $name => $value) {
      $mimeheaders[] = $name . ': ' . Unicode::mimeHeaderEncode($value);
    }
    $line_endings = Settings::get('mail_line_endings', PHP_EOL);
    $output = implode($line_endings, $mimeheaders) . $line_endings;

    // 'Subject:' is a mail header and should not be translated.
    $output .= 'Subject: ' . $message['subject'] . $line_endings;

    // Blank line to separate headers from body.
    $output .= $line_endings;
    $output .= preg_replace('@\\r?\\n@', $line_endings, $message['body']);
    return $output;
  }

}

Members

Name	Modifiers	Type	Description	Overrides
LoggerMail::$logger	protected	property	The logger.
LoggerMail::create	public static	function	Creates an instance of the plugin. Overrides ContainerFactoryPluginInterface::create
LoggerMail::format	public	function	Formats a message prior to sending. Overrides MailInterface::format
LoggerMail::formatMessage	protected	function	Formats the mail message for display.
LoggerMail::mail	public	function	Sends a message composed by \Drupal\Core\Mail\MailManagerInterface->mail(). Overrides MailInterface::mail
LoggerMail::__construct	public	function	Constructs a new LoggerMail object.