Generated when a message is being sent.

package Swift
subpackage Events
author Chris Corbyn

 Methods

Create a new SendEvent for $source and $message.

__construct(\Swift_Transport $source, \Swift_Mime_Message $message) 

Parameters

Returns true if this Event will not bubble any further up the stack.

bubbleCancelled() : boolean
Inherited
inherited_from \Swift_Events_EventObject::bubbleCancelled()

Returns

boolean

Prevent this Event from bubbling any further up the stack.

cancelBubble($cancel) 
Inherited
inherited_from \Swift_Events_EventObject::cancelBubble()

Parameters

$cancel

Get an recipient addresses which were not accepted for delivery.

getFailedRecipients() : string[]

Returns

string[]

Get the Message being sent.

getMessage() : \Swift_Mime_Message

Get the result of this Event.

getResult() : int

The return value is a bitmask from RESULT_SUCCESS, RESULT_TENTATIVE, RESULT_FAILED

Returns

int

Get the source object of this event.

getSource() : object
Inherited
inherited_from \Swift_Events_EventObject::getSource()

Returns

object

Get the Transport used to send the Message.

getTransport() : \Swift_Transport

Set the array of addresses that failed in sending.

setFailedRecipients(array $recipients) 

Parameters

$recipients

array

Set the result of sending.

setResult($result) : int

Parameters

$result

Returns

int

 Properties

 

$_bubbleCancelled 
Inherited
inherited_from \Swift_Events_EventObject::$$_bubbleCancelled
 

$_failedRecipients : string[]
 

$_message : \Swift_Mime_Message
 

$_result : int
 

$_source 
Inherited
inherited_from \Swift_Events_EventObject::$$_source

 Constants

 

Sending failed

RESULT_FAILED 
 

Sending has yet to occur

RESULT_PENDING 
 

Sending was successful

RESULT_SUCCESS 
 

Sending worked, but there were some failures

RESULT_TENTATIVE