Docs For Class LoggerAppenderMailEvent

Description

Log events to an email address.

Log events to an email address. It will be created an email for each event. Parameters are $smtpHost (optional), $port (optional), $from (optional), $to, $subject (optional).

A layout is required.

version: $Revision: 1.6 $
author: VxR <mailto:vxr@vxr.it>
author: Domenico Lordi <mailto:lordi@interfree.it>

Located in Program_Root/log4php/appenders/LoggerAppenderMailEvent.php (line 49)

LoggerAppender
   |
   --LoggerAppenderSkeleton
      |
      --LoggerAppenderMailEvent

Variable Summary

string $from

integer $port

mixed $requiresLayout

string $smtpHost

string $subject

string $to

Method Summary

LoggerAppenderMailEvent LoggerAppenderMailEvent (string $name)

void activateOptions ()

void append (mixed $event)

string getFrom ()

integer getPort ()

string getSmtpHost ()

string getSubject ()

string getTo ()

void setFrom (mixed $from)

void setPort (mixed $port)

void setSmtpHost (mixed $smtphost)

void setSubject (mixed $subject)

void setTo (mixed $to)

Variables

string $from = '' (line 54)

var: 'from' field

integer $port = 25 (line 59)

var: 'from' field

mixed $requiresLayout = true (line 76)

Redefinition of:

LoggerAppenderSkeleton::$requiresLayout

string $smtpHost = '' (line 64)

var: hostname.

string $subject = '' (line 69)

var: 'subject' field

string $to = '' (line 74)

var: 'to' field

Inherited Variables

Inherited from LoggerAppenderSkeleton

LoggerAppenderSkeleton::$closed
LoggerAppenderSkeleton::$errorHandler
LoggerAppenderSkeleton::$headFilter
LoggerAppenderSkeleton::$layout
LoggerAppenderSkeleton::$name
LoggerAppenderSkeleton::$tailFilter
LoggerAppenderSkeleton::$threshold

Methods

Constructor LoggerAppenderMailEvent (line 83)

Constructor.

LoggerAppenderMailEvent LoggerAppenderMailEvent (string $name)

string $name: appender name

activateOptions (line 88)

void activateOptions ()

Redefinition of:

LoggerAppenderSkeleton::activateOptions(): Called after the appender paramters are set with setter methods.

append (line 121)

void append (mixed $event)

Redefinition of:

LoggerAppenderSkeleton::append(): Subclasses of LoggerAppenderSkeleton should implement this method to perform actual logging.

getFrom (line 93)

string getFrom ()

getPort (line 98)

integer getPort ()

getSmtpHost (line 103)

string getSmtpHost ()

getSubject (line 108)

string getSubject ()

getTo (line 113)

string getTo ()

setFrom (line 115)

void setFrom (mixed $from)

setPort (line 116)

void setPort (mixed $port)

setSmtpHost (line 117)

void setSmtpHost (mixed $smtphost)

setSubject (line 118)

void setSubject (mixed $subject)

setTo (line 119)

void setTo (mixed $to)

Inherited Methods

Inherited From LoggerAppenderSkeleton

LoggerAppenderSkeleton::LoggerAppenderSkeleton()
LoggerAppenderSkeleton::activateOptions()
LoggerAppenderSkeleton::addFilter()
LoggerAppenderSkeleton::append()
LoggerAppenderSkeleton::clearFilters()
LoggerAppenderSkeleton::close()
LoggerAppenderSkeleton::doAppend()
LoggerAppenderSkeleton::finalize()
LoggerAppenderSkeleton::getErrorHandler()
LoggerAppenderSkeleton::getFilter()
LoggerAppenderSkeleton::getFirstFilter()
LoggerAppenderSkeleton::getLayout()
LoggerAppenderSkeleton::getName()
LoggerAppenderSkeleton::getThreshold()
LoggerAppenderSkeleton::isAsSevereAsThreshold()
LoggerAppenderSkeleton::requiresLayout()
LoggerAppenderSkeleton::setErrorHandler()
LoggerAppenderSkeleton::setLayout()
LoggerAppenderSkeleton::setName()
LoggerAppenderSkeleton::setThreshold()

Inherited From LoggerAppender

LoggerAppender::factory()
LoggerAppender::singleton()