handleBatch()
handle()
reset()
pushProcessor()
popProcessor()
setFormatter()
getFormatter()
__construct()
isHandling()
setLevel()
getLevel()
setBubble()
getBubble()
close()
__destruct()
__sleep()

No public properties found

No constants found

send()
write()
getHighestRecord()
isHtmlBody()
getDefaultFormatter()
processRecord()
resetProcessors()
getSubjectFormatter()
buildMessage()

$processors
$formatter
$level
$bubble
$mailer

N/A

No private methods found

$messageTemplate

N/A

File: vendor/monolog/monolog/src/Monolog/Handler/SwiftMailerHandler.php
Package: Application
Class hierarchy: Handler

AbstractHandler

AbstractProcessingHandler

MailHandler

\Monolog\Handler\SwiftMailerHandler
Uses

Tags

author	Gyula Sallai
phpstan-import-type	Record from \Monolog\Logger
deprecated	Since Monolog 2.6. Use SymfonyMailerHandler instead.

Properties

$processors

$processors : callable[]

Type

callable[] —

Inherited from: \Monolog\Handler\ProcessableHandlerTrait
Uses

Tags

phpstan-var	array<ProcessorInterface\|callable(Record): Record>

$formatter

$formatter : ?\Monolog\Formatter\FormatterInterface

Type

FormatterInterface —

$level

$level : int

Type

int —

Inherited from: \Monolog\Handler\AbstractHandler
Uses

Tags

phpstan-var	Level

$bubble

$bubble : bool

Type

bool —

$mailer

$mailer : \Swift_Mailer

Type

\Swift_Mailer —

$messageTemplate

$messageTemplate

Methods

handleBatch()

handleBatch(array  $records) : void

Handles a set of records at once.

Parameters

array

$records

The records to handle (an array of record arrays)

handle()

handle(array  $record) : bool

{@inheritDoc}

Parameters

array

$record

Returns

bool —

reset()

reset() : void

pushProcessor()

pushProcessor(callable  $callback) : \Monolog\Handler\HandlerInterface

{@inheritDoc}

Parameters

callable

$callback

Returns

\Monolog\Handler\HandlerInterface —

popProcessor()

popProcessor() : callable

{@inheritDoc}

Returns

callable —

setFormatter()

setFormatter(\Monolog\Formatter\FormatterInterface  $formatter) : \Monolog\Handler\HandlerInterface

{@inheritDoc}

Parameters

\Monolog\Formatter\FormatterInterface

$formatter

Returns

\Monolog\Handler\HandlerInterface —

getFormatter()

getFormatter() : \Monolog\Formatter\FormatterInterface

{@inheritDoc}

Returns

\Monolog\Formatter\FormatterInterface —

__construct()

__construct(\Swift_Mailer  $mailer, callable|\Swift_Message  $message, mixed  $level = Logger::ERROR, bool  $bubble = true) : mixed

Parameters

\Swift_Mailer	$mailer	The mailer to use
callable\|\Swift_Message	$message	An example message for real messages, only the body will be replaced
mixed	$level
bool	$bubble

Returns

mixed —

Inherited from: \Monolog\Handler\SwiftMailerHandler
Uses

Tags

psalm-param	Swift_Message\|callable(string, Record[]): Swift_Message $message

isHandling()

isHandling(array  $record) : bool

{@inheritDoc}

Parameters

array

$record

Returns

bool —

setLevel()

setLevel(mixed  $level) : self

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

Parameters

mixed

$level

Returns

self —

getLevel()

getLevel() : int

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

Returns

int —

Inherited from: \Monolog\Handler\AbstractHandler
Uses

Tags

phpstan-return	Level

setBubble()

setBubble(bool  $bubble) : self

Sets the bubbling behavior.

Parameters

bool

$bubble

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

Returns

self —

getBubble()

getBubble() : bool

Gets the bubbling behavior.

Returns

bool —

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

close()

close() : void

Closes the handler.

__destruct()

__destruct() : mixed

Returns

mixed —

__sleep()

__sleep() : mixed

Returns

mixed —

send()

send(string  $content, array  $records) : void

Send a mail with the given content

Parameters

string	$content	formatted email body to be sent
array	$records	the array of log records that formed this content

write()

write(array  $record) : void

Writes the record down to the log of the implementing handler

Parameters

array

$record

abstract

Inherited from: \Monolog\Handler\AbstractProcessingHandler
Uses

Tags

phpstan-param	FormattedRecord $record

getHighestRecord()

getHighestRecord(array  $records) : array

Parameters

array

$records

Returns

array —

Inherited from: \Monolog\Handler\MailHandler
Uses

Tags

phpstan-param	non-empty-array<Record> $records
phpstan-return	Record

isHtmlBody()

isHtmlBody(string  $body) : bool

Parameters

string

$body

Returns

bool —

getDefaultFormatter()

getDefaultFormatter() : \Monolog\Formatter\FormatterInterface

Gets the default formatter.

Overwrite this if the LineFormatter is not a good default for your handler.

Returns

\Monolog\Formatter\FormatterInterface —

processRecord()

processRecord(array  $record) : array

Processes a record.

Parameters

array

$record

Returns

array —

Inherited from: \Monolog\Handler\ProcessableHandlerTrait
Uses

Tags

phpstan-param	Record $record
phpstan-return	Record

resetProcessors()

resetProcessors() : void

getSubjectFormatter()

getSubjectFormatter(string|null  $format) : \Monolog\Formatter\FormatterInterface

Gets the formatter for the Swift_Message subject.

Parameters

string|null

$format

The format of the subject

Returns

\Monolog\Formatter\FormatterInterface —

buildMessage()

buildMessage(string  $content, array  $records) : \Swift_Message

Creates instance of Swift_Message to be sent

Parameters

string	$content	formatted email body to be sent
array	$records	Log records that formed the content

Returns

\Swift_Message —

Inherited from: \Monolog\Handler\SwiftMailerHandler
Uses

Tags

phpstan-param	Record[] $records