Retrieve messages from a local mailbox file. More...

Inheritance diagram for MailinglistMailboxRetrieve:

Collaboration diagram for MailinglistMailboxRetrieve:

Public Member Functions
	__destruct ()
	Destructor. 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...

MailinglistRetrieveInterface
	get_message_list ($max=0)
	Overrides/Implements Mailinglist:Retrieve::get_message_list Connect to mailbox and run message retrieval. More...

	get_message ($id)
	Overrides/Implements MailinglistRetrieve::get_message(). More...

	purge_message ($id)
	Overrides/Implements MailinglistRetrieve::purge_message();. More...

	close ()
	Overrides/Implements MailinglistRetrieve::close(). More...

Public Member Functions inherited from MailinglistRetrieve
	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...

	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 local mailbox file.

Definition at line 10 of file MailinglistMailboxRetrieve.class.php.

Constructor & Destructor Documentation

__destruct ( )

Destructor.

Definition at line 200 of file MailinglistMailboxRetrieve.class.php.

200 {

201 }

Member Function Documentation

close ( )

Overrides/Implements MailinglistRetrieve::close().

Implements MailinglistRetrieveInterface.

Definition at line 192 of file MailinglistMailboxRetrieve.class.php.

192 {

193 }

edit_form	(	&	$form,
		&	$form_state
	)

Implements ctools_export_ui::edit_form().

called via mailinglist_export_ui

Definition at line 21 of file MailinglistMailboxRetrieve.class.php.

References _mailinglist_decode_password(), and MailinglistExportable\get_setting().

                                            {
     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'),
     );
 
   }

Here is the call graph for this function:

edit_form_submit	(	&	$form,
		&	$form_state
	)

Implements ctools_export_ui::edit_form_submit().

Called via mailinglist_export_ui.

Definition at line 151 of file MailinglistMailboxRetrieve.class.php.

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

edit_form_validate	(	&	$form,
		&	$form_state
	)

Implements ctools_export_ui::edit_form_validate().

Called via mailinglist_export_ui.

Definition at line 130 of file MailinglistMailboxRetrieve.class.php.

                                                     {
     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');
     }
   }

get_message ( $id )

Overrides/Implements MailinglistRetrieve::get_message().

Implements MailinglistRetrieveInterface.

Definition at line 178 of file MailinglistMailboxRetrieve.class.php.

                                    {
     $msg = "";
     return new MailinglistMessage($msg);
   }

get_message_list ( $max = 0 )

Overrides/Implements Mailinglist:Retrieve::get_message_list Connect to mailbox and run message retrieval.

Returns: array Retrieved messages.

Implements MailinglistRetrieveInterface.

Definition at line 170 of file MailinglistMailboxRetrieve.class.php.

                                            {
     $res = array();
     return $res;
   }

purge_message ( $id )

Overrides/Implements MailinglistRetrieve::purge_message();.

Implements MailinglistRetrieveInterface.

Definition at line 186 of file MailinglistMailboxRetrieve.class.php.

186 {

187 }

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

mailinglist/plugins/mailinglist/retrieve/MailinglistMailboxRetrieve.class.php

Public Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation