MailinglistRetrieveUI Class Reference

Represents an email mailbox (IMAP, POP3, etc...). More...

Inheritance diagram for MailinglistRetrieveUI:

Collaboration diagram for MailinglistRetrieveUI:

Public Member Functions
ctools_export_ui
	hook_menu (&$items)
	Implements ctools_export_ui::hook_form(). More...
	edit_form (&$form, &$form_state)
	Implements ctools_export_ui::edit_form(). More...
	list_header ($form_state)
	list_header() More...
	test_page ($js, $input, $mailbox)
	Callback to test a mailbox connection. More...
	process_page ($js, $input, $mailbox)
	process_page() More...
Public Member Functions inherited from MailinglistExportUI
	edit_form (&$form, &$form_state)
	Implements ctools_export_ui::edit_form(). More...
	edit_form_validate (&$form, &$form_state)
	Implements ctools_export_ui::edit_form_validate(). More...
	edit_form_submit (&$form, &$form_state)
	Implements ctools_export_ui::edit_form_submit(). More...
	edit_save_form ($form_state)
	delete_form_submit (&$form_state)
	Implements ctools_export_ui::delete_form_submit(). More...

Detailed Description

Represents an email mailbox (IMAP, POP3, etc...).

Definition at line 11 of file MailinglistRetrieveUI.class.php.

Member Function Documentation

edit_form	(	&	$form,
		&	$form_state
	)

Implements ctools_export_ui::edit_form().

Definition at line 30 of file MailinglistRetrieveUI.class.php.

References _mailinglist_build_options(), and mailinglist_get_plugins().

                                           {

    // All Retrievers will need some settings for connection.
    $form['connection']['#tree'] = FALSE;
    $form['connection']['#weight'] = 20;
    $form['connection']['settings']= array(
      '#type' => 'fieldset',
      '#title' => 'Mailbox connection settings',
      '#tree' => TRUE,
      '#collapsible' => TRUE,
      '#collapsed' => FALSE,
    );

    $form['extra']['#tree'] = FALSE;
    $form['extra']['#weight'] = 90;
    $form['extra']['settings']= array(
      '#type' => 'fieldset',
      '#title' => 'More settings',
      '#tree' => TRUE,
      '#collapsible' => TRUE,
      '#collapsed' => TRUE,
    );

    parent::edit_form($form, $form_state);

    // object_type selection is not dependant on type of object

    $retrieve_plugins = mailinglist_get_plugins('mailinglist', 'retrieve');
    /* Type of Mail Box */
    $form['info']['object_type'] = array(
      '#type' => 'select',
      '#title' => t('Mailbox Type'),
      '#options' => _mailinglist_build_options($retrieve_plugins),
      '#default_value' => isset($form_state['item']->object_type) ? $form_state['item']->object_type : NULL,
      '#description' => t('Plug in to use to read mailbox'),
      '#required' => TRUE,
    );
  }

Here is the call graph for this function:

hook_menu

(

&

$items

)

Implements ctools_export_ui::hook_form().

Definition at line 20 of file MailinglistRetrieveUI.class.php.

                              {
    parent::hook_menu($items);
    if (isset($items['admin/config/system/mailinglist/mailbox'])) {
        $items['admin/config/system/mailinglist/mailbox']['type'] = MENU_LOCAL_TASK;
    }
  }

list_header

(

$form_state

)

list_header()

Definition at line 72 of file MailinglistRetrieveUI.class.php.

                                    {
    if (isset($form_state['input']['test_result'])) {
      return $form_state['input']['test_result'];
    }
  }

process_page	(		$js,
			$input,
			$mailbox
	)

process_page()

UI Callback for mailinglist_mailbox_ui process operation

Definition at line 96 of file MailinglistRetrieveUI.class.php.

References mailinglist_list_load_all().

                                               {
//  dpm($js);
//  dpm($input);
    dpm($mailbox, 'process_page');
    $page['list'] = array(
      '#theme' => 'table',
      '#header' => array(
        array('data' => 'Message', ),
        array('data' => 'List'),
        array('data' => 'Results', ),
        array('data' => 'Subject', ),
      ),
      '#rows' => array(),
    );

    drupal_set_title($this->get_page_title('process', $mailbox));

    // Check if we have a real mailbox object
    if (method_exists($mailbox, 'get_message_list')) {
      $lists = mailinglist_list_load_all();
      $msg_list = $mailbox->get_message_list($mailbox->settings['limit']);
      if (!$msg_list) {
        // Avoid error message on error, maybe should log the error?
        $msg_list = array();
      }
      foreach ($msg_list as $msg_idx => $msg_id) {
        $msg = $mailbox->get_message($msg_id);
        dpm($msg, $msg_id);
        $handled = FALSE;
        foreach ($lists as $list => $listobj) {
          $handled = $listobj->processMessage($msg);
          if ($handled) {
            if ($mailbox->get_setting('delete_after_read', FALSE)) {
                dpm('Purge', $msg_id);
//              $mailbox -> purge_msg($msg_id);
            }
            break;
          }
        } // end of foreach ($lists), process handled code
        if ($handled == FALSE) {
          $list = "**None**";
          $handled = "Unhandled";
        }
        if ($handled === TRUE) {
          $handled = "Match";
        }
        $row = array($msg_id, $list, $handled, $msg->header('Subject'));
        $msg_list[$msg_idx] = array($msg_id, $handled ? $list : 'Unhandled');
        $page['list']['#rows'][$msg_idx] = $row;
      }
      $mailbox->close();
    }
    return $page;
  }

Here is the call graph for this function:

test_page	(		$js,
			$input,
			$mailbox
	)

Callback to test a mailbox connection.

Definition at line 81 of file MailinglistRetrieveUI.class.php.

References _mailinglist_mailbox_test_output().

                                            {
    $input['test_result'] = _mailinglist_mailbox_test_output($mailbox);
    if (!$js) {
      drupal_goto(ctools_export_ui_plugin_base_path($this->plugin));
    }
    else {
      return $this->list_page($js, $input);
    }
  }

Here is the call graph for this function:

---

The documentation for this class was generated from the following file:

• mailinglist/plugins/ctools/export_ui/MailinglistRetrieveUI.class.php