Mailinglist
 All Data Structures Files Functions Variables Pages
MailinglistRetrieve.class.php
Go to the documentation of this file.
1 <?php
9 require_once("MailinglistMessage.class.php");
10 
24  public function test() {
25  return array();
26  }
27 
31  public function get_message_list($max=0) {
32  return array();
33  }
34 
36  public function get_message($id) {
37  return FALSE;
38  }
39 
41  public function purge_message($id) {
42  return;
43  }
44 
46  public function close() {
47  }
49 
57  function edit_form(&$form, &$form_state) {
58  parent::edit_form($form, $form_state);
59  $form['info']['admin_title']['#description'] = t('Suggested, but not required, to be the email address of the mailbox.');
60 
61  $form['extra']['settings']['limit'] = array(
62  '#type' => 'textfield',
63  '#title' => t('Maximum messages to retrieve'),
64  '#size' => 5,
65  '#maxlength' => 5,
66  '#default_value' => $this->get_setting('limit', 0),
67  '#description' => t('To prevent timeout errors from large mailboxes you can limit the maximum number of messages that will be retrieved during each cron run. Set to zero for no limit.'),
68  '#element_validate' => array('element_validate_integer'),
69  '#required' => TRUE,
70  );
71  $form['extra']['settings']['encoding'] = array(
72  '#type' => 'textfield',
73  '#title' => t('Default character encoding'),
74  '#default_value' => $this->get_setting('encoding', 'UTF-8'),
75  '#description' => t('The default character encoding to use when an incoming message does not define an encoding.'),
76  '#required' => TRUE,
77  );
78  }
79 
83  function edit_form_validate(&$form, &$form_state) {
84  parent::edit_form_validate($form, $form_state);
86  }
87 
91  function edit_form_submit(&$form, &$form_state) {
92  parent::edit_form_submit($form, $form_state);
93  }
95 }
get_message_list($max=0)
Returns a list of messages that are available.
close()
delete marked messages and close connection
get_setting($name, $def=NULL)
get_settings()
edit_form(&$form, &$form_state)
Implements ctools_export_ui::edit_form().
edit_form_submit(&$form, &$form_state)
Implements ctools_export_ui::edit_form_submit().
get_message($id)
Get an email message by its id code (what is returned by get_message_list()
Place for common code for classes used in export_ui classes.
edit_form_validate(&$form, &$form_state)
Implements ctools_export_ui::edit_form_validate().
purge_message($id)
mark message for deletion
Retrieve messages from a Mailinglist Mailbox.
interface MailinglistRetrieveInterface