FuseGuard Logo

fuseguard.components.loggers
Component CFMailLogger

loggers.BaseLogger
  |
  +--loggers.CFMailLogger

A Logger that sends log messages via email using the cfmail tag. Please ensure that you have specified a SMTP server in the CF admin or in your Application.cfc

Method Summary
public void addRecipient([string email])
          Add an email address to send to
public array getConfigurables()
          Returns configurable settings.
public string getStorageDescription()
          Returns a description of where the data is stored, eg datasource name.
public boolean isViewable()
          If the log is viewable such as a file or DB return true, if not (email, or IM) return false.
public void logRequest(numeric level, [any filter], [variablename type="inspectRequest"], [string message=""], [string detail=""])
public void setFromAddress(string email)
public void setRecipientList([string emailList])
          A list of email addresses to send logs to
public void setSMTPServer(string smtpServer, [string smtpUsername=""], [string smtpPassword=""])
          Set the SMTP Server username, and password

Methods inherited from loggers.BaseLogger
setLogOnlyBlocked, logOnlyBlocked, getDescription, isPurgeable, isVerbose, purgeLogs, setEscapeMessage, init, hasLogReader, escapesMessage, setVerbose, getName
 

Method Detail

addRecipient

public void addRecipient([string email])
Add an email address to send to

Parameters:
[string email]

getConfigurables

public array getConfigurables()
Returns configurable settings.


getStorageDescription

public string getStorageDescription()
Returns a description of where the data is stored, eg datasource name.


isViewable

public boolean isViewable()
If the log is viewable such as a file or DB return true, if not (email, or IM) return false.


logRequest

public void logRequest(numeric level, [any filter], [variablename type="inspectRequest"], [string message=""], [string detail=""])
Parameters:
numeric level
[any filter] - a Filter object
[variablename type="inspectRequest"]
[string message=""]
[string detail=""]

setFromAddress

public void setFromAddress(string email)
Parameters:
string email

setRecipientList

public void setRecipientList([string emailList])
A list of email addresses to send logs to

Parameters:
[string emailList]

setSMTPServer

public void setSMTPServer(string smtpServer, [string smtpUsername=""], [string smtpPassword=""])
Set the SMTP Server username, and password

Parameters:
string smtpServer - Host Name or IP Address of SMTP Server
[string smtpUsername=""] - User Name for SMTP Server
[string smtpPassword=""] - Password for SMTP Server