Nested and Inner Type Summary

Modifier and Type	Class and Description
pack-priv class	SMTPAppenderBase.SenderRunnable

Field Summary

Modifier and Type	Field and Description
pack-priv boolean	asynchronousSending
protected Future<?>	asynchronousSendingFuture
protected CyclicBufferTracker<E>	cbTracker
private String	charsetEncoding
pack-priv long	delayBetweenStatusMessages
protected Discriminator<E>	discriminator
pack-priv static InternetAddress[]	EMPTY_IA_ARRAY
private int	errorCount
protected EventEvaluator<E>	eventEvaluator
private String	from
private String	jndiLocation
pack-priv long	lastTrackerStatusPrint
protected Layout<E>	layout
pack-priv String	localhost
pack-priv static final long	MAX_DELAY_BETWEEN_STATUS_MESSAGES
pack-priv String	password
protected Session	session
private boolean	sessionViaJNDI
private String	smtpHost
private int	smtpPort
private boolean	ssl
private boolean	starttls
protected Layout<E>	subjectLayout
private String	subjectStr
private List<PatternLayoutBase<E>>	toPatternLayoutList
pack-priv String	username

Inherited from ch.qos.logback.core.AppenderBase:: name started

Constructor Summary

Access	Constructor and Description
public	SMTPAppenderBase()

Method Summary

Modifier and Type	Method and Description
public void	addTo(String to)
protected void	append(E eventObject) Implements abstract ch.qos.logback.core.AppenderBase.append. Perform SMTPAppender specific appending actions, delegating some of them to a subclass and checking if the event triggers an e-mail to be sent.
private Session	buildSessionFromProperties()
public boolean	checkEntryConditions() This method determines if there is a sense in attempting to append.
protected abstract boolean	eventMarksEndOfLife(E eventObject)
protected abstract void	fillBuffer(CyclicBuffer<E> cb, StringBuffer sbuf)
pack-priv InternetAddress	getAddress(String addressStr)
public String	Returns: the charset encoding value getCharsetEncoding()
public CyclicBufferTracker<E>	getCyclicBufferTracker()
public Discriminator<E>	getDiscriminator()
public String	getFrom() Returns value of the From option.
public String	getJndiLocation()
public Layout<E>	getLayout()
public String	getLocalhost()
public String	getPassword()
public String	getSMTPHost() Alias for getSmtpHost().
public String	getSmtpHost() Returns value of the SMTPHost option.
public int	getSMTPPort() Alias for `getSmtpPort`
public int	getSmtpPort() See `setSmtpPort`
public String	getSubject() Returns value of the Subject option.
public List<String>	getToAsListOfString()
public List<PatternLayoutBase<E>>	getToList() Returns value of the toList option.
public String	getUsername()
public boolean	isAsynchronousSending()
public boolean	isSessionViaJNDI()
public boolean	isSSL()
public boolean	isSTARTTLS()
private Session	lookupSessionInJNDI()
protected abstract PatternLayoutBase<E>	makeNewToPatternLayout(String toPattern)
protected abstract Layout<E>	Returns: a layout as appropriate for the module makeSubjectLayout(String subjectStr) return a layout for the subject string as appropriate for the module.
private List<InternetAddress>	parseAddress(E event)
protected void	sendBuffer(CyclicBuffer<E> cb, E lastEventObject) Send the contents of the cyclic buffer as an e-mail message.
public void	setAsynchronousSending(boolean determines whether sending is done asynchronously or not asynchronousSending) By default, SMTAppender transmits emails asynchronously.
public void	setCharsetEncoding(String charsetEncoding) Set the character set encoding of the outgoing email messages.
public void	setCyclicBufferTracker(CyclicBufferTracker<E> cbTracker)
public void	setDiscriminator(Discriminator<E> discriminator)
public void	setEvaluator(EventEvaluator<E> eventEvaluator) The EventEvaluator option takes a string value representing the name of the class implementing the `EventEvaluator` interface.
public void	setFrom(String from) The From option takes a string value which should be an e-mail address of the sender.
public void	setJndiLocation(String jndiLocation) Set the location where a `jakarta.mail.Session` resource is located in JNDI.
public void	setLayout(Layout<E> layout)
public void	setLocalhost(String localhost) Set the "mail.smtp.localhost" property to the value passed as parameter to this method.
public void	setPassword(String password)
public void	setSessionViaJNDI(boolean whether to obtain a javax.mail.Session by JNDI sessionViaJNDI) If set to true, a `jakarta.mail.Session` resource will be retrieved from JNDI.
public void	setSMTPHost(String smtpHost) Alias for smtpHost
public void	setSmtpHost(String smtpHost) The smtpHost option takes a string value which should be the host name of the SMTP server that will send the e-mail message.
public void	setSMTPPort(int port) Alias for `setSmtpPort`.
public void	setSmtpPort(int port) The port where the SMTP server is running.
public void	setSSL(boolean ssl)
public void	setSTARTTLS(boolean startTLS)
public void	setSubject(String subject) The Subject option takes a string value which should be the subject of the e-mail message.
public void	setUsername(String username)
public void	start() Overrides ch.qos.logback.core.AppenderBase.start. Implements ch.qos.logback.core.spi.LifeCycle.start. Start the appender
public synchronized void	stop() Overrides ch.qos.logback.core.AppenderBase.stop. Implements ch.qos.logback.core.spi.LifeCycle.stop.
protected abstract void	subAppend(CyclicBuffer<E> cb, E eventObject)
protected void	updateMimeMsg(MimeMessage mimeMsg, CyclicBuffer<E> cb, E lastEventObject) Allows to extend classes to update mime message (e.g.: Add headers)

