\Monolog\HandlerSendGridHandler

SendGridrHandler uses the SendGrid API v2 function to send Log emails, more information in https://sendgrid.com/docs/API_Reference/Web_API/mail.html

Summary

Methods
Properties
Constants
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()
$processors
$formatter
$level
$bubble
$apiUser
$apiKey
$from
$to
$subject
N/A
No private methods found
No private properties found
N/A

Properties

$processors

$processors : callable[]

Type

callable[]

$formatter

$formatter : ?\Monolog\Formatter\FormatterInterface

Type

FormatterInterface

$level

$level : int

Type

int

$bubble

$bubble : bool

Type

bool

$apiUser

$apiUser : string

The SendGrid API User

Type

string

$apiKey

$apiKey : string

The SendGrid API Key

Type

string

$from

$from : string

The email addresses to which the message will be sent

Type

string

$to

$to : string[]

The email addresses to which the message will be sent

Type

string[]

$subject

$subject : string

The subject of the email

Type

string

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(string  $apiUser, string  $apiKey, string  $from, string|string[]  $to, string  $subject, mixed  $level = Logger::ERROR, bool  $bubble = true) : mixed

Parameters

string $apiUser

The SendGrid API User

string $apiKey

The SendGrid API Key

string $from

The sender of the email

string|string[] $to

The recipients of the email

string $subject

The subject of the mail

mixed $level
bool $bubble

Returns

mixed —

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 —

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

getHighestRecord()

getHighestRecord(array  $records) : array

Parameters

array $records

Returns

array —

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 —

resetProcessors()

resetProcessors() : void