Documentation

SwiftMailerHandler extends MailHandler
in package

SwiftMailerHandler uses Swift_Mailer to send the emails

Tags
author

Gyula Sallai

Table of Contents

$bubble  : mixed
$formatter  : FormatterInterface
$level  : mixed
$mailer  : mixed
$processors  : mixed
$messageTemplate  : mixed
__construct()  : mixed
__destruct()  : mixed
__get()  : mixed
BC getter, to be removed in 2.0
close()  : mixed
Closes the handler.
getBubble()  : bool
Gets the bubbling behavior.
getFormatter()  : FormatterInterface
Gets the formatter.
getLevel()  : int
Gets minimum logging level at which this handler will be triggered.
handle()  : mixed
{@inheritdoc}
handleBatch()  : mixed
Handles a set of records at once.
isHandling()  : bool
Checks whether the given record will be handled by this handler.
popProcessor()  : callable
Removes the processor on top of the stack and returns it.
pushProcessor()  : self
Adds a processor in the stack.
reset()  : mixed
setBubble()  : self
Sets the bubbling behavior.
setFormatter()  : self
Sets the formatter.
setLevel()  : self
Sets minimum logging level at which this handler will be triggered.
buildMessage()  : Swift_Message
Creates instance of Swift_Message to be sent
getDefaultFormatter()  : FormatterInterface
Gets the default formatter.
getHighestRecord()  : mixed
getSubjectFormatter()  : FormatterInterface
Gets the formatter for the Swift_Message subject.
processRecord()  : array<string|int, mixed>
Processes a record.
send()  : mixed
Send a mail with the given content
write()  : void
Writes the record down to the log of the implementing handler

Properties

Methods

__construct()

public __construct(Swift_Mailer $mailer, callable|Swift_Message $message[, int $level = Logger::ERROR ][, bool $bubble = true ]) : mixed
Parameters
$mailer : Swift_Mailer

The mailer to use

$message : callable|Swift_Message

An example message for real messages, only the body will be replaced

$level : int = Logger::ERROR

The minimum logging level at which this handler will be triggered

$bubble : bool = true

Whether the messages that are handled can bubble up the stack or not

Return values
mixed —

__get()

BC getter, to be removed in 2.0

public __get(mixed $name) : mixed
Parameters
$name : mixed
Return values
mixed —

close()

Closes the handler.

public close() : mixed

This will be called automatically when the object is destroyed

Return values
mixed —

getBubble()

Gets the bubbling behavior.

public getBubble() : bool
Return values
bool —

true means that this handler allows bubbling. false means that bubbling is not permitted.

getLevel()

Gets minimum logging level at which this handler will be triggered.

public getLevel() : int
Return values
int —

handle()

{@inheritdoc}

public handle(array<string|int, mixed> $record) : mixed
Parameters
$record : array<string|int, mixed>
Return values
mixed —

handleBatch()

Handles a set of records at once.

public handleBatch(array<string|int, mixed> $records) : mixed
Parameters
$records : array<string|int, mixed>

The records to handle (an array of record arrays)

Return values
mixed —

isHandling()

Checks whether the given record will be handled by this handler.

public isHandling(array<string|int, mixed> $record) : bool
Parameters
$record : array<string|int, mixed>

Partial log record containing only a level key

Return values
bool —

popProcessor()

Removes the processor on top of the stack and returns it.

public popProcessor() : callable
Return values
callable —

pushProcessor()

Adds a processor in the stack.

public pushProcessor(mixed $callback) : self
Parameters
$callback : mixed
Return values
self —

setBubble()

Sets the bubbling behavior.

public setBubble(bool $bubble) : self
Parameters
$bubble : bool

true means that this handler allows bubbling. false means that bubbling is not permitted.

Return values
self —

setLevel()

Sets minimum logging level at which this handler will be triggered.

public setLevel(int|string $level) : self
Parameters
$level : int|string

Level or level name

Return values
self —

buildMessage()

Creates instance of Swift_Message to be sent

protected buildMessage(string $content, array<string|int, mixed> $records) : Swift_Message
Parameters
$content : string

formatted email body to be sent

$records : array<string|int, mixed>

Log records that formed the content

Return values
Swift_Message —

getHighestRecord()

protected getHighestRecord(array<string|int, mixed> $records) : mixed
Parameters
$records : array<string|int, mixed>
Return values
mixed —

processRecord()

Processes a record.

protected processRecord(array<string|int, mixed> $record) : array<string|int, mixed>
Parameters
$record : array<string|int, mixed>
Return values
array<string|int, mixed> —

send()

Send a mail with the given content

protected send(mixed $content, array<string|int, mixed> $records) : mixed
Parameters
$content : mixed

formatted email body to be sent

$records : array<string|int, mixed>

the array of log records that formed this content

Return values
mixed —

write()

Writes the record down to the log of the implementing handler

protected abstract write(array<string|int, mixed> $record) : void
Parameters
$record : array<string|int, mixed>
Return values
void —

Search results