SendGridHandler
extends MailHandler
in package
SendGridrHandler uses the SendGrid API v2 function to send Log emails, more information in https://sendgrid.com/docs/API_Reference/Web_API/mail.html
Tags
Table of Contents
Properties
- $apiKey : string
- The SendGrid API Key
- $apiUser : string
- The SendGrid API User
- $bubble : bool
- $formatter : FormatterInterface|null
- $from : string
- The email addresses to which the message will be sent
- $level : Level
- $processors : array<string|int, callable>
- $subject : string
- The subject of the email
- $to : array<string|int, string>
- The email addresses to which the message will be sent
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.
- getDefaultFormatter() : FormatterInterface
- Gets the default formatter.
- getHighestRecord() : LogRecord
- 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
$apiKey
The SendGrid API Key
protected
string
$apiKey
$apiUser
The SendGrid API User
protected
string
$apiUser
$bubble
protected
bool
$bubble
= true
$formatter
protected
FormatterInterface|null
$formatter
= null
$from
The email addresses to which the message will be sent
protected
string
$from
$level
protected
Level
$level
= \Monolog\Level::Debug
$processors
protected
array<string|int, callable>
$processors
= []
Tags
$subject
The subject of the email
protected
string
$subject
$to
The email addresses to which the message will be sent
protected
array<string|int, string>
$to
Methods
__construct()
public
__construct(string $apiUser, string $apiKey, string $from, string|array<string|int, string> $to, string $subject[, int|string|Level $level = Level::Error ][, bool $bubble = true ]) : mixed
Parameters
- $apiUser : string
-
The SendGrid API User
- $apiKey : string
-
The SendGrid API Key
- $from : string
-
The sender of the email
- $to : string|array<string|int, string>
-
The recipients of the email
- $subject : string
-
The subject of the mail
- $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
__destruct()
public
__destruct() : mixed
__sleep()
public
__sleep() : mixed
close()
Closes the handler.
public
close() : void
Tags
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.
getFormatter()
public
getFormatter() : FormatterInterface
Tags
Return values
FormatterInterfacegetLevel()
Gets minimum logging level at which this handler will be triggered.
public
getLevel() : Level
Return values
Levelhandle()
Handles a record.
public
handle(LogRecord $record) : bool
Parameters
- $record : LogRecord
-
The record to handle
Tags
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
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
Return values
boolpopProcessor()
public
popProcessor() : callable
Tags
Return values
callablepushProcessor()
public
pushProcessor(callable $callback) : HandlerInterface
Parameters
- $callback : callable
Tags
Return values
HandlerInterfacereset()
public
reset() : void
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
$thissetFormatter()
public
setFormatter(FormatterInterface $formatter) : HandlerInterface
Parameters
- $formatter : FormatterInterface
Tags
Return values
HandlerInterfacesetLevel()
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
Return values
$thisgetDefaultFormatter()
Gets the default formatter.
protected
getDefaultFormatter() : FormatterInterface
Return values
FormatterInterfacegetHighestRecord()
protected
getHighestRecord(array<string|int, mixed> $records) : LogRecord
Parameters
- $records : array<string|int, mixed>
Tags
Return values
LogRecordisHtmlBody()
protected
isHtmlBody(string $body) : bool
Parameters
- $body : string
Return values
boolprocessRecord()
protected
processRecord(LogRecord $record) : LogRecord
Parameters
- $record : LogRecord
Return values
LogRecordresetProcessors()
protected
resetProcessors() : void
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
Tags
write()
Writes the (already formatted) record down to the log of the implementing handler
protected
write(LogRecord $record) : void
Parameters
- $record : LogRecord