class MimeMail in Mime Mail 8

Defines the default Drupal mail backend, using PHP's native mail() function.

Plugin annotation


@Mail(
  id = "mime_mail",
  label = @Translation("Mime Mail mailer"),
  description = @Translation("Sends MIME-encoded emails with embedded images and attachments.")
)

Hierarchy

class \Drupal\Core\Mail\Plugin\Mail\PhpMail implements MailInterface
- class \Drupal\mimemail\Plugin\Mail\MimeMail implements ContainerFactoryPluginInterface

Expanded class hierarchy of MimeMail

File

src/Plugin/Mail/MimeMail.php, line 24

Namespace

Drupal\mimemail\Plugin\Mail

View source

class MimeMail extends PhpMail implements ContainerFactoryPluginInterface {

  /**
   * The module handler service.
   *
   * @var \Drupal\Core\Extension\ModuleHandlerInterface
   */
  protected $moduleHandler;

  /**
   * The email.validator service.
   *
   * @var \Drupal\Component\Utility\EmailValidatorInterface
   */
  protected $emailValidator;

  /**
   * The renderer service.
   *
   * @var \Drupal\Core\Render\RendererInterface
   */
  protected $renderer;

  /**
   * MimeMail plugin constructor.
   *
   * @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 configuration factory service.
   * @param \Drupal\Core\Extension\ModuleHandlerInterface $module_handler
   *   The module handler service.
   * @param \Drupal\Component\Utility\EmailValidatorInterface $email_validator
   *   The email validator service.
   * @param \Drupal\Core\Render\RendererInterface $renderer
   *   The renderer service.
   */
  public function __construct(array $configuration, $plugin_id, $plugin_definition, ConfigFactoryInterface $config_factory, ModuleHandlerInterface $module_handler, EmailValidatorInterface $email_validator, RendererInterface $renderer) {

    // Bypass parent constructor because the parent statically initializes
    // $this->configFactory (defined in the parent) instead of injecting it.
    $this->configFactory = $config_factory;
    $this->moduleHandler = $module_handler;
    $this->emailValidator = $email_validator;
    $this->renderer = $renderer;
  }

  /**
   * {@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('module_handler'), $container
      ->get('email.validator'), $container
      ->get('renderer'));
  }

  /**
   * {@inheritdoc}
   */
  public function format(array $message) {
    if (is_array($message['body'])) {
      $message['body'] = implode("\n\n", $message['body']);
    }
    if (preg_match('/plain/', $message['headers']['Content-Type'])) {
      if (!($format = $this->configFactory
        ->get('mimemail.settings')
        ->get('format'))) {
        $format = filter_fallback_format();
      }
      $langcode = isset($message['langcode']) ? $message['langcode'] : '';
      $message['body'] = check_markup($message['body'], $format, $langcode);
    }
    $message = $this
      ->prepareMessage($message);
    return $message;
  }

  /**
   * Prepares the message for sending.
   *
   * @param array $message
   *   An array containing the message data. The optional parameters are:
   *   - plain: Whether to send the message as plaintext only or HTML. If
   *     this evaluates to TRUE the message will be sent as plaintext.
   *   - plaintext: Optional plaintext portion of a multipart email.
   *   - attachments: An array of arrays which describe one or more attachments.
   *     Existing files can be added by path, dynamically-generated files can be
   *     added by content. The internal array contains the following elements:
   *      - filepath: Relative Drupal path to an existing file
   *        (filecontent is NULL).
   *      - filecontent: The actual content of the file (filepath is NULL).
   *      - filename: The filename of the file.
   *      - filemime: The MIME type of the file.
   *      The array of arrays looks something like this:
   *      Array
   *      (
   *        [0] => Array
   *        (
   *         [filepath] => '/sites/default/files/attachment.txt'
   *         [filecontent] => 'My attachment.'
   *         [filename] => 'attachment.txt'
   *         [filemime] => 'text/plain'
   *        )
   *      )
   *
   * @return array
   *   All details of the message.
   */
  protected function prepareMessage(array $message) {
    $module = $message['module'];
    $key = $message['key'];
    $to = $message['to'];
    $from = $message['from'];
    $subject = $message['subject'];
    $body = $message['body'];
    $headers = isset($message['params']['headers']) ? $message['params']['headers'] : [];
    $plain = isset($message['params']['plain']) ? $message['params']['plain'] : NULL;
    $plaintext = isset($message['params']['plaintext']) ? $message['params']['plaintext'] : NULL;
    $attachments = isset($message['params']['attachments']) ? $message['params']['attachments'] : [];
    $site_name = $this->configFactory
      ->get('system.site')
      ->get('name');
    $site_mail = $this->configFactory
      ->get('system.site')
      ->get('mail');
    $simple_address = $this->configFactory
      ->get('mimemail.settings')
      ->get('simple_address');

    // Override site mails default sender.
    if (empty($from) || $from == $site_mail) {
      $mimemail_name = $this->configFactory
        ->get('mimemail.settings')
        ->get('name');
      $mimemail_mail = $this->configFactory
        ->get('mimemail.settings')
        ->get('mail');
      $from = [
        'name' => !empty($mimemail_name) ? $mimemail_name : $site_name,
        'mail' => !empty($mimemail_mail) ? $mimemail_mail : $site_mail,
      ];
    }
    if (empty($body)) {

      // Body is empty, this is a plaintext message.
      $plain = TRUE;
    }
    elseif (is_null($plain)) {
      if (is_string($to) && $this->emailValidator
        ->isValid($to)) {
        $user_plaintext_field = $this->configFactory
          ->get('mimemail.settings')
          ->get('user_plaintext_field');
        if (is_object($account = user_load_by_mail($to)) && $account
          ->hasField($user_plaintext_field)) {

          /* @var boolean $plain */
          $plain = $account->{$user_plaintext_field}->value;

          // Might as well pass the user object to the address function.
          $to = $account;
        }
      }
    }

    // Removing newline character introduced by _drupal_wrap_mail_line().
    $subject = str_replace([
      "\n",
    ], '', trim(MailFormatHelper::htmlToText($subject)));
    $body = [
      '#theme' => 'mimemail_message',
      '#module' => $module,
      '#key' => $key,
      '#recipient' => $to,
      '#subject' => $subject,
      '#body' => $body,
    ];
    $body = $this->renderer
      ->renderPlain($body);

    /*foreach (module_implements('mail_post_process') as $module) {
        $function = $module . '_mail_post_process';
        $function($body, $key);
      }*/
    $plain = $plain || $this->configFactory
      ->get('mimemail.settings')
      ->get('textonly');
    $from = MimeMailFormatHelper::mimeMailAddress($from);
    $mail = MimeMailFormatHelper::mimeMailHtmlBody($body, $subject, $plain, $plaintext, $attachments);
    $headers = array_merge($message['headers'], $headers, $mail['headers']);
    $message['to'] = MimeMailFormatHelper::mimeMailAddress($to, $simple_address);
    $message['from'] = $from;
    $message['subject'] = $subject;
    $message['body'] = $mail['body'];
    $message['headers'] = MimeMailFormatHelper::mimeMailHeaders($headers, $from);
    return $message;
  }

}

Members

Name	Modifiers	Type	Description	Overrides
MimeMail::$emailValidator	protected	property	The email.validator service.
MimeMail::$moduleHandler	protected	property	The module handler service.
MimeMail::$renderer	protected	property	The renderer service.
MimeMail::create	public static	function	Creates an instance of the plugin. Overrides ContainerFactoryPluginInterface::create
MimeMail::format	public	function	Concatenates and wraps the email body for plain-text mails. Overrides PhpMail::format
MimeMail::prepareMessage	protected	function	Prepares the message for sending.
MimeMail::__construct	public	function	MimeMail plugin constructor. Overrides PhpMail::__construct
PhpMail::$configFactory	protected	property	The configuration factory.
PhpMail::mail	public	function	Sends an email message. Overrides MailInterface::mail	2
PhpMail::_isShellSafe	protected static	function	Disallows potentially unsafe shell characters.

You are here

class MimeMail in Mime Mail 8

Plugin annotation

Hierarchy

File

Namespace

Members

API Navigation