Swift_Events_SendEvent Class Reference

Inheritance diagram for Swift_Events_SendEvent:

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

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

Private Attributes
	$_message
	$_transport
	$failedRecipients = array()
	$result

Detailed Description

Definition at line 19 of file SendEvent.php.

Constructor & Destructor Documentation

Swift_Events_SendEvent::__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 63 of file SendEvent.php.

References __construct().

Here is the call graph for this function:

Member Function Documentation

Swift_Events_SendEvent::getFailedRecipients

(

)

Get an recipient addresses which were not accepted for delivery.

Returns

string[]

Definition at line 102 of file SendEvent.php.

Referenced by Swift_Plugins_ReporterPlugin\sendPerformed().

Here is the caller graph for this function:

Swift_Events_SendEvent::getMessage

(

)

Get the Message being sent.

Returns

Swift_Mime_Message

Definition at line 84 of file SendEvent.php.

References $_message.

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

Here is the caller graph for this function:

Swift_Events_SendEvent::getResult

(

)

Get the result of this Event. The return value is a bitmask from RESULT_SUCCESS, RESULT_TENTATIVE, RESULT_FAILED

Returns

int

Definition at line 122 of file SendEvent.php.

Swift_Events_SendEvent::getTransport

(

)

Get the Transport used to send the Message.

Returns

Swift_Transport

Definition at line 75 of file SendEvent.php.

References Swift_Events_EventObject\getSource().

Referenced by Swift_Plugins_AntiFloodPlugin\sendPerformed().

Here is the call graph for this function:

Here is the caller graph for this function:

Swift_Events_SendEvent::setFailedRecipients

(

$recipients

)

Set the array of addresses that failed in sending.

Parameters

array

$recipients

Definition at line 93 of file SendEvent.php.

Swift_Events_SendEvent::setResult

(

$result

)

Set the result of sending.

Returns

int

Definition at line 111 of file SendEvent.php.

References $result.

Member Data Documentation

Swift_Events_SendEvent::$_message

private

Definition at line 38 of file SendEvent.php.

Referenced by getMessage().

Swift_Events_SendEvent::$_transport

private

Definition at line 44 of file SendEvent.php.

Swift_Events_SendEvent::$failedRecipients = array()

private

Definition at line 50 of file SendEvent.php.

Swift_Events_SendEvent::$result

private

Definition at line 56 of file SendEvent.php.

Referenced by setResult().

const Swift_Events_SendEvent::RESULT_FAILED = 0x1000

Sending failed

Definition at line 32 of file SendEvent.php.

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

const Swift_Events_SendEvent::RESULT_PENDING = 0x0001

Sending has yet to occur

Definition at line 23 of file SendEvent.php.

const Swift_Events_SendEvent::RESULT_SUCCESS = 0x0010

Sending was successful

Definition at line 26 of file SendEvent.php.

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

const Swift_Events_SendEvent::RESULT_TENTATIVE = 0x0100

Sending worked, but there were some failures

Definition at line 29 of file SendEvent.php.

Referenced by Swift_Transport_AbstractSmtpTransport\send().

---

The documentation for this class was generated from the following file:

• L:/XOOPS_Allure/SVN_XOOPS2/RMC/rmcommon/trunk/rmcommon/class/swift/classes/Swift/Events/SendEvent.php