Swift_Events_ResponseEvent
extends Swift_Events_EventObject
in package
Generated when a response is received on a SMTP connection.
Tags
Table of Contents
- $bubbleCancelled : mixed
- The state of this Event (should it bubble up the stack?)
- $response : string
- The response received from the server.
- $source : mixed
- The source of this Event
- $valid : bool
- The overall result.
- __construct() : mixed
- Create a new ResponseEvent for $source and $response.
- 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.
- getResponse() : string
- Get the response which was received from the server.
- getSource() : object
- Get the source object of this event.
- isValid() : bool
- Get the success status of this Event.
Properties
$bubbleCancelled
The state of this Event (should it bubble up the stack?)
private
mixed
$bubbleCancelled
= alse
$response
The response received from the server.
private
string
$response
$source
The source of this Event
private
mixed
$source
$valid
The overall result.
private
bool
$valid
Methods
__construct()
Create a new ResponseEvent for $source and $response.
public
__construct(Swift_Transport $source, string $response[, bool $valid = false ]) : mixed
Parameters
- $source : Swift_Transport
- $response : string
- $valid : bool = false
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 —getResponse()
Get the response which was received from the server.
public
getResponse() : string
Return values
string —getSource()
Get the source object of this event.
public
getSource() : object
Return values
object —isValid()
Get the success status of this Event.
public
isValid() : bool