Swift_Events_SendEvent Class Reference

Inheritance diagram for Swift_Events_SendEvent:

Public Member Functions
	__construct (Swift_Transport $source, Swift_Mime_Message $message)
	getTransport ()
	getMessage ()
	setFailedRecipients ($recipients)
	getFailedRecipients ()
	setResult ($result)
	getResult ()
Public Member Functions inherited from Swift_Events_EventObject
	__construct ($source)
	getSource ()
	cancelBubble ($cancel=true)
	bubbleCancelled ()

Public Attributes
const	RESULT_PENDING = 0x0001
const	RESULT_SPOOLED = 0x0011
const	RESULT_SUCCESS = 0x0010
const	RESULT_TENTATIVE = 0x0100
const	RESULT_FAILED = 0x1000

Private Attributes
	$_message
	$_failedRecipients = array()
	$_result

Detailed Description

Generated when a message is being sent.

Author

Chris Corbyn

Definition at line 16 of file SendEvent.php.

Constructor & Destructor Documentation

__construct	(	Swift_Transport	$source,
		Swift_Mime_Message	$message
	)

Create a new SendEvent for $source and $message.

Parameters

Swift_Transport	$source
Swift_Mime_Message	$message

Definition at line 60 of file SendEvent.php.

Member Function Documentation

getFailedRecipients

(

)

Get an recipient addresses which were not accepted for delivery.

Returns

string[]

Definition at line 102 of file SendEvent.php.

References $_failedRecipients.

Referenced by Swift_Plugins_ReporterPlugin\sendPerformed().

getMessage

(

)

Get the Message being sent.

Returns

Swift_Mime_Message

Definition at line 82 of file SendEvent.php.

References $_message.

Referenced by Swift_Plugins_ImpersonatePlugin\beforeSendPerformed(), Swift_Plugins_MessageLogger\beforeSendPerformed(), Swift_Plugins_DecoratorPlugin\beforeSendPerformed(), Swift_Plugins_RedirectingPlugin\beforeSendPerformed(), Swift_Plugins_BandwidthMonitorPlugin\sendPerformed(), Swift_Plugins_ReporterPlugin\sendPerformed(), Swift_Plugins_ImpersonatePlugin\sendPerformed(), Swift_Plugins_DecoratorPlugin\sendPerformed(), and Swift_Plugins_RedirectingPlugin\sendPerformed().

getResult

(

)

Get the result of this Event.

The return value is a bitmask from {

See Also

RESULT_PENDING, RESULT_SUCCESS, RESULT_TENTATIVE, RESULT_FAILED}

Returns

int

Definition at line 125 of file SendEvent.php.

References $_result.

getTransport

(

)

Get the Transport used to send the Message.

Returns

Swift_Transport

Definition at line 72 of file SendEvent.php.

References Swift_Events_EventObject\getSource().

Referenced by Swift_Plugins_AntiFloodPlugin\sendPerformed().

setFailedRecipients

(

$recipients

)

Set the array of addresses that failed in sending.

Parameters

array

$recipients

Definition at line 92 of file SendEvent.php.

setResult

(

$result

)

Set the result of sending.

Parameters

int

$result

Definition at line 112 of file SendEvent.php.

Member Data Documentation

$_failedRecipients = array()

private

Definition at line 45 of file SendEvent.php.

Referenced by getFailedRecipients().

$_message

private

Definition at line 38 of file SendEvent.php.

Referenced by getMessage().

$_result

private

Definition at line 52 of file SendEvent.php.

Referenced by getResult().

const RESULT_FAILED = 0x1000

Sending failed

Definition at line 31 of file SendEvent.php.

Referenced by Swift_Transport_SpoolTransport\send(), Swift_Transport_MailTransport\send(), and Swift_Transport_AbstractSmtpTransport\send().

const RESULT_PENDING = 0x0001

Sending has yet to occur

Definition at line 19 of file SendEvent.php.

const RESULT_SPOOLED = 0x0011

Email is spooled, ready to be sent

Definition at line 22 of file SendEvent.php.

Referenced by Swift_Transport_SpoolTransport\send().

const RESULT_SUCCESS = 0x0010

Sending was successful

Definition at line 25 of file SendEvent.php.

Referenced by Swift_Transport_NullTransport\send(), Swift_Transport_SendmailTransport\send(), Swift_Transport_MailTransport\send(), and Swift_Transport_AbstractSmtpTransport\send().

const RESULT_TENTATIVE = 0x0100

Sending worked, but there were some failures

Definition at line 28 of file SendEvent.php.

Referenced by Swift_Transport_AbstractSmtpTransport\send().