Inherited from ch.qos.logback.core.AppenderBase:: addFilter clearAllFilters doAppend getCopyOfAttachedFiltersList getFilterChainDecision getName isStarted setName toString

Field Detail

asynchronousSending	back to summary
pack-priv boolean asynchronousSending

asynchronousSendingFuture	back to summary
protected Future<?> asynchronousSendingFuture

cbTracker	back to summary
protected CyclicBufferTracker<E> cbTracker

charsetEncoding	back to summary
private String charsetEncoding

delayBetweenStatusMessages	back to summary
pack-priv long delayBetweenStatusMessages

discriminator	back to summary
protected Discriminator<E> discriminator

EMPTY_IA_ARRAY	back to summary
pack-priv static InternetAddress[] EMPTY_IA_ARRAY

errorCount	back to summary
private int errorCount

eventEvaluator	back to summary
protected EventEvaluator<E> eventEvaluator

from	back to summary
private String from

jndiLocation	back to summary
private String jndiLocation

lastTrackerStatusPrint	back to summary
pack-priv long lastTrackerStatusPrint

layout	back to summary
protected Layout<E> layout

layout

back to summary

protected Layout<E> layout

localhost	back to summary
pack-priv String localhost

MAX_DELAY_BETWEEN_STATUS_MESSAGES	back to summary
pack-priv static final long MAX_DELAY_BETWEEN_STATUS_MESSAGES

password	back to summary
pack-priv String password

session	back to summary
protected Session session

sessionViaJNDI	back to summary
private boolean sessionViaJNDI

smtpHost	back to summary
private String smtpHost

smtpPort	back to summary
private int smtpPort

ssl	back to summary
private boolean ssl

starttls	back to summary
private boolean starttls

subjectLayout	back to summary
protected Layout<E> subjectLayout

subjectStr	back to summary
private String subjectStr

toPatternLayoutList	back to summary
private List<PatternLayoutBase<E>> toPatternLayoutList

username	back to summary
pack-priv String username

Constructor Detail

SMTPAppenderBase	back to summary
public SMTPAppenderBase()

Method Detail

addTo	back to summary
public void addTo(String to)

append	back to summary
protected void append(E eventObject) Implements abstract ch.qos.logback.core.AppenderBase.append. Perform SMTPAppender specific appending actions, delegating some of them to a subclass and checking if the event triggers an e-mail to be sent.

