Class Swift_Events_SendEvent

Generated when a message is being sent.

Swift_Events_EventObject implements Swift_Events_Event

Extended by

Swift_Events_SendEvent

Package: Swift\Events
Author: Chris Corbyn
Located at vendors/swiftmailer/lib/classes/Swift/Events/SendEvent.php

Methods summary

`public`	# `__construct( Swift_Transport $source, Swift_Mime_Message $message )` Create a new SendEvent for $source and $message. Create a new SendEvent for $source and $message. Parameters `$source` `Swift_Transport` $source `$message` `Swift_Mime_Message` $message Overrides `Swift_Events_EventObject::__construct`
`public Swift_Transport`	# `getTransport( )` Get the Transport used to send the Message. Get the Transport used to send the Message. Returns `Swift_Transport`
`public Swift_Mime_Message`	# `getMessage( )` Get the Message being sent. Get the Message being sent. Returns `Swift_Mime_Message`
`public`	# `setFailedRecipients( array $recipients )` Set the array of addresses that failed in sending. Set the array of addresses that failed in sending. Parameters `$recipients` `array` $recipients
`public string[]`	# `getFailedRecipients( )` Get an recipient addresses which were not accepted for delivery. Get an recipient addresses which were not accepted for delivery. Returns `string[]`
`public integer`	# `setResult( mixed $result )` Set the result of sending. Set the result of sending. Returns `integer`
`public integer`	# `getResult( )` Get the result of this Event. The return value is a bitmask from RESULT_PENDING, RESULT_SUCCESS, RESULT_TENTATIVE, RESULT_FAILED Get the result of this Event. The return value is a bitmask from RESULT_PENDING, RESULT_SUCCESS, RESULT_TENTATIVE, RESULT_FAILED Returns `integer`

Methods inherited from Swift_Events_EventObject

bubbleCancelled(), cancelBubble(), getSource()

Magic methods summary

Constants summary

`integer`	`RESULT_PENDING`	`0x0001`	# Sending has yet to occur Sending has yet to occur
`integer`	`RESULT_SUCCESS`	`0x0010`	# Sending was successful Sending was successful
`integer`	`RESULT_TENTATIVE`	`0x0100`	# Sending worked, but there were some failures Sending worked, but there were some failures
`integer`	`RESULT_FAILED`	`0x1000`	# Sending failed Sending failed

Properties summary

`private Swift_Mime_Message`	`$_message`	# The Message being sent. The Message being sent.
`private string[]`	`$_failedRecipients`	# Any recipients which failed after sending. Any recipients which failed after sending.
`private integer`	`$_result`	# The overall result as a bitmask from the class constants. The overall result as a bitmask from the class constants.