Class Swift_Events_SendEvent

InheritanceSwift_Events_SendEvent » Swift_Events_EventObject
ImplementsSwift_Events_Event

Generated when a message is being sent.

Public Methods

Hide inherited methods

MethodDescriptionDefined By
__construct() Create a new SendEvent for $source and $message. Swift_Events_SendEvent
bubbleCancelled() Returns true if this Event will not bubble any further up the stack. Swift_Events_EventObject
cancelBubble() Prevent this Event from bubbling any further up the stack. Swift_Events_EventObject
getFailedRecipients() Get an recipient addresses which were not accepted for delivery. Swift_Events_SendEvent
getMessage() Get the Message being sent. Swift_Events_SendEvent
getResult() Get the result of this Event. Swift_Events_SendEvent
getSource() Get the source object of this event. Swift_Events_EventObject
getTransport() Get the Transport used to send the Message. Swift_Events_SendEvent
setFailedRecipients() Set the array of addresses that failed in sending. Swift_Events_SendEvent
setResult() Set the result of sending. Swift_Events_SendEvent

Constants

Hide inherited constants

ConstantValueDescriptionDefined By
RESULT_FAILED 4096 Sending failed Swift_Events_SendEvent
RESULT_PENDING 1 Sending has yet to occur Swift_Events_SendEvent
RESULT_SPOOLED 17 Email is spooled, ready to be sent Swift_Events_SendEvent
RESULT_SUCCESS 16 Sending was successful Swift_Events_SendEvent
RESULT_TENTATIVE 256 Sending worked, but there were some failures Swift_Events_SendEvent

Method Details

__construct() public method

Create a new SendEvent for $source and $message.

public void __construct ( Swift_Transport $source, Swift_Mime_Message $message )
$source Swift_Transport
$message Swift_Mime_Message
getFailedRecipients() public method

Get an recipient addresses which were not accepted for delivery.

public string[] getFailedRecipients ( )
getMessage() public method

Get the Message being sent.

public Swift_Mime_Message getMessage ( )
getResult() public method

Get the result of this Event.

The return value is a bitmask from {@see RESULT_PENDING, RESULT_SUCCESS, RESULT_TENTATIVE, RESULT_FAILED}

public int getResult ( )
getTransport() public method

Get the Transport used to send the Message.

public Swift_Transport getTransport ( )
setFailedRecipients() public method

Set the array of addresses that failed in sending.

public void setFailedRecipients ( $recipients )
$recipients array
setResult() public method

Set the result of sending.

public void setResult ( $result )
$result int