modules/couriermta/couriermta.module

<?php
// $Id: couriermta.module,v 1.1.2.7 2008/04/15 19:44:33 oadaeh Exp $

/**
 * @file
 * This is the main code file for the Courier MTA module. This module allows
 * administrators and/or users to manage their Courier e-mail account(s)
 * through a Drupal website.
 */


/**
 * Display help and module information.
 * @param section The section of the site we're displaying help on.
 * @return The help text for the section.
 */
function couriermta_help($section = '') {
  $output = '';

  switch ($section) {
    case 'admin/settings/couriermta':
      $output = t('This module gives administrators the capability of using a Drupal website to manage the user accounts on a Courier e-mail server.');
      break;
  }

  return $output;
}  //  End of couriermta_help().


/**
 * The valid permissions for this module.
 * @return array An array of valid permissions for the module.
 */
function couriermta_perm() {
  return array('administrator couriermta users');
}  //  End of couriermta_perm().


/**
 * The stub for the menu callback.
 * @param may_cache A boolean indicating whether cacheable menu items should be returned.
 * @return An array of menu items.
 */
function couriermta_menu($may_cache) {
  $items = array();

  $items[] = array(
    'path'               => 'admin/settings/couriermta',
    'title'              => t('Courier MTA'),
    'callback'           => 'drupal_get_form',
    'callback arguments' => array('couriermta_admin_settings'),
    'access'             => user_access('administer site configuration'),
    'description'        => t('Configure how the module saves data for the mail server.')
  );

  return $items;
}  //  End of couriermta_menu().


/**
 * Courier user administration settings form.
 */
