Documentation

SymfonyMailerHandler extends MailHandler
in package

SymfonyMailerHandler uses Symfony's Mailer component to send the emails

Tags
author

Jordi Boggiano j.boggiano@seld.be

Table of Contents

Properties

$bubble  : bool
$formatter  : FormatterInterface|null
$level  : Level
$mailer  : MailerInterface|TransportInterface
$processors  : array<string|int, callable>
$emailTemplate  : Email|callable(string, array<string|int, LogRecord>): Email

Methods

__construct()  : mixed
__destruct()  : mixed
__sleep()  : mixed
close()  : void
Closes the handler.
getBubble()  : bool
Gets the bubbling behavior.
getFormatter()  : FormatterInterface
getLevel()  : Level
Gets minimum logging level at which this handler will be triggered.
handle()  : bool
Handles a record.
handleBatch()  : void
Handles a set of records at once.
isHandling()  : bool
Checks whether the given record will be handled by this handler.
popProcessor()  : callable
pushProcessor()  : HandlerInterface
reset()  : void
setBubble()  : $this
Sets the bubbling behavior.
setFormatter()  : HandlerInterface
setLevel()  : $this
Sets minimum logging level at which this handler will be triggered.
buildMessage()  : Email
Creates instance of Email to be sent
getDefaultFormatter()  : FormatterInterface
Gets the default formatter.
getHighestRecord()  : LogRecord
getSubjectFormatter()  : FormatterInterface
Gets the formatter for the Swift_Message subject.
isHtmlBody()  : bool
processRecord()  : LogRecord
resetProcessors()  : void
send()  : void
Send a mail with the given content
write()  : void
Writes the (already formatted) record down to the log of the implementing handler

Properties

$processors

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

array<(callable(LogRecord): LogRecord)|ProcessorInterface>

Methods

__construct()

public __construct(MailerInterface|TransportInterface $mailer, Closure|Email $email[, int|string|Level $level = Level::Error ][, bool $bubble = true ]) : mixed
Parameters
$mailer : MailerInterface|TransportInterface

The mailer to use

$email : Closure|Email

An email template, the subject/body will be replaced

$level : int|string|Level = Level::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

Tags
phpstan-param

Email|Closure(string, LogRecord[]): Email $email

__destruct()

public __destruct() : mixed

close()

Closes the handler.

public close() : void
Tags
inheritDoc

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() : Level
Return values
Level

handle()

Handles a record.

public handle(LogRecord $record) : bool
Parameters
$record : LogRecord

The record to handle

Tags
inheritDoc
Return values
bool —

true means that this handler handled the record, and that bubbling is not permitted. false means the record was either not processed or that this handler allows bubbling.

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

Tags
inheritDoc

isHandling()

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

public isHandling(LogRecord $record) : bool
Parameters
$record : LogRecord

Partial log record having only a level initialized

Tags
inheritDoc
Return values
bool

setBubble()

Sets the bubbling behavior.

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

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

Return values
$this

setLevel()

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

public setLevel(Level|LogLevel::* $level) : $this
Parameters
$level : Level|LogLevel::*

Level or level name

Tags
phpstan-param

value-ofLevel::VALUES|value-ofLevel::NAMES|Level|LogLevel::* $level

Return values
$this

buildMessage()

Creates instance of Email to be sent

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

formatted email body to be sent

$records : array<string|int, LogRecord>

Log records that formed the content

Return values
Email

getHighestRecord()

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

non-empty-array<LogRecord> $records

Return values
LogRecord

isHtmlBody()

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

send()

Send a mail with the given content

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

formatted email body to be sent

$records : array<string|int, mixed>

the array of log records that formed this content

write()

Writes the (already formatted) record down to the log of the implementing handler

protected write(LogRecord $record) : void
Parameters
$record : LogRecord
Tags
inheritDoc 

        

        
    




    

    

                                

                

                                
    

        On this page

        
    


                

                            

            

    

        

            
Search results