org.apache.log4j.net
public class SMTPAppender extends AppenderSkeleton
The number of logging events delivered in this e-mail depend on
the value of BufferSize option. The
SMTPAppender
keeps only the last
BufferSize
logging events in its cyclic buffer. This
keeps memory requirements at a reasonable level while still
delivering useful application context.
Modifier and Type | Field and Description |
---|---|
protected CyclicBuffer |
cb |
protected TriggeringEventEvaluator |
evaluator |
protected javax.mail.Message |
msg |
closed, errorHandler, headFilter, layout, name, tailFilter, threshold
Constructor and Description |
---|
SMTPAppender()
The default constructor will instantiate the appender with a
TriggeringEventEvaluator that will trigger on events with
level ERROR or higher. |
SMTPAppender(TriggeringEventEvaluator evaluator)
Use
evaluator passed as parameter as the TriggeringEventEvaluator for this SMTPAppender. |
Modifier and Type | Method and Description |
---|---|
void |
activateOptions()
Activate the specified options, such as the smtp host, the
recipient, from, etc.
|
protected void |
addressMessage(javax.mail.Message msg)
Address message.
|
void |
append(LoggingEvent event)
Perform SMTPAppender specific appending actions, mainly adding
the event to a cyclic buffer and checking if the event triggers
an e-mail to be sent.
|
protected boolean |
checkEntryConditions()
This method determines if there is a sense in attempting to append.
|
void |
close()
Release any resources allocated within the appender such as file
handles, network connections, etc.
|
protected javax.mail.Session |
createSession()
Create mail session.
|
String |
getBcc()
Get the bcc recipient addresses.
|
int |
getBufferSize()
Returns value of the BufferSize option.
|
String |
getCc()
Get the cc recipient addresses.
|
String |
getEvaluatorClass()
Returns value of the EvaluatorClass option.
|
String |
getFrom()
Returns value of the From option.
|
boolean |
getLocationInfo()
Returns value of the LocationInfo option.
|
boolean |
getSMTPDebug()
Get SMTP debug.
|
String |
getSMTPHost()
Returns value of the SMTPHost option.
|
String |
getSMTPPassword()
Get SMTP password.
|
String |
getSMTPUsername()
Get SMTP user name.
|
String |
getSubject()
Returns value of the Subject option.
|
String |
getTo()
Returns value of the To option.
|
boolean |
requiresLayout()
The
SMTPAppender requires a layout . |
protected void |
sendBuffer()
Send the contents of the cyclic buffer as an e-mail message.
|
void |
setBcc(String addresses)
Set the bcc recipient addresses.
|
void |
setBufferSize(int bufferSize)
The BufferSize option takes a positive integer
representing the maximum number of logging events to collect in a
cyclic buffer.
|
void |
setCc(String addresses)
Set the cc recipient addresses.
|
void |
setEvaluatorClass(String value)
The EvaluatorClass option takes a string value
representing the name of the class implementing the
TriggeringEventEvaluator interface. |
void |
setFrom(String from)
The From option takes a string value which should be a
e-mail address of the sender.
|
void |
setLocationInfo(boolean locationInfo)
The LocationInfo option takes a boolean value.
|
void |
setSMTPDebug(boolean debug)
Setting the SmtpDebug option to true will cause the mail session to log its server interaction to stdout.
|
void |
setSMTPHost(String smtpHost)
The SMTPHost option takes a string value which should be a
the host name of the SMTP server that will send the e-mail message.
|
void |
setSMTPPassword(String password)
The SmtpPassword option takes a string value which should be the password required to authenticate against
the mail server.
|
void |
setSMTPUsername(String username)
The SmtpUsername option takes a string value which should be the username required to authenticate against
the mail server.
|
void |
setSubject(String subject)
The Subject option takes a string value which should be a
the subject of the e-mail message.
|
void |
setTo(String to)
The To option takes a string value which should be a
comma separated list of e-mail address of the recipients.
|
addFilter, clearFilters, doAppend, finalize, getErrorHandler, getFilter, getFirstFilter, getLayout, getName, getThreshold, isAsSevereAsThreshold, setErrorHandler, setLayout, setName, setThreshold
protected CyclicBuffer cb
protected javax.mail.Message msg
protected TriggeringEventEvaluator evaluator
public SMTPAppender()
TriggeringEventEvaluator
that will trigger on events with
level ERROR or higher.public SMTPAppender(TriggeringEventEvaluator evaluator)
evaluator
passed as parameter as the TriggeringEventEvaluator
for this SMTPAppender.public void activateOptions()
activateOptions
in interface OptionHandler
activateOptions
in class AppenderSkeleton
protected void addressMessage(javax.mail.Message msg) throws javax.mail.MessagingException
msg
- message, may not be null.javax.mail.MessagingException
- thrown if error addressing message.protected javax.mail.Session createSession()
public void append(LoggingEvent event)
append
in class AppenderSkeleton
protected boolean checkEntryConditions()
It checks whether there is a set output target and also if
there is a set layout. If these checks fail, then the boolean
value false
is returned.
public void close()
Appender
It is a programming error to append to a closed appender.
public String getTo()
public boolean requiresLayout()
SMTPAppender
requires a layout
.protected void sendBuffer()
public String getEvaluatorClass()
public String getFrom()
public String getSubject()
public void setFrom(String from)
public void setSubject(String subject)
public void setBufferSize(int bufferSize)
BufferSize
is reached,
oldest events are deleted as new events are added to the
buffer. By default the size of the cyclic buffer is 512 events.public void setSMTPHost(String smtpHost)
public String getSMTPHost()
public void setTo(String to)
public int getBufferSize()
public void setEvaluatorClass(String value)
TriggeringEventEvaluator
interface. A corresponding object will
be instantiated and assigned as the triggering event evaluator
for the SMTPAppender.public void setLocationInfo(boolean locationInfo)
Location information extraction is comparatively very slow and should be avoided unless performance is not a concern.
public boolean getLocationInfo()
public void setCc(String addresses)
addresses
- recipient addresses as comma separated string, may be null.public String getCc()
public void setBcc(String addresses)
addresses
- recipient addresses as comma separated string, may be null.public String getBcc()
public void setSMTPPassword(String password)
password
- password, may be null.public void setSMTPUsername(String username)
username
- user name, may be null.public void setSMTPDebug(boolean debug)
debug
- debug flag.public String getSMTPPassword()
public String getSMTPUsername()
public boolean getSMTPDebug()
Copyright 2000-2005 Apache Software Foundation.