| <!DOCTYPE HTML> |
| <html lang="en"> |
| <head> |
| <!-- Generated by javadoc (17) --> |
| <title>SendMailCommand (Apache JMeter dist 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.jmeter.protocol.smtp.sampler.protocol, class: SendMailCommand"> |
| <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> |
| <div class="about-language"><b>Apache JMeter</b></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="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.jmeter.protocol.smtp.sampler.protocol</a></div> |
| <h1 title="Class SendMailCommand" class="title">Class SendMailCommand</h1> |
| </div> |
| <div class="inheritance" title="Inheritance Tree"><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">java.lang.Object</a> |
| <div class="inheritance">org.apache.jmeter.protocol.smtp.sampler.protocol.SendMailCommand</div> |
| </div> |
| <section class="class-description" id="class-description"> |
| <hr> |
| <div class="type-signature"><span class="modifiers">public class </span><span class="element-name type-name-label">SendMailCommand</span> |
| <span class="extends-implements">extends <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a></span></div> |
| <div class="block">This class performs all tasks necessary to send a message (build message, |
| prepare connection, send message). Provides getter-/setter-methods for an |
| SmtpSampler-object to configure transport and message settings. The |
| send-mail-command itself is started by the SmtpSampler-object.</div> |
| </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">SendMailCommand</a>()</code></div> |
| <div class="col-last even-row-color"> |
| <div class="block">Standard-Constructor</div> |
| </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>void</code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#addAttachment(java.io.File)" class="member-name-link">addAttachment</a><wbr>(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/io/File.html" title="class or interface in java.io" class="external-link">File</a> attachment)</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Adds an attachment to current message - to be called by |
| SmtpSampler-object</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>void</code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#addHeader(java.lang.String,java.lang.String)" class="member-name-link">addHeader</a><wbr>(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> headerName, |
| <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> headerValue)</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Adds a header-part to current HashMap of headers - to be called by |
| SmtpSampler-object</div> |
| </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>void</code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#clearAttachments()" class="member-name-link">clearAttachments</a>()</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Clear all attachments for current message</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>void</code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#clearHeaders()" class="member-name-link">clearHeaders</a>()</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Deletes all current headers in HashMap</div> |
| </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>void</code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#execute()" class="member-name-link">execute</a>()</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Processes prepareMessage() and execute()</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>void</code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#execute(javax.mail.Message)" class="member-name-link">execute</a><wbr>(javax.mail.Message message)</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Sends message to mailserver, waiting for delivery if using synchronous |
| mode.</div> |
| </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/util/List.html" title="class or interface in java.util" class="external-link">List</a><<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/io/File.html" title="class or interface in java.io" class="external-link">File</a>></code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getAttachments()" class="member-name-link">getAttachments</a>()</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Returns all attachment for current message - standard getter</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a></code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getConnectionTimeout()" class="member-name-link">getConnectionTimeout</a>()</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Returns connection timeout for the SMTP-connection - returns the |
| default connection timeout if no value has been supplied.</div> |
| </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="../../../../testelement/property/CollectionProperty.html" title="class in org.apache.jmeter.testelement.property">CollectionProperty</a></code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getHeaders()" class="member-name-link">getHeaders</a>()</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Returns headers for current message - standard getter</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a></code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getPassword()" class="member-name-link">getPassword</a>()</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Returns password to authenticate at the mailserver - standard getter</div> |
| </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/util/List.html" title="class or interface in java.util" class="external-link">List</a><javax.mail.internet.InternetAddress></code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getReceiverBCC()" class="member-name-link">getReceiverBCC</a>()</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Returns receivers of current message as <code>InternetAddress</code> ("bcc") - standard |
| getter</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/util/List.html" title="class or interface in java.util" class="external-link">List</a><javax.mail.internet.InternetAddress></code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getReceiverCC()" class="member-name-link">getReceiverCC</a>()</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Returns receivers of current message as <code>InternetAddress</code> ("cc") - standard |
| getter</div> |
| </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a></code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getSender()" class="member-name-link">getSender</a>()</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Returns sender-address for current message - standard getter</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a></code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getSmtpPort()" class="member-name-link">getSmtpPort</a>()</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Returns port to be used for SMTP-connection (standard 25 or 465) - |
| standard getter</div> |
| </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a></code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getSmtpServer()" class="member-name-link">getSmtpServer</a>()</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Returns FQDN or IP of SMTP-server to be used to send message - standard |
| getter</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a></code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getSubject()" class="member-name-link">getSubject</a>()</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Returns subject for current message - standard getter</div> |
| </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a></code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getTimeout()" class="member-name-link">getTimeout</a>()</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Returns timeout for the SMTP-connection - returns the |
| default timeout if no value has been supplied.</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a></code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getTlsProtocolsToUse()" class="member-name-link">getTlsProtocolsToUse</a>()</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a></code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getUsername()" class="member-name-link">getUsername</a>()</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Returns username to authenticate at the mailserver - standard getter</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>boolean</code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getUseSSL()" class="member-name-link">getUseSSL</a>()</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Returns if SSL is used to send message - standard getter</div> |
| </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>boolean</code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getUseStartTLS()" class="member-name-link">getUseStartTLS</a>()</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Returns if StartTLS is used to transmit message - standard getter</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>boolean</code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#isEnforceStartTLS()" class="member-name-link">isEnforceStartTLS</a>()</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Returns if StartTLS is enforced to secure the connection, i.e.</div> |
| </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>boolean</code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#isSynchronousMode()" class="member-name-link">isSynchronousMode</a>()</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Returns if synchronous-mode is used for current message (i.e.</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>boolean</code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#isTrustAllCerts()" class="member-name-link">isTrustAllCerts</a>()</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Returns if sampler should trust all certificates - standard getter</div> |
| </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>boolean</code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#isUseAuthentication()" class="member-name-link">isUseAuthentication</a>()</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Returns if authentication is used to access the mailserver - standard |
| getter</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>javax.mail.Message</code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#prepareMessage()" class="member-name-link">prepareMessage</a>()</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Prepares message prior to be sent via execute()-method, i.e.</div> |
| </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>void</code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#setAttachments(java.util.List)" class="member-name-link">setAttachments</a><wbr>(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/util/List.html" title="class or interface in java.util" class="external-link">List</a><<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/io/File.html" title="class or interface in java.io" class="external-link">File</a>> attachments)</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Adds attachments to current message</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>void</code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#setConnectionTimeOut(java.lang.String)" class="member-name-link">setConnectionTimeOut</a><wbr>(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> connectionTimeOut)</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>void</code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#setEmlMessage(java.lang.String)" class="member-name-link">setEmlMessage</a><wbr>(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> emlMessage)</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Sets eml-message to be sent</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>void</code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#setEnableDebug(boolean)" class="member-name-link">setEnableDebug</a><wbr>(boolean selected)</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>void</code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#setEnforceStartTLS(boolean)" class="member-name-link">setEnforceStartTLS</a><wbr>(boolean enforceStartTLS)</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Instructs object to enforce StartTLS and not to fallback to plain |
| SMTP-connection - to be called by SmtpSampler-object</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>void</code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#setHeaderFields(org.apache.jmeter.testelement.property.CollectionProperty)" class="member-name-link">setHeaderFields</a><wbr>(<a href="../../../../testelement/property/CollectionProperty.html" title="class in org.apache.jmeter.testelement.property">CollectionProperty</a> headerFields)</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Sets headers for current message</div> |
| </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>void</code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#setMailBody(java.lang.String)" class="member-name-link">setMailBody</a><wbr>(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> body)</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Set the mail body.</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>void</code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#setPassword(java.lang.String)" class="member-name-link">setPassword</a><wbr>(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> password)</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Sets password to authenticate at the mailserver - to be called by |
| SmtpSampler-object</div> |
| </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>void</code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#setPlainBody(boolean)" class="member-name-link">setPlainBody</a><wbr>(boolean plainBody)</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Set whether to send a plain body (i.e.</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>void</code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#setReceiverBCC(java.util.List)" class="member-name-link">setReceiverBCC</a><wbr>(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/util/List.html" title="class or interface in java.util" class="external-link">List</a><javax.mail.internet.InternetAddress> receiverBCC)</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Sets receivers of current message ("bcc") - to be called by |
| SmtpSampler-object</div> |
| </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>void</code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#setReceiverCC(java.util.List)" class="member-name-link">setReceiverCC</a><wbr>(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/util/List.html" title="class or interface in java.util" class="external-link">List</a><javax.mail.internet.InternetAddress> receiverCC)</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Sets receivers of current message ("cc") - to be called by |
| SmtpSampler-object</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>void</code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#setReceiverTo(java.util.List)" class="member-name-link">setReceiverTo</a><wbr>(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/util/List.html" title="class or interface in java.util" class="external-link">List</a><javax.mail.internet.InternetAddress> receiverTo)</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Sets receivers of current message ("to") - to be called by |
| SmtpSampler-object</div> |
| </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>void</code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#setReplyTo(java.util.List)" class="member-name-link">setReplyTo</a><wbr>(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/util/List.html" title="class or interface in java.util" class="external-link">List</a><javax.mail.internet.InternetAddress> replyTo)</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>void</code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#setSender(java.lang.String)" class="member-name-link">setSender</a><wbr>(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> sender)</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Sets the sender-address for the current message - to be called by |
| SmtpSampler-object</div> |
| </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>void</code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#setSmtpPort(java.lang.String)" class="member-name-link">setSmtpPort</a><wbr>(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> smtpPort)</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Sets port to be used for SMTP-connection (standard 25 or 465) - to be |
| called by SmtpSampler-object</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>void</code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#setSmtpServer(java.lang.String)" class="member-name-link">setSmtpServer</a><wbr>(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> smtpServer)</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Sets FQDN or IP of SMTP-server to be used to send message - to be called |
| by SmtpSampler-object</div> |
| </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>void</code></div> |
| <div class="col-second even-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/en/java/javase/11/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> subject)</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Sets subject for current message - called by SmtpSampler-object</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>void</code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#setSynchronousMode(boolean)" class="member-name-link">setSynchronousMode</a><wbr>(boolean synchronousMode)</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Sets the use of synchronous-mode (i.e.</div> |
| </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>void</code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#setTimeOut(java.lang.String)" class="member-name-link">setTimeOut</a><wbr>(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> timeOut)</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>void</code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#setTlsProtocolsToUse(java.lang.String)" class="member-name-link">setTlsProtocolsToUse</a><wbr>(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> tlsProtocols)</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Sets the list of protocols to be used on TLS handshake</div> |
| </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>void</code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#setTrustAllCerts(boolean)" class="member-name-link">setTrustAllCerts</a><wbr>(boolean trustAllCerts)</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Determines if SMTP-sampler should trust all certificates, no matter what |
| CA - to be called by SmtpSampler-object</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>void</code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#setTrustStoreToUse(java.lang.String)" class="member-name-link">setTrustStoreToUse</a><wbr>(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> trustStoreToUse)</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Sets the path to the local truststore to be used for SSL / StartTLS - to |
| be called by SmtpSampler-object</div> |
| </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>void</code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#setUseAuthentication(boolean)" class="member-name-link">setUseAuthentication</a><wbr>(boolean useAuthentication)</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Sets if authentication should be used to access the mailserver - to be |
| called by SmtpSampler-object</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>void</code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#setUseEmlMessage(boolean)" class="member-name-link">setUseEmlMessage</a><wbr>(boolean sendEmlMessage)</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>void</code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#setUseLocalTrustStore(boolean)" class="member-name-link">setUseLocalTrustStore</a><wbr>(boolean useLocalTrustStore)</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Assigns the object to use a local truststore for SSL / StartTLS - to be |
| called by SmtpSampler-object</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>void</code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#setUsername(java.lang.String)" class="member-name-link">setUsername</a><wbr>(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> username)</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Sets username to authenticate at the mailserver - to be called by |
| SmtpSampler-object</div> |
| </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>void</code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#setUseSSL(boolean)" class="member-name-link">setUseSSL</a><wbr>(boolean useSSL)</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Sets SSL to secure the delivery channel for the message - to be called by |
| SmtpSampler-object</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>void</code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#setUseStartTLS(boolean)" class="member-name-link">setUseStartTLS</a><wbr>(boolean useStartTLS)</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Sets StartTLS to secure the delivery channel for the message - to be |
| called by SmtpSampler-object</div> |
| </div> |
| </div> |
| </div> |
| </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/en/java/javase/11/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a></h3> |
| <code><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html#clone()" title="class or interface in java.lang" class="external-link">clone</a>, <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/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/en/java/javase/11/docs/api/java.base/java/lang/Object.html#finalize()" title="class or interface in java.lang" class="external-link">finalize</a>, <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html#getClass()" title="class or interface in java.lang" class="external-link">getClass</a>, <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html#hashCode()" title="class or interface in java.lang" class="external-link">hashCode</a>, <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html#notify()" title="class or interface in java.lang" class="external-link">notify</a>, <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html#notifyAll()" title="class or interface in java.lang" class="external-link">notifyAll</a>, <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html#toString()" title="class or interface in java.lang" class="external-link">toString</a>, <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html#wait()" title="class or interface in java.lang" class="external-link">wait</a>, <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html#wait(long)" title="class or interface in java.lang" class="external-link">wait</a>, <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html#wait(long,int)" title="class or interface in java.lang" class="external-link">wait</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>SendMailCommand</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="element-name">SendMailCommand</span>()</div> |
| <div class="block">Standard-Constructor</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="prepareMessage()"> |
| <h3>prepareMessage</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type">javax.mail.Message</span> <span class="element-name">prepareMessage</span>() |
| throws <span class="exceptions">javax.mail.MessagingException, |
| <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/io/IOException.html" title="class or interface in java.io" class="external-link">IOException</a></span></div> |
| <div class="block">Prepares message prior to be sent via execute()-method, i.e. sets |
| properties such as protocol, authentication, etc.</div> |
| <dl class="notes"> |
| <dt>Returns:</dt> |
| <dd>Message-object to be sent to execute()-method</dd> |
| <dt>Throws:</dt> |
| <dd><code>javax.mail.MessagingException</code> - when problems constructing or sending the mail occur</dd> |
| <dd><code><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/io/IOException.html" title="class or interface in java.io" class="external-link">IOException</a></code> - when the mail content can not be read or truststore problems |
| are detected</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="execute(javax.mail.Message)"> |
| <h3>execute</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type">void</span> <span class="element-name">execute</span><wbr><span class="parameters">(javax.mail.Message message)</span> |
| throws <span class="exceptions">javax.mail.MessagingException, |
| <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/InterruptedException.html" title="class or interface in java.lang" class="external-link">InterruptedException</a></span></div> |
| <div class="block">Sends message to mailserver, waiting for delivery if using synchronous |
| mode.</div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>message</code> - Message previously prepared by prepareMessage()</dd> |
| <dt>Throws:</dt> |
| <dd><code>javax.mail.MessagingException</code> - when problems sending the mail arise</dd> |
| <dd><code><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/InterruptedException.html" title="class or interface in java.lang" class="external-link">InterruptedException</a></code> - when interrupted while waiting for delivery in synchronous |
| mode</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="execute()"> |
| <h3>execute</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type">void</span> <span class="element-name">execute</span>() |
| throws <span class="exceptions">javax.mail.MessagingException, |
| <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/io/IOException.html" title="class or interface in java.io" class="external-link">IOException</a>, |
| <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/InterruptedException.html" title="class or interface in java.lang" class="external-link">InterruptedException</a></span></div> |
| <div class="block">Processes prepareMessage() and execute()</div> |
| <dl class="notes"> |
| <dt>Throws:</dt> |
| <dd><code><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/InterruptedException.html" title="class or interface in java.lang" class="external-link">InterruptedException</a></code> - when interrupted while waiting for delivery in synchronous |
| modus</dd> |
| <dd><code><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/io/IOException.html" title="class or interface in java.io" class="external-link">IOException</a></code> - when the mail content can not be read or truststore problems |
| are detected</dd> |
| <dd><code>javax.mail.MessagingException</code> - when problems constructing or sending the mail occur</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="getSmtpServer()"> |
| <h3>getSmtpServer</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a></span> <span class="element-name">getSmtpServer</span>()</div> |
| <div class="block">Returns FQDN or IP of SMTP-server to be used to send message - standard |
| getter</div> |
| <dl class="notes"> |
| <dt>Returns:</dt> |
| <dd>FQDN or IP of SMTP-server</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="setSmtpServer(java.lang.String)"> |
| <h3>setSmtpServer</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type">void</span> <span class="element-name">setSmtpServer</span><wbr><span class="parameters">(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> smtpServer)</span></div> |
| <div class="block">Sets FQDN or IP of SMTP-server to be used to send message - to be called |
| by SmtpSampler-object</div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>smtpServer</code> - FQDN or IP of SMTP-server</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="getSender()"> |
| <h3>getSender</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a></span> <span class="element-name">getSender</span>()</div> |
| <div class="block">Returns sender-address for current message - standard getter</div> |
| <dl class="notes"> |
| <dt>Returns:</dt> |
| <dd>sender-address</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="setSender(java.lang.String)"> |
| <h3>setSender</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type">void</span> <span class="element-name">setSender</span><wbr><span class="parameters">(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> sender)</span></div> |
| <div class="block">Sets the sender-address for the current message - to be called by |
| SmtpSampler-object</div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>sender</code> - Sender-address for current message</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="getSubject()"> |
| <h3>getSubject</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a></span> <span class="element-name">getSubject</span>()</div> |
| <div class="block">Returns subject for current message - standard getter</div> |
| <dl class="notes"> |
| <dt>Returns:</dt> |
| <dd>Subject of current message</dd> |
| </dl> |
| </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">void</span> <span class="element-name">setSubject</span><wbr><span class="parameters">(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> subject)</span></div> |
| <div class="block">Sets subject for current message - called by SmtpSampler-object</div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>subject</code> - Subject for message of current message - may be null</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="getUsername()"> |
| <h3>getUsername</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a></span> <span class="element-name">getUsername</span>()</div> |
| <div class="block">Returns username to authenticate at the mailserver - standard getter</div> |
| <dl class="notes"> |
| <dt>Returns:</dt> |
| <dd>Username for mailserver</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="setUsername(java.lang.String)"> |
| <h3>setUsername</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type">void</span> <span class="element-name">setUsername</span><wbr><span class="parameters">(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> username)</span></div> |
| <div class="block">Sets username to authenticate at the mailserver - to be called by |
| SmtpSampler-object</div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>username</code> - Username for mailserver</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="getPassword()"> |
| <h3>getPassword</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a></span> <span class="element-name">getPassword</span>()</div> |
| <div class="block">Returns password to authenticate at the mailserver - standard getter</div> |
| <dl class="notes"> |
| <dt>Returns:</dt> |
| <dd>Password for mailserver</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="setPassword(java.lang.String)"> |
| <h3>setPassword</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type">void</span> <span class="element-name">setPassword</span><wbr><span class="parameters">(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> password)</span></div> |
| <div class="block">Sets password to authenticate at the mailserver - to be called by |
| SmtpSampler-object</div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>password</code> - Password for mailserver</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="setReceiverTo(java.util.List)"> |
| <h3>setReceiverTo</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type">void</span> <span class="element-name">setReceiverTo</span><wbr><span class="parameters">(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/util/List.html" title="class or interface in java.util" class="external-link">List</a><javax.mail.internet.InternetAddress> receiverTo)</span></div> |
| <div class="block">Sets receivers of current message ("to") - to be called by |
| SmtpSampler-object</div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>receiverTo</code> - List of receivers</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="getReceiverCC()"> |
| <h3>getReceiverCC</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/util/List.html" title="class or interface in java.util" class="external-link">List</a><javax.mail.internet.InternetAddress></span> <span class="element-name">getReceiverCC</span>()</div> |
| <div class="block">Returns receivers of current message as <code>InternetAddress</code> ("cc") - standard |
| getter</div> |
| <dl class="notes"> |
| <dt>Returns:</dt> |
| <dd>List of receivers</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="setReceiverCC(java.util.List)"> |
| <h3>setReceiverCC</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type">void</span> <span class="element-name">setReceiverCC</span><wbr><span class="parameters">(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/util/List.html" title="class or interface in java.util" class="external-link">List</a><javax.mail.internet.InternetAddress> receiverCC)</span></div> |
| <div class="block">Sets receivers of current message ("cc") - to be called by |
| SmtpSampler-object</div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>receiverCC</code> - List of receivers</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="getReceiverBCC()"> |
| <h3>getReceiverBCC</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/util/List.html" title="class or interface in java.util" class="external-link">List</a><javax.mail.internet.InternetAddress></span> <span class="element-name">getReceiverBCC</span>()</div> |
| <div class="block">Returns receivers of current message as <code>InternetAddress</code> ("bcc") - standard |
| getter</div> |
| <dl class="notes"> |
| <dt>Returns:</dt> |
| <dd>List of receivers</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="setReceiverBCC(java.util.List)"> |
| <h3>setReceiverBCC</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type">void</span> <span class="element-name">setReceiverBCC</span><wbr><span class="parameters">(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/util/List.html" title="class or interface in java.util" class="external-link">List</a><javax.mail.internet.InternetAddress> receiverBCC)</span></div> |
| <div class="block">Sets receivers of current message ("bcc") - to be called by |
| SmtpSampler-object</div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>receiverBCC</code> - List of receivers</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="isUseAuthentication()"> |
| <h3>isUseAuthentication</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type">boolean</span> <span class="element-name">isUseAuthentication</span>()</div> |
| <div class="block">Returns if authentication is used to access the mailserver - standard |
| getter</div> |
| <dl class="notes"> |
| <dt>Returns:</dt> |
| <dd>True if authentication is used to access mailserver</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="setUseAuthentication(boolean)"> |
| <h3>setUseAuthentication</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type">void</span> <span class="element-name">setUseAuthentication</span><wbr><span class="parameters">(boolean useAuthentication)</span></div> |
| <div class="block">Sets if authentication should be used to access the mailserver - to be |
| called by SmtpSampler-object</div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>useAuthentication</code> - Should authentication be used to access mailserver?</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="getUseSSL()"> |
| <h3>getUseSSL</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type">boolean</span> <span class="element-name">getUseSSL</span>()</div> |
| <div class="block">Returns if SSL is used to send message - standard getter</div> |
| <dl class="notes"> |
| <dt>Returns:</dt> |
| <dd>True if SSL is used to transmit message</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="setUseSSL(boolean)"> |
| <h3>setUseSSL</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type">void</span> <span class="element-name">setUseSSL</span><wbr><span class="parameters">(boolean useSSL)</span></div> |
| <div class="block">Sets SSL to secure the delivery channel for the message - to be called by |
| SmtpSampler-object</div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>useSSL</code> - Should StartTLS be used to secure SMTP-connection?</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="getUseStartTLS()"> |
| <h3>getUseStartTLS</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type">boolean</span> <span class="element-name">getUseStartTLS</span>()</div> |
| <div class="block">Returns if StartTLS is used to transmit message - standard getter</div> |
| <dl class="notes"> |
| <dt>Returns:</dt> |
| <dd>True if StartTLS is used to transmit message</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="setUseStartTLS(boolean)"> |
| <h3>setUseStartTLS</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type">void</span> <span class="element-name">setUseStartTLS</span><wbr><span class="parameters">(boolean useStartTLS)</span></div> |
| <div class="block">Sets StartTLS to secure the delivery channel for the message - to be |
| called by SmtpSampler-object</div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>useStartTLS</code> - Should StartTLS be used to secure SMTP-connection?</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="getSmtpPort()"> |
| <h3>getSmtpPort</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a></span> <span class="element-name">getSmtpPort</span>()</div> |
| <div class="block">Returns port to be used for SMTP-connection (standard 25 or 465) - |
| standard getter</div> |
| <dl class="notes"> |
| <dt>Returns:</dt> |
| <dd>Port to be used for SMTP-connection</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="setSmtpPort(java.lang.String)"> |
| <h3>setSmtpPort</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type">void</span> <span class="element-name">setSmtpPort</span><wbr><span class="parameters">(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> smtpPort)</span></div> |
| <div class="block">Sets port to be used for SMTP-connection (standard 25 or 465) - to be |
| called by SmtpSampler-object</div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>smtpPort</code> - Port to be used for SMTP-connection</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="isTrustAllCerts()"> |
| <h3>isTrustAllCerts</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type">boolean</span> <span class="element-name">isTrustAllCerts</span>()</div> |
| <div class="block">Returns if sampler should trust all certificates - standard getter</div> |
| <dl class="notes"> |
| <dt>Returns:</dt> |
| <dd>True if all Certificates are trusted</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="setTrustAllCerts(boolean)"> |
| <h3>setTrustAllCerts</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type">void</span> <span class="element-name">setTrustAllCerts</span><wbr><span class="parameters">(boolean trustAllCerts)</span></div> |
| <div class="block">Determines if SMTP-sampler should trust all certificates, no matter what |
| CA - to be called by SmtpSampler-object</div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>trustAllCerts</code> - Should all certificates be trusted?</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="setEnforceStartTLS(boolean)"> |
| <h3>setEnforceStartTLS</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type">void</span> <span class="element-name">setEnforceStartTLS</span><wbr><span class="parameters">(boolean enforceStartTLS)</span></div> |
| <div class="block">Instructs object to enforce StartTLS and not to fallback to plain |
| SMTP-connection - to be called by SmtpSampler-object</div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>enforceStartTLS</code> - Should StartTLS be enforced?</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="isEnforceStartTLS()"> |
| <h3>isEnforceStartTLS</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type">boolean</span> <span class="element-name">isEnforceStartTLS</span>()</div> |
| <div class="block">Returns if StartTLS is enforced to secure the connection, i.e. no |
| fallback is used (plain SMTP) - standard getter</div> |
| <dl class="notes"> |
| <dt>Returns:</dt> |
| <dd>True if StartTLS is enforced</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="getHeaders()"> |
| <h3>getHeaders</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="../../../../testelement/property/CollectionProperty.html" title="class in org.apache.jmeter.testelement.property">CollectionProperty</a></span> <span class="element-name">getHeaders</span>()</div> |
| <div class="block">Returns headers for current message - standard getter</div> |
| <dl class="notes"> |
| <dt>Returns:</dt> |
| <dd>CollectionProperty of headers for current message</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="setHeaderFields(org.apache.jmeter.testelement.property.CollectionProperty)"> |
| <h3>setHeaderFields</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type">void</span> <span class="element-name">setHeaderFields</span><wbr><span class="parameters">(<a href="../../../../testelement/property/CollectionProperty.html" title="class in org.apache.jmeter.testelement.property">CollectionProperty</a> headerFields)</span></div> |
| <div class="block">Sets headers for current message</div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>headerFields</code> - CollectionProperty of headers for current message</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="addHeader(java.lang.String,java.lang.String)"> |
| <h3>addHeader</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type">void</span> <span class="element-name">addHeader</span><wbr><span class="parameters">(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> headerName, |
| <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> headerValue)</span></div> |
| <div class="block">Adds a header-part to current HashMap of headers - to be called by |
| SmtpSampler-object</div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>headerName</code> - Key for current header</dd> |
| <dd><code>headerValue</code> - Value for current header</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="clearHeaders()"> |
| <h3>clearHeaders</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type">void</span> <span class="element-name">clearHeaders</span>()</div> |
| <div class="block">Deletes all current headers in HashMap</div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="getAttachments()"> |
| <h3>getAttachments</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/util/List.html" title="class or interface in java.util" class="external-link">List</a><<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/io/File.html" title="class or interface in java.io" class="external-link">File</a>></span> <span class="element-name">getAttachments</span>()</div> |
| <div class="block">Returns all attachment for current message - standard getter</div> |
| <dl class="notes"> |
| <dt>Returns:</dt> |
| <dd>List of attachments for current message</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="setAttachments(java.util.List)"> |
| <h3>setAttachments</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type">void</span> <span class="element-name">setAttachments</span><wbr><span class="parameters">(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/util/List.html" title="class or interface in java.util" class="external-link">List</a><<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/io/File.html" title="class or interface in java.io" class="external-link">File</a>> attachments)</span></div> |
| <div class="block">Adds attachments to current message</div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>attachments</code> - List of files to be added as attachments to current message</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="addAttachment(java.io.File)"> |
| <h3>addAttachment</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type">void</span> <span class="element-name">addAttachment</span><wbr><span class="parameters">(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/io/File.html" title="class or interface in java.io" class="external-link">File</a> attachment)</span></div> |
| <div class="block">Adds an attachment to current message - to be called by |
| SmtpSampler-object</div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>attachment</code> - File-object to be added as attachment to current message</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="clearAttachments()"> |
| <h3>clearAttachments</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type">void</span> <span class="element-name">clearAttachments</span>()</div> |
| <div class="block">Clear all attachments for current message</div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="isSynchronousMode()"> |
| <h3>isSynchronousMode</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type">boolean</span> <span class="element-name">isSynchronousMode</span>()</div> |
| <div class="block">Returns if synchronous-mode is used for current message (i.e. time for |
| delivery, ... is measured) - standard getter</div> |
| <dl class="notes"> |
| <dt>Returns:</dt> |
| <dd>True if synchronous-mode is used</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="setSynchronousMode(boolean)"> |
| <h3>setSynchronousMode</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type">void</span> <span class="element-name">setSynchronousMode</span><wbr><span class="parameters">(boolean synchronousMode)</span></div> |
| <div class="block">Sets the use of synchronous-mode (i.e. time for delivery, ... is |
| measured) - to be called by SmtpSampler-object</div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>synchronousMode</code> - Should synchronous-mode be used?</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="setTimeOut(java.lang.String)"> |
| <h3>setTimeOut</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type">void</span> <span class="element-name">setTimeOut</span><wbr><span class="parameters">(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> timeOut)</span></div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>timeOut</code> - the timeOut to set</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="getTimeout()"> |
| <h3>getTimeout</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a></span> <span class="element-name">getTimeout</span>()</div> |
| <div class="block">Returns timeout for the SMTP-connection - returns the |
| default timeout if no value has been supplied.</div> |
| <dl class="notes"> |
| <dt>Returns:</dt> |
| <dd>Timeout to be set for SMTP-connection</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="setConnectionTimeOut(java.lang.String)"> |
| <h3>setConnectionTimeOut</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type">void</span> <span class="element-name">setConnectionTimeOut</span><wbr><span class="parameters">(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> connectionTimeOut)</span></div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>connectionTimeOut</code> - the connectionTimeOut to set</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="getConnectionTimeout()"> |
| <h3>getConnectionTimeout</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a></span> <span class="element-name">getConnectionTimeout</span>()</div> |
| <div class="block">Returns connection timeout for the SMTP-connection - returns the |
| default connection timeout if no value has been supplied.</div> |
| <dl class="notes"> |
| <dt>Returns:</dt> |
| <dd>Connection timeout to be set for SMTP-connection</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="setUseLocalTrustStore(boolean)"> |
| <h3>setUseLocalTrustStore</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type">void</span> <span class="element-name">setUseLocalTrustStore</span><wbr><span class="parameters">(boolean useLocalTrustStore)</span></div> |
| <div class="block">Assigns the object to use a local truststore for SSL / StartTLS - to be |
| called by SmtpSampler-object</div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>useLocalTrustStore</code> - Should a local truststore be used?</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="setTrustStoreToUse(java.lang.String)"> |
| <h3>setTrustStoreToUse</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type">void</span> <span class="element-name">setTrustStoreToUse</span><wbr><span class="parameters">(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> trustStoreToUse)</span></div> |
| <div class="block">Sets the path to the local truststore to be used for SSL / StartTLS - to |
| be called by SmtpSampler-object</div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>trustStoreToUse</code> - Path to local truststore</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="setUseEmlMessage(boolean)"> |
| <h3>setUseEmlMessage</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type">void</span> <span class="element-name">setUseEmlMessage</span><wbr><span class="parameters">(boolean sendEmlMessage)</span></div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="setEmlMessage(java.lang.String)"> |
| <h3>setEmlMessage</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type">void</span> <span class="element-name">setEmlMessage</span><wbr><span class="parameters">(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> emlMessage)</span></div> |
| <div class="block">Sets eml-message to be sent</div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>emlMessage</code> - path to eml-message</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="setMailBody(java.lang.String)"> |
| <h3>setMailBody</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type">void</span> <span class="element-name">setMailBody</span><wbr><span class="parameters">(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> body)</span></div> |
| <div class="block">Set the mail body.</div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>body</code> - the body of the mail</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="setPlainBody(boolean)"> |
| <h3>setPlainBody</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type">void</span> <span class="element-name">setPlainBody</span><wbr><span class="parameters">(boolean plainBody)</span></div> |
| <div class="block">Set whether to send a plain body (i.e. not multipart/mixed)</div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>plainBody</code> - <code>true</code> if sending a plain body (i.e. not multipart/mixed)</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="setEnableDebug(boolean)"> |
| <h3>setEnableDebug</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type">void</span> <span class="element-name">setEnableDebug</span><wbr><span class="parameters">(boolean selected)</span></div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="setReplyTo(java.util.List)"> |
| <h3>setReplyTo</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type">void</span> <span class="element-name">setReplyTo</span><wbr><span class="parameters">(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/util/List.html" title="class or interface in java.util" class="external-link">List</a><javax.mail.internet.InternetAddress> replyTo)</span></div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="setTlsProtocolsToUse(java.lang.String)"> |
| <h3>setTlsProtocolsToUse</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type">void</span> <span class="element-name">setTlsProtocolsToUse</span><wbr><span class="parameters">(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> tlsProtocols)</span></div> |
| <div class="block">Sets the list of protocols to be used on TLS handshake</div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>tlsProtocols</code> - Space separated list</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="getTlsProtocolsToUse()"> |
| <h3>getTlsProtocolsToUse</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a></span> <span class="element-name">getTlsProtocolsToUse</span>()</div> |
| </section> |
| </li> |
| </ul> |
| </section> |
| </li> |
| </ul> |
| </section> |
| <!-- ========= END OF CLASS DATA ========= --> |
| </main> |
| <footer role="contentinfo"> |
| <hr> |
| <p class="legal-copy"><small>Copyright © 1998-2024 Apache Software Foundation. All Rights Reserved.</small></p> |
| </footer> |
| </div> |
| </div> |
| </body> |
| </html> |
