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.9 $
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)

void close ()

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 = null (line 52)

var: 'from' field

integer $port = 25 (line 57)

var: 'from' field

mixed $requiresLayout = true (line 74)

Redefinition of:

LoggerAppenderSkeleton::$requiresLayout

string $smtpHost = null (line 62)

var: hostname.

string $subject = '' (line 67)

var: 'subject' field

string $to = null (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(): Derived appenders should override this method if option structure requires it.

append (line 127)

void append (mixed $event)

Redefinition of:

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

close (line 91)

void close ()

Redefinition of:

LoggerAppenderSkeleton::close()

getFrom (line 99)

string getFrom ()

getPort (line 104)

integer getPort ()

getSmtpHost (line 109)

string getSmtpHost ()

getSubject (line 114)

string getSubject ()

getTo (line 119)

string getTo ()

setFrom (line 121)

void setFrom (mixed $from)

setPort (line 122)

void setPort (mixed $port)

setSmtpHost (line 123)

void setSmtpHost (mixed $smtphost)

setSubject (line 124)

void setSubject (mixed $subject)

setTo (line 125)

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()
LoggerAppenderSkeleton::__sleep()
LoggerAppenderSkeleton::__wakeup()

Inherited From LoggerAppender

LoggerAppender::addFilter()
LoggerAppender::clearFilters()
LoggerAppender::close()
LoggerAppender::doAppend()
LoggerAppender::factory()
LoggerAppender::getErrorHandler()
LoggerAppender::getFilter()
LoggerAppender::getLayout()
LoggerAppender::getName()
LoggerAppender::requiresLayout()
LoggerAppender::setErrorHandler()
LoggerAppender::setLayout()
LoggerAppender::setName()
LoggerAppender::singleton()