MailinglistMailboxRetrieve.class.php

Go to the documentation of this file.

<?php
class MailinglistMailboxRetrieve extends MailinglistRetrieve {

  function edit_form(&$form, &$form_state) {
    parent::edit_form($form, $form_state);
    global $cookie_domain;

    /* Parameters that we need:
    Base:
    Hostname:
    Port:
    Timeout:
    UseSocket
    Username:
    Password:

    Extra:
    APOPDetect:
    Delete when done:
    Logging: No, Yes, Yes-ShowPasswords
    */

    $ajax_settings = array(
      'callback' => '_mailinglist_mailbox_test',
      'wrapper' => 'mailinglist_test_results',
      'event' => 'change',
      'progress' => array(
        'type' => 'throbber',
        'message' => t('Please wait - testing connection settings...'),
      ),
    );
    $form['connection']['settings']['domain'] = array(
      '#type' => 'textfield',
      '#title' => t('Domain'),
      '#default_value' => $this->get_setting('domain'),
      '#required' => TRUE,
      '#description' => t('The domain of the server used to collect mail.'),
      '#ajax' => $ajax_settings,
    );
    $form['connection']['settings']['port'] = array(
      '#type' => 'textfield',
      '#title' => t('Port'),
      '#size' => 5,
      '#maxlength' => 5,
      '#default_value' => $this->get_setting('port'),
      '#description' => t('The mailbox port number (usually 110 for POP3).'),
      '#element_validate' => array('element_validate_integer_positive'),
      '#required' => TRUE,
      '#ajax' => $ajax_settings,
    );
    $form['connection']['settings']['name'] = array(
      '#type' => 'textfield',
      '#title' => t('Username'),
      '#default_value' => $this->get_setting('name'),
      '#required' => TRUE,
      '#description' => t('This username is used while logging into this mailbox during mail retrieval.'),
      '#ajax' => $ajax_settings,
    );
    $form['connection']['settings']['pass'] = array(
      '#type' => 'textfield',
      '#title' => t('Password'),
      '#default_value' => _mailinglist_decode_password($this->get_setting('pass')),
      '#description' => t('The mailbox password corresponding to the username above. Consider using a non-vital password, since this field is stored with minimal encryption in the database and displayed here.'),
      '#ajax' => $ajax_settings,
    );

    $form['connection']['settings']['results'] = array(
      '#type' => 'container',
      '#attributes' => array(
        'id' => 'mailinglist_test_results',
      ),
    );

    $form['connection']['settings']['timeout'] = array(
      '#type' => 'textfield',
      '#title' => t('Timeout'),
      '#size' => 5,
      '#maxlength' => 5,
      '#default_value' => $this->get_setting('timeout', 10),
      '#description' => t('Timeout (in Sec) to connect to server'),
      '#element_validate' => array('element_validate_number'),
      '#required' => TRUE,
      '#ajax' => $ajax_settings,
    );

    $form['extra']['settings']['apop'] = array(
      '#type' => 'checkbox',
      '#title' => t('Detect APOP?'),
      '#default_value' => $this->get_setting('apop', FALSE),
      '#description' => t('Check to enable APOP protocal detection'),
    );

    $form['extra']['settings']['delete_after_read'] = array(
      '#type' => 'checkbox',
      '#title' => t('Delete messages after they are processed?'),
      '#default_value' => $this->get_setting('delete_after_read', TRUE),
      '#description' => t('Uncheck this box to leave read messages in the mailbox. They will not be processed again unless they become marked as unread. You normallys should check this box.'),
    );

    $form['extra']['settings']['ipv6'] = array(
      '#type' => 'checkbox',
      '#title' => t('IPv6'),
      '#default_value' => $this->get_setting('ipv6', FALSE),
      '#description' => t('Use IPv6'),
    );

  }

  function edit_form_validate(&$form, &$form_state) {
    parent::edit_form_validate($form, $form_state);
    if ($form_state['values']['settings']['port'] < 1 || 65535 < $form_state['values']['settings']['port']) {
      form_set_error('port', t('Port must be between 1 and 65535'));
    }

    if ($form_state['values']['settings']['port'] != 110) {
      drupal_set_message(t('Non-standard Pop3 Port: @port', array('@port' => (int)$form_state['values']['settings']['port'])), 'warning');
    }

    // If POP3 mailbox is chosen, messages should be deleted after processing.
    // Do not set an actual error because this is helpful for testing purposes.
    if ( $form_state['values']['settings']['delete_after_read'] == 0) {
      drupal_set_message(t('Unless you check off "Delete messages after they are processed" when using a POP3 mailbox, old emails will be re-imported each time the mailbox is processed.'), 'warning');
    }
  }

  function edit_form_submit(&$form, &$form_state) {
    parent::edit_form_submit($form, $form_state);
  }


  public function get_message_list($max=0) {
    $res = array();
    return $res;
  }

  public function get_message($id) {
    $msg = "";
    return new MailinglistMessage($msg);
  }

  public function purge_message($id) {
  }

  public function close() {
  }

  public function __destruct() {
  }
}