\Swift_Events_SendEvent
Generated when a message is being sent.
- Author: Chris Corbyn
Synopsis
class Swift_Events_SendEvent
extends Swift_Events_EventObject
{
- // constants
- const RESULT_PENDING = 0x0001;
- const RESULT_SUCCESS = 0x0010;
- const RESULT_TENTATIVE = 0x0100;
- const RESULT_FAILED = 0x1000;
- // members
- private Swift_Mime_Message $_message;
- private array $_failedRecipients;
- private integer $_result;
- // methods
- public void __construct()
- public Swift_Transport getTransport()
- public Swift_Mime_Message getMessage()
- public void setFailedRecipients()
- public array getFailedRecipients()
- public void setResult()
- public integer getResult()
- // Inherited methods from Swift_Events_EventObject
- public void __construct()
- public getSource()
- public void cancelBubble()
- public boolean bubbleCancelled()
Hierarchy
Extends
Constants
Name | Value |
---|---|
RESULT_PENDING | 0x0001 |
RESULT_SUCCESS | 0x0010 |
RESULT_TENTATIVE | 0x0100 |
RESULT_FAILED | 0x1000 |
Members
private
- $_failedRecipients
—
array
Any recipients which failed after sending. - $_message
—
Swift_Mime_Message
The Message being sent. - $_result
—
integer
The overall result as a bitmask from the class constants.
Methods
public
- __construct() — Create a new SendEvent for $source and $message.
- getFailedRecipients() — Get an recipient addresses which were not accepted for delivery.
- getMessage() — Get the Message being sent.
- getResult() — Get the result of this Event.
- getTransport() — Get the Transport used to send the Message.
- setFailedRecipients() — Set the array of addresses that failed in sending.
- setResult() — Set the result of sending.
Inherited from Swift_Events_EventObject
public
- bubbleCancelled() — Returns true if this Event will not bubble any further up the stack.
- cancelBubble() — Prevent this Event from bubbling any further up the stack.
- getSource() — Get the source object of this event.