function couriermta_admin_settings() {
  $form = array();

  $form['couriermta_instructions_line1'] = array(
    '#value'  => t('For each of the pattern fields below, if you specify an absolute value, that value will be saved in the database for each user as specified in the form field. If you enter a pattern, that pattern will be modified on a per user basis and saved in the database that way.'),
    '#prefix' => '<p>',
    '#suffix' => '</p>',
  );
  $form['couriermta_instructions_line2'] = array(
    '#value' => t('For example, if you entered "/var/spool/mail" for the home form field below, that would be the value that would be saved in the database for each user. If, however, you entered "/var/spool/mail/!domain_name/!user_name" for the home form field below, the value that would be saved in the database would be based on the users\' e-mail address and would be different for every user.'),
    '#prefix' => '<p>',
    '#suffix' => '</p>',
  );

  if (module_exists('token')) {
    $form['couriermta_token'] = array(
      '#type'        => 'fieldset',
      '#title'       => t('Token parsing'),
      '#collapsible' => TRUE,
      '#description' => t('If you have the Token module installed, you may use that module\'s tokens for any of the pattern fields below. Posible replcement tokens are listed in the "Replacement tokens" fieldset below.'),
    );
    $form['couriermta_token']['couriermta_use_token_module'] = array(
      '#type'          => 'checkbox',
      '#title'         => t('Use Token module.'),
      '#default_value' => variable_get('couriermta_use_token_module', '0'),
      '#description'   => t('Check this box if you wish to use the Token module\'s parsing for the pattern fields below.'),
    );
    $form['couriermta_token']['couriermta_replacement_tokens'] = array(
      '#type'        => 'fieldset',
      '#title'       => t('Replacement tokens'),
      '#collapsible' => TRUE,
      '#collapsed'   => TRUE,
      '#description' => t('You may use any of the following replacements tokens for use in any of the pattern fields below.'),
    );
    $form['couriermta_token']['couriermta_replacement_tokens']['token_help'] = array(
      '#value' => theme('token_help'),
    );
  }
  else {
    $form['couriermta_token'] = array(
      '#type'        => 'fieldset',
      '#title'       => t('Token parsing'),
      '#collapsible' => TRUE,
      '#description' => t('If you have the Token module installed, you may use that module\'s tokens for any of the pattern fields below.'),
    );
    $form['couriermta_token']['couriermta_use_token_module'] = array(
      '#type'          => 'checkbox',
      '#title'         => t('Use Token module.'),
      '#disabled'      => TRUE,
      '#default_value' => variable_get('couriermta_use_token_module', '0'),
      '#description'   => t('Install and enable the Token module to enable this field.'),
    );
  }

  $form['couriermta_email'] = array(
    '#type'        => 'fieldset',
    '#title'       => t('E-mail address'),
    '#collapsible' => TRUE,
    '#description' => t('Use this area to specify how the user\'s Courier e-mail address should be entered in the Courier database table. If you check the "Use the user\'s given e-mail address." checkbox, then the "E-mail pattern" field will be ignored.'),
  );
  $form['couriermta_email']['couriermta_email_users_address'] = array(
    '#type'          => 'checkbox',
    '#title'         => t('Use the user\'s given e-mail address.'),
    '#default_value' => variable_get('couriermta_email_users_address', '1'),
  );
  $form['couriermta_email']['couriermta_email_pattern'] = array(
    '#type'          => 'textfield',
    '#title'         => t('E-mail pattern'),
    '#default_value' => variable_get('couriermta_email_pattern', ''),
    '#description'   => t('The default value for the e-mail field. This field will be ignored if the "Use the user\'s given e-mail address." checkbox above is checked.'),
  );

  $form['couriermta_password'] = array(
    '#type'        => 'fieldset',
    '#title'       => t('Password'),
    '#collapsible' => TRUE,
    '#description' => t('Use this area to specify how the user\'s Courier password should be entered in the Courier database table.'),
  );
  $form['couriermta_password']['couriermta_password_users_password'] = array(
    '#type'          => 'checkbox',
    '#title'         => t('Use the user\'s given password.'),
    '#default_value' => variable_get('couriermta_password_users_password', '1'),
  );
  $form['couriermta_password']['couriermta_password_type'] = array(
    '#type'          => 'radios',
    '#title'         => t('Password type to create'),
    '#default_value' => variable_get('couriermta_password_type', '0'),
    '#options'       => array(t('Encrypted'), t('Cleartext'), t('Both')),
    '#description'   => t('Choose whether to create an encrypted password, a cleartext password or both.'),
  );
  $form['couriermta_password']['couriermta_password'] = array(
    '#type'          => 'textfield',
    '#title'         => t('Password pattern'),
    '#default_value' => variable_get('couriermta_password', ''),
    '#description'   => t('The default value for the password field. This field will be ignored if the "Use the user\'s given password." checkbox above is checked.'),
  );

  $form['couriermta_name'] = array(
    '#type'        => 'fieldset',
    '#title'       => t('User name'),
    '#collapsible' => TRUE,
    '#description' => t('Use this area to specify how the user\'s Courier user\'s name field should be entered in the Courier database table. If you check the "Use the user\'s given name." checkbox, then the "Name pattern" field will be ignored.'),
  );
  $form['couriermta_name']['couriermta_users_name'] = array(
    '#type'          => 'checkbox',
    '#title'         => t('Use the user\'s given user name.'),
    '#default_value' => variable_get('couriermta_users_name', '1'),
  );
  $form['couriermta_name']['couriermta_name_pattern'] = array(
    '#type'          => 'textfield',
    '#title'         => t('Name pattern'),
    '#default_value' => variable_get('couriermta_name', ''),
    '#description'   => t('The default value for the name field. This field will be ignored if the "Use the user\'s given user name." checkbox above is checked.'),
  );

  $form['couriermta_uid'] = array(
    '#type'        => 'fieldset',
    '#title'       => t('UID'),
    '#collapsible' => TRUE,
    '#description' => t('Use this area to specify how the user\'s Courier UID field should be entered in the Courier database table.'),
  );
  $form['couriermta_uid']['couriermta_uid_pattern'] = array(
    '#type'          => 'textfield',
    '#title'         => t('UID pattern'),
    '#default_value' => variable_get('couriermta_uid_pattern', '65534'),
    '#description'   => t('The default value for the user id field.'),
  );

  $form['couriermta_gid'] = array(
    '#type'        => 'fieldset',
    '#title'       => t('GID'),
    '#collapsible' => TRUE,
    '#description' => t('Use this area to specify how the user\'s Courier GID field should be entered in the Courier database table.'),
  );
  $form['couriermta_gid']['couriermta_gid_pattern'] = array(
    '#type'          => 'textfield',
    '#title'         => t('GID pattern'),
    '#default_value' => variable_get('couriermta_gid_pattern', '65534'),
    '#description'   => t('The default value for the group id field.'),
  );

  $form['couriermta_home'] = array(
    '#type'        => 'fieldset',
    '#title'       => t('Home'),
    '#collapsible' => TRUE,
    '#description' => t('Use this area to specify how the user\'s Courier home field should be entered in the Courier database table.'),
  );
  $form['couriermta_home']['couriermta_home_pattern'] = array(
    '#type'          => 'textfield',
    '#title'         => t('Home pattern'),
    '#default_value' => variable_get('couriermta_home_pattern', '/var/spool/mail/!domain_name/!user_name'),
    '#description'   => t('The default value for the home field. You may use "!domain_name" to represent the domain part of the user\'s e-mail address (the part after the @ sign) and "!user_name" to represent the user part of the user\'s e-mail address (the part before the @ sign). If you have checked the box above to use the Token module for pattern field parsing, !domain_name and !user_name will not work.'),
  );

  $form['couriermta_maildir'] = array(
    '#type'        => 'fieldset',
    '#title'       => t('Maildir'),
    '#collapsible' => TRUE,
    '#description' => t('Use this area to specify how the user\'s Courier maildir field should be entered in the Courier database table.'),
  );
  $form['couriermta_maildir']['couriermta_maildir_pattern'] = array(
    '#type'          => 'textfield',
    '#title'         => t('Maildir pattern'),
    '#default_value' => variable_get('couriermta_maildir_pattern', '/var/spool/mail/!domain_name/!user_name'),
    '#description'   => t('The default value for the home field. You may use "!domain_name" to represent the domain part of the user\'s e-mail address (the part after the @ sign) and "!user_name" to represent the user part of the user\'s e-mail address (the part before the @ sign). If you have checked the box above to use the Token module for pattern field parsing, !domain_name and !user_name will not work.'),
  );

  $form['couriermta_defaultdelivery'] = array(
    '#type'        => 'fieldset',
    '#title'       => t('Default delivery'),
    '#collapsible' => TRUE,
    '#description' => t('Use this area to specify how the user\'s Courier defaultdelivery field should be entered in the Courier database table.'),
  );
  $form['couriermta_defaultdelivery']['couriermta_defaultdelivery_pattern'] = array(
    '#type'          => 'textfield',
    '#title'         => t('Default delivery pattern'),
    '#default_value' => variable_get('couriermta_defaultdelivery_pattern', ''),
    '#description'   => t('The default value for the default delivery field.'),
  );

  $form['couriermta_quota'] = array(
    '#type'        => 'fieldset',
    '#title'       => t('Quota'),
    '#collapsible' => TRUE,
    '#description' => t('Use this area to specify how the user\'s Courier quota field should be entered in the Courier database table.'),
  );
  $form['couriermta_quota']['couriermta_quota_pattern'] = array(
    '#type'          => 'textfield',
    '#title'         => t('Quota pattern'),
    '#default_value' => variable_get('couriermta_quota_pattern', ''),
    '#description'   => t('The default value for the quota field.'),
  );

  $form['couriermta_options'] = array(
    '#type'        => 'fieldset',
    '#title'       => t('Options'),
    '#collapsible' => TRUE,
    '#description' => t('Use this area to specify how the user\'s Courier options field should be entered in the Courier database table.'),
  );
  $form['couriermta_options']['couriermta_options_pattern'] = array(
    '#type'          => 'textfield',
    '#title'         => t('Options pattern'),
    '#default_value' => variable_get('couriermta_options_pattern', ''),
    '#description'   => t('The default value for the options field.'),
  );

  $form['couriermta_allow_email_alias'] = array(
    '#type'          => 'checkbox',
    '#title'         => t('Allow users to specify an e-mail alias.'),
    '#default_value' => variable_get('couriermta_allow_email_alias', '0'),
    '#description'   => t('Check this option if you want to allow the users to specify an e-mail address to forward e-mails to.'),
  );

  return system_settings_form($form);
}  //  End of couriermta_admin_settings().


