coldbox.system.logging.appenders

Class EmailAppender

lucee.Component
    extended by coldbox.system.logging.AbstractAppender
      extended by coldbox.system.logging.appenders.EmailAppender

Copyright Since 2005 ColdBox Framework by Luis Majano and Ortus Solutions, Corp www.ortussolutions.com --- An appender that sends out emails Properties: - subject - Get's pre-pended with the category field. - from - required - to - required can be a ; list of emails - cc - bcc - mailserver (optional) - mailpassword (optional) - mailusername (optional) - mailport (optional - 25)

Class Attributes:
  • synchronized : false
    •  
  • accessors : true
    •  
  • persistent : false
    •  
    Constructor Summary
    init(any name, [struct properties='[runtime expression]'], [any layout=''], [any levelMin='0'], [any levelMax='4'])
          Constructor.
    Method Summary
    any logMessage(LogEvent logEvent)
         Write an entry into the appender.
     
    Methods inherited from class coldbox.system.logging.AbstractAppender
    $log, canLog, err, getColdbox, getCustomLayout, getHash, getInitialized, getLevelMax, getLevelMin, getLockTimeout, getLogBox, getLogListener, getName, getProperties, getProperty, getUtil, getWirebox, hasCustomLayout, isInitialized, lock, onLogListenerEnd, onLogListenerSleep, onLogListenerStart, onRegistration, onUnRegistration, out, processQueueElement, propertyExists, queueMessage, runLogListener, setColdbox, setCustomLayout, setInitialized, setLevelMax, setLevelMin, setLockTimeout, setLogBox, setLogListener, setName, setProperties, setProperty, setWirebox, severityToString, shutdown, startLogListener
     
    Methods inherited from class lucee.Component
    None
    Constructor Detail

    init

    public init(any name, [struct properties='[runtime expression]'], [any layout=''], [any levelMin='0'], [any levelMax='4'])

    Constructor

    Parameters:
    name - The unique name for this appender.
    properties - A map of configuration properties for the appender"
    layout - The layout class to use in this appender for custom message rendering.
    levelMin - The default log level for this appender, by default it is 0. Optional. ex: LogBox.logLevels.WARN
    levelMax - The default log level for this appender, by default it is 5. Optional. ex: LogBox.logLevels.WARN
    Method Detail

    logMessage

    public any logMessage(LogEvent logEvent)

    Write an entry into the appender. You must implement this method yourself.

    Overrides:
    logMessage in class AbstractAppender
    Parameters:
    logEvent - The logging event to log