twisted.mail.alias.ProcessAlias : API documentation

class documentation

class ProcessAlias(AliasBase): (source)

An alias which is handled by the execution of a program.

Instance Variable	`path`	The arguments to pass to the process. The first string is the executable's name.
Instance Variable	`program`	The path of the program to be executed.
Instance Variable	`reactor`	A reactor which will be used to create and timeout the child process.
Method	`__init__`
Method	`__str__`	Build a string representation of this `ProcessAlias` instance.
Method	`spawnProcess`	Spawn a process.
Method	`createMessageReceiver`	Launch a process and create a message receiver to pass a message to the process.

Inherited from AliasBase:

Instance Variable	`domains`	See `__init__`.
Instance Variable	`original`	The original address being aliased.
Method	`domain`	Return the domain associated with original address.
Method	`resolve`	Map this alias to its ultimate destination.

The arguments to pass to the process. The first string is the executable's name.

(type: list of bytes)

The path of the program to be executed.

(type: bytes)

A reactor which will be used to create and timeout the child process.

(type: IReactorTime and IReactorProcess provider)

def __init__(self, path, *args): (source)

overrides twisted.mail.alias.AliasBase.__init__

Parameters	path	The command to invoke the program consisting of the path to the executable followed by any arguments. (type: `bytes`)
	args	Arguments for `AliasBase.__init__`. (type: 2-`tuple` of (0) `dict` mapping `bytes` to `IDomain` provider, (1) `bytes`)

def __str__(self): (source)

Build a string representation of this ProcessAlias instance.

Returns A string containing the command used to invoke the process. (type: bytes)

def spawnProcess(self, proto, program, path): (source)

Spawn a process.

This wraps the spawnProcess method on reactor so that it can be customized for test purposes.

Parameters	proto	An object which will be notified of all events related to the created process. (type: `IProcessProtocol` provider)
	program	The full path name of the file to execute. (type: `bytes`)
	path	The arguments to pass to the process. The first string should be the executable's name. (type: `list` of `bytes`)
Returns	A process transport. (type: `IProcessTransport` provider)

def createMessageReceiver(self): (source)

from twisted.mail.interfaces.IAlias

Launch a process and create a message receiver to pass a message to the process.

Returns A message receiver which delivers a message to the process. (type: MessageWrapper)

API Documentation for Twisted, generated by pydoctor 21.2.2 at 2021-06-04 02:13:44.