Package org.apache.logging.log4j.core.appender

Class SmtpAppender.Builder

java.lang.Object

org.apache.logging.log4j.core.filter.AbstractFilterable.Builder<B>

org.apache.logging.log4j.core.appender.AbstractAppender.Builder<SmtpAppender.Builder>

org.apache.logging.log4j.core.appender.SmtpAppender.Builder

All Implemented Interfaces:

Builder<SmtpAppender>

Enclosing class:

SmtpAppender

public static class SmtpAppender.Builder
extends AbstractAppender.Builder<SmtpAppender.Builder>
implements Builder<SmtpAppender>

Since:

2.13.2

Field Summary

Fields

Modifier and Type	Field	Description
private java.lang.String	bcc
private int	bufferSize
private java.lang.String	cc
private java.lang.String	from
private java.lang.String	replyTo
private boolean	smtpDebug
private java.lang.String	smtpHost
private java.lang.String	smtpPassword
private int	smtpPort
private java.lang.String	smtpProtocol
private java.lang.String	smtpUsername
private SslConfiguration	sslConfiguration
private java.lang.String	subject
private java.lang.String	to

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
SmtpAppender	build()	Builds the object after all configuration has been set.
SmtpAppender.Builder	setBcc(java.lang.String bcc)	Comma-separated list of BCC email addresses.
SmtpAppender.Builder	setBufferSize(int bufferSize)	Number of log events to buffer before sending an email.
SmtpAppender.Builder	setCc(java.lang.String cc)	Comma-separated list of CC email addresses.
SmtpAppender.Builder	setFilter(Filter filter)	Specifies the filter used for this appender.
SmtpAppender.Builder	setFrom(java.lang.String from)	Email address of the sender.
SmtpAppender.Builder	setLayout(Layout<? extends java.io.Serializable> layout)	Specifies the layout used for the email message body.
SmtpAppender.Builder	setReplyTo(java.lang.String replyTo)	Comma-separated list of Reply-To email addresses.
SmtpAppender.Builder	setSmtpDebug(boolean smtpDebug)	Enables or disables mail session debugging on STDOUT.
SmtpAppender.Builder	setSmtpHost(java.lang.String smtpHost)	Host name of SMTP server to send messages through.
SmtpAppender.Builder	setSmtpPassword(java.lang.String smtpPassword)	Password to authenticate with SMTP server.
SmtpAppender.Builder	setSmtpPort(int smtpPort)	Port number of SMTP server to send messages through.
SmtpAppender.Builder	setSmtpProtocol(java.lang.String smtpProtocol)	Transport protocol to use for SMTP such as "smtp" or "smtps".
SmtpAppender.Builder	setSmtpUsername(java.lang.String smtpUsername)	Username to authenticate with SMTP server.
SmtpAppender.Builder	setSslConfiguration(SslConfiguration sslConfiguration)	Specifies an SSL configuration for smtps connections.
SmtpAppender.Builder	setSubject(java.lang.String subject)	Subject template for the email messages.
SmtpAppender.Builder	setTo(java.lang.String to)	Comma-separated list of recipient email addresses.

Methods inherited from class org.apache.logging.log4j.core.appender.AbstractAppender.Builder

getConfiguration, getLayout, getName, getOrCreateLayout, getOrCreateLayout, isIgnoreExceptions, setConfiguration, setIgnoreExceptions, setName, withConfiguration, withIgnoreExceptions, withLayout, withName

Methods inherited from class org.apache.logging.log4j.core.filter.AbstractFilterable.Builder

asBuilder, getFilter, getPropertyArray, setPropertyArray, withFilter

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

to

@PluginBuilderAttribute
private java.lang.String to

cc

@PluginBuilderAttribute
private java.lang.String cc

bcc

@PluginBuilderAttribute
private java.lang.String bcc

from

@PluginBuilderAttribute
private java.lang.String from

replyTo

@PluginBuilderAttribute
private java.lang.String replyTo

subject

@PluginBuilderAttribute
private java.lang.String subject

smtpProtocol

@PluginBuilderAttribute
private java.lang.String smtpProtocol

smtpHost

@PluginBuilderAttribute
private java.lang.String smtpHost

smtpPort

@PluginBuilderAttribute
@ValidPort
private int smtpPort

smtpUsername

@PluginBuilderAttribute
private java.lang.String smtpUsername

smtpPassword

@PluginBuilderAttribute(sensitive=true)
private java.lang.String smtpPassword

smtpDebug

@PluginBuilderAttribute
private boolean smtpDebug

bufferSize

@PluginBuilderAttribute
private int bufferSize

sslConfiguration

@PluginElement("SSL")
private SslConfiguration sslConfiguration

Constructor Detail

Builder

public Builder()

Method Detail

setTo

public SmtpAppender.Builder setTo(java.lang.String to)

Comma-separated list of recipient email addresses.

setCc

public SmtpAppender.Builder setCc(java.lang.String cc)

Comma-separated list of CC email addresses.

setBcc

public SmtpAppender.Builder setBcc(java.lang.String bcc)

Comma-separated list of BCC email addresses.

setFrom

public SmtpAppender.Builder setFrom(java.lang.String from)

Email address of the sender.

setReplyTo

public SmtpAppender.Builder setReplyTo(java.lang.String replyTo)

Comma-separated list of Reply-To email addresses.

setSubject

public SmtpAppender.Builder setSubject(java.lang.String subject)

Subject template for the email messages.

See Also:

PatternLayout

setSmtpProtocol

public SmtpAppender.Builder setSmtpProtocol(java.lang.String smtpProtocol)

Transport protocol to use for SMTP such as "smtp" or "smtps". Defaults to "smtp".

setSmtpHost

public SmtpAppender.Builder setSmtpHost(java.lang.String smtpHost)

Host name of SMTP server to send messages through.

setSmtpPort

public SmtpAppender.Builder setSmtpPort(int smtpPort)

Port number of SMTP server to send messages through.

setSmtpUsername

public SmtpAppender.Builder setSmtpUsername(java.lang.String smtpUsername)

Username to authenticate with SMTP server.

setSmtpPassword

public SmtpAppender.Builder setSmtpPassword(java.lang.String smtpPassword)

Password to authenticate with SMTP server.

setSmtpDebug

public SmtpAppender.Builder setSmtpDebug(boolean smtpDebug)

Enables or disables mail session debugging on STDOUT. Disabled by default.

setBufferSize

public SmtpAppender.Builder setBufferSize(int bufferSize)

Number of log events to buffer before sending an email. Defaults to 512.

setSslConfiguration

public SmtpAppender.Builder setSslConfiguration(SslConfiguration sslConfiguration)

Specifies an SSL configuration for smtps connections.

setLayout

public SmtpAppender.Builder setLayout(Layout<? extends java.io.Serializable> layout)

Specifies the layout used for the email message body. By default, this uses the default HTML layout.

Overrides:

setLayout in class AbstractAppender.Builder<SmtpAppender.Builder>

setFilter

public SmtpAppender.Builder setFilter(Filter filter)

Specifies the filter used for this appender. By default, uses a ThresholdFilter with a level of ERROR.

Overrides:

setFilter in class AbstractFilterable.Builder<SmtpAppender.Builder>

build

public SmtpAppender build()

Description copied from interface: Builder

Builds the object after all configuration has been set. This will use default values for any unspecified attributes for the object.

Specified by:

build in interface Builder<SmtpAppender>

Returns:

the configured instance.