Class: Swift_Events_SendEvent

Source Location: /vendors/swift/classes/Swift/Events/SendEvent.php

Class Overview

Swift_Events_EventObject
   |
   --Swift_Events_SendEvent

Generated when a message is being sent.

Author(s):

Chris Corbyn

Constants

Methods

Inherited Methods

Class: Swift_Events_EventObject

Swift_Events_EventObject::__construct(): Create a new EventObject originating at $source.
Swift_Events_EventObject::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::getSource(): Get the source object of this event.

Class Details

[line 19]
Generated when a message is being sent.

Tags:

author:	Chris Corbyn
filesource:	Source Code for this file

[ Top ]

Class Methods

constructor __construct [line 63]

Swift_Events_SendEvent __construct(
Swift_Transport
$source, Swift_Mime_Message
$message)

Create a new SendEvent for $source and $message.

Tags:

access:

public

Overrides Swift_Events_EventObject::__construct() (Create a new EventObject originating at $source.)

Parameters:

Swift_Transport	$source
Swift_Mime_Message	$message

[ Top ]

method getFailedRecipients [line 102]

string[] getFailedRecipients(
)

Get an recipient addresses which were not accepted for delivery.

Tags:

access:

public

[ Top ]

method getMessage [line 84]

Swift_Mime_Message getMessage(
)

Get the Message being sent.

Tags:

access:

public

[ Top ]

method getResult [line 122]

int getResult(
)

Get the result of this Event.

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

Tags:

access:

public

[ Top ]

method getTransport [line 75]

Swift_Transport getTransport(
)

Get the Transport used to send the Message.

Tags:

access:

public

[ Top ]

method setFailedRecipients [line 93]

void setFailedRecipients(
array
$recipients)

Set the array of addresses that failed in sending.

Tags:

access:

public

Parameters:

array

$recipients

[ Top ]

method setResult [line 111]

int setResult(

$result)

Set the result of sending.

Tags:

access:

public

Parameters:

$result

[ Top ]

Class Constants

RESULT_FAILED = 0x1000

[line 32]

Sending failed

[ Top ]

RESULT_PENDING = 0x0001

[line 23]

Sending has yet to occur

[ Top ]

RESULT_SUCCESS = 0x0010

[line 26]

Sending was successful

[ Top ]

RESULT_TENTATIVE = 0x0100

[line 29]

Sending worked, but there were some failures

[ Top ]

Documentation generated on Mon, 05 Sep 2011 20:34:11 -0500 by phpDocumentor 1.4.3