smtp.admin.inc in SMTP Authentication Support 7

Same filename and directory in other branches
7.2 smtp.admin.inc
Administrative page code for the smtp module.
File

smtp.admin.inc
View source
<?php

/**
 * @file
 * Administrative page code for the smtp module.
 */

/**
 * Administrative settings.
 */
function smtp_admin_settings() {
  if (variable_get('smtp_on', 0)) {
    drupal_set_message(t('SMTP.module is active.'));
  }
  else {
    drupal_set_message(t('SMTP.module is INACTIVE.'));
  }
  $logging = variable_get('smtp_debugging', SMTP_LOGGING_ERRORS);
  $form['onoff'] = array(
    '#type' => 'fieldset',
    '#title' => t('Install options'),
  );
  $form['onoff']['smtp_on'] = array(
    '#type' => 'radios',
    '#title' => t('Turn this module on or off'),
    '#default_value' => variable_get('smtp_on', FALSE),
    '#options' => array(
      1 => t('On'),
      0 => t('Off'),
    ),
    '#description' => t('To uninstall this module you must turn it off here first.'),
  );
  $form['onoff']['smtp_deliver'] = array(
    '#type' => 'radios',
    '#title' => t('Turn on delivery of emails'),
    '#default_value' => variable_get('smtp_deliver', TRUE),
    '#options' => array(
      1 => t('On'),
      0 => t('Off'),
    ),
    '#description' => t('With this option turned off, email messages will be queued up and processed as normal, but not actually delivered. This option should only be used for testing purposes.'),
  );
  $form['onoff']['smtp_queue'] = array(
    '#type' => 'checkbox',
    '#title' => t('Send mail by queue'),
    '#default_value' => variable_get('smtp_queue', FALSE),
    '#description' => t('Mails will be sent by drupal queue api.'),
  );
  $form['onoff']['smtp_queue_fail'] = array(
    '#type' => 'checkbox',
    '#title' => t('Retry sending mail on error.'),
    '#default_value' => variable_get('smtp_queue_fail', FALSE),
    '#description' => t('Mails will be added to the queue and sent by drupal queue api.'),
  );
  $form['server'] = array(
    '#type' => 'fieldset',
    '#title' => t('SMTP server settings'),
  );
  $form['server']['smtp_host'] = array(
    '#type' => 'textfield',
    '#title' => t('SMTP server'),
    '#default_value' => variable_get('smtp_host', ''),
    '#description' => t('The address of your outgoing SMTP server.'),
  );
  $form['server']['smtp_hostbackup'] = array(
    '#type' => 'textfield',
    '#title' => t('SMTP backup server'),
    '#default_value' => variable_get('smtp_hostbackup', ''),
    '#description' => t('The address of your outgoing SMTP backup server. If the primary server can\'t be found this one will be tried. This is optional.'),
  );
  $form['server']['smtp_port'] = array(
    '#type' => 'textfield',
    '#title' => t('SMTP port'),
    '#size' => 6,
    '#maxlength' => 6,
    '#default_value' => variable_get('smtp_port', '25'),
    '#description' => t('The default SMTP port is 25, if that is being blocked try 80. Gmail uses 465. See !url for more information on configuring for use with Gmail.', array(
      '!url' => l(t('this page'), 'http://gmail.google.com/support/bin/answer.py?answer=13287'),
    )),
  );

  // Only display the option if openssl is installed.
  if (function_exists('openssl_open')) {
    $encryption_options = array(
      'standard' => t('No'),
      'ssl' => t('Use SSL'),
      'tls' => t('Use TLS'),
    );
    $encryption_description = t('This allows connection to a SMTP server that requires SSL encryption such as Gmail.');
  }
  else {
    variable_set('smtp_protocol', 'standard');
    $encryption_options = array(
      'standard' => t('No'),
    );
    $encryption_description = t('Your PHP installation does not have SSL enabled. See the !url page on php.net for more information. Gmail requires SSL.', array(
      '!url' => l(t('OpenSSL Functions'), 'http://php.net/openssl'),
    ));
  }
  $form['server']['smtp_protocol'] = array(
    '#type' => 'select',
    '#title' => t('Use encrypted protocol'),
    '#default_value' => variable_get('smtp_protocol', 'standard'),
    '#options' => $encryption_options,
    '#description' => $encryption_description,
  );
  $form['server']['smtp_ssl_context'] = array(
    '#type' => 'fieldset',
    '#title' => t('SSL Context Options'),
    '#description' => t('Be careful when adjusting following options. See more details !url.', array(
      '!url' => l(t('here'), 'https://secure.php.net/manual/en/context.ssl.php'),
    )),
    '#states' => array(
      'invisible' => array(
        ':input[name="smtp_protocol"]' => array(
          'value' => t('standard'),
        ),
      ),
    ),
  );
  $form['server']['smtp_ssl_context']['smtp_verify_peer'] = array(
    '#type' => 'checkbox',
    '#title' => t('Verify SMTP server SSL certificate'),
    '#default_value' => variable_get('smtp_verify_peer', version_compare(phpversion(), '5.6.0', '>=')),
    '#description' => t('This option is enabled by default from PHP 5.6.0. It checks whether SMTP server certificate is valid.'),
    '#states' => array(
      'invisible' => array(
        ':input[name="smtp_protocol"]' => array(
          'value' => t('standard'),
        ),
      ),
    ),
  );
  if (version_compare(phpversion(), '5.6.0', '>=')) {
    $form['server']['smtp_ssl_context']['smtp_verify_peer_name'] = array(
      '#type' => 'checkbox',
      '#title' => t('Verify SMTP server SSL certificate CN'),
      '#default_value' => variable_get('smtp_verify_peer_name', TRUE),
      '#description' => t('This option is introduced in PHP 5.6.0 and is enabled by default. It checks whether SMTP server certificate CN matches the SMTP server you specify above.'),
      '#states' => array(
        'invisible' => array(
          ':input[name="smtp_protocol"]' => array(
            'value' => t('standard'),
          ),
        ),
      ),
    );
  }
  $form['server']['smtp_ssl_context']['smtp_allow_self_signed'] = array(
    '#type' => 'checkbox',
    '#title' => t('Allow SMTP server to use self-signed certificate'),
    '#default_value' => variable_get('smtp_allow_self_signed', FALSE),
    '#description' => t('This option is disabled by default. It only takes effect when option <b>Verify SMTP server SSL certificate</b> is enabled.'),
    '#states' => array(
      'invisible' => array(
        ':input[name="smtp_protocol"]' => array(
          'value' => t('standard'),
        ),
      ),
    ),
  );
  $form['auth'] = array(
    '#type' => 'fieldset',
    '#title' => t('SMTP Authentication'),
    '#description' => t('Leave blank if your SMTP server does not require authentication.'),
  );
  $form['auth']['smtp_username'] = array(
    '#type' => 'textfield',
    '#title' => t('Username'),
    '#default_value' => variable_get('smtp_username', ''),
    '#description' => t('SMTP Username.'),
  );
  $form['auth']['smtp_password'] = array(
    '#type' => 'password',
    '#title' => t('Password'),
    '#default_value' => variable_get('smtp_password', ''),
    '#description' => t('SMTP password. If you have already entered your password before, you should leave this field blank, unless you want to change the stored password.'),
    '#attributes' => array(
      'autocomplete' => 'off',
    ),
  );
  $form['email_options'] = array(
    '#type' => 'fieldset',
    '#title' => t('E-mail options'),
  );
  $form['email_options']['smtp_from'] = array(
    '#type' => 'textfield',
    '#title' => t('E-mail from address'),
    '#default_value' => variable_get('smtp_from', ''),
    '#description' => t('The e-mail address that all e-mails will be from.'),
  );
  $form['email_options']['smtp_fromname'] = array(
    '#type' => 'textfield',
    '#title' => t('E-mail from name'),
    '#default_value' => variable_get('smtp_fromname', ''),
    '#description' => t('The name that all e-mails will be from. If left blank will use the site name of:') . ' ' . variable_get('site_name', 'Drupal powered site'),
  );
  $form['email_options']['smtp_allowhtml'] = array(
    '#type' => 'checkbox',
    '#title' => t('Allow to send e-mails formatted as Html'),
    '#default_value' => variable_get('smtp_allowhtml', 0),
    '#description' => t('Checking this box will allow Html formatted e-mails to be sent with the SMTP protocol.'),
  );
  $form['client'] = array(
    '#type' => 'fieldset',
    '#title' => t('SMTP client settings'),
  );
  $form['client']['smtp_client_hostname'] = array(
    '#type' => 'textfield',
    '#title' => t('Hostname'),
    '#default_value' => variable_get('smtp_client_hostname', ''),
    '#description' => t('The hostname to use in the Message-Id and Received headers, and as the default HELO string. Leave blank for using %server_name.', array(
      '%server_name' => isset($_SERVER['SERVER_NAME']) ? $_SERVER['SERVER_NAME'] : 'localhost.localdomain',
    )),
  );
  $form['client']['smtp_client_helo'] = array(
    '#type' => 'textfield',
    '#title' => t('HELO'),
    '#default_value' => variable_get('smtp_client_helo', ''),
    '#description' => t('The SMTP HELO/EHLO of the message. Defaults to hostname (see above).'),
  );
  $form['email_test'] = array(
    '#type' => 'fieldset',
    '#title' => t('Send test e-mail'),
  );
  $form['email_test']['smtp_test_address'] = array(
    '#type' => 'textfield',
    '#title' => t('E-mail address to send a test e-mail to'),
    '#default_value' => '',
    '#description' => t('Type in an address to have a test e-mail sent there.'),
  );
  $form['debugging'] = array(
    '#type' => 'fieldset',
    '#title' => t('Debugging and logging'),
  );
  $logging_options = array(
    SMTP_LOGGING_ALL => t('Log everything'),
    SMTP_LOGGING_ERRORS => t('Errors only'),
    SMTP_LOGGING_NONE => t('No logging'),
  );
  $form['debugging']['smtp_debugging'] = array(
    '#type' => 'select',
    '#title' => t('Logging'),
    '#options' => $logging_options,
    '#default_value' => $logging,
    '#description' => t('Choose the appropriate log level. "Log everything" will log errors and informational messages when an email is sent. "Errors only" will only create a log entry when sending failed. "No logging" will disable all logging for this module.'),
  );
  $form['email_test']['smtp_reroute_address'] = array(
    '#type' => 'textfield',
    '#title' => t('E-mail address to reroute all emails to'),
    '#default_value' => variable_get('smtp_reroute_address', ''),
    '#description' => t('All emails sent by the site will be rerouted to this email address; use with caution.'),
  );
  $form['debugging']['maillog'] = array(
    '#type' => 'fieldset',
    '#title' => t('Maillog integration'),
  );
  if (!module_exists('maillog')) {
    $form['debugging']['maillog']['#description'] = t('Installing the <a href="@url">Maillog module</a> also allows keeping copies of all emails sent through the site.', array(
      '@url' => 'https://www.drupal.org/project/maillog',
    ));
  }
  else {
    $form['debugging']['maillog']['#description'] = t('The <a href="@url">Maillog module</a> is installed, it can also be used to keep copies of all emails sent through the site.', array(
      '@url' => url('admin/config/development/maillog'),
    ));
    $form['debugging']['maillog']['maillog_log'] = array(
      '#type' => 'checkbox',
      '#title' => t("Create table entries in maillog table for each e-mail."),
      '#default_value' => variable_get('maillog_log', TRUE),
    );
    $form['debugging']['maillog']['maillog_devel'] = array(
      '#type' => 'checkbox',
      '#title' => t("Display the e-mails on page using devel module (if enabled)."),
      '#default_value' => variable_get('maillog_devel', TRUE),
      '#disabled' => !module_exists('devel'),
    );
  }
  $form['#submit'][] = 'smtp_admin_settings_form_submit';
  $form = system_settings_form($form);
  $form['#submit'][] = 'smtp_admin_settings_submit_post_system_settings';
  return $form;
}

