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:

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

  1. log4php.appender.email = LoggerAppenderMail
  2. log4php.appender.email.layout = LoggerLayoutTTCC
  3. log4php.appender.email.from = someone@example.com
  4. log4php.appender.email.to = root
  5. log4php.appender.email.subject = Log4php test
  6. 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: 883108 $

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

LoggerAppender
   |
   --LoggerAppenderMailEvent
Variable Summary
Method Summary
LoggerAppenderMailEvent __construct ([string $name = ''])
void __destruct ()
void activateOptions ()
void append (LoggerLoggingEvent $event)
void close ()
void setDry ( $dry)
void setFrom ( $from)
void setPort ( $port)
void setSmtpHost ( $smtpHost)
void setSubject ( $subject)
void setTo ( $to)
Variables
mixed $requiresLayout = true (line 84)
  • access: protected

Redefinition of:
LoggerAppender::$requiresLayout

Inherited Variables

Inherited from LoggerAppender

LoggerAppender::$closed
LoggerAppender::$filter
LoggerAppender::$layout
LoggerAppender::$name
LoggerAppender::$threshold
Methods
Constructor __construct (line 94)

Constructor.

  • access: public
LoggerAppenderMailEvent __construct ([string $name = ''])
  • string $name: appender name

Redefinition of:
LoggerAppender::__construct()
Constructor
Destructor __destruct (line 98)
  • access: public
void __destruct ()
activateOptions (line 102)
  • access: public
void activateOptions ()

Redefinition of:
LoggerAppender::activateOptions()
Derived appenders should override this method if option structure requires it.
append (line 146)
  • access: public
void append (LoggerLoggingEvent $event)

Redefinition of:
LoggerAppender::append()
Subclasses of LoggerAppender should implement this method to perform actual logging.
close (line 118)
  • access: public
void close ()

Redefinition of:
LoggerAppender::close()
Release any resources allocated.
setDry (line 142)
  • access: public
void setDry ( $dry)
  • $dry
setFrom (line 122)
  • access: public
void setFrom ( $from)
  • $from
setPort (line 126)
  • access: public
void setPort ( $port)
  • $port
setSmtpHost (line 130)
  • access: public
void setSmtpHost ( $smtpHost)
  • $smtpHost
setSubject (line 134)
  • access: public
void setSubject ( $subject)
  • $subject
setTo (line 138)
  • 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::getFilter()
LoggerAppender::getFirstFilter()
LoggerAppender::getLayout()
LoggerAppender::getName()
LoggerAppender::getThreshold()
LoggerAppender::isAsSevereAsThreshold()
LoggerAppender::requiresLayout()
LoggerAppender::setLayout()
LoggerAppender::setName()
LoggerAppender::setThreshold()

Documentation generated on Fri, 27 Nov 2009 07:44:47 +0100 by phpDocumentor 1.4.3