| <!DOCTYPE HTML> |
| <html lang="en"> |
| <head> |
| <!-- Generated by javadoc (17) --> |
| <title>SmtpAppender.Builder (Apache Log4j Core 2.23.1 API)</title> |
| <meta name="viewport" content="width=device-width, initial-scale=1"> |
| <meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> |
| <meta name="description" content="declaration: package: org.apache.logging.log4j.core.appender, class: SmtpAppender, class: Builder"> |
| <meta name="generator" content="javadoc/ClassWriterImpl"> |
| <link rel="stylesheet" type="text/css" href="../../../../../../stylesheet.css" title="Style"> |
| <link rel="stylesheet" type="text/css" href="../../../../../../script-dir/jquery-ui.min.css" title="Style"> |
| <link rel="stylesheet" type="text/css" href="../../../../../../jquery-ui.overrides.css" title="Style"> |
| <script type="text/javascript" src="../../../../../../script.js"></script> |
| <script type="text/javascript" src="../../../../../../script-dir/jquery-3.6.1.min.js"></script> |
| <script type="text/javascript" src="../../../../../../script-dir/jquery-ui.min.js"></script> |
| </head> |
| <body class="class-declaration-page"> |
| <script type="text/javascript">var evenRowColor = "even-row-color"; |
| var oddRowColor = "odd-row-color"; |
| var tableTab = "table-tab"; |
| var activeTableTab = "active-table-tab"; |
| var pathtoroot = "../../../../../../"; |
| loadScripts(document, 'script');</script> |
| <noscript> |
| <div>JavaScript is disabled on your browser.</div> |
| </noscript> |
| <div class="flex-box"> |
| <header role="banner" class="flex-header"> |
| <nav role="navigation"> |
| <!-- ========= START OF TOP NAVBAR ======= --> |
| <div class="top-nav" id="navbar-top"> |
| <div class="skip-nav"><a href="#skip-navbar-top" title="Skip navigation links">Skip navigation links</a></div> |
| <ul id="navbar-top-firstrow" class="nav-list" title="Navigation"> |
| <li><a href="../../../../../../index.html">Overview</a></li> |
| <li><a href="package-summary.html">Package</a></li> |
| <li class="nav-bar-cell1-rev">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#class">Help</a></li> |
| </ul> |
| </div> |
| <div class="sub-nav"> |
| <div> |
| <ul class="sub-nav-list"> |
| <li>Summary: </li> |
| <li>Nested | </li> |
| <li>Field | </li> |
| <li><a href="#constructor-summary">Constr</a> | </li> |
| <li><a href="#method-summary">Method</a></li> |
| </ul> |
| <ul class="sub-nav-list"> |
| <li>Detail: </li> |
| <li>Field | </li> |
| <li><a href="#constructor-detail">Constr</a> | </li> |
| <li><a href="#method-detail">Method</a></li> |
| </ul> |
| </div> |
| <div class="nav-list-search"><label for="search-input">SEARCH:</label> |
| <input type="text" id="search-input" value="search" disabled="disabled"> |
| <input type="reset" id="reset-button" value="reset" disabled="disabled"> |
| </div> |
| </div> |
| <!-- ========= END OF TOP NAVBAR ========= --> |
| <span class="skip-nav" id="skip-navbar-top"></span></nav> |
| </header> |
| <div class="flex-content"> |
| <main role="main"> |
| <!-- ======== START OF CLASS DATA ======== --> |
| <div class="header"> |
| <div class="sub-title"><span class="package-label-in-type">Package</span> <a href="package-summary.html">org.apache.logging.log4j.core.appender</a></div> |
| <h1 title="Class SmtpAppender.Builder" class="title">Class SmtpAppender.Builder</h1> |
| </div> |
| <div class="inheritance" title="Inheritance Tree"><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html" title="class or interface in java.lang" class="external-link">java.lang.Object</a> |
| <div class="inheritance"><a href="../filter/AbstractFilterable.Builder.html" title="class in org.apache.logging.log4j.core.filter">org.apache.logging.log4j.core.filter.AbstractFilterable.Builder</a><B> |
| <div class="inheritance"><a href="AbstractAppender.Builder.html" title="class in org.apache.logging.log4j.core.appender">org.apache.logging.log4j.core.appender.AbstractAppender.Builder</a><<a href="SmtpAppender.Builder.html" title="class in org.apache.logging.log4j.core.appender">SmtpAppender.Builder</a>> |
| <div class="inheritance">org.apache.logging.log4j.core.appender.SmtpAppender.Builder</div> |
| </div> |
| </div> |
| </div> |
| <section class="class-description" id="class-description"> |
| <dl class="notes"> |
| <dt>All Implemented Interfaces:</dt> |
| <dd><code><a href="../util/Builder.html" title="interface in org.apache.logging.log4j.core.util">Builder</a><<a href="SmtpAppender.html" title="class in org.apache.logging.log4j.core.appender">SmtpAppender</a>></code></dd> |
| </dl> |
| <dl class="notes"> |
| <dt>Enclosing class:</dt> |
| <dd><a href="SmtpAppender.html" title="class in org.apache.logging.log4j.core.appender">SmtpAppender</a></dd> |
| </dl> |
| <hr> |
| <div class="type-signature"><span class="modifiers">public static class </span><span class="element-name type-name-label">SmtpAppender.Builder</span> |
| <span class="extends-implements">extends <a href="AbstractAppender.Builder.html" title="class in org.apache.logging.log4j.core.appender">AbstractAppender.Builder</a><<a href="SmtpAppender.Builder.html" title="class in org.apache.logging.log4j.core.appender">SmtpAppender.Builder</a>> |
| implements <a href="../util/Builder.html" title="interface in org.apache.logging.log4j.core.util">Builder</a><<a href="SmtpAppender.html" title="class in org.apache.logging.log4j.core.appender">SmtpAppender</a>></span></div> |
| <dl class="notes"> |
| <dt>Since:</dt> |
| <dd>2.13.2</dd> |
| </dl> |
| </section> |
| <section class="summary"> |
| <ul class="summary-list"> |
| <!-- ======== CONSTRUCTOR SUMMARY ======== --> |
| <li> |
| <section class="constructor-summary" id="constructor-summary"> |
| <h2>Constructor Summary</h2> |
| <div class="caption"><span>Constructors</span></div> |
| <div class="summary-table two-column-summary"> |
| <div class="table-header col-first">Constructor</div> |
| <div class="table-header col-last">Description</div> |
| <div class="col-constructor-name even-row-color"><code><a href="#%3Cinit%3E()" class="member-name-link">Builder</a>()</code></div> |
| <div class="col-last even-row-color"> </div> |
| </div> |
| </section> |
| </li> |
| <!-- ========== METHOD SUMMARY =========== --> |
| <li> |
| <section class="method-summary" id="method-summary"> |
| <h2>Method Summary</h2> |
| <div id="method-summary-table"> |
| <div class="table-tabs" role="tablist" aria-orientation="horizontal"><button id="method-summary-table-tab0" role="tab" aria-selected="true" aria-controls="method-summary-table.tabpanel" tabindex="0" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table', 3)" class="active-table-tab">All Methods</button><button id="method-summary-table-tab2" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab2', 3)" class="table-tab">Instance Methods</button><button id="method-summary-table-tab4" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab4', 3)" class="table-tab">Concrete Methods</button></div> |
| <div id="method-summary-table.tabpanel" role="tabpanel"> |
| <div class="summary-table three-column-summary" aria-labelledby="method-summary-table-tab0"> |
| <div class="table-header col-first">Modifier and Type</div> |
| <div class="table-header col-second">Method</div> |
| <div class="table-header col-last">Description</div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="SmtpAppender.html" title="class in org.apache.logging.log4j.core.appender">SmtpAppender</a></code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#build()" class="member-name-link">build</a>()</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Builds the object after all configuration has been set.</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="SmtpAppender.Builder.html" title="class in org.apache.logging.log4j.core.appender">SmtpAppender.Builder</a></code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#setBcc(java.lang.String)" class="member-name-link">setBcc</a><wbr>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> bcc)</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Comma-separated list of BCC email addresses.</div> |
| </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="SmtpAppender.Builder.html" title="class in org.apache.logging.log4j.core.appender">SmtpAppender.Builder</a></code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#setBufferSize(int)" class="member-name-link">setBufferSize</a><wbr>(int bufferSize)</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Number of log events to buffer before sending an email.</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="SmtpAppender.Builder.html" title="class in org.apache.logging.log4j.core.appender">SmtpAppender.Builder</a></code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#setCc(java.lang.String)" class="member-name-link">setCc</a><wbr>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> cc)</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Comma-separated list of CC email addresses.</div> |
| </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="SmtpAppender.Builder.html" title="class in org.apache.logging.log4j.core.appender">SmtpAppender.Builder</a></code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#setFilter(org.apache.logging.log4j.core.Filter)" class="member-name-link">setFilter</a><wbr>(<a href="../Filter.html" title="interface in org.apache.logging.log4j.core">Filter</a> filter)</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Specifies the filter used for this appender.</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="SmtpAppender.Builder.html" title="class in org.apache.logging.log4j.core.appender">SmtpAppender.Builder</a></code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#setFrom(java.lang.String)" class="member-name-link">setFrom</a><wbr>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> from)</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Email address of the sender.</div> |
| </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="SmtpAppender.Builder.html" title="class in org.apache.logging.log4j.core.appender">SmtpAppender.Builder</a></code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#setLayout(org.apache.logging.log4j.core.Layout)" class="member-name-link">setLayout</a><wbr>(<a href="../Layout.html" title="interface in org.apache.logging.log4j.core">Layout</a><? extends <a href="https://docs.oracle.com/javase/8/docs/api/java/io/Serializable.html" title="class or interface in java.io" class="external-link">Serializable</a>> layout)</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Specifies the layout used for the email message body.</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="SmtpAppender.Builder.html" title="class in org.apache.logging.log4j.core.appender">SmtpAppender.Builder</a></code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#setReplyTo(java.lang.String)" class="member-name-link">setReplyTo</a><wbr>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> replyTo)</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Comma-separated list of Reply-To email addresses.</div> |
| </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="SmtpAppender.Builder.html" title="class in org.apache.logging.log4j.core.appender">SmtpAppender.Builder</a></code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#setSmtpDebug(boolean)" class="member-name-link">setSmtpDebug</a><wbr>(boolean smtpDebug)</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Enables or disables mail session debugging on STDOUT.</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="SmtpAppender.Builder.html" title="class in org.apache.logging.log4j.core.appender">SmtpAppender.Builder</a></code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#setSmtpHost(java.lang.String)" class="member-name-link">setSmtpHost</a><wbr>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> smtpHost)</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Host name of SMTP server to send messages through.</div> |
| </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="SmtpAppender.Builder.html" title="class in org.apache.logging.log4j.core.appender">SmtpAppender.Builder</a></code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#setSmtpPassword(java.lang.String)" class="member-name-link">setSmtpPassword</a><wbr>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> smtpPassword)</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Password to authenticate with SMTP server.</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="SmtpAppender.Builder.html" title="class in org.apache.logging.log4j.core.appender">SmtpAppender.Builder</a></code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#setSmtpPort(int)" class="member-name-link">setSmtpPort</a><wbr>(int smtpPort)</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Port number of SMTP server to send messages through.</div> |
| </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="SmtpAppender.Builder.html" title="class in org.apache.logging.log4j.core.appender">SmtpAppender.Builder</a></code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#setSmtpProtocol(java.lang.String)" class="member-name-link">setSmtpProtocol</a><wbr>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> smtpProtocol)</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Transport protocol to use for SMTP such as "smtp" or "smtps".</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="SmtpAppender.Builder.html" title="class in org.apache.logging.log4j.core.appender">SmtpAppender.Builder</a></code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#setSmtpUsername(java.lang.String)" class="member-name-link">setSmtpUsername</a><wbr>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> smtpUsername)</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Username to authenticate with SMTP server.</div> |
| </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="SmtpAppender.Builder.html" title="class in org.apache.logging.log4j.core.appender">SmtpAppender.Builder</a></code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#setSslConfiguration(org.apache.logging.log4j.core.net.ssl.SslConfiguration)" class="member-name-link">setSslConfiguration</a><wbr>(<a href="../net/ssl/SslConfiguration.html" title="class in org.apache.logging.log4j.core.net.ssl">SslConfiguration</a> sslConfiguration)</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Specifies an SSL configuration for smtps connections.</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="SmtpAppender.Builder.html" title="class in org.apache.logging.log4j.core.appender">SmtpAppender.Builder</a></code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#setSubject(java.lang.String)" class="member-name-link">setSubject</a><wbr>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> subject)</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Subject template for the email messages.</div> |
| </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="SmtpAppender.Builder.html" title="class in org.apache.logging.log4j.core.appender">SmtpAppender.Builder</a></code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#setTo(java.lang.String)" class="member-name-link">setTo</a><wbr>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> to)</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Comma-separated list of recipient email addresses.</div> |
| </div> |
| </div> |
| </div> |
| </div> |
| <div class="inherited-list"> |
| <h3 id="methods-inherited-from-class-org.apache.logging.log4j.core.appender.AbstractAppender.Builder">Methods inherited from class org.apache.logging.log4j.core.appender.<a href="AbstractAppender.Builder.html" title="class in org.apache.logging.log4j.core.appender">AbstractAppender.Builder</a></h3> |
| <code><a href="AbstractAppender.Builder.html#getConfiguration()">getConfiguration</a>, <a href="AbstractAppender.Builder.html#getErrorPrefix()">getErrorPrefix</a>, <a href="AbstractAppender.Builder.html#getLayout()">getLayout</a>, <a href="AbstractAppender.Builder.html#getName()">getName</a>, <a href="AbstractAppender.Builder.html#getOrCreateLayout()">getOrCreateLayout</a>, <a href="AbstractAppender.Builder.html#getOrCreateLayout(java.nio.charset.Charset)">getOrCreateLayout</a>, <a href="AbstractAppender.Builder.html#isIgnoreExceptions()">isIgnoreExceptions</a>, <a href="AbstractAppender.Builder.html#setConfiguration(org.apache.logging.log4j.core.config.Configuration)">setConfiguration</a>, <a href="AbstractAppender.Builder.html#setIgnoreExceptions(boolean)">setIgnoreExceptions</a>, <a href="AbstractAppender.Builder.html#setName(java.lang.String)">setName</a>, <a href="AbstractAppender.Builder.html#withConfiguration(org.apache.logging.log4j.core.config.Configuration)">withConfiguration</a>, <a href="AbstractAppender.Builder.html#withIgnoreExceptions(boolean)">withIgnoreExceptions</a>, <a href="AbstractAppender.Builder.html#withLayout(org.apache.logging.log4j.core.Layout)">withLayout</a>, <a href="AbstractAppender.Builder.html#withName(java.lang.String)">withName</a></code></div> |
| <div class="inherited-list"> |
| <h3 id="methods-inherited-from-class-org.apache.logging.log4j.core.filter.AbstractFilterable.Builder">Methods inherited from class org.apache.logging.log4j.core.filter.<a href="../filter/AbstractFilterable.Builder.html" title="class in org.apache.logging.log4j.core.filter">AbstractFilterable.Builder</a></h3> |
| <code><a href="../filter/AbstractFilterable.Builder.html#asBuilder()">asBuilder</a>, <a href="../filter/AbstractFilterable.Builder.html#getFilter()">getFilter</a>, <a href="../filter/AbstractFilterable.Builder.html#getPropertyArray()">getPropertyArray</a>, <a href="../filter/AbstractFilterable.Builder.html#setPropertyArray(org.apache.logging.log4j.core.config.Property%5B%5D)">setPropertyArray</a>, <a href="../filter/AbstractFilterable.Builder.html#withFilter(org.apache.logging.log4j.core.Filter)">withFilter</a></code></div> |
| <div class="inherited-list"> |
| <h3 id="methods-inherited-from-class-java.lang.Object">Methods inherited from class java.lang.<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a></h3> |
| <code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#clone--" title="class or interface in java.lang" class="external-link">clone</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#equals-java.lang.Object-" title="class or interface in java.lang" class="external-link">equals</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#finalize--" title="class or interface in java.lang" class="external-link">finalize</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#getClass--" title="class or interface in java.lang" class="external-link">getClass</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#hashCode--" title="class or interface in java.lang" class="external-link">hashCode</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#notify--" title="class or interface in java.lang" class="external-link">notify</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#notifyAll--" title="class or interface in java.lang" class="external-link">notifyAll</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#toString--" title="class or interface in java.lang" class="external-link">toString</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait--" title="class or interface in java.lang" class="external-link">wait</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait-long-" title="class or interface in java.lang" class="external-link">wait</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait-long-int-" title="class or interface in java.lang" class="external-link">wait</a></code></div> |
| <div class="inherited-list"> |
| <h3 id="methods-inherited-from-class-org.apache.logging.log4j.core.util.Builder">Methods inherited from interface org.apache.logging.log4j.core.util.<a href="../util/Builder.html" title="interface in org.apache.logging.log4j.core.util">Builder</a></h3> |
| <code><a href="../util/Builder.html#getErrorPrefix()">getErrorPrefix</a>, <a href="../util/Builder.html#isValid()">isValid</a></code></div> |
| </section> |
| </li> |
| </ul> |
| </section> |
| <section class="details"> |
| <ul class="details-list"> |
| <!-- ========= CONSTRUCTOR DETAIL ======== --> |
| <li> |
| <section class="constructor-details" id="constructor-detail"> |
| <h2>Constructor Details</h2> |
| <ul class="member-list"> |
| <li> |
| <section class="detail" id="<init>()"> |
| <h3>Builder</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="element-name">Builder</span>()</div> |
| </section> |
| </li> |
| </ul> |
| </section> |
| </li> |
| <!-- ============ METHOD DETAIL ========== --> |
| <li> |
| <section class="method-details" id="method-detail"> |
| <h2>Method Details</h2> |
| <ul class="member-list"> |
| <li> |
| <section class="detail" id="setTo(java.lang.String)"> |
| <h3>setTo</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="SmtpAppender.Builder.html" title="class in org.apache.logging.log4j.core.appender">SmtpAppender.Builder</a></span> <span class="element-name">setTo</span><wbr><span class="parameters">(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> to)</span></div> |
| <div class="block">Comma-separated list of recipient email addresses.</div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="setCc(java.lang.String)"> |
| <h3>setCc</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="SmtpAppender.Builder.html" title="class in org.apache.logging.log4j.core.appender">SmtpAppender.Builder</a></span> <span class="element-name">setCc</span><wbr><span class="parameters">(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> cc)</span></div> |
| <div class="block">Comma-separated list of CC email addresses.</div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="setBcc(java.lang.String)"> |
| <h3>setBcc</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="SmtpAppender.Builder.html" title="class in org.apache.logging.log4j.core.appender">SmtpAppender.Builder</a></span> <span class="element-name">setBcc</span><wbr><span class="parameters">(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> bcc)</span></div> |
| <div class="block">Comma-separated list of BCC email addresses.</div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="setFrom(java.lang.String)"> |
| <h3>setFrom</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="SmtpAppender.Builder.html" title="class in org.apache.logging.log4j.core.appender">SmtpAppender.Builder</a></span> <span class="element-name">setFrom</span><wbr><span class="parameters">(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> from)</span></div> |
| <div class="block">Email address of the sender.</div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="setReplyTo(java.lang.String)"> |
| <h3>setReplyTo</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="SmtpAppender.Builder.html" title="class in org.apache.logging.log4j.core.appender">SmtpAppender.Builder</a></span> <span class="element-name">setReplyTo</span><wbr><span class="parameters">(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> replyTo)</span></div> |
| <div class="block">Comma-separated list of Reply-To email addresses.</div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="setSubject(java.lang.String)"> |
| <h3>setSubject</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="SmtpAppender.Builder.html" title="class in org.apache.logging.log4j.core.appender">SmtpAppender.Builder</a></span> <span class="element-name">setSubject</span><wbr><span class="parameters">(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> subject)</span></div> |
| <div class="block">Subject template for the email messages.</div> |
| <dl class="notes"> |
| <dt>See Also:</dt> |
| <dd> |
| <ul class="see-list"> |
| <li><a href="../layout/PatternLayout.html" title="class in org.apache.logging.log4j.core.layout"><code>PatternLayout</code></a></li> |
| </ul> |
| </dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="setSmtpProtocol(java.lang.String)"> |
| <h3>setSmtpProtocol</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="SmtpAppender.Builder.html" title="class in org.apache.logging.log4j.core.appender">SmtpAppender.Builder</a></span> <span class="element-name">setSmtpProtocol</span><wbr><span class="parameters">(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> smtpProtocol)</span></div> |
| <div class="block">Transport protocol to use for SMTP such as "smtp" or "smtps". Defaults to "smtp".</div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="setSmtpHost(java.lang.String)"> |
| <h3>setSmtpHost</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="SmtpAppender.Builder.html" title="class in org.apache.logging.log4j.core.appender">SmtpAppender.Builder</a></span> <span class="element-name">setSmtpHost</span><wbr><span class="parameters">(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> smtpHost)</span></div> |
| <div class="block">Host name of SMTP server to send messages through.</div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="setSmtpPort(int)"> |
| <h3>setSmtpPort</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="SmtpAppender.Builder.html" title="class in org.apache.logging.log4j.core.appender">SmtpAppender.Builder</a></span> <span class="element-name">setSmtpPort</span><wbr><span class="parameters">(int smtpPort)</span></div> |
| <div class="block">Port number of SMTP server to send messages through.</div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="setSmtpUsername(java.lang.String)"> |
| <h3>setSmtpUsername</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="SmtpAppender.Builder.html" title="class in org.apache.logging.log4j.core.appender">SmtpAppender.Builder</a></span> <span class="element-name">setSmtpUsername</span><wbr><span class="parameters">(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> smtpUsername)</span></div> |
| <div class="block">Username to authenticate with SMTP server.</div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="setSmtpPassword(java.lang.String)"> |
| <h3>setSmtpPassword</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="SmtpAppender.Builder.html" title="class in org.apache.logging.log4j.core.appender">SmtpAppender.Builder</a></span> <span class="element-name">setSmtpPassword</span><wbr><span class="parameters">(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> smtpPassword)</span></div> |
| <div class="block">Password to authenticate with SMTP server.</div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="setSmtpDebug(boolean)"> |
| <h3>setSmtpDebug</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="SmtpAppender.Builder.html" title="class in org.apache.logging.log4j.core.appender">SmtpAppender.Builder</a></span> <span class="element-name">setSmtpDebug</span><wbr><span class="parameters">(boolean smtpDebug)</span></div> |
| <div class="block">Enables or disables mail session debugging on STDOUT. Disabled by default.</div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="setBufferSize(int)"> |
| <h3>setBufferSize</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="SmtpAppender.Builder.html" title="class in org.apache.logging.log4j.core.appender">SmtpAppender.Builder</a></span> <span class="element-name">setBufferSize</span><wbr><span class="parameters">(int bufferSize)</span></div> |
| <div class="block">Number of log events to buffer before sending an email. Defaults to 512.</div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="setSslConfiguration(org.apache.logging.log4j.core.net.ssl.SslConfiguration)"> |
| <h3>setSslConfiguration</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="SmtpAppender.Builder.html" title="class in org.apache.logging.log4j.core.appender">SmtpAppender.Builder</a></span> <span class="element-name">setSslConfiguration</span><wbr><span class="parameters">(<a href="../net/ssl/SslConfiguration.html" title="class in org.apache.logging.log4j.core.net.ssl">SslConfiguration</a> sslConfiguration)</span></div> |
| <div class="block">Specifies an SSL configuration for smtps connections.</div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="setLayout(org.apache.logging.log4j.core.Layout)"> |
| <h3>setLayout</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="SmtpAppender.Builder.html" title="class in org.apache.logging.log4j.core.appender">SmtpAppender.Builder</a></span> <span class="element-name">setLayout</span><wbr><span class="parameters">(<a href="../Layout.html" title="interface in org.apache.logging.log4j.core">Layout</a><? extends <a href="https://docs.oracle.com/javase/8/docs/api/java/io/Serializable.html" title="class or interface in java.io" class="external-link">Serializable</a>> layout)</span></div> |
| <div class="block">Specifies the layout used for the email message body. By default, this uses the |
| <a href="../layout/HtmlLayout.html#createDefaultLayout()">default HTML layout</a>.</div> |
| <dl class="notes"> |
| <dt>Overrides:</dt> |
| <dd><code><a href="AbstractAppender.Builder.html#setLayout(org.apache.logging.log4j.core.Layout)">setLayout</a></code> in class <code><a href="AbstractAppender.Builder.html" title="class in org.apache.logging.log4j.core.appender">AbstractAppender.Builder</a><<a href="SmtpAppender.Builder.html" title="class in org.apache.logging.log4j.core.appender">SmtpAppender.Builder</a>></code></dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="setFilter(org.apache.logging.log4j.core.Filter)"> |
| <h3>setFilter</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="SmtpAppender.Builder.html" title="class in org.apache.logging.log4j.core.appender">SmtpAppender.Builder</a></span> <span class="element-name">setFilter</span><wbr><span class="parameters">(<a href="../Filter.html" title="interface in org.apache.logging.log4j.core">Filter</a> filter)</span></div> |
| <div class="block">Specifies the filter used for this appender. By default, uses a <a href="../filter/ThresholdFilter.html" title="class in org.apache.logging.log4j.core.filter"><code>ThresholdFilter</code></a> with a level of |
| ERROR.</div> |
| <dl class="notes"> |
| <dt>Overrides:</dt> |
| <dd><code><a href="../filter/AbstractFilterable.Builder.html#setFilter(org.apache.logging.log4j.core.Filter)">setFilter</a></code> in class <code><a href="../filter/AbstractFilterable.Builder.html" title="class in org.apache.logging.log4j.core.filter">AbstractFilterable.Builder</a><<a href="SmtpAppender.Builder.html" title="class in org.apache.logging.log4j.core.appender">SmtpAppender.Builder</a>></code></dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="build()"> |
| <h3>build</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="SmtpAppender.html" title="class in org.apache.logging.log4j.core.appender">SmtpAppender</a></span> <span class="element-name">build</span>()</div> |
| <div class="block"><span class="descfrm-type-label">Description copied from interface: <code><a href="../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 class="notes"> |
| <dt>Specified by:</dt> |
| <dd><code><a href="../util/Builder.html#build()">build</a></code> in interface <code><a href="../util/Builder.html" title="interface in org.apache.logging.log4j.core.util">Builder</a><<a href="SmtpAppender.html" title="class in org.apache.logging.log4j.core.appender">SmtpAppender</a>></code></dd> |
| <dt>Returns:</dt> |
| <dd>the configured instance.</dd> |
| </dl> |
| </section> |
| </li> |
| </ul> |
| </section> |
| </li> |
| </ul> |
| </section> |
| <!-- ========= END OF CLASS DATA ========= --> |
| </main> |
| <footer role="contentinfo"> |
| <hr> |
| <p class="legal-copy"><small><p align="center"> Copyright © 1999-2024 <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> |
| </footer> |
| </div> |
| </div> |
| </body> |
| </html> |
