Send an e-mail when a specific logging event occurs, typically on errors or fatal errors. More...

#include <smtpappender.h>

Inheritance diagram for log4cxx::net::SMTPAppender:

Public Member Functions
	SMTPAppender ()

	SMTPAppender (log4cxx::helpers::Pool &p)
	The default constructor will instantiate the appender with a spi::TriggeringEventEvaluator that will trigger on events with level ERROR or higher. More...

	SMTPAppender (spi::TriggeringEventEvaluatorPtr evaluator)
	Use `evaluator` passed as parameter as the spi::TriggeringEventEvaluator for this net::SMTPAppender. More...

	~SMTPAppender ()

virtual void	setOption (const LogString &option, const LogString &value)
	Set options. More...

virtual void	activateOptions (log4cxx::helpers::Pool &p)
	Activate the specified options, such as the smtp host, the recipient, from, etc. More...

virtual void	append (const spi::LoggingEventPtr &event, log4cxx::helpers::Pool &p)
	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. More...

virtual void	close ()
	Release any resources allocated within the appender such as file handles, network connections, etc. More...

LogString	getTo () const
	Returns value of the To option. More...

LogString	getCc () const
	Returns value of the cc option. More...

LogString	getBcc () const
	Returns value of the bcc option. More...

virtual bool	requiresLayout () const
	The `SMTPAppender` requires a `layout`. More...

void	sendBuffer (log4cxx::helpers::Pool &p)
	Send the contents of the cyclic buffer as an e-mail message. More...

LogString	getEvaluatorClass ()
	Returns value of the EvaluatorClass option. More...

LogString	getFrom () const
	Returns value of the From option. More...

LogString	getSubject () const
	Returns value of the Subject option. More...

void	setFrom (const LogString &from)
	The From option takes a string value which should be a e-mail address of the sender. More...

void	setSubject (const LogString &subject)
	The Subject option takes a string value which should be a the subject of the e-mail message. More...

void	setBufferSize (int bufferSize)
	The BufferSize option takes a positive integer representing the maximum number of logging events to collect in a cyclic buffer. More...

