phpmailer.module in PHPMailer 7.3

Integrates the PHPMailer library for SMTP e-mail delivery.

File

phpmailer.module

<?php

/**
 * @file
 * Integrates the PHPMailer library for SMTP e-mail delivery.
 */

/**
 * Implements hook_perm().
 */
function phpmailer_permission() {
  return array(
    'administer phpmailer settings' => array(
      'title' => t('Administer PHPMailer settings'),
      'restrict access' => TRUE,
    ),
  );
}

/**
 * Implements hook_menu().
 */
function phpmailer_menu() {
  $items['admin/config/system/phpmailer'] = array(
    'title' => 'PHPMailer',
    'description' => 'Configure PHPMailer settings.',
    'page callback' => 'drupal_get_form',
    'page arguments' => array(
      'phpmailer_settings_form',
    ),
    'access arguments' => array(
      'administer phpmailer settings',
    ),
    'file' => 'phpmailer.admin.inc',
  );

  // @todo Move to Mime Mail project.
  $items['phpmailer/preview'] = array(
    'title' => 'Mail preview',
    'page callback' => 'phpmailer_preview',
    'access callback' => 'phpmailer_preview_access',
    'file' => 'phpmailer.admin.inc',
    'type' => MENU_CALLBACK,
  );
  return $items;
}

/**
 * Implements hook_form_FORM_ID_alter().
 */
function phpmailer_form_mimemail_admin_settings_alter(&$form, &$form_state) {

  // Hide the Mime Mail global enabler setting if phpmailer is used to deliver
  // e-mails (they can't be both active).
  if (phpmailer_enabled()) {
    $mimemail_alter =& $form['mimemail']['mimemail_alter'];
    $mimemail_alter['#disabled'] = TRUE;
    $mimemail_alter['#default_value'] = 0;
    $mimemail_alter['#description'] = t('PHPMailer has been set to deliver all site messages. To let Mime Mail apply styles and formatting to system e-mails but still use PHPMailer for mail transport, uncheck <em>Use PHPMailer to send e-mails</em> first on the <a href="@url">PHPMailer settings page</a>. Then activate this setting and choose PHPMailer from the list of e-mail engines below.', array(
      '@url' => url('admin/config/system/phpmailer'),
    ));
  }

  // @todo Move to MimeMail project.
  $form['preview'] = array(
    '#type' => 'item',
    '#title' => t('Preview'),
    '#value' => t('See a <a href="@url" target="_blank">preview of a styled e-mail</a> using the current message template (<code>mimemail-message.tpl.php</code>).', array(
      '@url' => url('phpmailer/preview'),
    )),
  );
  $form['buttons']['#weight'] = 10;
}

/**
 * Determine if PHPMailer is used to deliver e-mails.
 */
function phpmailer_enabled() {

  // We need to rely on our 'smtp_on' variable, since PHPMailer may not be
  // configured as the default mail system.
  return (bool) variable_get('smtp_on', 0);
}

/**
 * Implements hook_mailengine().
 */
function phpmailer_mailengine($op, $message = array()) {
  if (!phpmailer_library_exists()) {
    return;
  }
  switch ($op) {
    case 'list':
      return array(
        'name' => t('PHPMailer'),
        'description' => t('Mailing engine using the PHPMailer library.'),
      );
    case 'settings':
      $form['info']['#markup'] = t('To configure your mail server settings, visit the <a href="@url">PHPMailer settings page</a>.', array(
        '@url' => url('admin/config/system/phpmailer'),
      ));
      return $form;
    case 'multiple':
    case 'single':
    case 'send':
      module_load_include('inc', 'phpmailer', 'includes/phpmailer.mimemail');

      // Mimemail API does not load mimemail.inc for other mailengines; we rely
      // on mimemail_rfc_headers(), so ensure that it is loaded.
      module_load_include('inc', 'mimemail');
      return mimemail_phpmailer_send($message);
  }
}

/**
 * Extract address and optional display name of an e-mail address.
 *
 * @param string $string
 *   A string containing one or more valid e-mail address(es) separated with
 *   commas.
 *
 * @return array
 *   An array containing all found e-mail addresses split into mail and name.
 *
 * @see http://tools.ietf.org/html/rfc5322#section-3.4
 */
function phpmailer_parse_address($string) {
  $parsed = array();

  // The display name may contain commas (3.4). Extract all quoted strings
  // (3.2.4) to a stack and replace them with a placeholder to prevent
  // splitting at wrong places.
  $string = preg_replace_callback('(".*?(?<!\\\\)")', '_phpmailer_stack', $string);

  // Build a regex that matches a name-addr (3.4).
  // @see valid_email_address()
  $user = '[a-zA-Z0-9_\\-\\.\\+\\^!#\\$%&*+\\/\\=\\?\\`\\|\\{\\}~\']+';
  $domain = '(?:(?:[a-zA-Z0-9]|[a-zA-Z0-9][a-zA-Z0-9\\-]*[a-zA-Z0-9])\\.?)+';
  $ipv4 = '[0-9]{1,3}(?:\\.[0-9]{1,3}){3}';
  $ipv6 = '[0-9a-fA-F]{1,4}(?:\\:[0-9a-fA-F]{1,4}){7}';
  $address = "{$user}@(?:{$domain}|(?:\\[(?:{$ipv4}|{$ipv6})\\]))";
  $adr_rx = "/^(?P<name>.*)\\s<(?P<address>{$address})>\$/";

  // Split string into multiple parts and process each.
  foreach (explode(',', $string) as $email) {

    // Re-inject stripped placeholders.
    $email = preg_replace_callback('(\\x01)', '_phpmailer_stack', trim($email));

    // Check if it's a name-addr or a plain address (3.4).
    if (preg_match($adr_rx, $email, $matches)) {

      // PHPMailer expects an unencoded display name.
      $parsed[] = array(
        'mail' => $matches['address'],
        'name' => mime_header_decode(stripslashes($matches['name'])),
      );
    }
    else {
      $parsed[] = array(
        'mail' => trim($email, '<>'),
        'name' => '',
      );
    }
  }
  return $parsed;
}

/**
 * Implements a FIFO stack to store extracted quoted strings.
 */
function _phpmailer_stack($matches = NULL) {
  $string = $matches[0];
  static $stack = array();
  if ($string == "\1") {

    // Unescape quoted characters (3.2.4) to prevent double escaping.
    return str_replace(array(
      '\\"',
      '\\\\',
    ), array(
      '"',
      '\\',
    ), array_shift($stack));
  }

  // Remove surrounding quotes and push on stack.
  array_push($stack, substr($string, 1, -1));

  // Return placeholder substitution. 0x01 may never appear outside a quoted
  // string (3.2.3).
  return "\1";
}

/**
 * Menu access callback; Determine access for HTML mail preview page.
 */
function phpmailer_preview_access() {
  if (module_exists('mimemail')) {
    return user_access('administer phpmailer settings');
  }
  return FALSE;
}

/**
 * Implements hook_registry_files_alter().
 *
 * @todo Consider to move this into Libraries API.
 */
function phpmailer_registry_files_alter(&$files, $modules) {
  $library_path = libraries_get_path('phpmailer');
  if (!$library_path) {
    return;
  }
  foreach (array(
    'class.phpmailer.php',
    'class.smtp.php',
  ) as $filename) {
    $files[$library_path . '/' . $filename] = array(
      'module' => 'phpmailer',
      'weight' => 0,
    );
  }
}

/**
 * Verify that PHPMailer libraries exist.
 */
function phpmailer_library_exists() {
  $library_path = libraries_get_path('phpmailer');
  if (!$library_path) {
    return FALSE;
  }
  foreach (array(
    'class.phpmailer.php',
    'class.smtp.php',
  ) as $filename) {
    if (!file_exists(DRUPAL_ROOT . '/' . $library_path . '/' . $filename)) {
      return FALSE;
    }
  }
  return TRUE;
}

Functions

Name	Description
phpmailer_enabled	Determine if PHPMailer is used to deliver e-mails.
phpmailer_form_mimemail_admin_settings_alter	Implements hook_form_FORM_ID_alter().
phpmailer_library_exists	Verify that PHPMailer libraries exist.
phpmailer_mailengine	Implements hook_mailengine().
phpmailer_menu	Implements hook_menu().
phpmailer_parse_address	Extract address and optional display name of an e-mail address.
phpmailer_permission	Implements hook_perm().
phpmailer_preview_access	Menu access callback; Determine access for HTML mail preview page.
phpmailer_registry_files_alter	Implements hook_registry_files_alter().
_phpmailer_stack	Implements a FIFO stack to store extracted quoted strings.