Overview

Packages

  • log4php
    • appenders
    • configurators
    • filters
    • helpers
    • layouts
    • pattern
    • renderers

Classes

  • LoggerAppenderConsole
  • LoggerAppenderDailyFile
  • LoggerAppenderEcho
  • LoggerAppenderFile
  • LoggerAppenderFirePHP
  • LoggerAppenderMail
  • LoggerAppenderMailEvent
  • LoggerAppenderMongoDB
  • LoggerAppenderNull
  • LoggerAppenderPDO
  • LoggerAppenderPhp
  • LoggerAppenderRollingFile
  • LoggerAppenderSocket
  • LoggerAppenderSyslog
  • Overview
  • Package
  • Class
  • Tree

Class LoggerAppenderMailEvent

LoggerAppenderMailEvent appends individual log events via email.

This appender is similar to LoggerAppenderMail, except that it sends each each log event in an individual email message at the time when it occurs.

This appender uses a layout.

Configurable parameters:

  • to - Email address(es) to which the log will be sent. Multiple email addresses may be specified by separating them with a comma.
  • from - Email address which will be used in the From field.
  • subject - Subject of the email message.
  • smtpHost - Used to override the SMTP server. Only works on Windows.
  • port - Used to override the default SMTP server port. Only works on Windows.
LoggerConfigurable
Extended by LoggerAppender
Extended by LoggerAppenderMailEvent
Package: log4php\appenders
License: Apache License, Version 2.0
Version: $Revision: 1343601 $
Link: Appender documentation
Located at appenders/LoggerAppenderMailEvent.php
Methods summary
public
# activateOptions( )

Prepares the appender for logging.

Prepares the appender for logging.

Derived appenders should override this method if option structure requires it.

Overrides

LoggerAppender::activateOptions()
public
# append( LoggerLoggingEvent $event )

Forwards the logging event to the destination.

Forwards the logging event to the destination.

Derived appenders should implement this method to perform actual logging.

Parameters

$event
LoggerLoggingEvent
$event
public
# setFrom( mixed $from )

Sets the 'from' parameter.

Sets the 'from' parameter.

public
# getFrom( )

Returns the 'from' parameter.

Returns the 'from' parameter.

public
# setPort( mixed $port )

Sets the 'port' parameter.

Sets the 'port' parameter.

public
# getPort( )

Returns the 'port' parameter.

Returns the 'port' parameter.

public
# setSmtpHost( mixed $smtpHost )

Sets the 'smtpHost' parameter.

Sets the 'smtpHost' parameter.

public
# getSmtpHost( )

Returns the 'smtpHost' parameter.

Returns the 'smtpHost' parameter.

public
# setSubject( mixed $subject )

Sets the 'subject' parameter.

Sets the 'subject' parameter.

public
# getSubject( )

Returns the 'subject' parameter.

Returns the 'subject' parameter.

public
# setTo( mixed $to )

Sets the 'to' parameter.

Sets the 'to' parameter.

public
# getTo( )

Returns the 'to' parameter.

Returns the 'to' parameter.

public
# setDry( mixed $dry )

Enables or disables dry mode.

Enables or disables dry mode.

Methods inherited from LoggerAppender
__construct(), __destruct(), addFilter(), clearFilters(), close(), doAppend(), getDefaultLayout(), getFilter(), getFirstFilter(), getLayout(), getName(), getThreshold(), isAsSevereAsThreshold(), requiresLayout(), setLayout(), setName(), setThreshold(), warn()
Methods inherited from LoggerConfigurable
setBoolean(), setFileSize(), setInteger(), setLevel(), setNumeric(), setPositiveInteger(), setString()
Properties summary
protected string $from
#

Email address to put in From field of the email.

Email address to put in From field of the email.

protected integer $port 25
#

Mail server port (widnows only).

Mail server port (widnows only).

protected string $smtpHost
#

Mail server hostname (windows only).

Mail server hostname (windows only).

protected string $subject 'Log4php Report'
#

The subject of the email.

The subject of the email.

protected string $to null
#

One or more comma separated email addresses to which to send the email.

One or more comma separated email addresses to which to send the email.

Properties inherited from LoggerAppender
$closed, $filter, $layout, $name, $requiresLayout, $threshold
Apache log4php API documentation generated by ApiGen 2.8.0