Diviner Tech Docs MetaMTAEmailTransactionCommand

abstract class MetaMTAEmailTransactionCommand
Phorge Technical Documentation (MetaMTA)

This class is not documented.

Tasks

Command Documentation

abstract public function getCommandSummary() — Return a brief human-readable description of the command effect.
public function getCommandSyntax() — Return a one-line Remarkup description of command syntax for documentation.
public function getCommandDescription() — Return a longer human-readable description of the command effect.

Other Methods

abstract public function getCommand()
abstract public function isCommandSupportedForObject($object)
abstract public function buildTransactions($viewer, $object, $mail, $command, $argv)
public function getCommandAliases()
public function getCommandObjects()
public static function getAllCommands()
public static function getAllCommandsForObject($object)
public static function getCommandMap($commands)

Methods

abstract public function getCommand()

This method is not documented.

Return

wild

abstract public function getCommandSummary()

Return a brief human-readable description of the command effect.

This should normally be one or two sentences briefly describing the command behavior.

Return

string

Brief human-readable remarkup.

public function getCommandSyntax()

Return a one-line Remarkup description of command syntax for documentation.

Return

string

Brief human-readable remarkup.

public function getCommandDescription()

Return a longer human-readable description of the command effect.

This can be as long as necessary to explain the command.

Return

string

Human-readable remarkup of whatever length is desired.

abstract public function isCommandSupportedForObject($object)

This method is not documented.

Parameters

PhabricatorApplicationTransactionInterface

$object

Return

wild

abstract public function buildTransactions($viewer, $object, $mail, $command, $argv)

This method is not documented.

Parameters

PhabricatorUser	$viewer
PhabricatorApplicationTransactionInterface	$object
PhabricatorMetaMTAReceivedMail	$mail
	$command
array	$argv

Return

wild

public function getCommandAliases()

This method is not documented.

Return

wild

public function getCommandObjects()

This method is not documented.

Return

wild

public static function getAllCommands()

This method is not documented.

Return

wild

public static function getAllCommandsForObject($object)

This method is not documented.

Parameters

PhabricatorApplicationTransactionInterface

$object

Return

wild

public static function getCommandMap($commands)

This method is not documented.

Parameters

array

$commands

Return

wild

Defined: src/applications/metamta/command/MetaMTAEmailTransactionCommand.php:6

abstract class MetaMTAEmailTransactionCommandPhorge Technical Documentation (MetaMTA)

Tasks

Command Documentation

Other Methods

Methods

abstract public function getCommand()

abstract public function getCommandSummary()

public function getCommandSyntax()

public function getCommandDescription()

abstract public function isCommandSupportedForObject($object)

abstract public function buildTransactions($viewer, $object, $mail, $command, $argv)

public function getCommandAliases()

public function getCommandObjects()

public static function getAllCommands()

public static function getAllCommandsForObject($object)

public static function getCommandMap($commands)

abstract class MetaMTAEmailTransactionCommand
Phorge Technical Documentation (MetaMTA)