Docs For Class LoggerAppenderMailEvent

Description

Log every events as a separate email.

Configurable parameters for this appender are:

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)
smtpHost - Sets the mail server (optional, default is ini_get('SMTP'))
port - Sets the port of the mail server (optional, default is 25)

An example:

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

log4php.appender.email = LoggerAppenderMail
log4php.appender.email.layout = LoggerLayoutTTCC
log4php.appender.email.from = someone@example.com
log4php.appender.email.to = root
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!

version: $Revision: 1237433 $

Located in /appenders/LoggerAppenderMailEvent.php (line 54)

LoggerConfigurable
   |
   --LoggerAppender
      |
      --LoggerAppenderMailEvent

Variable Summary

indiciates $dry

string $from

integer $port

string $smtpHost

string $subject

string $to

Method Summary

void activateOptions ()

void append (LoggerLoggingEvent $event)

void setDry ( $dry)

void setFrom ( $from)

void setPort ( $port)

void setSmtpHost ( $smtpHost)

void setSubject ( $subject)

void setTo ( $to)

Variables

indiciates $dry = false (line 82)

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

string $from (line 59)

'from' field (defaults to 'sendmail_from' from php.ini on win32).

access: protected

integer $port = 25 (line 64)

Mailserver port (win32 only).

access: protected

string $smtpHost = null (line 69)

Mailserver hostname (win32 only).

access: protected

string $subject = '' (line 74)

var: 'subject' field
access: protected

string $to = null (line 79)

var: 'to' field
access: protected

Inherited Variables

Inherited from LoggerAppender

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

Methods

activateOptions (line 84)

access: public

void activateOptions ()

Redefinition of:

LoggerAppender::activateOptions(): Prepares the appender for logging.

append (line 125)

access: public

void append (LoggerLoggingEvent $event)

LoggerLoggingEvent $event

Redefinition of:

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

setDry (line 121)

access: public

void setDry ( $dry)

$dry

setFrom (line 101)

access: public

void setFrom ( $from)

$from

setPort (line 105)

access: public

void setPort ( $port)

$port

setSmtpHost (line 109)

access: public

void setSmtpHost ( $smtpHost)

$smtpHost

setSubject (line 113)

access: public

void setSubject ( $subject)

$subject

setTo (line 117)

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()