MailhandlerRetrieve.class.php in Mailhandler 6.2

Definition of MailhandlerRetrieve class.

File

plugins/mailhandler/retrieve/MailhandlerRetrieve.class.php

<?php

/**
 * @file
 * Definition of MailhandlerRetrieve class.
 */

/**
 * Retrieve messages from a Mailhandler Mailbox.
 */
abstract class MailhandlerRetrieve {

  /**
   * Connect to mailbox and run message retrieval.
   *
   * @param $mailbox
   *   Array of mailbox configuration.
   * @param $filter_name
   *   Mailhandler filter to restrict what messages are retrieved.
   */
  public function retrieve($mailbox, $filter_name = 'MailhandlerFilters') {
    return;
  }

  /**
   * Test connection.
   */
  public function test($mailbox) {
    return array();
  }
  public function purge_message($mailbox, $message) {
    return;
  }

}

Classes

Name	Description
MailhandlerRetrieve	Retrieve messages from a Mailhandler Mailbox.