Google Git
Sign in
apache / logging-log4j-site / 9755b12b39efbc0142688f9b1a11ec68db89f97b / . / 2.13.2 / log4j-core / apidocs / org / apache / logging / log4j / core / appender / SmtpAppender.Builder.html
blob: ec924667de81286cdb78ac3cf11b3b4611a170d4 [file] [log] [blame]
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<!-- NewPage -->
<html lang="en">
<head>
<!-- Generated by javadoc (1.8.0_144) on Sat Apr 25 12:11:38 MST 2020 -->
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>SmtpAppender.Builder (Apache Log4j Core 2.13.2 API)</title>
<meta name="date" content="2020-04-25">
<link rel="stylesheet" type="text/css" href="../../../../../../stylesheet.css" title="Style">
<script type="text/javascript" src="../../../../../../script.js"></script>
</head>
<body>
<script type="text/javascript"><!--
try {
if (location.href.indexOf('is-external=true') == -1) {
parent.document.title="SmtpAppender.Builder (Apache Log4j Core 2.13.2 API)";
}
}
catch(err) {
}
//-->
var methods = {"i0":10,"i1":10,"i2":10,"i3":10,"i4":10,"i5":10,"i6":10,"i7":10,"i8":10,"i9":10,"i10":10,"i11":10,"i12":10,"i13":10,"i14":10,"i15":10,"i16":10};
var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],8:["t4","Concrete Methods"]};
var altColor = "altColor";
var rowColor = "rowColor";
var tableTab = "tableTab";
var activeTableTab = "activeTableTab";
</script>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
<!-- ========= START OF TOP NAVBAR ======= -->
<div class="topNav"><a name="navbar.top">
<!-- -->
</a>
<div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div>
<a name="navbar.top.firstrow">
<!-- -->
</a>
<ul class="navList" title="Navigation">
<li><a href="../../../../../../overview-summary.html">Overview</a></li>
<li><a href="package-summary.html">Package</a></li>
<li class="navBarCell1Rev">Class</li>
<li><a href="class-use/SmtpAppender.Builder.html">Use</a></li>
<li><a href="package-tree.html">Tree</a></li>
<li><a href="../../../../../../deprecated-list.html">Deprecated</a></li>
<li><a href="../../../../../../index-all.html">Index</a></li>
<li><a href="../../../../../../help-doc.html">Help</a></li>
</ul>
</div>
<div class="subNav">
<ul class="navList">
<li><a href="../../../../../../org/apache/logging/log4j/core/appender/SmtpAppender.html" title="class in org.apache.logging.log4j.core.appender"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li><a href="../../../../../../org/apache/logging/log4j/core/appender/SocketAppender.html" title="class in org.apache.logging.log4j.core.appender"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../../../index.html?org/apache/logging/log4j/core/appender/SmtpAppender.Builder.html" target="_top">Frames</a></li>
<li><a href="SmtpAppender.Builder.html" target="_top">No&nbsp;Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_top">
<li><a href="../../../../../../allclasses-noframe.html">All&nbsp;Classes</a></li>
</ul>
<div>
<script type="text/javascript"><!--
allClassesLink = document.getElementById("allclasses_navbar_top");
if(window==top) {
allClassesLink.style.display = "block";
}
else {
allClassesLink.style.display = "none";
}
//-->
</script>
</div>
<div>
<ul class="subNavList">
<li>Summary:&nbsp;</li>
<li>Nested&nbsp;|&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li><a href="#constructor.summary">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="#method.summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail:&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li><a href="#constructor.detail">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="#method.detail">Method</a></li>
</ul>
</div>
<a name="skip.navbar.top">
<!-- -->
</a></div>
<!-- ========= END OF TOP NAVBAR ========= -->
<!-- ======== START OF CLASS DATA ======== -->
<div class="header">
<div class="subTitle">org.apache.logging.log4j.core.appender</div>
<h2 title="Class SmtpAppender.Builder" class="title">Class SmtpAppender.Builder</h2>
</div>
<div class="contentContainer">
<ul class="inheritance">
<li><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">java.lang.Object</a></li>
<li>
<ul class="inheritance">
<li><a href="../../../../../../org/apache/logging/log4j/core/filter/AbstractFilterable.Builder.html" title="class in org.apache.logging.log4j.core.filter">org.apache.logging.log4j.core.filter.AbstractFilterable.Builder</a>&lt;B&gt;</li>
<li>
<ul class="inheritance">
<li><a href="../../../../../../org/apache/logging/log4j/core/appender/AbstractAppender.Builder.html" title="class in org.apache.logging.log4j.core.appender">org.apache.logging.log4j.core.appender.AbstractAppender.Builder</a>&lt;<a href="../../../../../../org/apache/logging/log4j/core/appender/SmtpAppender.Builder.html" title="class in org.apache.logging.log4j.core.appender">SmtpAppender.Builder</a>&gt;</li>
<li>
<ul class="inheritance">
<li>org.apache.logging.log4j.core.appender.SmtpAppender.Builder</li>
</ul>
</li>
</ul>
</li>
</ul>
</li>
</ul>
<div class="description">
<ul class="blockList">
<li class="blockList">
<dl>
<dt>All Implemented Interfaces:</dt>
<dd><a href="../../../../../../org/apache/logging/log4j/core/util/Builder.html" title="interface in org.apache.logging.log4j.core.util">Builder</a>&lt;<a href="../../../../../../org/apache/logging/log4j/core/appender/SmtpAppender.html" title="class in org.apache.logging.log4j.core.appender">SmtpAppender</a>&gt;</dd>
</dl>
<dl>
<dt>Enclosing class:</dt>
<dd><a href="../../../../../../org/apache/logging/log4j/core/appender/SmtpAppender.html" title="class in org.apache.logging.log4j.core.appender">SmtpAppender</a></dd>
</dl>
<hr>
<br>
<pre>public static class <a href="../../../../../../src-html/org/apache/logging/log4j/core/appender/SmtpAppender.html#line.79">SmtpAppender.Builder</a>
extends <a href="../../../../../../org/apache/logging/log4j/core/appender/AbstractAppender.Builder.html" title="class in org.apache.logging.log4j.core.appender">AbstractAppender.Builder</a>&lt;<a href="../../../../../../org/apache/logging/log4j/core/appender/SmtpAppender.Builder.html" title="class in org.apache.logging.log4j.core.appender">SmtpAppender.Builder</a>&gt;
implements <a href="../../../../../../org/apache/logging/log4j/core/util/Builder.html" title="interface in org.apache.logging.log4j.core.util">Builder</a>&lt;<a href="../../../../../../org/apache/logging/log4j/core/appender/SmtpAppender.html" title="class in org.apache.logging.log4j.core.appender">SmtpAppender</a>&gt;</pre>
<dl>
<dt><span class="simpleTagLabel">Since:</span></dt>
<dd>2.13.2</dd>
</dl>
</li>
</ul>
</div>
<div class="summary">
<ul class="blockList">
<li class="blockList">
<!-- ======== CONSTRUCTOR SUMMARY ======== -->
<ul class="blockList">
<li class="blockList"><a name="constructor.summary">
<!-- -->
</a>
<h3>Constructor Summary</h3>
<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Constructor Summary table, listing constructors, and an explanation">
<caption><span>Constructors</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colOne" scope="col">Constructor and Description</th>
</tr>
<tr class="altColor">
<td class="colOne"><code><span class="memberNameLink"><a href="../../../../../../org/apache/logging/log4j/core/appender/SmtpAppender.Builder.html#Builder--">Builder</a></span>()</code>&nbsp;</td>
</tr>
</table>
</li>
</ul>
<!-- ========== METHOD SUMMARY =========== -->
<ul class="blockList">
<li class="blockList"><a name="method.summary">
<!-- -->
</a>
<h3>Method Summary</h3>
<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation">
<caption><span id="t0" class="activeTableTab"><span>All Methods</span><span class="tabEnd">&nbsp;</span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd">&nbsp;</span></span><span id="t4" class="tableTab"><span><a href="javascript:show(8);">Concrete Methods</a></span><span class="tabEnd">&nbsp;</span></span></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colLast" scope="col">Method and Description</th>
</tr>
<tr id="i0" class="altColor">
<td class="colFirst"><code><a href="../../../../../../org/apache/logging/log4j/core/appender/SmtpAppender.html" title="class in org.apache.logging.log4j.core.appender">SmtpAppender</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/logging/log4j/core/appender/SmtpAppender.Builder.html#build--">build</a></span>()</code>
<div class="block">Builds the object after all configuration has been set.</div>
</td>
</tr>
<tr id="i1" class="rowColor">
<td class="colFirst"><code><a href="../../../../../../org/apache/logging/log4j/core/appender/SmtpAppender.Builder.html" title="class in org.apache.logging.log4j.core.appender">SmtpAppender.Builder</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/logging/log4j/core/appender/SmtpAppender.Builder.html#setBcc-java.lang.String-">setBcc</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;bcc)</code>
<div class="block">Comma-separated list of BCC email addresses.</div>
</td>
</tr>
<tr id="i2" class="altColor">
<td class="colFirst"><code><a href="../../../../../../org/apache/logging/log4j/core/appender/SmtpAppender.Builder.html" title="class in org.apache.logging.log4j.core.appender">SmtpAppender.Builder</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/logging/log4j/core/appender/SmtpAppender.Builder.html#setBufferSize-int-">setBufferSize</a></span>(int&nbsp;bufferSize)</code>
<div class="block">Number of log events to buffer before sending an email.</div>
</td>
</tr>
<tr id="i3" class="rowColor">
<td class="colFirst"><code><a href="../../../../../../org/apache/logging/log4j/core/appender/SmtpAppender.Builder.html" title="class in org.apache.logging.log4j.core.appender">SmtpAppender.Builder</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/logging/log4j/core/appender/SmtpAppender.Builder.html#setCc-java.lang.String-">setCc</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;cc)</code>
<div class="block">Comma-separated list of CC email addresses.</div>
</td>
</tr>
<tr id="i4" class="altColor">
<td class="colFirst"><code><a href="../../../../../../org/apache/logging/log4j/core/appender/SmtpAppender.Builder.html" title="class in org.apache.logging.log4j.core.appender">SmtpAppender.Builder</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/logging/log4j/core/appender/SmtpAppender.Builder.html#setFilter-org.apache.logging.log4j.core.Filter-">setFilter</a></span>(<a href="../../../../../../org/apache/logging/log4j/core/Filter.html" title="interface in org.apache.logging.log4j.core">Filter</a>&nbsp;filter)</code>
<div class="block">Specifies the filter used for this appender.</div>
</td>
</tr>
<tr id="i5" class="rowColor">
<td class="colFirst"><code><a href="../../../../../../org/apache/logging/log4j/core/appender/SmtpAppender.Builder.html" title="class in org.apache.logging.log4j.core.appender">SmtpAppender.Builder</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/logging/log4j/core/appender/SmtpAppender.Builder.html#setFrom-java.lang.String-">setFrom</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;from)</code>
<div class="block">Email address of the sender.</div>
</td>
</tr>
<tr id="i6" class="altColor">
<td class="colFirst"><code><a href="../../../../../../org/apache/logging/log4j/core/appender/SmtpAppender.Builder.html" title="class in org.apache.logging.log4j.core.appender">SmtpAppender.Builder</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/logging/log4j/core/appender/SmtpAppender.Builder.html#setLayout-org.apache.logging.log4j.core.Layout-">setLayout</a></span>(<a href="../../../../../../org/apache/logging/log4j/core/Layout.html" title="interface in org.apache.logging.log4j.core">Layout</a>&lt;? extends <a href="https://docs.oracle.com/javase/8/docs/api/java/io/Serializable.html?is-external=true" title="class or interface in java.io">Serializable</a>&gt;&nbsp;layout)</code>
<div class="block">Specifies the layout used for the email message body.</div>
</td>
</tr>
<tr id="i7" class="rowColor">
<td class="colFirst"><code><a href="../../../../../../org/apache/logging/log4j/core/appender/SmtpAppender.Builder.html" title="class in org.apache.logging.log4j.core.appender">SmtpAppender.Builder</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/logging/log4j/core/appender/SmtpAppender.Builder.html#setReplyTo-java.lang.String-">setReplyTo</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;replyTo)</code>
<div class="block">Comma-separated list of Reply-To email addresses.</div>
</td>
</tr>
<tr id="i8" class="altColor">
<td class="colFirst"><code><a href="../../../../../../org/apache/logging/log4j/core/appender/SmtpAppender.Builder.html" title="class in org.apache.logging.log4j.core.appender">SmtpAppender.Builder</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/logging/log4j/core/appender/SmtpAppender.Builder.html#setSmtpDebug-boolean-">setSmtpDebug</a></span>(boolean&nbsp;smtpDebug)</code>
<div class="block">Enables or disables mail session debugging on STDOUT.</div>
</td>
</tr>
<tr id="i9" class="rowColor">
<td class="colFirst"><code><a href="../../../../../../org/apache/logging/log4j/core/appender/SmtpAppender.Builder.html" title="class in org.apache.logging.log4j.core.appender">SmtpAppender.Builder</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/logging/log4j/core/appender/SmtpAppender.Builder.html#setSmtpHost-java.lang.String-">setSmtpHost</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;smtpHost)</code>
<div class="block">Host name of SMTP server to send messages through.</div>
</td>
</tr>
<tr id="i10" class="altColor">
<td class="colFirst"><code><a href="../../../../../../org/apache/logging/log4j/core/appender/SmtpAppender.Builder.html" title="class in org.apache.logging.log4j.core.appender">SmtpAppender.Builder</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/logging/log4j/core/appender/SmtpAppender.Builder.html#setSmtpPassword-java.lang.String-">setSmtpPassword</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;smtpPassword)</code>
<div class="block">Password to authenticate with SMTP server.</div>
</td>
</tr>
<tr id="i11" class="rowColor">
<td class="colFirst"><code><a href="../../../../../../org/apache/logging/log4j/core/appender/SmtpAppender.Builder.html" title="class in org.apache.logging.log4j.core.appender">SmtpAppender.Builder</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/logging/log4j/core/appender/SmtpAppender.Builder.html#setSmtpPort-int-">setSmtpPort</a></span>(int&nbsp;smtpPort)</code>
<div class="block">Port number of SMTP server to send messages through.</div>
</td>
</tr>
<tr id="i12" class="altColor">
<td class="colFirst"><code><a href="../../../../../../org/apache/logging/log4j/core/appender/SmtpAppender.Builder.html" title="class in org.apache.logging.log4j.core.appender">SmtpAppender.Builder</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/logging/log4j/core/appender/SmtpAppender.Builder.html#setSmtpProtocol-java.lang.String-">setSmtpProtocol</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;smtpProtocol)</code>
<div class="block">Transport protocol to use for SMTP such as "smtp" or "smtps".</div>
</td>
</tr>
<tr id="i13" class="rowColor">
<td class="colFirst"><code><a href="../../../../../../org/apache/logging/log4j/core/appender/SmtpAppender.Builder.html" title="class in org.apache.logging.log4j.core.appender">SmtpAppender.Builder</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/logging/log4j/core/appender/SmtpAppender.Builder.html#setSmtpUsername-java.lang.String-">setSmtpUsername</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;smtpUsername)</code>
<div class="block">Username to authenticate with SMTP server.</div>
</td>
</tr>
<tr id="i14" class="altColor">
<td class="colFirst"><code><a href="../../../../../../org/apache/logging/log4j/core/appender/SmtpAppender.Builder.html" title="class in org.apache.logging.log4j.core.appender">SmtpAppender.Builder</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/logging/log4j/core/appender/SmtpAppender.Builder.html#setSslConfiguration-org.apache.logging.log4j.core.net.ssl.SslConfiguration-">setSslConfiguration</a></span>(<a href="../../../../../../org/apache/logging/log4j/core/net/ssl/SslConfiguration.html" title="class in org.apache.logging.log4j.core.net.ssl">SslConfiguration</a>&nbsp;sslConfiguration)</code>
<div class="block">Specifies an SSL configuration for smtps connections.</div>
</td>
</tr>
<tr id="i15" class="rowColor">
<td class="colFirst"><code><a href="../../../../../../org/apache/logging/log4j/core/appender/SmtpAppender.Builder.html" title="class in org.apache.logging.log4j.core.appender">SmtpAppender.Builder</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/logging/log4j/core/appender/SmtpAppender.Builder.html#setSubject-java.lang.String-">setSubject</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;subject)</code>
<div class="block">Subject template for the email messages.</div>
</td>
</tr>
<tr id="i16" class="altColor">
<td class="colFirst"><code><a href="../../../../../../org/apache/logging/log4j/core/appender/SmtpAppender.Builder.html" title="class in org.apache.logging.log4j.core.appender">SmtpAppender.Builder</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/logging/log4j/core/appender/SmtpAppender.Builder.html#setTo-java.lang.String-">setTo</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;to)</code>
<div class="block">Comma-separated list of recipient email addresses.</div>
</td>
</tr>
</table>
<ul class="blockList">
<li class="blockList"><a name="methods.inherited.from.class.org.apache.logging.log4j.core.appender.AbstractAppender.Builder">
<!-- -->
</a>
<h3>Methods inherited from class&nbsp;org.apache.logging.log4j.core.appender.<a href="../../../../../../org/apache/logging/log4j/core/appender/AbstractAppender.Builder.html" title="class in org.apache.logging.log4j.core.appender">AbstractAppender.Builder</a></h3>
<code><a href="../../../../../../org/apache/logging/log4j/core/appender/AbstractAppender.Builder.html#getConfiguration--">getConfiguration</a>, <a href="../../../../../../org/apache/logging/log4j/core/appender/AbstractAppender.Builder.html#getLayout--">getLayout</a>, <a href="../../../../../../org/apache/logging/log4j/core/appender/AbstractAppender.Builder.html#getName--">getName</a>, <a href="../../../../../../org/apache/logging/log4j/core/appender/AbstractAppender.Builder.html#getOrCreateLayout--">getOrCreateLayout</a>, <a href="../../../../../../org/apache/logging/log4j/core/appender/AbstractAppender.Builder.html#getOrCreateLayout-java.nio.charset.Charset-">getOrCreateLayout</a>, <a href="../../../../../../org/apache/logging/log4j/core/appender/AbstractAppender.Builder.html#isIgnoreExceptions--">isIgnoreExceptions</a>, <a href="../../../../../../org/apache/logging/log4j/core/appender/AbstractAppender.Builder.html#setConfiguration-org.apache.logging.log4j.core.config.Configuration-">setConfiguration</a>, <a href="../../../../../../org/apache/logging/log4j/core/appender/AbstractAppender.Builder.html#setIgnoreExceptions-boolean-">setIgnoreExceptions</a>, <a href="../../../../../../org/apache/logging/log4j/core/appender/AbstractAppender.Builder.html#setName-java.lang.String-">setName</a>, <a href="../../../../../../org/apache/logging/log4j/core/appender/AbstractAppender.Builder.html#withConfiguration-org.apache.logging.log4j.core.config.Configuration-">withConfiguration</a>, <a href="../../../../../../org/apache/logging/log4j/core/appender/AbstractAppender.Builder.html#withIgnoreExceptions-boolean-">withIgnoreExceptions</a>, <a href="../../../../../../org/apache/logging/log4j/core/appender/AbstractAppender.Builder.html#withLayout-org.apache.logging.log4j.core.Layout-">withLayout</a>, <a href="../../../../../../org/apache/logging/log4j/core/appender/AbstractAppender.Builder.html#withName-java.lang.String-">withName</a></code></li>
</ul>
<ul class="blockList">
<li class="blockList"><a name="methods.inherited.from.class.org.apache.logging.log4j.core.filter.AbstractFilterable.Builder">
<!-- -->
</a>
<h3>Methods inherited from class&nbsp;org.apache.logging.log4j.core.filter.<a href="../../../../../../org/apache/logging/log4j/core/filter/AbstractFilterable.Builder.html" title="class in org.apache.logging.log4j.core.filter">AbstractFilterable.Builder</a></h3>
<code><a href="../../../../../../org/apache/logging/log4j/core/filter/AbstractFilterable.Builder.html#asBuilder--">asBuilder</a>, <a href="../../../../../../org/apache/logging/log4j/core/filter/AbstractFilterable.Builder.html#getFilter--">getFilter</a>, <a href="../../../../../../org/apache/logging/log4j/core/filter/AbstractFilterable.Builder.html#getPropertyArray--">getPropertyArray</a>, <a href="../../../../../../org/apache/logging/log4j/core/filter/AbstractFilterable.Builder.html#setPropertyArray-org.apache.logging.log4j.core.config.Property:A-">setPropertyArray</a>, <a href="../../../../../../org/apache/logging/log4j/core/filter/AbstractFilterable.Builder.html#withFilter-org.apache.logging.log4j.core.Filter-">withFilter</a></code></li>
</ul>
<ul class="blockList">
<li class="blockList"><a name="methods.inherited.from.class.java.lang.Object">
<!-- -->
</a>
<h3>Methods inherited from class&nbsp;java.lang.<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a></h3>
<code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#clone--" title="class or interface in java.lang">clone</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#equals-java.lang.Object-" title="class or interface in java.lang">equals</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#finalize--" title="class or interface in java.lang">finalize</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#getClass--" title="class or interface in java.lang">getClass</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#hashCode--" title="class or interface in java.lang">hashCode</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#notify--" title="class or interface in java.lang">notify</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#notifyAll--" title="class or interface in java.lang">notifyAll</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#toString--" title="class or interface in java.lang">toString</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#wait--" title="class or interface in java.lang">wait</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#wait-long-" title="class or interface in java.lang">wait</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#wait-long-int-" title="class or interface in java.lang">wait</a></code></li>
</ul>
</li>
</ul>
</li>
</ul>
</div>
<div class="details">
<ul class="blockList">
<li class="blockList">
<!-- ========= CONSTRUCTOR DETAIL ======== -->
<ul class="blockList">
<li class="blockList"><a name="constructor.detail">
<!-- -->
</a>
<h3>Constructor Detail</h3>
<a name="Builder--">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>Builder</h4>
<pre>public&nbsp;<a href="../../../../../../src-html/org/apache/logging/log4j/core/appender/SmtpAppender.Builder.html#line.79">Builder</a>()</pre>
</li>
</ul>
</li>
</ul>
<!-- ============ METHOD DETAIL ========== -->
<ul class="blockList">
<li class="blockList"><a name="method.detail">
<!-- -->
</a>
<h3>Method Detail</h3>
<a name="setTo-java.lang.String-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setTo</h4>
<pre>public&nbsp;<a href="../../../../../../org/apache/logging/log4j/core/appender/SmtpAppender.Builder.html" title="class in org.apache.logging.log4j.core.appender">SmtpAppender.Builder</a>&nbsp;<a href="../../../../../../src-html/org/apache/logging/log4j/core/appender/SmtpAppender.Builder.html#line.127">setTo</a>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;to)</pre>
<div class="block">Comma-separated list of recipient email addresses.</div>
</li>
</ul>
<a name="setCc-java.lang.String-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setCc</h4>
<pre>public&nbsp;<a href="../../../../../../org/apache/logging/log4j/core/appender/SmtpAppender.Builder.html" title="class in org.apache.logging.log4j.core.appender">SmtpAppender.Builder</a>&nbsp;<a href="../../../../../../src-html/org/apache/logging/log4j/core/appender/SmtpAppender.Builder.html#line.135">setCc</a>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;cc)</pre>
<div class="block">Comma-separated list of CC email addresses.</div>
</li>
</ul>
<a name="setBcc-java.lang.String-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setBcc</h4>
<pre>public&nbsp;<a href="../../../../../../org/apache/logging/log4j/core/appender/SmtpAppender.Builder.html" title="class in org.apache.logging.log4j.core.appender">SmtpAppender.Builder</a>&nbsp;<a href="../../../../../../src-html/org/apache/logging/log4j/core/appender/SmtpAppender.Builder.html#line.143">setBcc</a>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;bcc)</pre>
<div class="block">Comma-separated list of BCC email addresses.</div>
</li>
</ul>
<a name="setFrom-java.lang.String-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setFrom</h4>
<pre>public&nbsp;<a href="../../../../../../org/apache/logging/log4j/core/appender/SmtpAppender.Builder.html" title="class in org.apache.logging.log4j.core.appender">SmtpAppender.Builder</a>&nbsp;<a href="../../../../../../src-html/org/apache/logging/log4j/core/appender/SmtpAppender.Builder.html#line.151">setFrom</a>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;from)</pre>
<div class="block">Email address of the sender.</div>
</li>
</ul>
<a name="setReplyTo-java.lang.String-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setReplyTo</h4>
<pre>public&nbsp;<a href="../../../../../../org/apache/logging/log4j/core/appender/SmtpAppender.Builder.html" title="class in org.apache.logging.log4j.core.appender">SmtpAppender.Builder</a>&nbsp;<a href="../../../../../../src-html/org/apache/logging/log4j/core/appender/SmtpAppender.Builder.html#line.159">setReplyTo</a>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;replyTo)</pre>
<div class="block">Comma-separated list of Reply-To email addresses.</div>
</li>
</ul>
<a name="setSubject-java.lang.String-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setSubject</h4>
<pre>public&nbsp;<a href="../../../../../../org/apache/logging/log4j/core/appender/SmtpAppender.Builder.html" title="class in org.apache.logging.log4j.core.appender">SmtpAppender.Builder</a>&nbsp;<a href="../../../../../../src-html/org/apache/logging/log4j/core/appender/SmtpAppender.Builder.html#line.168">setSubject</a>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;subject)</pre>
<div class="block">Subject template for the email messages.</div>
<dl>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../../../../../../org/apache/logging/log4j/core/layout/PatternLayout.html" title="class in org.apache.logging.log4j.core.layout"><code>PatternLayout</code></a></dd>
</dl>
</li>
</ul>
<a name="setSmtpProtocol-java.lang.String-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setSmtpProtocol</h4>
<pre>public&nbsp;<a href="../../../../../../org/apache/logging/log4j/core/appender/SmtpAppender.Builder.html" title="class in org.apache.logging.log4j.core.appender">SmtpAppender.Builder</a>&nbsp;<a href="../../../../../../src-html/org/apache/logging/log4j/core/appender/SmtpAppender.Builder.html#line.176">setSmtpProtocol</a>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;smtpProtocol)</pre>
<div class="block">Transport protocol to use for SMTP such as "smtp" or "smtps". Defaults to "smtp".</div>
</li>
</ul>
<a name="setSmtpHost-java.lang.String-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setSmtpHost</h4>
<pre>public&nbsp;<a href="../../../../../../org/apache/logging/log4j/core/appender/SmtpAppender.Builder.html" title="class in org.apache.logging.log4j.core.appender">SmtpAppender.Builder</a>&nbsp;<a href="../../../../../../src-html/org/apache/logging/log4j/core/appender/SmtpAppender.Builder.html#line.184">setSmtpHost</a>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;smtpHost)</pre>
<div class="block">Host name of SMTP server to send messages through.</div>
</li>
</ul>
<a name="setSmtpPort-int-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setSmtpPort</h4>
<pre>public&nbsp;<a href="../../../../../../org/apache/logging/log4j/core/appender/SmtpAppender.Builder.html" title="class in org.apache.logging.log4j.core.appender">SmtpAppender.Builder</a>&nbsp;<a href="../../../../../../src-html/org/apache/logging/log4j/core/appender/SmtpAppender.Builder.html#line.192">setSmtpPort</a>(int&nbsp;smtpPort)</pre>
<div class="block">Port number of SMTP server to send messages through.</div>
</li>
</ul>
<a name="setSmtpUsername-java.lang.String-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setSmtpUsername</h4>
<pre>public&nbsp;<a href="../../../../../../org/apache/logging/log4j/core/appender/SmtpAppender.Builder.html" title="class in org.apache.logging.log4j.core.appender">SmtpAppender.Builder</a>&nbsp;<a href="../../../../../../src-html/org/apache/logging/log4j/core/appender/SmtpAppender.Builder.html#line.200">setSmtpUsername</a>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;smtpUsername)</pre>
<div class="block">Username to authenticate with SMTP server.</div>
</li>
</ul>
<a name="setSmtpPassword-java.lang.String-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setSmtpPassword</h4>
<pre>public&nbsp;<a href="../../../../../../org/apache/logging/log4j/core/appender/SmtpAppender.Builder.html" title="class in org.apache.logging.log4j.core.appender">SmtpAppender.Builder</a>&nbsp;<a href="../../../../../../src-html/org/apache/logging/log4j/core/appender/SmtpAppender.Builder.html#line.208">setSmtpPassword</a>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;smtpPassword)</pre>
<div class="block">Password to authenticate with SMTP server.</div>
</li>
</ul>
<a name="setSmtpDebug-boolean-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setSmtpDebug</h4>
<pre>public&nbsp;<a href="../../../../../../org/apache/logging/log4j/core/appender/SmtpAppender.Builder.html" title="class in org.apache.logging.log4j.core.appender">SmtpAppender.Builder</a>&nbsp;<a href="../../../../../../src-html/org/apache/logging/log4j/core/appender/SmtpAppender.Builder.html#line.216">setSmtpDebug</a>(boolean&nbsp;smtpDebug)</pre>
<div class="block">Enables or disables mail session debugging on STDOUT. Disabled by default.</div>
</li>
</ul>
<a name="setBufferSize-int-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setBufferSize</h4>
<pre>public&nbsp;<a href="../../../../../../org/apache/logging/log4j/core/appender/SmtpAppender.Builder.html" title="class in org.apache.logging.log4j.core.appender">SmtpAppender.Builder</a>&nbsp;<a href="../../../../../../src-html/org/apache/logging/log4j/core/appender/SmtpAppender.Builder.html#line.224">setBufferSize</a>(int&nbsp;bufferSize)</pre>
<div class="block">Number of log events to buffer before sending an email. Defaults to .</div>
</li>
</ul>
<a name="setSslConfiguration-org.apache.logging.log4j.core.net.ssl.SslConfiguration-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setSslConfiguration</h4>
<pre>public&nbsp;<a href="../../../../../../org/apache/logging/log4j/core/appender/SmtpAppender.Builder.html" title="class in org.apache.logging.log4j.core.appender">SmtpAppender.Builder</a>&nbsp;<a href="../../../../../../src-html/org/apache/logging/log4j/core/appender/SmtpAppender.Builder.html#line.232">setSslConfiguration</a>(<a href="../../../../../../org/apache/logging/log4j/core/net/ssl/SslConfiguration.html" title="class in org.apache.logging.log4j.core.net.ssl">SslConfiguration</a>&nbsp;sslConfiguration)</pre>
<div class="block">Specifies an SSL configuration for smtps connections.</div>
</li>
</ul>
<a name="setLayout-org.apache.logging.log4j.core.Layout-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setLayout</h4>
<pre>public&nbsp;<a href="../../../../../../org/apache/logging/log4j/core/appender/SmtpAppender.Builder.html" title="class in org.apache.logging.log4j.core.appender">SmtpAppender.Builder</a>&nbsp;<a href="../../../../../../src-html/org/apache/logging/log4j/core/appender/SmtpAppender.Builder.html#line.242">setLayout</a>(<a href="../../../../../../org/apache/logging/log4j/core/Layout.html" title="interface in org.apache.logging.log4j.core">Layout</a>&lt;? extends <a href="https://docs.oracle.com/javase/8/docs/api/java/io/Serializable.html?is-external=true" title="class or interface in java.io">Serializable</a>&gt;&nbsp;layout)</pre>
<div class="block">Specifies the layout used for the email message body. By default, this uses the
<a href="../../../../../../org/apache/logging/log4j/core/layout/HtmlLayout.html#createDefaultLayout--">default HTML layout</a>.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Overrides:</span></dt>
<dd><code><a href="../../../../../../org/apache/logging/log4j/core/appender/AbstractAppender.Builder.html#setLayout-org.apache.logging.log4j.core.Layout-">setLayout</a></code>&nbsp;in class&nbsp;<code><a href="../../../../../../org/apache/logging/log4j/core/appender/AbstractAppender.Builder.html" title="class in org.apache.logging.log4j.core.appender">AbstractAppender.Builder</a>&lt;<a href="../../../../../../org/apache/logging/log4j/core/appender/SmtpAppender.Builder.html" title="class in org.apache.logging.log4j.core.appender">SmtpAppender.Builder</a>&gt;</code></dd>
</dl>
</li>
</ul>
<a name="setFilter-org.apache.logging.log4j.core.Filter-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setFilter</h4>
<pre>public&nbsp;<a href="../../../../../../org/apache/logging/log4j/core/appender/SmtpAppender.Builder.html" title="class in org.apache.logging.log4j.core.appender">SmtpAppender.Builder</a>&nbsp;<a href="../../../../../../src-html/org/apache/logging/log4j/core/appender/SmtpAppender.Builder.html#line.251">setFilter</a>(<a href="../../../../../../org/apache/logging/log4j/core/Filter.html" title="interface in org.apache.logging.log4j.core">Filter</a>&nbsp;filter)</pre>
<div class="block">Specifies the filter used for this appender. By default, uses a <a href="../../../../../../org/apache/logging/log4j/core/filter/ThresholdFilter.html" title="class in org.apache.logging.log4j.core.filter"><code>ThresholdFilter</code></a> with a level of
ERROR.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Overrides:</span></dt>
<dd><code><a href="../../../../../../org/apache/logging/log4j/core/filter/AbstractFilterable.Builder.html#setFilter-org.apache.logging.log4j.core.Filter-">setFilter</a></code>&nbsp;in class&nbsp;<code><a href="../../../../../../org/apache/logging/log4j/core/filter/AbstractFilterable.Builder.html" title="class in org.apache.logging.log4j.core.filter">AbstractFilterable.Builder</a>&lt;<a href="../../../../../../org/apache/logging/log4j/core/appender/SmtpAppender.Builder.html" title="class in org.apache.logging.log4j.core.appender">SmtpAppender.Builder</a>&gt;</code></dd>
</dl>
</li>
</ul>
<a name="build--">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>build</h4>
<pre>public&nbsp;<a href="../../../../../../org/apache/logging/log4j/core/appender/SmtpAppender.html" title="class in org.apache.logging.log4j.core.appender">SmtpAppender</a>&nbsp;<a href="../../../../../../src-html/org/apache/logging/log4j/core/appender/SmtpAppender.Builder.html#line.256">build</a>()</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from interface:&nbsp;<code><a href="../../../../../../org/apache/logging/log4j/core/util/Builder.html#build--">Builder</a></code></span></div>
<div class="block">Builds the object after all configuration has been set. This will use default values for any
unspecified attributes for the object.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../../../../../../org/apache/logging/log4j/core/util/Builder.html#build--">build</a></code>&nbsp;in interface&nbsp;<code><a href="../../../../../../org/apache/logging/log4j/core/util/Builder.html" title="interface in org.apache.logging.log4j.core.util">Builder</a>&lt;<a href="../../../../../../org/apache/logging/log4j/core/appender/SmtpAppender.html" title="class in org.apache.logging.log4j.core.appender">SmtpAppender</a>&gt;</code></dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the configured instance.</dd>
</dl>
</li>
</ul>
</li>
</ul>
</li>
</ul>
</div>
</div>
<!-- ========= END OF CLASS DATA ========= -->
<!-- ======= START OF BOTTOM NAVBAR ====== -->
<div class="bottomNav"><a name="navbar.bottom">
<!-- -->
</a>
<div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div>
<a name="navbar.bottom.firstrow">
<!-- -->
</a>
<ul class="navList" title="Navigation">
<li><a href="../../../../../../overview-summary.html">Overview</a></li>
<li><a href="package-summary.html">Package</a></li>
<li class="navBarCell1Rev">Class</li>
<li><a href="class-use/SmtpAppender.Builder.html">Use</a></li>
<li><a href="package-tree.html">Tree</a></li>
<li><a href="../../../../../../deprecated-list.html">Deprecated</a></li>
<li><a href="../../../../../../index-all.html">Index</a></li>
<li><a href="../../../../../../help-doc.html">Help</a></li>
</ul>
</div>
<div class="subNav">
<ul class="navList">
<li><a href="../../../../../../org/apache/logging/log4j/core/appender/SmtpAppender.html" title="class in org.apache.logging.log4j.core.appender"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li><a href="../../../../../../org/apache/logging/log4j/core/appender/SocketAppender.html" title="class in org.apache.logging.log4j.core.appender"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../../../index.html?org/apache/logging/log4j/core/appender/SmtpAppender.Builder.html" target="_top">Frames</a></li>
<li><a href="SmtpAppender.Builder.html" target="_top">No&nbsp;Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_bottom">
<li><a href="../../../../../../allclasses-noframe.html">All&nbsp;Classes</a></li>
</ul>
<div>
<script type="text/javascript"><!--
allClassesLink = document.getElementById("allclasses_navbar_bottom");
if(window==top) {
allClassesLink.style.display = "block";
}
else {
allClassesLink.style.display = "none";
}
//-->
</script>
</div>
<div>
<ul class="subNavList">
<li>Summary:&nbsp;</li>
<li>Nested&nbsp;|&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li><a href="#constructor.summary">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="#method.summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail:&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li><a href="#constructor.detail">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="#method.detail">Method</a></li>
</ul>
</div>
<a name="skip.navbar.bottom">
<!-- -->
</a></div>
<!-- ======== END OF BOTTOM NAVBAR ======= -->
<p class="legalCopy"><small><p align="center">Copyright &#169; 1999-2020 <a href="https://www.apache.org/">The Apache Software Foundation</a>. All Rights Reserved.<br /> Apache Logging, Apache Log4j, Log4j, Apache, the Apache feather logo, the Apache Logging project logo, and the Apache Log4j logo are trademarks of The Apache Software Foundation.</p></small></p>
</body>
</html>