MessageEvent
extends Event
in package
FinalYes
Allows the transformation of a Message and the Envelope before the email is sent.
Tags
Table of Contents
Properties
- $envelope : mixed
- $message : mixed
- $propagationStopped : mixed
- $queued : mixed
- $transport : mixed
Methods
- __construct() : mixed
- getEnvelope() : Envelope
- getMessage() : RawMessage
- getTransport() : string
- isPropagationStopped() : bool
- Is propagation stopped?
- isQueued() : bool
- setEnvelope() : void
- setMessage() : void
- stopPropagation() : void
- Stops the propagation of the event to further event listeners.
Properties
$envelope
private
mixed
$envelope
$message
private
mixed
$message
$propagationStopped
private
mixed
$propagationStopped
= false
$queued
private
mixed
$queued
$transport
private
mixed
$transport
Methods
__construct()
public
__construct(RawMessage $message, Envelope $envelope, string $transport[, bool $queued = false ]) : mixed
Parameters
- $message : RawMessage
- $envelope : Envelope
- $transport : string
- $queued : bool = false
getEnvelope()
public
getEnvelope() : Envelope
Return values
EnvelopegetMessage()
public
getMessage() : RawMessage
Return values
RawMessagegetTransport()
public
getTransport() : string
Return values
stringisPropagationStopped()
Is propagation stopped?
public
isPropagationStopped() : bool
Return values
bool —True if the Event is complete and no further listeners should be called. False to continue calling listeners.
isQueued()
public
isQueued() : bool
Return values
boolsetEnvelope()
public
setEnvelope(Envelope $envelope) : void
Parameters
- $envelope : Envelope
setMessage()
public
setMessage(RawMessage $message) : void
Parameters
- $message : RawMessage
stopPropagation()
Stops the propagation of the event to further event listeners.
public
stopPropagation() : void
If multiple event listeners are connected to the same event, no further event listener will be triggered once any trigger calls stopPropagation().