public class SMTPAppender extends AppenderSkeleton implements UnrecognizedElementHandler
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.
By default, an email message will be sent when an ERROR or higher severity
message is appended. The triggering criteria can be modified by setting the
evaluatorClass property with the name of a class implementing
TriggeringEventEvaluator, setting the evaluator property with an instance of
TriggeringEventEvaluator or nesting a triggeringPolicy element where the
specified class implements TriggeringEventEvaluator.
This class has implemented UnrecognizedElementHandler since 1.2.15.
Since 1.2.16, SMTP over SSL is supported by setting SMTPProtocol to "smpts".
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.
|
protected String |
formatBody()
Layout body of email message.
|
String |
getBcc()
Get the bcc recipient addresses.
|
int |
getBufferSize()
Returns value of the BufferSize option.
|
String |
getCc()
Get the cc recipient addresses.
|
TriggeringEventEvaluator |
getEvaluator()
Get triggering evaluator.
|
String |
getEvaluatorClass()
Returns value of the EvaluatorClass option.
|
String |
getFrom()
Returns value of the From option.
|
boolean |
getLocationInfo()
Returns value of the LocationInfo option.
|
String |
getReplyTo()
Get the reply addresses.
|
boolean |
getSendOnClose()
Get sendOnClose.
|
boolean |
getSMTPDebug()
Get SMTP debug.
|
String |
getSMTPHost()
Returns value of the SMTPHost option.
|
String |
getSMTPPassword()
Get SMTP password.
|
int |
getSMTPPort()
Get port.
|
String |
getSMTPProtocol()
Get transport protocol.
|
String |
getSMTPUsername()
Get SMTP user name.
|
String |
getSubject()
Returns value of the Subject option.
|
String |
getTo()
Returns value of the To option.
|
boolean |
parseUnrecognizedElement(Element element,
Properties props)
Called to inform a configured object when an unrecognized child element is
encountered.
|
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 |
setCheckServerIdentity(boolean checkServerIdentity)
Setting the checkServerIdentity option to false will disable server identity check.
|
void |
setEvaluator(TriggeringEventEvaluator trigger)
Sets triggering evaluator.
|
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 |
setReplyTo(String addresses)
Set the e-mail addresses to which replies should be directed.
|
void |
setSendOnClose(boolean val)
Set sendOnClose.
|
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 |
setSMTPPort(int val)
Set port.
|
void |
setSMTPProtocol(String val)
Set transport protocol.
|
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
.requiresLayout
in interface Appender
protected String formatBody()
protected void sendBuffer()
public String getEvaluatorClass()
public String getFrom()
public String getReplyTo()
public String getSubject()
public void setFrom(String from)
public void setReplyTo(String addresses)
addresses
- reply addresses as comma separated string, may be null.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 void setCheckServerIdentity(boolean checkServerIdentity)
checkServerIdentity
- public String getSMTPPassword()
public String getSMTPUsername()
public boolean getSMTPDebug()
public final void setEvaluator(TriggeringEventEvaluator trigger)
trigger
- triggering event evaluator.public final TriggeringEventEvaluator getEvaluator()
public boolean parseUnrecognizedElement(Element element, Properties props) throws Exception
parseUnrecognizedElement
in interface UnrecognizedElementHandler
element
- element, may not be null.props
- properties in force, may be null.Exception
- throw an exception to prevent activation of the configured
object.public final String getSMTPProtocol()
public final void setSMTPProtocol(String val)
val
- transport protocol, may be null.public final int getSMTPPort()
public final void setSMTPPort(int val)
val
- port, negative values indicate use of default ports for protocol.public final boolean getSendOnClose()
public final void setSendOnClose(boolean val)
val
- if true all buffered logging events will be sent when appender is
closed.Copyright © 1999–2022 QOS.CH Sarl. All rights reserved.