append

back to summary

protected void append(E eventObject)

Implements abstract ch.qos.logback.core.AppenderBase.append.

Perform SMTPAppender specific appending actions, delegating some of them to a subclass and checking if the event triggers an e-mail to be sent.

buildSessionFromProperties	back to summary
private Session buildSessionFromProperties()

checkEntryConditions back to summary

checkEntryConditions	back to summary
public boolean checkEntryConditions() This method determines if there is a sense in attempting to append. 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 boolean checkEntryConditions()

This method determines if there is a sense in attempting to append.

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.

eventMarksEndOfLife	back to summary
protected abstract boolean eventMarksEndOfLife(E eventObject)

fillBuffer	back to summary
protected abstract void fillBuffer(CyclicBuffer<E> cb, StringBuffer sbuf)

getAddress	back to summary
pack-priv InternetAddress getAddress(String addressStr)

getCharsetEncoding	back to summary
public String getCharsetEncoding() Returns:String the charset encoding value See Also `setCharsetEncoding(String)`

getCyclicBufferTracker	back to summary
public CyclicBufferTracker<E> getCyclicBufferTracker()

getDiscriminator	back to summary
public Discriminator<E> getDiscriminator()

getFrom	back to summary
public String getFrom() Returns value of the From option.

getJndiLocation	back to summary
public String getJndiLocation()

getLayout	back to summary
public Layout<E> getLayout()

getLocalhost	back to summary
public String getLocalhost()

getPassword	back to summary
public String getPassword()

getSMTPHost	back to summary
public String getSMTPHost() Alias for getSmtpHost().

getSmtpHost	back to summary
public String getSmtpHost() Returns value of the SMTPHost option.

getSMTPPort	back to summary
public int getSMTPPort() Alias for `getSmtpPort`

getSmtpPort	back to summary
public int getSmtpPort() See `setSmtpPort`

getSubject	back to summary
public String getSubject() Returns value of the Subject option.

getToAsListOfString	back to summary
public List<String> getToAsListOfString()

getToList	back to summary
public List<PatternLayoutBase<E>> getToList() Returns value of the toList option.

getUsername	back to summary
public String getUsername()

isAsynchronousSending	back to summary
public boolean isAsynchronousSending()

isSessionViaJNDI	back to summary
public boolean isSessionViaJNDI()

isSSL	back to summary
public boolean isSSL()

isSTARTTLS	back to summary
public boolean isSTARTTLS()

lookupSessionInJNDI	back to summary
private Session lookupSessionInJNDI()

makeNewToPatternLayout	back to summary
protected abstract PatternLayoutBase<E> makeNewToPatternLayout(String toPattern)

makeSubjectLayout

back to summary

protected abstract Layout<E> makeSubjectLayout(String subjectStr)

return a layout for the subject string as appropriate for the module. If the subjectStr parameter is null, then a default value for subjectStr should be used.

Returns:Layout<E>: a layout as appropriate for the module

parseAddress	back to summary
private List<InternetAddress> parseAddress(E event)

sendBuffer

back to summary

protected void sendBuffer(CyclicBuffer<E> cb, E lastEventObject)

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

Annotations

@SuppressWarnings:null

setAsynchronousSending

back to summary

public void setAsynchronousSending(boolean asynchronousSending)

By default, SMTAppender transmits emails asynchronously. For synchronous email transmission set asynchronousSending to 'false'.

Parameters

asynchronousSending:boolean: determines whether sending is done asynchronously or not

Since

1.0.4

setCharsetEncoding	back to summary
public void setCharsetEncoding(String charsetEncoding) Set the character set encoding of the outgoing email messages. The default encoding is "UTF-8" which usually works well for most purposes.

setCyclicBufferTracker	back to summary
public void setCyclicBufferTracker(CyclicBufferTracker<E> cbTracker)

setDiscriminator	back to summary
public void setDiscriminator(Discriminator<E> discriminator)

