NativeMailerHandler uses the mail() function to send the emails. More...

Inheritance diagram for Monolog\Handler\NativeMailerHandler:

Collaboration diagram for Monolog\Handler\NativeMailerHandler:

Public Member Functions

__construct ($to, $subject, $from, $level=Logger::ERROR, $bubble=true, $maxColumnWidth=70)

addHeader ($headers)

Add headers to the message. More...

addParameter ($parameters)

Add parameters to the message. More...

getContentType ()

getEncoding ()

setContentType ($contentType)

setEncoding ($encoding)

Public Member Functions inherited from Monolog\Handler\MailHandler

handleBatch (array $records)

{{Handles a set of records at once.

Parameters

array $records The records to handle (an array of record arrays)

}} More...

Public Member Functions inherited from Monolog\Handler\AbstractProcessingHandler

handle (array $record)

{Handles a record.All records may be passed to this method, and the handler should discard those that it does not want to handle.The return value of this function controls the bubbling process of the handler stack. Unless the bubbling is interrupted (by returning true), the Logger class will keep on calling further handlers in the stack with a given log record.

Parameters

array $record The record to handle

Returns: Boolean 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.

} More...

Public Member Functions inherited from Monolog\Handler\AbstractHandler

__construct ($level=Logger::DEBUG, $bubble=true)

isHandling (array $record)

{Checks whether the given record will be handled by this handler.This is mostly done for performance reasons, to avoid calling processors for nothing.Handlers should still check the record levels within handle(), returning false in isHandling() is no guarantee that handle() will not be called, and isHandling() might not be called for a given record.

Parameters

array $record Partial log record containing only a level key

Returns: Boolean

} More...

handleBatch (array $records)

{Handles a set of records at once.

Parameters

array $records The records to handle (an array of record arrays)

} More...

close ()

Closes the handler. More...

pushProcessor ($callback)

{Adds a processor in the stack.

Parameters

callable $callback

Returns: self

} More...

popProcessor ()

{Removes the processor on top of the stack and returns it.

Returns: callable

} More...

setFormatter (FormatterInterface $formatter)

{Sets the formatter.

Parameters

FormatterInterface $formatter

Returns: self

} More...

getFormatter ()

{Gets the formatter.

Returns: FormatterInterface

} More...

setLevel ($level)

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

getLevel ()

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

setBubble ($bubble)

Sets the bubbling behavior. More...

getBubble ()

Gets the bubbling behavior. More...

__destruct ()

isHandling (array $record)

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

handle (array $record)

Handles a record. More...

handleBatch (array $records)

Handles a set of records at once. More...

pushProcessor ($callback)

Adds a processor in the stack. More...

popProcessor ()

Removes the processor on top of the stack and returns it. More...

setFormatter (FormatterInterface $formatter)

Sets the formatter. More...

getFormatter ()

Gets the formatter. More...

Protected Member Functions

send ($content, array $records)

{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

} More...

Protected Member Functions inherited from Monolog\Handler\MailHandler

send ($content, array $records)

Send a mail with the given content. More...

write (array $record)

{Writes the record down to the log of the implementing handler.

Parameters

array $record

Returns: void

} More...

Protected Member Functions inherited from Monolog\Handler\AbstractProcessingHandler

write (array $record)

Writes the record down to the log of the implementing handler. More...

processRecord (array $record)

Processes a record. More...

Protected Member Functions inherited from Monolog\Handler\AbstractHandler

getDefaultFormatter ()

Gets the default formatter. More...

Protected Attributes
	$to

	$subject

	$headers = array()

	$parameters = array()

	$maxColumnWidth

	$contentType = 'text/plain'

	$encoding = 'utf-8'

Protected Attributes inherited from Monolog\Handler\AbstractHandler
	$level = Logger::DEBUG

	$bubble = true

	$formatter

	$processors = array()

Detailed Description

NativeMailerHandler uses the mail() function to send the emails.

Author: Christophe Coevoet stof@.nosp@m.notk.nosp@m..org; Mark Garrett mark@.nosp@m.mode.nosp@m.rndev.nosp@m.elop.nosp@m.erllc.nosp@m..com

