MailinglistRetrieve Class Reference

Retrieve messages from a Mailinglist Mailbox. More...

Inheritance diagram for MailinglistRetrieve:

Collaboration diagram for MailinglistRetrieve:

Public Member Functions
MailinglistRetrieveInteface
	test ()
	Test connection. More...
	get_message_list ($max=0)
	Returns a list of messages that are available. More...
	get_message ($id)
	Get an email message by its id code (what is returned by get_message_list() More...
	purge_message ($id)
	mark message for deletion More...
	close ()
	delete marked messages and close connection More...
ctools_export_ui
	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...
Public Member Functions inherited from MailinglistExportable
	get_setting ($name, $def=NULL)
	get_settings() More...
	created ()
	created() More...
	edited ($old)
	edited() More...
	changedType (MailinglistPolymorpicExportableInterface $old)
	changedType() More...
	delete ()
	delete() More...
	baseName ()
	baseName() More...
	edit_form (&$form, &$form_state)
	Implements ctools_export_ui::edit_form() called via mailinglist_export_ui Build an edit form for our object. 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...
	log ($str, $level=self::LOG_NOTICE, $parms=array())
	log() More...
	log_screen ($str, $parms=array(), $level=self::LOG_NOTICE)
	log_screen() More...
	log_db ($str, $parms=array(), $level=self::LOG_ERROR)
	log_db(). More...
	log_file ($str, $parms=array(), $level=self::LOG_INFO)
	log_file(). More...
MailinglistPolymorphicExportableInterface
MailinglistRetrieveInterface

Additional Inherited Members
Data Fields inherited from MailinglistExportable
	$object_type
	The type of object we are. More...
	$settings
	Generic Array to hold misc settings so all can use same schema. More...
	$export_type
	Needed by CTools. More...
const	LOG_OFF = 0
const	LOG_SCREEN = 1
const	LOG_DB = 2
const	LOG_DB_SCREEN = 3
const	LOG_FILE = 4
const	LOG_FILE_SCREEN = 5
const	LOG_DEBUG = WATCHDOG_DEBUG
const	LOG_INFO = WATCHDOG_INFO
const	LOG_NOTICE = WATCHDOG_NOTICE
const	LOG_WARNING = WATCHDOG_WARNING
const	LOG_ERROR = WATCHDOG_ERROR
const	LOG_CRITICAL = WATCHDOG_CRITICAL
const	LOG_ALERT = WATCHDOG_ALERT
const	LOG_EMERGENCY = WATCHDOG_EMERGENCY
	$logging_screen = self::LOG_DEBUG
	$logging_db = self::LOG_INFO
	$logging_file = self::LOG_DEBUG

Detailed Description

Retrieve messages from a Mailinglist Mailbox.

Definition at line 14 of file MailinglistRetrieve.class.php.

Member Function Documentation

close

(

)

delete marked messages and close connection

Implements MailinglistRetrieveInterface.

Definition at line 46 of file MailinglistRetrieve.class.php.

                          {
  }

edit_form	(	&	$form,
		&	$form_state
	)

Implements ctools_export_ui::edit_form().

Definition at line 57 of file MailinglistRetrieve.class.php.

References MailinglistExportable\get_setting().

                                           {
    parent::edit_form($form, $form_state);
    $form['info']['admin_title']['#description'] = t('Suggested, but not required, to be the email address of the mailbox.');

    $form['extra']['settings']['limit'] = array(
      '#type' => 'textfield',
      '#title' => t('Maximum messages to retrieve'),
      '#size' => 5,
      '#maxlength' => 5,
      '#default_value' => $this->get_setting('limit', 0),
      '#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.'),
      '#element_validate' => array('element_validate_integer'),
      '#required' => TRUE,
  );
    $form['extra']['settings']['encoding'] = array(
      '#type' => 'textfield',
      '#title' => t('Default character encoding'),
      '#default_value' => $this->get_setting('encoding', 'UTF-8'),
      '#description' => t('The default character encoding to use when an incoming message does not define an encoding.'),
      '#required' => TRUE,
  );
  }

Here is the call graph for this function:

edit_form_submit	(	&	$form,
		&	$form_state
	)

Implements ctools_export_ui::edit_form_submit().

Definition at line 91 of file MailinglistRetrieve.class.php.

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

edit_form_validate	(	&	$form,
		&	$form_state
	)

Implements ctools_export_ui::edit_form_validate().

Todo:

_mailinglist_list_test($form, $form_state);

Definition at line 83 of file MailinglistRetrieve.class.php.

                                                    {
    parent::edit_form_validate($form, $form_state);
  }

get_message

(

$id

)

Get an email message by its id code (what is returned by get_message_list()

Implements MailinglistRetrieveInterface.

Definition at line 36 of file MailinglistRetrieve.class.php.

                                   {
    return FALSE;
  }

get_message_list

(

$max = 0

)

Returns a list of messages that are available.

Implements MailinglistRetrieveInterface.

Definition at line 31 of file MailinglistRetrieve.class.php.

                                           {
    return array();
  }

purge_message

(

$id

)

mark message for deletion

Implements MailinglistRetrieveInterface.

Definition at line 41 of file MailinglistRetrieve.class.php.

                                     {
    return;
  }

test

(

)

Test connection.

Implements MailinglistRetrieveInterface.

Definition at line 24 of file MailinglistRetrieve.class.php.

                         {
    return array();
  }

---

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

• mailinglist/plugins/mailinglist/retrieve/MailinglistRetrieve.class.php