Swift_Events_CommandEvent
extends Swift_Events_EventObject
in package
Generated when a command is sent over an SMTP connection.
Tags
Table of Contents
- $bubbleCancelled : mixed
- The state of this Event (should it bubble up the stack?)
- $command : string
- The command sent to the server.
- $source : mixed
- The source of this Event
- $successCodes : array<string|int, int>
- An array of codes which a successful response will contain.
- __construct() : mixed
- Create a new CommandEvent for $source with $command.
- bubbleCancelled() : bool
- Returns true if this Event will not bubble any further up the stack.
- cancelBubble() : mixed
- Prevent this Event from bubbling any further up the stack.
- getCommand() : string
- Get the command which was sent to the server.
- getSource() : object
- Get the source object of this event.
- getSuccessCodes() : array<string|int, int>
- Get the numeric response codes which indicate success for this command.
Properties
$bubbleCancelled
The state of this Event (should it bubble up the stack?)
private
mixed
$bubbleCancelled
= alse
$command
The command sent to the server.
private
string
$command
$source
The source of this Event
private
mixed
$source
$successCodes
An array of codes which a successful response will contain.
private
array<string|int, int>
$successCodes
= []
Methods
__construct()
Create a new CommandEvent for $source with $command.
public
__construct(Swift_Transport $source, string $command[, array<string|int, mixed> $successCodes = [] ]) : mixed
Parameters
- $source : Swift_Transport
- $command : string
- $successCodes : array<string|int, mixed> = []
Return values
mixed —bubbleCancelled()
Returns true if this Event will not bubble any further up the stack.
public
bubbleCancelled() : bool
Return values
bool —cancelBubble()
Prevent this Event from bubbling any further up the stack.
public
cancelBubble([mixed $cancel = true ]) : mixed
Parameters
- $cancel : mixed = true
Return values
mixed —getCommand()
Get the command which was sent to the server.
public
getCommand() : string
Return values
string —getSource()
Get the source object of this event.
public
getSource() : object
Return values
object —getSuccessCodes()
Get the numeric response codes which indicate success for this command.
public
getSuccessCodes() : array<string|int, int>