NativeMailerHandler
extends MailHandler
in package
NativeMailerHandler uses the mail() function to send the emails
Tags
Table of Contents
Properties
- $bubble : bool
- $contentType : string|null
- The Content-type for the message
- $encoding : string
- The encoding for the message
- $formatter : FormatterInterface|null
- $headers : array<string|int, string>
- Optional headers for the message
- $level : int
- $maxColumnWidth : int
- The wordwrap length for the message
- $parameters : array<string|int, string>
- Optional parameters for the message
- $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
- addHeader() : self
- Add headers to the message
- addParameter() : self
- Add parameters to the message
- close() : void
- Closes the handler.
- getBubble() : bool
- Gets the bubbling behavior.
- getContentType() : string|null
- getEncoding() : string
- 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}
- popProcessor() : callable
- {@inheritDoc}
- pushProcessor() : HandlerInterface
- {@inheritDoc}
- reset() : void
- setBubble() : self
- Sets the bubbling behavior.
- setContentType() : self
- setEncoding() : self
- setFormatter() : HandlerInterface
- {@inheritDoc}
- setLevel() : self
- Sets minimum logging level at which this handler will be triggered.
- getDefaultFormatter() : FormatterInterface
- Gets the default formatter.
- getHighestRecord() : array<string|int, mixed>
- 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
Properties
$bubble
protected
bool
$bubble
= true
$contentType
The Content-type for the message
protected
string|null
$contentType
$encoding
The encoding for the message
protected
string
$encoding
= 'utf-8'
$formatter
protected
FormatterInterface|null
$formatter
$headers
Optional headers for the message
protected
array<string|int, string>
$headers
= []
$level
protected
int
$level
= \Monolog\Logger::DEBUG
Tags
$maxColumnWidth
The wordwrap length for the message
protected
int
$maxColumnWidth
$parameters
Optional parameters for the message
protected
array<string|int, string>
$parameters
= []
$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|array<string|int, string> $to, string $subject, string $from[, mixed $level = Logger::ERROR ][, bool $bubble = true ][, int $maxColumnWidth = 70 ]) : mixed
Parameters
- $to : string|array<string|int, string>
-
The receiver of the mail
- $subject : string
-
The subject of the mail
- $from : string
-
The sender of the mail
- $level : mixed = Logger::ERROR
- $bubble : bool = true
- $maxColumnWidth : int = 70
-
The maximum column width that the message lines will have
__destruct()
public
__destruct() : mixed
__sleep()
public
__sleep() : mixed
addHeader()
Add headers to the message
public
addHeader(string|array<string|int, string> $headers) : self
Parameters
- $headers : string|array<string|int, string>
-
Custom added headers
Return values
selfaddParameter()
Add parameters to the message
public
addParameter(string|array<string|int, string> $parameters) : self
Parameters
- $parameters : string|array<string|int, string>
-
Custom added parameters
Return values
selfclose()
Closes the handler.
public
close() : 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.
getContentType()
public
getContentType() : string|null
Return values
string|nullgetEncoding()
public
getEncoding() : string
Return values
stringgetFormatter()
{@inheritDoc}
public
getFormatter() : FormatterInterface
Return values
FormatterInterfacegetLevel()
Gets minimum logging level at which this handler will be triggered.
public
getLevel() : int
Tags
Return values
inthandle()
{@inheritDoc}
public
handle(array<string|int, mixed> $record) : bool
Parameters
- $record : array<string|int, mixed>
Return values
boolhandleBatch()
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)
isHandling()
{@inheritDoc}
public
isHandling(array<string|int, mixed> $record) : bool
Parameters
- $record : array<string|int, mixed>
Return values
boolpopProcessor()
{@inheritDoc}
public
popProcessor() : callable
Return values
callablepushProcessor()
{@inheritDoc}
public
pushProcessor(callable $callback) : HandlerInterface
Parameters
- $callback : callable
Return values
HandlerInterfacereset()
public
reset() : void
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
selfsetContentType()
public
setContentType(string $contentType) : self
Parameters
- $contentType : string
-
The content type of the email - Defaults to text/plain. Use text/html for HTML messages.
Return values
selfsetEncoding()
public
setEncoding(string $encoding) : self
Parameters
- $encoding : string
Return values
selfsetFormatter()
{@inheritDoc}
public
setFormatter(FormatterInterface $formatter) : HandlerInterface
Parameters
- $formatter : FormatterInterface
Return values
HandlerInterfacesetLevel()
Sets minimum logging level at which this handler will be triggered.
public
setLevel(Level|LevelName|LogLevel::* $level) : self
Parameters
- $level : Level|LevelName|LogLevel::*
-
Level or level name
Return values
selfgetDefaultFormatter()
Gets the default formatter.
protected
getDefaultFormatter() : FormatterInterface
Overwrite this if the LineFormatter is not a good default for your handler.
Return values
FormatterInterfacegetHighestRecord()
protected
getHighestRecord(array<string|int, mixed> $records) : array<string|int, mixed>
Parameters
- $records : array<string|int, mixed>
Tags
Return values
array<string|int, mixed>isHtmlBody()
protected
isHtmlBody(string $body) : bool
Parameters
- $body : string
Return values
boolprocessRecord()
Processes a record.
protected
processRecord(array<string|int, mixed> $record) : array<string|int, mixed>
Parameters
- $record : array<string|int, mixed>
Tags
Return values
array<string|int, mixed>resetProcessors()
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
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>