mail_edit_user.inc in Mail Editor 6

A sample implementation of Mail Editor hooks for User core module.

File

mail_edit_user.inc

<?php

/**
 * @file
 * A sample implementation of Mail Editor hooks for User core module.
 */

/**
 * Implementation of hook_mailkeys().
 */
function user_mailkeys() {
  return array(
    'register_admin_created' => t('Welcome message for user created by the admin'),
    // has password
    'register_no_approval_required' => t('Welcome message when user self-registers'),
    // has password
    'register_pending_approval' => t('Welcome message, user pending admin approval'),
    // has password
    'register_pending_approval_admin' => t('Message to admin, user is pending'),
    // has password
    'password_reset' => t('Password recovery request'),
    'status_activated' => t('Account activated'),
    'status_blocked' => t('Account blocked'),
    'status_deleted' => t('Account deleted'),
  );
}

/**
 * Implementation of hook_mail_edit_tokens_list().
 */
function user_mail_edit_tokens_list($mailkey, $options = array()) {
  $tokens = array();
  switch ($mailkey) {
    case 'register_admin_created':
    case 'register_no_approval_required':
    case 'register_pending_approval':
    case 'register_pending_approval_admin':
      $tokens['!password'] = "User's raw password";
    case 'password_reset':
    case 'status_activated':
    case 'status_blocked':
    case 'status_deleted':
      $tokens['!username'] = t("User's username");
      $tokens['!username_themed'] = t("User's username (themed)");
      $tokens['!site'] = t('Site name');
      $tokens['!login_url'] = t('One time login URL for password reset');
      $tokens['!uri_brief'] = "Website's URL without the leading http://";
      $tokens['!uri'] = t("Website's URL");
      $tokens['!mailto'] = t("User's Email address (email address to which this email is being sent to)");
      $tokens['!date'] = t("Date and time when this email is sent");
      $tokens['!login_uri'] = t("URL to user's profile or login form if user is not logged in");
      $tokens['!edit_uri'] = t("URL to user's profile edit page");
      break;
  }
  return $tokens;
}

/**
 * Implementation of hook_mail_edit_tokens_value().
 */
function user_mail_edit_tokens_value($mailkey, $mail, $options = array()) {
  global $base_url;
  $account = $mail['params']['account'];
  $language = $mail['language'];
  $tokens = array(
    '!username_themed' => strip_tags(theme('username', $account, array(
      'plain' => TRUE,
    ))),
    '!username' => $account->name,
    '!site' => variable_get('site_name', 'Drupal'),
    '!login_url' => user_pass_reset_url($account),
    '!uri_brief' => drupal_substr($base_url, drupal_strlen('http://')),
    '!uri' => $base_url,
    '!mailto' => $account->mail,
    '!date' => format_date(time(), 'medium', '', NULL, $language->language),
    '!login_uri' => url('user', array(
      'absolute' => TRUE,
      'language' => $language,
    )),
    '!edit_uri' => url('user/' . $account->uid . '/edit', array(
      'absolute' => TRUE,
      'language' => $language,
    )),
  );
  if (!empty($account->password)) {
    $tokens['!password'] = $account->password;
  }
  return $tokens;
}

/**
 * Implementation of hook_mail_edit_text().
 */
function user_mail_edit_text($mailkey, $langcode) {
  $return = array();
  $return['subject'] = _user_mail_text($mailkey . '_subject', $langcode);
  $return['body'] = _user_mail_text($mailkey . '_body', $langcode);
  return $return;
}

Functions

Name	Description
user_mailkeys	Implementation of hook_mailkeys().
user_mail_edit_text	Implementation of hook_mail_edit_text().
user_mail_edit_tokens_list	Implementation of hook_mail_edit_tokens_list().
user_mail_edit_tokens_value	Implementation of hook_mail_edit_tokens_value().