Documentation

SwiftMailerHandler extends SwiftMailerHandler
in package

Extended SwiftMailerHandler that flushes mail queue if necessary.

Tags
author

Philipp Kräutli pkraeutli@astina.ch

final
deprecated

since Symfony 5.4

Table of Contents

$bubble  : bool
$formatter  : FormatterInterface|null
$instantFlush  : mixed
$level  : int
$mailer  : Swift_Mailer
$processors  : array<string|int, callable>
$transport  : mixed
$messageTemplate  : Swift_Message|callable
__construct()  : mixed
__destruct()  : mixed
__sleep()  : mixed
close()  : void
Closes the handler.
getBubble()  : bool
Gets the bubbling behavior.
getFormatter()  : FormatterInterface
{@inheritDoc}
getLevel()  : int
Gets minimum logging level at which this handler will be triggered.
handle()  : bool
{@inheritDoc}
handleBatch()  : void
Handles a set of records at once.
isHandling()  : bool
{@inheritDoc}
onCliTerminate()  : mixed
After the CLI application has been terminated we will always flush messages.
onKernelTerminate()  : mixed
After the kernel has been terminated we will always flush messages.
popProcessor()  : callable
{@inheritDoc}
pushProcessor()  : HandlerInterface
{@inheritDoc}
reset()  : void
{@inheritdoc}
setBubble()  : self
Sets the bubbling behavior.
setFormatter()  : HandlerInterface
{@inheritDoc}
setLevel()  : self
Sets minimum logging level at which this handler will be triggered.
setTransport()  : mixed
buildMessage()  : Swift_Message
Creates instance of Swift_Message to be sent
getDefaultFormatter()  : FormatterInterface
Gets the default formatter.
getHighestRecord()  : array<string|int, mixed>
getSubjectFormatter()  : FormatterInterface
Gets the formatter for the Swift_Message subject.
isHtmlBody()  : bool
processRecord()  : array<string|int, mixed>
Processes a record.
resetProcessors()  : void
send()  : void
Send a mail with the given content
write()  : void
Writes the record down to the log of the implementing handler
flushMemorySpool()  : mixed
Flushes the mail queue if a memory spool is used.

Properties

$level

protected int $level = MonologLogger::DEBUG
Tags
phpstan-var

Level

$processors

protected array<string|int, callable> $processors = []
Tags
phpstan-var

array<ProcessorInterface|callable(Record): Record>

Methods

__construct()

public __construct([int|string $level = Logger::DEBUG ][, bool $bubble = true ]) : mixed
Parameters
$level : int|string = Logger::DEBUG

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

Tags
phpstan-param

Level|LevelName|LogLevel::* $level

Return values
mixed —

__destruct()

public __destruct() : mixed
Return values
mixed —

__sleep()

public __sleep() : mixed
Return values
mixed —

close()

Closes the handler.

public close() : void
Return values
void —

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
Tags
phpstan-return

Level

Return values
int —

handle()

{@inheritDoc}

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

handleBatch()

Handles a set of records at once.

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

The records to handle (an array of record arrays)

Return values
void —

isHandling()

{@inheritDoc}

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

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(Level|LevelName|\Psr\Log\LogLevel::* $level) : self
Parameters
$level : Level|LevelName|\Psr\Log\LogLevel::*

Level or level name

Return values
self —

setTransport()

public setTransport(Swift_Transport $transport) : mixed
Parameters
$transport : Swift_Transport
Return values
mixed —

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

Tags
phpstan-param

Record[] $records

Return values
Swift_Message —

getHighestRecord()

protected getHighestRecord(array<string|int, mixed> $records) : array<string|int, mixed>
Parameters
$records : array<string|int, mixed>
Tags
phpstan-param

non-empty-array $records

phpstan-return

Record

Return values
array<string|int, mixed> —

isHtmlBody()

protected isHtmlBody(string $body) : bool
Parameters
$body : string
Return values
bool —

processRecord()

Processes a record.

protected processRecord(array<string|int, mixed> $record) : array<string|int, mixed>
Parameters
$record : array<string|int, mixed>
Tags
phpstan-param

Record $record

phpstan-return

Record

Return values
array<string|int, mixed> —

send()

Send a mail with the given content

protected send(mixed $content, array<string|int, mixed> $records) : void
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
void —

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>
Tags
phpstan-param

FormattedRecord $record

Return values
void —

flushMemorySpool()

Flushes the mail queue if a memory spool is used.

private flushMemorySpool() : mixed
Return values
mixed —

Search results