You are here

abstract class MailhandlerCommands in Mailhandler 6.2

Same name and namespace in other branches
  1. 7.2 plugins/mailhandler/commands/MailhandlerCommands.class.php \MailhandlerCommands

Allows additional Feeds Processor sources to be mapped.

When selected from the Mailhandler Parser, uses properties of a message to set Feeds Processor sources. These sources can come from standard IMAP headers / MIME parts, be "commanded" by key: value pairs in message bodies, etc...

Hierarchy

Expanded class hierarchy of MailhandlerCommands

4 string references to 'MailhandlerCommands'
MailhandlerCommands.inc in plugins/mailhandler/commands/MailhandlerCommands.inc
MailhandlerCommandsDefault.inc in plugins/mailhandler/commands/MailhandlerCommandsDefault.inc
MailhandlerCommandsFiles.inc in plugins/mailhandler/commands/MailhandlerCommandsFiles.inc
MailhandlerCommandsHeaders.inc in plugins/mailhandler/commands/MailhandlerCommandsHeaders.inc

File

plugins/mailhandler/commands/MailhandlerCommands.class.php, line 15
Definition of MailhandlerCommands class.

View source
abstract class MailhandlerCommands {
  protected $commands = NULL;

  /**
   * Parse commands from email body.
   *
   * @param $object
   *   Node object of the node being built for submission.
   */
  public function parse(&$message, $source, $client) {
    return;
  }

  /**
   * Process parsed commands by applying / manipulating the node object.
   *
   * @param $object
   *   Node object of the node being built for submission.
   */
  public abstract function process(&$message, $source);

  /**
   * Return mapping sources in the same manner as a Feeds Parser.
   *
   * @return
   *   Array containing mapping sources in standard Feeds Parser format.
   */
  public function getMappingSources($config) {
    return array();
  }

  /**
   * Build configuration form.
   */
  public function configForm(&$form, &$form_state, $config) {
    return;
  }

  /**
   * Build source form.
   */
  public function sourceForm(&$form, $source_config) {
    return;
  }

}

Members

Namesort descending Modifiers Type Description Overrides
MailhandlerCommands::$commands protected property
MailhandlerCommands::configForm public function Build configuration form. 2
MailhandlerCommands::getMappingSources public function Return mapping sources in the same manner as a Feeds Parser. 3
MailhandlerCommands::parse public function Parse commands from email body. 1
MailhandlerCommands::process abstract public function Process parsed commands by applying / manipulating the node object. 3
MailhandlerCommands::sourceForm public function Build source form. 1