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

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

var: 'from' field

integer $port = 25 (line 57)

var: 'from' field

mixed $requiresLayout = true (line 74)

Redefinition of:

LoggerAppenderSkeleton::$requiresLayout

string $smtpHost = '' (line 62)

var: hostname.

string $subject = '' (line 67)

var: 'subject' field

string $to = '' (line 72)

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

Constructor.

LoggerAppenderMailEvent LoggerAppenderMailEvent (string $name)

string $name: appender name

activateOptions (line 86)

void activateOptions ()

Redefinition of:

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

append (line 119)

void append (mixed $event)

Redefinition of:

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

getFrom (line 91)

string getFrom ()

getPort (line 96)

integer getPort ()

getSmtpHost (line 101)

string getSmtpHost ()

getSubject (line 106)

string getSubject ()

getTo (line 111)

string getTo ()

setFrom (line 113)

void setFrom (mixed $from)

setPort (line 114)

void setPort (mixed $port)

setSmtpHost (line 115)

void setSmtpHost (mixed $smtphost)

setSubject (line 116)

void setSubject (mixed $subject)

setTo (line 117)

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