void	setSMTPHost (const LogString &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. More...

LogString	getSMTPHost () const
	Returns value of the SMTPHost option. More...

void	setSMTPPort (int port)
	The SMTPPort option takes a string value which should be a the port of the SMTP server that will send the e-mail message. More...

int	getSMTPPort () const
	Returns value of the SMTPHost option. More...

void	setTo (const LogString &to)
	The To option takes a string value which should be a comma separated list of e-mail address of the recipients. More...

void	setCc (const LogString &to)
	The Cc option takes a string value which should be a comma separated list of e-mail address of the cc'd recipients. More...

void	setBcc (const LogString &to)
	The Bcc option takes a string value which should be a comma separated list of e-mail address of the bcc'd recipients. More...

void	setSMTPUsername (const LogString &newVal)
	The SMTPUsername option takes a string value which should be a the user name for the SMTP server. More...

LogString	getSMTPUsername () const
	Returns value of the SMTPUsername option. More...

void	setSMTPPassword (const LogString &newVal)
	The SMTPPassword option takes a string value which should be a the password for the SMTP server. More...

LogString	getSMTPPassword () const
	Returns value of the SMTPPassword option. More...

int	getBufferSize () const
	Returns value of the BufferSize option. More...

log4cxx::spi::TriggeringEventEvaluatorPtr	getEvaluator () const
	Gets the current triggering evaluator. More...

void	setEvaluator (log4cxx::spi::TriggeringEventEvaluatorPtr &trigger)
	Sets the triggering evaluator. More...

void	setEvaluatorClass (const LogString &value)
	The EvaluatorClass option takes a string value representing the name of the class implementing the spi::TriggeringEventEvaluator interface. More...

void	setLocationInfo (bool locationInfo)
	The LocationInfo option is provided for compatibility with log4j and has no effect in log4cxx. More...

bool	getLocationInfo () const
	Returns value of the LocationInfo option. More...

Public Member Functions inherited from log4cxx::AppenderSkeleton
	AppenderSkeleton ()

	AppenderSkeleton (const LayoutPtr &layout)

void	finalize ()
	Finalize this appender by calling the derived class' `close` method. More...

virtual void	activateOptions (log4cxx::helpers::Pool &)
	Derived appenders should override this method if option structure requires it. More...

virtual void	setOption (const LogString &option, const LogString &value)
	Set `option` to `value`. More...

void	addFilter (const spi::FilterPtr &newFilter)
	Add a filter to end of the filter list. More...

void	clearFilters ()
	Clear the filters chain. More...

const spi::ErrorHandlerPtr &	getErrorHandler () const
	Return the currently set spi::ErrorHandler for this Appender. More...

spi::FilterPtr	getFilter () const
	Returns the head Filter. More...

const spi::FilterPtr &	getFirstFilter () const
	Return the first filter in the filter chain for this Appender. More...

LayoutPtr	getLayout () const
	Returns the layout of this appender. More...

LogString	getName () const
	Returns the name of this Appender. More...

const LevelPtr &	getThreshold () const
	Returns this appenders threshold level. More...

bool	isAsSevereAsThreshold (const LevelPtr &level) const
	Check whether the message level is below the appender's threshold. More...

virtual void	doAppend (const spi::LoggingEventPtr &event, log4cxx::helpers::Pool &pool)
	This method performs threshold checks and invokes filters before delegating actual logging to the subclasses specific AppenderSkeleton::append method. More...

void	setErrorHandler (const spi::ErrorHandlerPtr eh)
	Set the `ErrorHandler` for this Appender. More...

void	setLayout (const LayoutPtr &layout1)
	Set the layout for this appender. More...

void	setName (const LogString &name1)
	Set the name of this Appender. More...

void	setThreshold (const LevelPtr &threshold)
	Set the threshold level. More...

Public Member Functions inherited from log4cxx::Appender
virtual	~Appender ()

void	asdf ()

virtual void	addFilter (const spi::FilterPtr &newFilter)=0
	Add a filter to the end of the filter list. More...

virtual spi::FilterPtr	getFilter () const =0
	Returns the head Filter. More...

virtual void	clearFilters ()=0
	Clear the list of filters by removing all the filters in it. More...

virtual void	close ()=0
	Release any resources allocated within the appender such as file handles, network connections, etc. More...

virtual void	doAppend (const spi::LoggingEventPtr &event, log4cxx::helpers::Pool &pool)=0
	Log in `Appender` specific way. More...

virtual LogString	getName () const =0
	Get the name of this appender. More...

virtual void	setLayout (const LayoutPtr &layout)=0
	Set the Layout for this appender. More...

virtual LayoutPtr	getLayout () const =0
	Returns this appenders layout. More...

virtual void	setName (const LogString &name)=0
	Set the name of this appender. More...

virtual bool	requiresLayout () const =0
	Configurators call this method to determine if the appender requires a layout. More...

Public Member Functions inherited from log4cxx::spi::OptionHandler
virtual	~OptionHandler ()

virtual void	activateOptions (log4cxx::helpers::Pool &p)=0
	Activate the options that were previously set with calls to option setters. More...

virtual void	setOption (const LogString &option, const LogString &value)=0
	Set `option` to `value`. More...

Public Member Functions inherited from log4cxx::helpers::Object
virtual	~Object ()

virtual bool	instanceof (const Class &clazz) const =0

virtual const void *	cast (const Class &clazz) const =0

Additional Inherited Members
Protected Member Functions inherited from log4cxx::AppenderSkeleton
virtual void	append (const spi::LoggingEventPtr &event, log4cxx::helpers::Pool &p)=0
	Subclasses of `AppenderSkeleton` should implement this method to perform actual logging. More...

void	doAppendImpl (const spi::LoggingEventPtr &event, log4cxx::helpers::Pool &pool)

Protected Attributes inherited from log4cxx::AppenderSkeleton
LayoutPtr	layout
	The layout variable does not need to be set if the appender implementation has its own layout. More...

LogString	name
	Appenders are named. More...

LevelPtr	threshold
	There is no level threshold filtering by default. More...

spi::ErrorHandlerPtr	errorHandler
	It is assumed and enforced that errorHandler is never null. More...

spi::FilterPtr	headFilter
	The first filter in the filter chain. More...

spi::FilterPtr	tailFilter
	The last filter in the filter chain. More...

bool	closed
	Is this appender closed? More...

log4cxx::helpers::Pool	pool

std::recursive_mutex	mutex

Detailed Description

Send an e-mail when a specific logging event occurs, typically on errors or fatal errors.

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.

Constructor & Destructor Documentation

◆ SMTPAppender() [1/3]

log4cxx::net::SMTPAppender::SMTPAppender ( )

◆ SMTPAppender() [2/3]

log4cxx::net::SMTPAppender::SMTPAppender ( log4cxx::helpers::Pool & p )

The default constructor will instantiate the appender with a spi::TriggeringEventEvaluator that will trigger on events with level ERROR or higher.

◆ SMTPAppender() [3/3]

log4cxx::net::SMTPAppender::SMTPAppender ( spi::TriggeringEventEvaluatorPtr evaluator )

Use evaluator passed as parameter as the spi::TriggeringEventEvaluator for this net::SMTPAppender.

◆ ~SMTPAppender()

log4cxx::net::SMTPAppender::~SMTPAppender ( )

Member Function Documentation

◆ activateOptions()

virtual void log4cxx::net::SMTPAppender::activateOptions ( log4cxx::helpers::Pool & p )

virtual

Activate the specified options, such as the smtp host, the recipient, from, etc.

Reimplemented from log4cxx::AppenderSkeleton.

◆ append()

virtual void log4cxx::net::SMTPAppender::append	(	const spi::LoggingEventPtr &	event,
		log4cxx::helpers::Pool &	p
	)

virtual

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.

Implements log4cxx::AppenderSkeleton.

◆ close()

virtual void log4cxx::net::SMTPAppender::close ( )

virtual

Release any resources allocated within the appender such as file handles, network connections, etc.

It is a programming error to append to a closed appender.

Implements log4cxx::Appender.

◆ getBcc()

LogString log4cxx::net::SMTPAppender::getBcc ( ) const

Returns value of the bcc option.

◆ getBufferSize()

int log4cxx::net::SMTPAppender::getBufferSize ( ) const

inline

Returns value of the BufferSize option.

◆ getCc()

LogString log4cxx::net::SMTPAppender::getCc ( ) const

Returns value of the cc option.

◆ getEvaluator()

log4cxx::spi::TriggeringEventEvaluatorPtr log4cxx::net::SMTPAppender::getEvaluator ( ) const

Gets the current triggering evaluator.

Returns: triggering evaluator.

◆ getEvaluatorClass()

LogString log4cxx::net::SMTPAppender::getEvaluatorClass ( )

Returns value of the EvaluatorClass option.

◆ getFrom()

LogString log4cxx::net::SMTPAppender::getFrom ( ) const

Returns value of the From option.

◆ getLocationInfo()

bool log4cxx::net::SMTPAppender::getLocationInfo ( ) const

Returns value of the LocationInfo option.

◆ getSMTPHost()

LogString log4cxx::net::SMTPAppender::getSMTPHost ( ) const

Returns value of the SMTPHost option.

◆ getSMTPPassword()

LogString log4cxx::net::SMTPAppender::getSMTPPassword ( ) const

Returns value of the SMTPPassword option.

◆ getSMTPPort()

int log4cxx::net::SMTPAppender::getSMTPPort ( ) const

Returns value of the SMTPHost option.

◆ getSMTPUsername()

LogString log4cxx::net::SMTPAppender::getSMTPUsername ( ) const

Returns value of the SMTPUsername option.

◆ getSubject()

LogString log4cxx::net::SMTPAppender::getSubject ( ) const

Returns value of the Subject option.

◆ getTo()

LogString log4cxx::net::SMTPAppender::getTo ( ) const

Returns value of the To option.

◆ requiresLayout()

virtual bool log4cxx::net::SMTPAppender::requiresLayout ( ) const

virtual

The SMTPAppender requires a layout.

Implements log4cxx::Appender.

◆ sendBuffer()

void log4cxx::net::SMTPAppender::sendBuffer ( log4cxx::helpers::Pool & p )

Send the contents of the cyclic buffer as an e-mail message.

◆ setBcc()

void log4cxx::net::SMTPAppender::setBcc ( const LogString & to )

The Bcc option takes a string value which should be a comma separated list of e-mail address of the bcc'd recipients.

◆ setBufferSize()

void log4cxx::net::SMTPAppender::setBufferSize ( int bufferSize )

The BufferSize option takes a positive integer representing the maximum number of logging events to collect in a cyclic buffer.

When the 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.

◆ setCc()

void log4cxx::net::SMTPAppender::setCc ( const LogString & to )

The Cc option takes a string value which should be a comma separated list of e-mail address of the cc'd recipients.

◆ setEvaluator()

void log4cxx::net::SMTPAppender::setEvaluator ( log4cxx::spi::TriggeringEventEvaluatorPtr & trigger )

Sets the triggering evaluator.

Parameters

trigger triggering evaluator.

◆ setEvaluatorClass()

void log4cxx::net::SMTPAppender::setEvaluatorClass ( const LogString & value )

The EvaluatorClass option takes a string value representing the name of the class implementing the spi::TriggeringEventEvaluator interface.

A corresponding object will be instantiated and assigned as the triggering event evaluator for the SMTPAppender.

◆ setFrom()

void log4cxx::net::SMTPAppender::setFrom ( const LogString & from )

The From option takes a string value which should be a e-mail address of the sender.

◆ setLocationInfo()

void log4cxx::net::SMTPAppender::setLocationInfo ( bool locationInfo )

The LocationInfo option is provided for compatibility with log4j and has no effect in log4cxx.

◆ setOption()

virtual void log4cxx::net::SMTPAppender::setOption	(	const LogString &	option,
		const LogString &	value
	)

virtual

Set options.

Reimplemented from log4cxx::AppenderSkeleton.

◆ setSMTPHost()

void log4cxx::net::SMTPAppender::setSMTPHost ( const LogString & 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.

◆ setSMTPPassword()

void log4cxx::net::SMTPAppender::setSMTPPassword ( const LogString & newVal )

The SMTPPassword option takes a string value which should be a the password for the SMTP server.

◆ setSMTPPort()

void log4cxx::net::SMTPAppender::setSMTPPort ( int port )

The SMTPPort option takes a string value which should be a the port of the SMTP server that will send the e-mail message.

◆ setSMTPUsername()

void log4cxx::net::SMTPAppender::setSMTPUsername ( const LogString & newVal )

The SMTPUsername option takes a string value which should be a the user name for the SMTP server.

◆ setSubject()

void log4cxx::net::SMTPAppender::setSubject ( const LogString & subject )

The Subject option takes a string value which should be a the subject of the e-mail message.

◆ setTo()

void log4cxx::net::SMTPAppender::setTo ( const LogString & to )

The To option takes a string value which should be a comma separated list of e-mail address of the recipients.

The documentation for this class was generated from the following file:

smtpappender.h

Public Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ SMTPAppender() [1/3]

◆ SMTPAppender() [2/3]

◆ SMTPAppender() [3/3]

◆ ~SMTPAppender()

Member Function Documentation

◆ activateOptions()

◆ append()

◆ close()

◆ getBcc()

◆ getBufferSize()

◆ getCc()

◆ getEvaluator()

◆ getEvaluatorClass()

◆ getFrom()

◆ getLocationInfo()

◆ getSMTPHost()

◆ getSMTPPassword()

◆ getSMTPPort()

◆ getSMTPUsername()

◆ getSubject()

◆ getTo()

◆ requiresLayout()

◆ sendBuffer()

◆ setBcc()

◆ setBufferSize()

◆ setCc()

◆ setEvaluator()

◆ setEvaluatorClass()

◆ setFrom()

◆ setLocationInfo()

◆ setOption()

◆ setSMTPHost()

◆ setSMTPPassword()

◆ setSMTPPort()

◆ setSMTPUsername()

◆ setSubject()

◆ setTo()