Definition at line 22 of file NativeMailerHandler.php.

Constructor & Destructor Documentation

◆ __construct()

Monolog\Handler\NativeMailerHandler::__construct	(	$to,
		$subject,
		$from,
		$level = `Logger::ERROR`,
		$bubble = `true`,
		$maxColumnWidth = `70`
	)

Parameters

string \| array	$to	The receiver of the mail
string	$subject	The subject of the mail
string	$from	The sender of the mail
integer	$level	The minimum logging level at which this handler will be triggered
boolean	$bubble	Whether the messages that are handled can bubble up the stack or not
int	$maxColumnWidth	The maximum column width that the message lines will have

Definition at line 74 of file NativeMailerHandler.php.

    {
        parent::__construct($level, $bubble);
        $this->to = is_array($to) ? $to : array($to);
        $this->subject = $subject;
        $this->addHeader(sprintf('From: %s', $from));
        $this->maxColumnWidth = $maxColumnWidth;
    }

References Monolog\Handler\AbstractHandler\$bubble, Monolog\Handler\AbstractHandler\$level, Monolog\Handler\NativeMailerHandler\$maxColumnWidth, Monolog\Handler\NativeMailerHandler\$subject, Monolog\Handler\NativeMailerHandler\$to, and Monolog\Handler\NativeMailerHandler\addHeader().

Here is the call graph for this function:

Member Function Documentation

◆ addHeader()

Monolog\Handler\NativeMailerHandler::addHeader ( $headers )

Add headers to the message.

Parameters

string | array $headers Custom added headers

Returns: self

Definition at line 89 of file NativeMailerHandler.php.

    {
        foreach ((array) $headers as $header) {
            if (strpos($header, "\n") !== false || strpos($header, "\r") !== false) {
                throw new \InvalidArgumentException('Headers can not contain newline characters for security reasons');
            }
            $this->headers[] = $header;
        }
 
        return $this;
    }

References $header, and Monolog\Handler\NativeMailerHandler\$headers.

Referenced by Monolog\Handler\NativeMailerHandler\__construct().

Here is the caller graph for this function:

◆ addParameter()

Monolog\Handler\NativeMailerHandler::addParameter ( $parameters )

Add parameters to the message.

Parameters

string | array $parameters Custom added parameters

Returns: self

Definition at line 107 of file NativeMailerHandler.php.

    {
        $this->parameters = array_merge($this->parameters, (array) $parameters);
 
        return $this;
    }

References Monolog\Handler\NativeMailerHandler\$parameters.

◆ getContentType()

Monolog\Handler\NativeMailerHandler::getContentType ( )

Returns: string $contentType

Definition at line 133 of file NativeMailerHandler.php.

    {
        return $this->contentType;
    }

References Monolog\Handler\NativeMailerHandler\$contentType.

Referenced by Monolog\Handler\NativeMailerHandler\send().

Here is the caller graph for this function:

◆ getEncoding()

Monolog\Handler\NativeMailerHandler::getEncoding ( )

Returns: string $encoding

Definition at line 141 of file NativeMailerHandler.php.

    {
        return $this->encoding;
    }

References Monolog\Handler\NativeMailerHandler\$encoding.

Referenced by Monolog\Handler\NativeMailerHandler\send().

Here is the caller graph for this function:

◆ send()

Monolog\Handler\NativeMailerHandler::send	(		$content,
		array	$records
	)

protected

{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

}

Reimplemented from Monolog\Handler\MailHandler.

Definition at line 117 of file NativeMailerHandler.php.

    {
        $content = wordwrap($content, $this->maxColumnWidth);
        $headers = ltrim(implode("\r\n", $this->headers) . "\r\n", "\r\n");
        $headers .= 'Content-type: ' . $this->getContentType() . '; charset=' . $this->getEncoding() . "\r\n";
        if ($this->getContentType() == 'text/html' && false === strpos($headers, 'MIME-Version:')) {
            $headers .= 'MIME-Version: 1.0' . "\r\n";
        }
        foreach ($this->to as $to) {
            mail($to, $this->subject, $content, $headers, implode(' ', $this->parameters));
        }
    }

References Monolog\Handler\NativeMailerHandler\$headers, Monolog\Handler\NativeMailerHandler\$to, Monolog\Handler\NativeMailerHandler\getContentType(), and Monolog\Handler\NativeMailerHandler\getEncoding().

Here is the call graph for this function:

◆ setContentType()

Monolog\Handler\NativeMailerHandler::setContentType ( $contentType )

Parameters

string $contentType The content type of the email - Defaults to text/plain. Use text/html for HTML messages.

Returns: self

Definition at line 151 of file NativeMailerHandler.php.

    {
        if (strpos($contentType, "\n") !== false || strpos($contentType, "\r") !== false) {
            throw new \InvalidArgumentException('The content type can not contain newline characters to prevent email header injection');
        }
 
        $this->contentType = $contentType;
 
        return $this;
    }

References Monolog\Handler\NativeMailerHandler\$contentType.

◆ setEncoding()

Monolog\Handler\NativeMailerHandler::setEncoding ( $encoding )

Parameters

string $encoding

Returns: self

Definition at line 166 of file NativeMailerHandler.php.

    {
        if (strpos($encoding, "\n") !== false || strpos($encoding, "\r") !== false) {
            throw new \InvalidArgumentException('The encoding can not contain newline characters to prevent email header injection');
        }
 
        $this->encoding = $encoding;
 
        return $this;
    }

References Monolog\Handler\NativeMailerHandler\$encoding.

Field Documentation

◆ $contentType

Monolog\Handler\NativeMailerHandler::$contentType = 'text/plain'

protected

Definition at line 58 of file NativeMailerHandler.php.

Referenced by Monolog\Handler\NativeMailerHandler\getContentType(), and Monolog\Handler\NativeMailerHandler\setContentType().

◆ $encoding

Monolog\Handler\NativeMailerHandler::$encoding = 'utf-8'

protected

Definition at line 64 of file NativeMailerHandler.php.

Referenced by Monolog\Handler\NativeMailerHandler\getEncoding(), and Monolog\Handler\NativeMailerHandler\setEncoding().

◆ $headers

Monolog\Handler\NativeMailerHandler::$headers = array()

protected

Definition at line 40 of file NativeMailerHandler.php.

Referenced by Monolog\Handler\NativeMailerHandler\addHeader(), and Monolog\Handler\NativeMailerHandler\send().

◆ $maxColumnWidth

Monolog\Handler\NativeMailerHandler::$maxColumnWidth

protected

Definition at line 52 of file NativeMailerHandler.php.

Referenced by Monolog\Handler\NativeMailerHandler\__construct().

◆ $parameters

Monolog\Handler\NativeMailerHandler::$parameters = array()

protected

Definition at line 46 of file NativeMailerHandler.php.

Referenced by Monolog\Handler\NativeMailerHandler\addParameter().

◆ $subject

Monolog\Handler\NativeMailerHandler::$subject

protected

Definition at line 34 of file NativeMailerHandler.php.

Referenced by Monolog\Handler\NativeMailerHandler\__construct().

◆ $to

Monolog\Handler\NativeMailerHandler::$to

protected

Definition at line 28 of file NativeMailerHandler.php.

Referenced by Monolog\Handler\NativeMailerHandler\__construct(), and Monolog\Handler\NativeMailerHandler\send().

The documentation for this class was generated from the following file:

Services/Logging/lib/vendor/monolog/monolog/src/Monolog/Handler/NativeMailerHandler.php

Public Member Functions

Protected Member Functions

Protected Attributes

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ addHeader()

◆ addParameter()

◆ getContentType()

◆ getEncoding()

◆ send()

◆ setContentType()

◆ setEncoding()

Field Documentation

◆ $contentType

◆ $encoding

◆ $headers

◆ $maxColumnWidth

◆ $parameters

◆ $subject

◆ $to