MessageEvent
extends Event
in package
Allows the transformation of a Message and the Envelope before the email is sent.
Tags
Table of Contents
- $envelope : mixed
- $message : mixed
- $propagationStopped : mixed
- $queued : mixed
- $transport : mixed
- __construct() : mixed
- getEnvelope() : Envelope
- getMessage() : RawMessage
- getTransport() : string
- isPropagationStopped() : bool
- isQueued() : bool
- setEnvelope() : void
- setMessage() : void
- stopPropagation() : mixed
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
Return values
mixed —getEnvelope()
public
getEnvelope() : Envelope
Return values
Envelope —getMessage()
public
getMessage() : RawMessage
Return values
RawMessage —getTransport()
public
getTransport() : string
Return values
string —isPropagationStopped()
public
isPropagationStopped() : bool
Tags
Return values
bool —Whether propagation was already stopped for this event
isQueued()
public
isQueued() : bool
Return values
bool —setEnvelope()
public
setEnvelope(Envelope $envelope) : void
Parameters
- $envelope : Envelope
Return values
void —setMessage()
public
setMessage(RawMessage $message) : void
Parameters
- $message : RawMessage
Return values
void —stopPropagation()
public
stopPropagation() : mixed