Swift_Events_SendEvent
extends Swift_Events_EventObject
in package
Generated when a message is being sent.
Tags
Table of Contents
- RESULT_FAILED = 0x1000
- Sending failed
- RESULT_PENDING = 0x1
- Sending has yet to occur
- RESULT_SPOOLED = 0x11
- Email is spooled, ready to be sent
- RESULT_SUCCESS = 0x10
- Sending was successful
- RESULT_TENTATIVE = 0x100
- Sending worked, but there were some failures
- $bubbleCancelled : mixed
- The state of this Event (should it bubble up the stack?)
- $failedRecipients : array<string|int, string>
- Any recipients which failed after sending.
- $message : Swift_Mime_SimpleMessage
- The Message being sent.
- $result : int
- The overall result as a bitmask from the class constants.
- $source : mixed
- The source of this Event
- __construct() : mixed
- Create a new SendEvent for $source and $message.
- bubbleCancelled() : bool
- Returns true if this Event will not bubble any further up the stack.
- cancelBubble() : mixed
- Prevent this Event from bubbling any further up the stack.
- getFailedRecipients() : array<string|int, string>
- Get an recipient addresses which were not accepted for delivery.
- getMessage() : Swift_Mime_SimpleMessage
- Get the Message being sent.
- getResult() : int
- Get the result of this Event.
- getSource() : object
- Get the source object of this event.
- getTransport() : Swift_Transport
- Get the Transport used to send the Message.
- setFailedRecipients() : mixed
- Set the array of addresses that failed in sending.
- setResult() : mixed
- Set the result of sending.
Constants
RESULT_FAILED
Sending failed
public
mixed
RESULT_FAILED
= 0x1000
RESULT_PENDING
Sending has yet to occur
public
mixed
RESULT_PENDING
= 0x1
RESULT_SPOOLED
Email is spooled, ready to be sent
public
mixed
RESULT_SPOOLED
= 0x11
RESULT_SUCCESS
Sending was successful
public
mixed
RESULT_SUCCESS
= 0x10
RESULT_TENTATIVE
Sending worked, but there were some failures
public
mixed
RESULT_TENTATIVE
= 0x100
Properties
$bubbleCancelled
The state of this Event (should it bubble up the stack?)
private
mixed
$bubbleCancelled
= alse
$failedRecipients
Any recipients which failed after sending.
private
array<string|int, string>
$failedRecipients
= []
$message
The Message being sent.
private
Swift_Mime_SimpleMessage
$message
$result
The overall result as a bitmask from the class constants.
private
int
$result
$source
The source of this Event
private
mixed
$source
Methods
__construct()
Create a new SendEvent for $source and $message.
public
__construct(Swift_Transport $source, Swift_Mime_SimpleMessage $message) : mixed
Parameters
- $source : Swift_Transport
- $message : Swift_Mime_SimpleMessage
Return values
mixed —bubbleCancelled()
Returns true if this Event will not bubble any further up the stack.
public
bubbleCancelled() : bool
Return values
bool —cancelBubble()
Prevent this Event from bubbling any further up the stack.
public
cancelBubble([mixed $cancel = true ]) : mixed
Parameters
- $cancel : mixed = true
Return values
mixed —getFailedRecipients()
Get an recipient addresses which were not accepted for delivery.
public
getFailedRecipients() : array<string|int, string>
Return values
array<string|int, string> —getMessage()
Get the Message being sent.
public
getMessage() : Swift_Mime_SimpleMessage
Return values
Swift_Mime_SimpleMessage —getResult()
Get the result of this Event.
public
getResult() : int
The return value is a bitmask from RESULT_PENDING, RESULT_SUCCESS, RESULT_TENTATIVE, RESULT_FAILED
Return values
int —getSource()
Get the source object of this event.
public
getSource() : object
Return values
object —getTransport()
Get the Transport used to send the Message.
public
getTransport() : Swift_Transport
Return values
Swift_Transport —setFailedRecipients()
Set the array of addresses that failed in sending.
public
setFailedRecipients(array<string|int, mixed> $recipients) : mixed
Parameters
- $recipients : array<string|int, mixed>
Return values
mixed —setResult()
Set the result of sending.
public
setResult(int $result) : mixed
Parameters
- $result : int