/**
 * Validation for the administrative settings form.
 */
function smtp_admin_settings_validate($form, &$form_state) {
  if ($form_state['values']['smtp_on'] == 1 && $form_state['values']['smtp_host'] == '') {
    form_set_error('smtp_host', t('You must enter a SMTP server address.'));
  }
  if ($form_state['values']['smtp_on'] == 1 && $form_state['values']['smtp_port'] == '') {
    form_set_error('smtp_port', t('You must enter a SMTP port number.'));
  }
  if ($form_state['values']['smtp_from'] && !valid_email_address($form_state['values']['smtp_from'])) {
    form_set_error('smtp_from', t('The provided from e-mail address is not valid.'));
  }
}

//  End of smtp_admin_settings_validate().

/**
 * Submit handler().
 */
function smtp_admin_settings_form_submit($form, &$form_state) {

  // Check if SMTP status has been changed.
  if (!variable_get('smtp_on', FALSE) && $form_state['values']['smtp_on'] || variable_get('smtp_on', FALSE) && !$form_state['values']['smtp_on']) {
    $mail_modes = variable_get('mail_system', array(
      'default-system' => 'DefaultMailSystem',
    ));

    // Turning on.
    if ($form_state['values']['smtp_on']) {
      variable_set('smtp_previous_mail_system', $mail_modes['default-system']);
      $mail_modes['default-system'] = 'SmtpMailSystem';
    }
    else {
      $mail_modes['default-system'] = variable_get('smtp_previous_mail_system', 'DefaultMailSystem');
    }
    variable_set('mail_system', $mail_modes);
  }

  // If username is set empty, we must set both username/password empty as well.
  if (empty($form_state['values']['smtp_username'])) {
    $form_state['values']['smtp_password'] = '';
  }
  elseif (empty($form_state['values']['smtp_password'])) {
    unset($form_state['values']['smtp_password']);
  }

  // Save the test address to send an email after all the settings have been
  // updated.
  $form_state['storage']['smtp']['smtp_test_address'] = $form_state['values']['smtp_test_address'];
  unset($form_state['values']['smtp_test_address']);
}