setEvaluator	back to summary
public void setEvaluator(EventEvaluator<E> eventEvaluator) The EventEvaluator option takes a string value representing the name of the class implementing the `EventEvaluator` interface. A corresponding object will be instantiated and assigned as the event evaluator for the SMTPAppender.

setFrom	back to summary
public void setFrom(String from) The From option takes a string value which should be an e-mail address of the sender.

setJndiLocation back to summary

public void setJndiLocation(String jndiLocation)

Set the location where a jakarta.mail.Session resource is located in JNDI. Default value is "java:comp/env/mail/Session".

Since: 1.0.6

setLayout	back to summary
public void setLayout(Layout<E> layout)

setLocalhost

back to summary

public void setLocalhost(String localhost)

Set the "mail.smtp.localhost" property to the value passed as parameter to this method.

Useful in case the hostname for the client host is not fully qualified and as a consequence the SMTP server rejects the clients HELO/EHLO command.

setPassword	back to summary
public void setPassword(String password)

setSessionViaJNDI back to summary

public void setSessionViaJNDI(boolean sessionViaJNDI)

If set to true, a jakarta.mail.Session resource will be retrieved from JNDI. Default is false.

Parameters

sessionViaJNDI:boolean: whether to obtain a javax.mail.Session by JNDI

Since

1.0.6

setSMTPHost	back to summary
public void setSMTPHost(String smtpHost) Alias for smtpHost

setSmtpHost	back to summary
public void setSmtpHost(String smtpHost) The smtpHost option takes a string value which should be the host name of the SMTP server that will send the e-mail message.

setSMTPPort	back to summary
public void setSMTPPort(int port) Alias for `setSmtpPort`.

setSmtpPort	back to summary
public void setSmtpPort(int port) The port where the SMTP server is running. Default value is 25.

setSSL	back to summary
public void setSSL(boolean ssl)

setSTARTTLS	back to summary
public void setSTARTTLS(boolean startTLS)

setSubject	back to summary
public void setSubject(String subject) The Subject option takes a string value which should be the subject of the e-mail message.

setUsername	back to summary
public void setUsername(String username)

start

back to summary

public void start()

Overrides ch.qos.logback.core.AppenderBase.start.

Implements ch.qos.logback.core.spi.LifeCycle.start.

Start the appender

stop

back to summary

public synchronized void stop()

Overrides ch.qos.logback.core.AppenderBase.stop.

Implements ch.qos.logback.core.spi.LifeCycle.stop.

subAppend	back to summary
protected abstract void subAppend(CyclicBuffer<E> cb, E eventObject)

updateMimeMsg	back to summary
protected void updateMimeMsg(MimeMessage mimeMsg, CyclicBuffer<E> cb, E lastEventObject) Allows to extend classes to update mime message (e.g.: Add headers)

ch.qos.logback.core.net back to summary

pack-priv Class SMTPAppenderBase.SenderRunnable

Class Inheritance

extends Object
implements Runnable

java.lang.Object
ch.qos.logback.core.net.SMTPAppenderBase.SenderRunnable

All Implemented Interfaces

java.lang.Runnable

Field Summary

Modifier and Type	Field and Description
pack-priv final CyclicBuffer<E>	cyclicBuffer
pack-priv final E	e

Constructor Summary

Access	Constructor and Description
pack-priv	SenderRunnable(CyclicBuffer<E> cyclicBuffer, E e)

Method Summary

Modifier and Type	Method and Description
public void	run() Implements java.lang.Runnable.run. Runs this operation.

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Field Detail

cyclicBuffer	back to summary
pack-priv final CyclicBuffer<E> cyclicBuffer

e	back to summary
pack-priv final E e

Constructor Detail

SenderRunnable	back to summary
pack-priv SenderRunnable(CyclicBuffer<E> cyclicBuffer, E e)

Method Detail

run

back to summary

public void run()

Implements java.lang.Runnable.run.

Doc from java.lang.Runnable.run.

Runs this operation.

public abstract Class SMTPAppenderBase<E>

Nested and Inner Type Summary

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

pack-priv Class SMTPAppenderBase.SenderRunnable

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail