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

public function __get($name)
public function __set($name, $value)
public function current()
public function key()
public function next()
public function rewind()
public function valid()
private function throwOnAttemptedIteration()
public function getPhobjectClassConstant($key, $byte_limit) — Read the value of a class constant.
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

public function __get($name)
Inherited

This method is not documented.

Parameters

$name

Return

wild

public function __set($name, $value)
Inherited

This method is not documented.

Parameters

	$name
	$value

Return

wild

public function current()
Inherited

This method is not documented.

Return

wild

public function key()
Inherited

This method is not documented.

Return

wild

public function next()
Inherited

This method is not documented.

Return

wild

public function rewind()
Inherited

This method is not documented.

Return

wild

public function valid()
Inherited

This method is not documented.

Return

wild

private function throwOnAttemptedIteration()
Inherited

This method is not documented.

Return

wild

public function getPhobjectClassConstant($key, $byte_limit)
Inherited

Phobject

Read the value of a class constant.

This is the same as just typing self::CONSTANTNAME, but throws a more useful message if the constant is not defined and allows the constant to be limited to a maximum length.

Parameters

string	$key	Name of the constant.
int\|null	$byte_limit	Maximum number of bytes permitted in the value.

Return

string

Value of the constant.

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
Extends: Phobject

abstract class MetaMTAEmailTransactionCommandPhorge Technical Documentation (MetaMTA)

Tasks

Command Documentation

Other Methods

Methods

public function __get($name)Inherited

public function __set($name, $value)Inherited

public function current()Inherited

public function key()Inherited

public function next()Inherited

public function rewind()Inherited

public function valid()Inherited

private function throwOnAttemptedIteration()Inherited

public function getPhobjectClassConstant($key, $byte_limit)Inherited

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)

public function __get($name)
Inherited

public function __set($name, $value)
Inherited

public function current()
Inherited

public function key()
Inherited

public function next()
Inherited

public function rewind()
Inherited

public function valid()
Inherited

private function throwOnAttemptedIteration()
Inherited

public function getPhobjectClassConstant($key, $byte_limit)
Inherited