/**
 * Implementation of hook_user.
 */
function couriermta_user($op, &$edit, &$account, $category = NULL) {
  if ($category == 'account') {
    switch ($op) {
      case 'delete':
        // Check to see if an alias has been specified.
        if (!db_result(db_query('SELECT alias FROM {couriermta_users} WHERE userid=%d', $account->uid))) {
          // The account to be deleted is a mailbox e-mail account.
          _couriermta_delete_mailbox_account(&$account);
        }
        else {
          // The account to be deleted is a aliased e-mail account.
          _couriermta_delete_aliased_account(&$account);
        }
        break;


      case 'form':
        if (variable_get('couriermta_allow_email_alias', '0') && $category == 'account') {
          // Add an e-mail alias area.
          $form['couriermta_email_alias'] = array(
            '#type' => 'fieldset',
            '#title' => t('E-mail alias settings'),
            '#collapsible' => TRUE,
            '#weight' => 1,
          );
          $form['couriermta_email_alias']['couriermta_email_alias_address'] = array(
            '#type' => 'textfield',
            '#title' => t('E-mail alias (optional)'),
            '#default_value' => db_result(db_query('SELECT alias FROM {couriermta_users} WHERE userid=%d', $account->uid)),
            '#description' => t('If this field is filled in with a valid e-mail address, all e-mail sent to the address entered in the "E-mail address" field above will be forwarded to this address instead. When changing from using a regular mailbox e-mail account to using an aliased e-mail account, a password must be given, as the existing password cannot be retrieved from the database and used. In order to revert back to using a regular mailbox e-mail address from an aliased one, simply clear this field.'),
          );

          return $form;
        }
        break;


      case 'insert':  //  **  MOSTLY DONE  **  //

// TODO: Check for edge case of account creation w/initial status of blocked.

        // Check to see if an alias has been specified.
        if ($edit['couriermta_email_alias_address'] == '') {
          // No alias was specified, so we treat this account as a mailbox e-mail account.
          _couriermta_insert_mailbox_account(&$edit, &$account);
        }
        else {
          // An alias was specified, so we treat this account as a aliased e-mail account.
          _couriermta_insert_aliased_account(&$edit, &$account);
        }

        $edit['couriermta_email_alias_address'] = NULL;
        break;


      case 'register':
        if (variable_get('couriermta_allow_email_alias', '0')) {
          // Add an e-mail alias area.
          $form['couriermta_email_alias'] = array(
            '#type' => 'fieldset',
            '#title' => t('E-mail alias settings'),
            '#collapsible' => TRUE,
            '#weight' => 1,
          );
          $form['couriermta_email_alias']['couriermta_email_alias_address'] = array(
            '#type' => 'textfield',
            '#title' => t('E-mail alias (optional)'),
            '#default_value' => db_result(db_query('SELECT alias FROM {couriermta_users} WHERE userid=%d', $account->uid)),
            '#description' => t('If this field is filled in with a valid e-mail address, all e-mail sent to the address entered in the "E-mail address" field above will be forwarded to this address instead. When changing from using a regular mailbox e-mail account to using an aliased e-mail account, a password must be given, as the existing password cannot be retrieved from the database and used. In order to revert back to using a regular mailbox e-mail address from an aliased one, simply clear this field.'),
          );

          return $form;
        }
        break;


      case 'update':
        // Make sure that the user is editing the user object.
        if (!empty($edit) && $category == 'account') {
          $account_couriermta_email_alias_address = db_result(db_query('SELECT alias FROM {couriermta_users} WHERE userid=%d', $account->uid));

          // First check to see if the account type has changed. If it has, then treat the operation as two operations: one insert & one delete.
          if ($account_couriermta_email_alias_address != '' && $edit['couriermta_email_alias_address'] == '') {
            // The account is currently setup to use an aliased e-mail and being changed to a mailbox account.
            // Delete the user's information from the alias file.
            _couriermta_delete_aliased_account(&$account);
            // Insert the user's information to the couriermta_users table.
            _couriermta_insert_mailbox_account(&$edit, &$account);
          }
          elseif ($account_couriermta_email_alias_address == '' && $edit['couriermta_email_alias_address'] != '') {
            // The account is currently a mailbox account and is being changed to an aliased account.
            // Delete the user's information from the couriermta_users table.
            _couriermta_delete_mailbox_account(&$account);
            // Insert the user's information to the alias file.
            _couriermta_insert_aliased_account(&$edit, &$account);
          }

          elseif ($account_couriermta_email_alias_address != '' && $edit['couriermta_email_alias_address'] != '') {
            // Update the user's information in the alias file and the couriermta_users table.
            _couriermta_update_aliased_account(&$edit, &$account);
          }
          // Everything else.
          else {
            _couriermta_update_mailbox_account(&$edit, &$account);
          }
        }
        break;


      case 'validate':
        // Verify a password is given when changing from an alias account to a mailbox account.
        // Check the name and mail fields to verify the object is actually being edited.
        if ($edit['name'] != '' && $edit['mail'] != '' && db_result(db_query('SELECT alias FROM {couriermta_users} WHERE userid=%d', $account->uid)) != '' && $edit['couriermta_email_alias_address'] == '' && $edit['pass'] == '') {
          form_set_error('pass', 'You must specify a password when changing from using an aliased e-mail account to using a regular mailbox account.');
        }

        // If an alias is specified, make sure it is not the same as the e-mail address specified.
        if ($edit['mail'] == $edit['couriermta_email_alias_address']) {
          form_set_error('couriermta_email_alias_address', 'You may not specify an alias that is the same as your e-mail address.');
        }
        break;
    }
  }
}  //  End of couriermta_user().


/**
 * Create a mailbox account.
 */
function _couriermta_insert_mailbox_account(&$edit, &$account) {
  // Get the data.
  $user_data = array();
  $user_data = _couriermta_create_user_sql_data(&$edit, &$account);

  // Insert the record.
  switch (variable_get('couriermta_password_type', '0')) {
    case 0:
      // Insert encrypted passwords only.
      if (!db_query('INSERT INTO {couriermta_users} (userid, email, crypt, clear, uid, gid, home, name, maildir, defaultdelivery, quota, auxoptions, alias, status) VALUES (%d, "%s", ENCRYPT("%s"), "", %d, %d, "%s", "%s", "%s", "%s", "%s", "%s", "%s", %d)', $user_data['userid'], $user_data['email'], $user_data['password'], $user_data['uid'], $user_data['gid'], $user_data['home'], $user_data['name'], $user_data['maildir'], $user_data['defaultdelivery'], $user_data['quota'], $user_data['auxoptions'], $user_data['alias'], $user_data['status'])) {
        watchdog('couriermta', t('The query inserting data into the couriermta_users table did not succeed.'), WATCHDOG_ERROR);
      }
      break;

    case 1:
      // Insert cleartext passwords only.
      if (!db_query('INSERT INTO {couriermta_users} (userid, email, crypt, clear, uid, gid, home, name, maildir, defaultdelivery, quota, auxoptions, alias, status) VALUES (%d, "%s", "", "%s", %d, %d, "%s", "%s", "%s", "%s", "%s", "%s", "%s", %d)', $user_data['userid'], $user_data['email'], $user_data['password'], $user_data['uid'], $user_data['gid'], $user_data['home'], $user_data['name'], $user_data['maildir'], $user_data['defaultdelivery '], $user_data['quota'], $user_data['auxoptions'], $user_data['alias'], $user_data['status'])) {
        watchdog('couriermta', t('The query inserting data into the couriermta_users table did not succeed.'), WATCHDOG_ERROR);
      }
      break;

    case 2:
      // Insert both encrypted and cleartext passwords.
      if (!db_query('INSERT INTO {couriermta_users} (userid, email, crypt, clear, uid, gid, home, name, maildir, defaultdelivery, quota, auxoptions, alias, status) VALUES (%d, "%s", ENCRYPT("%s"), "%s", %d, %d, "%s", "%s", "%s", "%s", "%s", "%s", "%s", %d)', $user_data['userid'], $user_data['email'], $user_data['password'], $user_data['password'], $user_data['uid'], $user_data['gid'], $user_data['home'], $user_data['name'], $user_data['maildir'], $user_data['defaultdelivery'], $user_data['quota'], $user_data['auxoptions'], $user_data['alias'], $user_data['status'])) {
        watchdog('couriermta', t('The query inserting data into the couriermta_users table did not succeed.'), WATCHDOG_ERROR);
      }
      break;
  }

  // Update the insertmailbox file.
  _couriermta_update_input_file('insert', 'mailbox', (empty($user_data['maildir'])) ? $user_data['home'] : $user_data['maildir'] .'
');
}  //  End of _couriermta_insert_mailbox_account().


/**
 * Create an alias account.
 */
function _couriermta_insert_aliased_account(&$edit, &$account) {
  // Get the data.
  $user_data = array();
  $user_data = _couriermta_create_user_sql_data(&$edit, &$account);

  // Update the couriermta_users table.
  if (!db_query('INSERT INTO {couriermta_users} (userid, alias, status) VALUES (%d, "%s", %d)', $user_data['userid'], $user_data['alias'], $user_data['status'])) {
    watchdog('couriermta', t('The query inserting data into the couriermta_users table did not succeed.'), WATCHDOG_ERROR);
  }

  // Update the insertalias file.
  _couriermta_update_input_file('insert', 'alias', $user_data['email'] .': '. $user_data['alias'] .'
');
} //  End of _couriermta_insert_aliased_account().


/**
 * Update a mailbox account.
 */
function _couriermta_update_mailbox_account(&$edit, &$account) {
  // Get the data.
  $user_data = array();
  $user_data = _couriermta_create_user_sql_data(&$edit, &$account);

  // Get the old mailbox directory before the database changes.
  if ($edit['mail'] != $account->mail) {
    if (!$oldmailboxdir =  db_result(db_query('SELECT maildir FROM {couriermta_users} WHERE userid=%d', $account->uid))) {
      $oldmailboxdir =  db_result(db_query('SELECT home FROM {couriermta_users} WHERE userid=%d', $account->uid));
    }
  }

  // Update the record.
  if ($user_data['password'] == '') {
    // The data does not include a password.
    if (!db_query('UPDATE {couriermta_users} SET email="%s", uid=%d, gid=%d, home="%s", name="%s", maildir="%s", defaultdelivery="%s", quota="%s", auxoptions="%s", alias="%s", status=%d WHERE userid=%d', $user_data['email'], $user_data['uid'], $user_data['gid'], $user_data['home'], $user_data['name'], $user_data['maildir'], $user_data['defaultdelivery'], $user_data['quota'], $user_data['auxoptions'], $user_data['alias'], $user_data['status'], $user_data['userid'])) {
      watchdog('couriermta', t('The query inserting data into the couriermta_users table did not succeed.'), WATCHDOG_ERROR);
    }
  }
  else {
    // The data includes a password.
    switch (variable_get('couriermta_password_type', '0')) {
      case 0:
        // Insert encrypted passwords only.
        if (!db_query('UPDATE {couriermta_users} SET email="%s", crypt=ENCRYPT("%s"), clear="", uid=%d, gid=%d, home="%s", name="%s", maildir="%s", defaultdelivery="%s", quota="%s", auxoptions="%s", alias="%s", status=%d WHERE userid=%d', $user_data['email'], $user_data['password'], $user_data['uid'], $user_data['gid'], $user_data['home'], $user_data['name'], $user_data['maildir'], $user_data['defaultdelivery'], $user_data['quota'], $user_data['auxoptions'], $user_data['alias'], $user_data['status'], $user_data['userid'])) {
          watchdog('couriermta', t('The query inserting data into the couriermta_users table did not succeed.'), WATCHDOG_ERROR);
        }
        break;

      case 1:
        // Insert cleartext passwords only.
        if (!db_query('UPDATE {couriermta_users} SET email="%s", crypt="", clear="%s", uid=%d, gid=%d, home="%s", name="%s", maildir="%s", defaultdelivery="%s", quota="%s", auxoptions="%s", alias="%s", status=%d WHERE userid=%d', $user_data['email'], $user_data['password'], $user_data['uid'], $user_data['gid'], $user_data['home'], $user_data['name'], $user_data['maildir'], $user_data['defaultdelivery'], $user_data['quota'], $user_data['auxoptions'], $user_data['alias'], $user_data['status'], $user_data['userid'])) {
          watchdog('couriermta', t('The query inserting data into the couriermta_users table did not succeed.'), WATCHDOG_ERROR);
        }
        break;

      case 2:
        // Insert both encrypted and cleartext passwords.
        if (!db_query('UPDATE {couriermta_users} SET email="%s", crypt=ENCRYPT("%s"), clear="%s", uid=%d, gid=%d, home="%s", name="%s", maildir="%s", defaultdelivery="%s", quota="%s", auxoptions="%s", alias="%s", status=%d WHERE userid=%d', $user_data['email'], $user_data['password'], $user_data['password'], $user_data['uid'], $user_data['gid'], $user_data['home'], $user_data['name'], $user_data['maildir'], $user_data['defaultdelivery'], $user_data['quota'], $user_data['auxoptions'], $user_data['alias'], $user_data['status'], $user_data['userid'])) {
          watchdog('couriermta', t('The query inserting data into the couriermta_users table did not succeed.'), WATCHDOG_ERROR);
        }
        break;
    }
  }

  if ($oldmailboxdir) {
    if (!$newmailboxdir =  db_result(db_query('SELECT maildir FROM {couriermta_users} WHERE userid=%d', $account->uid))) {
      $newmailboxdir =  db_result(db_query('SELECT home FROM {couriermta_users} WHERE userid=%d', $account->uid));
    }

    // Update the updatemailbox file.
    _couriermta_update_input_file('update', 'mailbox', $oldmailboxdir .':'. $newmailboxdir .'
');
  }
}  //  End of _couriermta_update_mailbox_account().


/**
 * Update an alias account.
 */
function _couriermta_update_aliased_account(&$edit, &$account) {
  // Get the data.
  $user_data = array();
  $user_data = _couriermta_create_user_sql_data(&$edit, &$account);

  if (db_result(db_query('SELECT alias FROM {couriermta_users} WHERE userid=%d', $account->uid)) != $user_data['alias']) {
    // Update the deletealias file.
    _couriermta_update_input_file('delete', 'alias', $account->mail .': '. db_result(db_query('SELECT alias FROM {couriermta_users} WHERE userid=%d', $account->uid)) .'
');

    // Update the insertalias file.
    _couriermta_update_input_file('insert', 'alias', $edit['mail'] .': '. $edit['couriermta_email_alias_address'] .'
');
  }

  // Update the couriermta_users table.
  if (!db_query('UPDATE {couriermta_users} SET alias="%s", status=%d WHERE userid=%d', $user_data['alias'], $user_data['status'], $user_data['userid'])) {
    watchdog('couriermta', t('The query inserting data into the couriermta_users table did not succeed.'), WATCHDOG_ERROR);
  }
}  //  End of _couriermta_update_aliased_account().


/**
 * Delete a mailbox account.
 */
function _couriermta_delete_mailbox_account(&$account) {
  if ($mailboxdir =  db_result(db_query('SELECT maildir FROM {couriermta_users} WHERE userid=%d', $account->uid))) {
    // Update the deletemailbox file.
    _couriermta_update_input_file('delete', 'mailbox', $mailboxdir .'
');
  }
  else {
    // Update the deletemailbox file.
    _couriermta_update_input_file('delete', 'mailbox', db_result(db_query('SELECT home FROM {couriermta_users} WHERE userid=%d', $account->uid)) .'
');
  }

  // Update the couriermta_users table.
  if (!db_query_range('DELETE FROM {couriermta_users} WHERE userid=%d AND email="%s"', $account->uid, $account->mail, 0, 1)) {
    watchdog('couriermta', t('The query to remove data from the couriermta_users table was not successfully executed.'), WATCHDOG_ERROR);
  }
}  //  End of _couriermta_delete_mailbox_account().


/**
 * Delete an alias account.
 */
function _couriermta_delete_aliased_account(&$account) {
  // Update the deletealias file.
  _couriermta_update_input_file('delete', 'alias', $account->mail .': '. db_result(db_query('SELECT alias FROM {couriermta_users} WHERE userid=%d', $account->uid)) .'
');

  // Update the couriermta_users table.
  if (!db_query_range('DELETE FROM {couriermta_users} WHERE userid=%d', $account->uid, 0, 1)) {
    watchdog('couriermta', t('The query to remove data from the couriermta_users table was not successfully executed.'), WATCHDOG_ERROR);
  }
}  //  End of _couriermta_delete_aliased_account().


/**
 * Creates an array with the data for an SQL string which can be used to
 * insert, update or delete data in the couriermta_users table.
 */
function _couriermta_create_user_sql_data(&$edit, &$account) {
  $user_data = array();
  $user_data['userid'] = $account->uid;

  if (module_exists('token') && variable_get('couriermta_use_token_module', '0') == 1) {
    if (variable_get('couriermta_email_users_address', '1') == 1) {
      $user_data['email'] = $edit['mail'];
    }
    else {
      $user_data['email'] = token_replace(variable_get('couriermta_email_pattern', ''));
    }

    if (variable_get('couriermta_password_users_password', '1') == 1) {
      $user_data['password'] = $edit['pass'];
    }
    else {
      $user_data['password'] = token_replace(variable_get('couriermta_password_encrypted', ''));
    }

    if (variable_get('couriermta_users_name', '1') == 1) {
      $user_data['name'] = $edit['name'];
    }
    else {
      $user_data['name'] = token_replace(variable_get('couriermta_name', ''));
    }

    $user_data['uid'] = token_replace(variable_get('couriermta_uid_pattern', '65534'));
    $user_data['gid'] = token_replace(variable_get('couriermta_gid_pattern', '65534'));

    $user_data['home']    = token_replace(variable_get('couriermta_home_pattern', '/var/spool/mail/'));
    $user_data['maildir'] = token_replace(variable_get('couriermta_maildir_pattern', '/var/spool/mail/'));

    $user_data['defaultdelivery'] = token_replace(variable_get('couriermta_defaultdelivery_pattern', ''));
    $user_data['quota']           = token_replace(variable_get('couriermta_quota_pattern', ''));
    $user_data['auxoptions']      = token_replace(variable_get('couriermta_options_pattern', ''));
  }
  else {
    if (variable_get('couriermta_email_users_address', '1') == 1) {
      $user_data['email'] = $edit['mail'];
    }
    else {
      $user_data['email'] = variable_get('couriermta_email_pattern', '');
    }

    if (variable_get('couriermta_password_users_password', '1') == 1) {
      $user_data['password'] = $edit['pass'];
    }
    else {
      $user_data['password'] = variable_get('couriermta_password_encrypted', '');
    }

    if (variable_get('couriermta_users_name', '1') == 1) {
      $user_data['name'] = $edit['name'];
    }
    else {
      $user_data['name'] = variable_get('couriermta_name', '');
    }

    $user_data['uid'] = variable_get('couriermta_uid_pattern', '65534');
    $user_data['gid'] = variable_get('couriermta_gid_pattern', '65534');

    $user_data_home = variable_get('couriermta_home_pattern', '/var/spool/mail/!domain_name/!user_name');
    if (strstr ($user_data_home, '!domain_name')) {
      if (strstr ($user_data_home, '!user_name')) {
        $user_data_home = str_replace('!user_name', substr($edit['mail'], 0, strpos($edit['mail'], '@')), $user_data_home);
        $user_data_home = str_replace('!domain_name', substr($edit['mail'], strpos($edit['mail'], '@') + 1, strlen($edit['mail'])), $user_data_home);
      }
      else {
        $user_data_home = str_replace('!domain_name', substr($edit['mail'], strpos($edit['mail'], '@') + 1, strlen($edit['mail'])), $user_data_home);
      }
    }
    else {
      if (strstr ($user_data_home, '!user_name')) {
        $user_data_home = str_replace('!user_name', substr($edit['mail'], 0, strpos($edit['mail'], '@')), $user_data_home);
      }
      else {
      }
    }
    $user_data['home'] = $user_data_home;

    $user_data_maildir = variable_get('couriermta_maildir_pattern', '/var/spool/mail/!domain_name/!user_name');
    if (strstr ($user_data_maildir, '!domain_name')) {
      if (strstr ($user_data_maildir, '!user_name')) {
        $user_data_maildir = str_replace('!user_name', substr($edit['mail'], 0, strpos($edit['mail'], '@')), $user_data_maildir);
        $user_data_maildir = str_replace('!domain_name', substr($edit['mail'], strpos($edit['mail'], '@') + 1, strlen($edit['mail'])), $user_data_maildir);
      }
      else {
        $user_data_maildir = str_replace('!domain_name', substr($edit['mail'], strpos($edit['mail'], '@') + 1, strlen($edit['mail'])), $user_data_maildir);
      }
    }
    else {
      if (strstr ($user_data_maildir, '!user_name')) {
        $user_data_maildir = str_replace('!user_name', substr($edit['mail'], 0, strpos($edit['mail'], '@')), $user_data_maildir);
      }
    }
    $user_data['maildir'] = $user_data_maildir;

    $user_data['defaultdelivery'] = variable_get('couriermta_defaultdelivery_pattern', '');
    $user_data['quota']           = variable_get('couriermta_quota_pattern', '');
    $user_data['auxoptions']      = variable_get('couriermta_options_pattern', '');
  }

  if (variable_get('couriermta_allow_email_alias', '0') == 1) {
    $user_data['alias'] = $edit['couriermta_email_alias_address'];
  }

  $user_data['status'] = $edit['status'];

  return $user_data;
}  //  End of _couriermta_create_user_sql_data().


/**
 * Updates the relevant input file.
 */
function _couriermta_update_input_file($operation, $email_type, $file_contents) {
  $file_name   = drupal_get_path('module', 'couriermta') .'/'. $operation . $email_type;
  $file_handle = fopen($file_name, 'a');

  if (!$file_handle) {
    watchdog('couriermta', t('The ') . $operation . $email_type . t(' file could not be opened. Check to make sure valid permissions are in place for ') . $file_name, WATCHDOG_ERROR);
  }
  else {
    if (!fwrite($file_handle, $file_contents)) {
      watchdog('couriermta', t('There was an error writing to the alias file.'), WATCHDOG_ERROR);
    }
    else {
      watchdog('couriermta', 'Successfully wrote to '. $file_name .'.');
    }

    if (!fclose($file_handle)) {
      watchdog('couriermta', t('There was an error closing the alias file.'), WATCHDOG_ERROR);
    }
  }
}  //  End of _couriermta_update_input_file().