/**
 * Submit handler for the administrative settings form containing all
 * functionality to be run after system_settings_form_submit.
 */
function smtp_admin_settings_submit_post_system_settings($form, &$form_state) {

  // If an address was given, send a test e-mail message.
  $test_address = $form_state['storage']['smtp']['smtp_test_address'];
  if ($test_address != '') {
    $language = language_default();
    $params['subject'] = t('Drupal SMTP test e-mail');
    $params['body'] = array(
      t('If you receive this message it means your site is capable of using SMTP to send e-mail.'),
    );
    drupal_mail('smtp', 'smtp-test', $test_address, $language, $params);
    drupal_set_message(t('A test e-mail has been sent to @email. You may want to <a href="!check">check the logs</a> for any error messages.', array(
      '@email' => $test_address,
      '!check' => url('admin/reports/dblog'),
    )));
  }
}
Functions

Name	Description
smtp_admin_settings	Administrative settings.
smtp_admin_settings_form_submit	Submit handler().
smtp_admin_settings_submit_post_system_settings	Submit handler for the administrative settings form containing all functionality to be run after system_settings_form_submit.
smtp_admin_settings_validate	Validation for the administrative settings form.
You are here

smtp.admin.inc in SMTP Authentication Support 7

File

Functions

API Navigation
