class DevelMailLog in Devel 8.3

Defines a mail backend that saves emails as temporary files.

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

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

By default the mails are saved in 'temporary://devel-mails'. This setting can be changed using 'debug_mail_directory' config setting. For example:

$config['devel.settings']['debug_mail_directory'] = 'temporary://my-directory';

The default filename pattern used is '%to-%subject-%datetime.mail.txt'. This setting can be changed using 'debug_mail_directory' config setting. For example:

$config['devel.settings']['debug_mail_file_format'] = 'devel-mail-%to-%subject-%datetime.mail.txt';

The following placeholders can be used in the filename pattern:

• %to: the email recipient.
• %subject: the email subject.
• %datetime: the current datetime in 'y-m-d_his' format.

Plugin annotation

@Mail(
  id = "devel_mail_log",
  label = @Translation("Devel Logging Mailer"),
  description = @Translation("Outputs the message as a file in the temporary directory.")
)

Hierarchy

• class \Drupal\devel\Plugin\Mail\DevelMailLog implements MailInterface, ContainerFactoryPluginInterface

1 file declares its use of DevelMailLog

DevelMailLogTest.php in tests/src/Kernel/DevelMailLogTest.php

File

src/Plugin/Mail/DevelMailLog.php, line 48

Namespace

Drupal\devel\Plugin\Mail

class DevelMailLog implements MailInterface, ContainerFactoryPluginInterface {

  /**
   * The devel.settings config object.
   *
   * @var \Drupal\Core\Config\Config
   */
  protected $config;

  /**
   * The file system service.
   *
   * @var \Drupal\Core\File\FileSystemInterface
   */
  protected $fileSystem;

  /**
   * Constructs a new DevelMailLog 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 \Drupal\Core\Config\ConfigFactoryInterface $config_factory
   *   The config factory service.
   * @param \Drupal\Core\File\FileSystemInterface $file_system
   *   The file system service.
   */
  public function __construct(array $configuration, $plugin_id, $plugin_definition, ConfigFactoryInterface $config_factory, FileSystemInterface $file_system) {
    $this->config = $config_factory
      ->get('devel.settings');
    $this->fileSystem = $file_system;
  }

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

  /**
   * {@inheritdoc}
   */
  public function mail(array $message) {
    $directory = $this->config
      ->get('debug_mail_directory');
    if (!$this
      ->prepareDirectory($directory)) {
      return FALSE;
    }
    $pattern = $this->config
      ->get('debug_mail_file_format');
    $filename = $this
      ->replacePlaceholders($pattern, $message);
    $output = $this
      ->composeMessage($message);
    return (bool) file_put_contents($directory . '/' . $filename, $output);
  }

  /**
   * {@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;
  }

  /**
   * Compose the output message.
   *
   * @param array $message
   *   A message array, as described in hook_mail_alter().
   *
   * @return string
   *   The output message.
   */
  protected function composeMessage(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;
  }

  /**
   * Replaces placeholders with sanitized values in a string.
   *
   * @param string $filename
   *   The string that contains the placeholders. The following placeholders
   *   are considered in the replacement:
   *   - %to: replaced by the email recipient value.
   *   - %subject: replaced by the email subject value.
   *   - %datetime: replaced by the current datetime in 'y-m-d_his' format.
   * @param array $message
   *   A message array, as described in hook_mail_alter().
   *
   * @return string
   *   The formatted string.
   */
  protected function replacePlaceholders($filename, array $message) {
    $tokens = [
      '%to' => $message['to'],
      '%subject' => $message['subject'],
      '%datetime' => date('y-m-d_his'),
    ];
    $filename = str_replace(array_keys($tokens), array_values($tokens), $filename);
    return preg_replace('/[^a-zA-Z0-9_\\-\\.@]/', '_', $filename);
  }

  /**
   * Checks that the directory exists and is writable.
   *
   * Public directories will be protected by adding an .htaccess which
   * indicates that the directory is private.
   *
   * @param string $directory
   *   A string reference containing the name of a directory path or URI.
   *
   * @return bool
   *   TRUE if the directory exists (or was created), is writable and is
   *   protected (if it is public). FALSE otherwise.
   */
  protected function prepareDirectory($directory) {
    if (!$this->fileSystem
      ->prepareDirectory($directory, FileSystemInterface::CREATE_DIRECTORY)) {
      return FALSE;
    }
    if (0 === strpos($directory, 'public://')) {
      return FileSecurity::writeHtaccess($directory);
    }
    return TRUE;
  }

}

Members

Name	Modifiers	Type	Description	Overrides
DevelMailLog::$config	protected	property	The devel.settings config object.
DevelMailLog::$fileSystem	protected	property	The file system service.
DevelMailLog::composeMessage	protected	function	Compose the output message.
DevelMailLog::create	public static	function	Creates an instance of the plugin. Overrides ContainerFactoryPluginInterface::create
DevelMailLog::format	public	function	Formats a message prior to sending. Overrides MailInterface::format
DevelMailLog::mail	public	function	Sends a message composed by \Drupal\Core\Mail\MailManagerInterface->mail(). Overrides MailInterface::mail
DevelMailLog::prepareDirectory	protected	function	Checks that the directory exists and is writable.
DevelMailLog::replacePlaceholders	protected	function	Replaces placeholders with sanitized values in a string.
DevelMailLog::__construct	public	function	Constructs a new DevelMailLog object.