abstract class MailhandlerRetrieve in Mailhandler 6.2

Retrieve messages from a Mailhandler Mailbox.

Hierarchy

• class \MailhandlerRetrieve

3 string references to 'MailhandlerRetrieve'

MailhandlerPhpImapRetrieve.inc in modules/mailhandler_php_imap/plugins/mailhandler/retrieve/MailhandlerPhpImapRetrieve.inc

MailhandlerRetrieve.inc in plugins/mailhandler/retrieve/MailhandlerRetrieve.inc

MailhandlerRetrieveDummy.inc in plugins/mailhandler/retrieve/MailhandlerRetrieveDummy.inc

File

plugins/mailhandler/retrieve/MailhandlerRetrieve.class.php, line 10

Definition of MailhandlerRetrieve class.

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;
  }

}

Members

Name	Modifiers	Type	Description	Overrides
MailhandlerRetrieve::purge_message	public	function		1
MailhandlerRetrieve::retrieve	public	function	Connect to mailbox and run message retrieval.	1
MailhandlerRetrieve::test	public	function	Test connection.	1