Docs For Class LoggerAppenderMail

Description

Appends log events to mail using php function http://www.php.net/mail.

The appender sends all log events at once after the request has been finsished and the appender is beeing closed.

Configurable parameters for this appender:

layout - Sets the layout class for this appender (required)
to - Sets the recipient of the mail (required)
from - Sets the sender of the mail (optional)
subject - Sets the subject of the mail (optional)

An example:

require_once dirname(__FILE__).'/../../main/php/Logger.php';
Logger::configure(dirname(__FILE__).'/../resources/appender_mail.properties');
$logger = Logger::getRootLogger();
$logger->fatal("Some critical message!");
$logger->fatal("Some more critical message!");

log4php.appender.email = LoggerAppenderMail
log4php.appender.email.layout = LoggerLayoutTTCC
log4php.appender.email.from = someone@example.com
log4php.appender.email.to = root@localhost
log4php.appender.email.subject = Log4php test
log4php.rootLogger = FATAL, email

The above will output something like:

      Date: Tue,  8 Sep 2009 21:51:04 +0200 (CEST)
      From: someone@example.com
      To: root@localhost
      Subject: Log4php test

      Tue Sep  8 21:51:04 2009,120 [5485] FATAL root - Some critical message!
      Tue Sep  8 21:51:06 2009,120 [5485] FATAL root - Some more critical message!

version: $Revision: 1213283 $

Located in /appenders/LoggerAppenderMail.php (line 55)

LoggerConfigurable
   |
   --LoggerAppender
      |
      --LoggerAppenderMail

Variable Summary

string $body

indiciates $dry

string $from

string $subject

string $to

Method Summary

void append (LoggerLoggingEvent $event)

void close ()

void setDry ( $dry)

void setFrom ( $from)

void setSubject ( $subject)

void setTo ( $to)

Variables

string $body = '' (line 70)

var: used to create mail body
access: protected

indiciates $dry = false (line 67)

var: if this appender should run in dry mode
access: protected

string $from = null (line 58)

var: 'from' field
access: protected

string $subject = 'Log4php Report' (line 61)

var: 'subject' field
access: protected

string $to = null (line 64)

var: 'to' field
access: protected

Inherited Variables

Inherited from LoggerAppender

LoggerAppender::$closed
LoggerAppender::$filter
LoggerAppender::$layout
LoggerAppender::$name
LoggerAppender::$requiresLayout
LoggerAppender::$threshold

Methods

append (line 108)

access: public

void append (LoggerLoggingEvent $event)

LoggerLoggingEvent $event

Redefinition of:

LoggerAppender::append(): Forwards the logging event to the destination.

close (line 72)

access: public

void close ()

Redefinition of:

LoggerAppender::close(): Releases any resources allocated by the appender.

setDry (line 104)

access: public

void setDry ( $dry)

$dry

setFrom (line 100)

access: public

void setFrom ( $from)

$from

setSubject (line 92)

access: public

void setSubject ( $subject)

$subject

setTo (line 96)

access: public

void setTo ( $to)

$to

Inherited Methods

Inherited From LoggerAppender

LoggerAppender::__construct()
LoggerAppender::activateOptions()
LoggerAppender::addFilter()
LoggerAppender::append()
LoggerAppender::clearFilters()
LoggerAppender::close()
LoggerAppender::doAppend()
LoggerAppender::getDefaultLayout()
LoggerAppender::getFilter()
LoggerAppender::getFirstFilter()
LoggerAppender::getLayout()
LoggerAppender::getName()
LoggerAppender::getThreshold()
LoggerAppender::isAsSevereAsThreshold()
LoggerAppender::requiresLayout()
LoggerAppender::setLayout()
LoggerAppender::setName()
LoggerAppender::setThreshold()
LoggerAppender::warn()

Inherited From LoggerConfigurable

LoggerConfigurable::setBoolean()
LoggerConfigurable::setFileSize()
LoggerConfigurable::setInteger()
LoggerConfigurable::setLevel()
LoggerConfigurable::setNumeric()
LoggerConfigurable::setPositiveInteger()
LoggerConfigurable::setString()
LoggerConfigurable::warn()