Added: dev/commons/email/2.0.0-M1-RC1/site/apidocs/org/apache/commons/mail2/javax/MultiPartEmail.html ============================================================================== --- dev/commons/email/2.0.0-M1-RC1/site/apidocs/org/apache/commons/mail2/javax/MultiPartEmail.html (added) +++ dev/commons/email/2.0.0-M1-RC1/site/apidocs/org/apache/commons/mail2/javax/MultiPartEmail.html Sat Jun 15 15:07:30 2024 @@ -0,0 +1,683 @@ +<!DOCTYPE HTML> +<html lang="en"> +<head> +<!-- Generated by javadoc (17) --> +<title>MultiPartEmail (Apache Commons Email for Javax 2.0.0-M1 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.commons.mail2.javax, class: MultiPartEmail"> +<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/MultiPartEmail.html">Use</a></li> +<li><a href="package-tree.html">Tree</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.commons.mail2.javax</a></div> +<h1 title="Class MultiPartEmail" class="title">Class MultiPartEmail</h1> +</div> +<div class="inheritance" title="Inheritance Tree"><a href="https://docs.oracle.com/en/java/javase/21/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"><a href="Email.html" title="class in org.apache.commons.mail2.javax">org.apache.commons.mail2.javax.Email</a> +<div class="inheritance">org.apache.commons.mail2.javax.MultiPartEmail</div> +</div> +</div> +<section class="class-description" id="class-description"> +<dl class="notes"> +<dt>Direct Known Subclasses:</dt> +<dd><code><a href="HtmlEmail.html" title="class in org.apache.commons.mail2.javax">HtmlEmail</a></code></dd> +</dl> +<hr> +<div class="type-signature"><span class="modifiers">public class </span><span class="element-name"><a href="../../../../../src-html/org/apache/commons/mail2/javax/MultiPartEmail.html#line-56">MultiPartEmail</a></span> +<span class="extends-implements">extends <a href="Email.html" title="class in org.apache.commons.mail2.javax">Email</a></span></div> +<div class="block">A multipart email. + <p> + This class is used to send multi-part internet email like messages with attachments. + </p> + <p> + To create a multi-part email, call the default constructor and then you can call setMsg() to set the message and call the different attach() methods. + </p></div> +<dl class="notes"> +<dt>Since:</dt> +<dd>1.0</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">MultiPartEmail</a>()</code></div> +<div class="col-last even-row-color"> +<div class="block">Constructs a new instance.</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><a href="Email.html" title="class in org.apache.commons.mail2.javax">Email</a></code></div> +<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#addPart(java.lang.String,java.lang.String)" class="member-name-link">addPart</a><wbr>(<a href="https://docs.oracle.com/en/java/javase/21/docs/api/java.base/java/lang/String.html"; title="class or interface in java.lang" class="external-link">String</a> partContent, + <a href="https://docs.oracle.com/en/java/javase/21/docs/api/java.base/java/lang/String.html"; title="class or interface in java.lang" class="external-link">String</a> partContentType)</code></div> +<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> +<div class="block">Adds a new part to the email.</div> +</div> +<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="Email.html" title="class in org.apache.commons.mail2.javax">Email</a></code></div> +<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#addPart(javax.mail.internet.MimeMultipart)" class="member-name-link">addPart</a><wbr>(<a href="https://docs.oracle.com/javaee/6/api/javax/mail/internet/MimeMultipart.html"; title="class or interface in javax.mail.internet" class="external-link">MimeMultipart</a> multipart)</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 new part to the email.</div> +</div> +<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="Email.html" title="class in org.apache.commons.mail2.javax">Email</a></code></div> +<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#addPart(javax.mail.internet.MimeMultipart,int)" class="member-name-link">addPart</a><wbr>(<a href="https://docs.oracle.com/javaee/6/api/javax/mail/internet/MimeMultipart.html"; title="class or interface in javax.mail.internet" class="external-link">MimeMultipart</a> multipart, + int index)</code></div> +<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> +<div class="block">Adds a new part to the email.</div> +</div> +<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="MultiPartEmail.html" title="class in org.apache.commons.mail2.javax">MultiPartEmail</a></code></div> +<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#attach(java.io.File)" class="member-name-link">attach</a><wbr>(<a href="https://docs.oracle.com/en/java/javase/21/docs/api/java.base/java/io/File.html"; title="class or interface in java.io" class="external-link">File</a> file)</code></div> +<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> +<div class="block">Attaches a file.</div> +</div> +<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="MultiPartEmail.html" title="class in org.apache.commons.mail2.javax">MultiPartEmail</a></code></div> +<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#attach(java.net.URL,java.lang.String,java.lang.String)" class="member-name-link">attach</a><wbr>(<a href="https://docs.oracle.com/en/java/javase/21/docs/api/java.base/java/net/URL.html"; title="class or interface in java.net" class="external-link">URL</a> url, + <a href="https://docs.oracle.com/en/java/javase/21/docs/api/java.base/java/lang/String.html"; title="class or interface in java.lang" class="external-link">String</a> name, + <a href="https://docs.oracle.com/en/java/javase/21/docs/api/java.base/java/lang/String.html"; title="class or interface in java.lang" class="external-link">String</a> description)</code></div> +<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> +<div class="block">Attaches a file located by its URL.</div> +</div> +<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="MultiPartEmail.html" title="class in org.apache.commons.mail2.javax">MultiPartEmail</a></code></div> +<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#attach(java.net.URL,java.lang.String,java.lang.String,java.lang.String)" class="member-name-link">attach</a><wbr>(<a href="https://docs.oracle.com/en/java/javase/21/docs/api/java.base/java/net/URL.html"; title="class or interface in java.net" class="external-link">URL</a> url, + <a href="https://docs.oracle.com/en/java/javase/21/docs/api/java.base/java/lang/String.html"; title="class or interface in java.lang" class="external-link">String</a> name, + <a href="https://docs.oracle.com/en/java/javase/21/docs/api/java.base/java/lang/String.html"; title="class or interface in java.lang" class="external-link">String</a> description, + <a href="https://docs.oracle.com/en/java/javase/21/docs/api/java.base/java/lang/String.html"; title="class or interface in java.lang" class="external-link">String</a> disposition)</code></div> +<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> +<div class="block">Attaches a file located by its URL.</div> +</div> +<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="MultiPartEmail.html" title="class in org.apache.commons.mail2.javax">MultiPartEmail</a></code></div> +<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#attach(java.nio.file.Path,java.nio.file.OpenOption...)" class="member-name-link">attach</a><wbr>(<a href="https://docs.oracle.com/en/java/javase/21/docs/api/java.base/java/nio/file/Path.html"; title="class or interface in java.nio.file" class="external-link">Path</a> file, + <a href="https://docs.oracle.com/en/java/javase/21/docs/api/java.base/java/nio/file/OpenOption.html"; title="class or interface in java.nio.file" class="external-link">OpenOption</a>... options)</code></div> +<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> +<div class="block">Attaches a path.</div> +</div> +<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="MultiPartEmail.html" title="class in org.apache.commons.mail2.javax">MultiPartEmail</a></code></div> +<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#attach(javax.activation.DataSource,java.lang.String,java.lang.String)" class="member-name-link">attach</a><wbr>(<a href="https://docs.oracle.com/javase/8/docs/api/javax/activation/DataSource.html"; title="class or interface in javax.activation" class="external-link">DataSource</a> dataSource, + <a href="https://docs.oracle.com/en/java/javase/21/docs/api/java.base/java/lang/String.html"; title="class or interface in java.lang" class="external-link">String</a> name, + <a href="https://docs.oracle.com/en/java/javase/21/docs/api/java.base/java/lang/String.html"; title="class or interface in java.lang" class="external-link">String</a> description)</code></div> +<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> +<div class="block">Attaches a file specified as a DataSource interface.</div> +</div> +<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="MultiPartEmail.html" title="class in org.apache.commons.mail2.javax">MultiPartEmail</a></code></div> +<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#attach(javax.activation.DataSource,java.lang.String,java.lang.String,java.lang.String)" class="member-name-link">attach</a><wbr>(<a href="https://docs.oracle.com/javase/8/docs/api/javax/activation/DataSource.html"; title="class or interface in javax.activation" class="external-link">DataSource</a> dataSource, + <a href="https://docs.oracle.com/en/java/javase/21/docs/api/java.base/java/lang/String.html"; title="class or interface in java.lang" class="external-link">String</a> name, + <a href="https://docs.oracle.com/en/java/javase/21/docs/api/java.base/java/lang/String.html"; title="class or interface in java.lang" class="external-link">String</a> description, + <a href="https://docs.oracle.com/en/java/javase/21/docs/api/java.base/java/lang/String.html"; title="class or interface in java.lang" class="external-link">String</a> disposition)</code></div> +<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> +<div class="block">Attaches a file specified as a DataSource interface.</div> +</div> +<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="MultiPartEmail.html" title="class in org.apache.commons.mail2.javax">MultiPartEmail</a></code></div> +<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#attach(org.apache.commons.mail2.javax.EmailAttachment)" class="member-name-link">attach</a><wbr>(<a href="EmailAttachment.html" title="class in org.apache.commons.mail2.javax">EmailAttachment</a> attachment)</code></div> +<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> +<div class="block">Attaches an EmailAttachment.</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="#buildMimeMessage()" class="member-name-link">buildMimeMessage</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 MimeMessage.</div> +</div> +<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>protected <a href="https://docs.oracle.com/javaee/6/api/javax/mail/BodyPart.html"; title="class or interface in javax.mail" class="external-link">BodyPart</a></code></div> +<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#createBodyPart()" class="member-name-link">createBodyPart</a>()</code></div> +<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> +<div class="block">Creates a body part object.</div> +</div> +<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>protected <a href="https://docs.oracle.com/javaee/6/api/javax/mail/internet/MimeMultipart.html"; title="class or interface in javax.mail.internet" class="external-link">MimeMultipart</a></code></div> +<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#createMimeMultipart()" class="member-name-link">createMimeMultipart</a>()</code></div> +<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> +<div class="block">Creates a mime multipart object.</div> +</div> +<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>protected <a href="https://docs.oracle.com/javaee/6/api/javax/mail/internet/MimeMultipart.html"; title="class or interface in javax.mail.internet" class="external-link">MimeMultipart</a></code></div> +<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getContainer()" class="member-name-link">getContainer</a>()</code></div> +<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> +<div class="block">Gets the message container.</div> +</div> +<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>protected <a href="https://docs.oracle.com/javaee/6/api/javax/mail/BodyPart.html"; title="class or interface in javax.mail" class="external-link">BodyPart</a></code></div> +<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getPrimaryBodyPart()" class="member-name-link">getPrimaryBodyPart</a>()</code></div> +<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> +<div class="block">Gets first body part of the message.</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/21/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="#getSubType()" class="member-name-link">getSubType</a>()</code></div> +<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> +<div class="block">Gets the MIME subtype of the email.</div> +</div> +<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>protected void</code></div> +<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#init()" class="member-name-link">init</a>()</code></div> +<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> +<div class="block">Initialize the multipart email.</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="#isBoolHasAttachments()" class="member-name-link">isBoolHasAttachments</a>()</code></div> +<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> +<div class="block">Tests whether there are attachments.</div> +</div> +<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>protected boolean</code></div> +<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#isInitialized()" class="member-name-link">isInitialized</a>()</code></div> +<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> +<div class="block">Tests if this object is initialized.</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="#setBoolHasAttachments(boolean)" class="member-name-link">setBoolHasAttachments</a><wbr>(boolean hasAttachments)</code></div> +<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> +<div class="block">Sets whether there are attachments.</div> +</div> +<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>protected void</code></div> +<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#setInitialized(boolean)" class="member-name-link">setInitialized</a><wbr>(boolean initialized)</code></div> +<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> +<div class="block">Sets the initialized status of this object.</div> +</div> +<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="Email.html" title="class in org.apache.commons.mail2.javax">Email</a></code></div> +<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#setMsg(java.lang.String)" class="member-name-link">setMsg</a><wbr>(<a href="https://docs.oracle.com/en/java/javase/21/docs/api/java.base/java/lang/String.html"; title="class or interface in java.lang" class="external-link">String</a> msg)</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 message of the email.</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="#setSubType(java.lang.String)" class="member-name-link">setSubType</a><wbr>(<a href="https://docs.oracle.com/en/java/javase/21/docs/api/java.base/java/lang/String.html"; title="class or interface in java.lang" class="external-link">String</a> subType)</code></div> +<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> +<div class="block">Sets the MIME subtype of the email.</div> +</div> +</div> +</div> +</div> +<div class="inherited-list"> +<h3 id="methods-inherited-from-class-org.apache.commons.mail2.javax.Email">Methods inherited from class org.apache.commons.mail2.javax.<a href="Email.html" title="class in org.apache.commons.mail2.javax">Email</a></h3> +<code><a href="Email.html#addBcc(java.lang.String)">addBcc</a>, <a href="Email.html#addBcc(java.lang.String...)">addBcc</a>, <a href="Email.html#addBcc(java.lang.String,java.lang.String)">addBcc</a>, <a href="Email.html#addBcc(java.lang.String,java.lang.String,java.lang.String)">addBcc</a>, <a href="Email.html#addCc(java.lang.String)">addCc</a>, <a href="Email.html#addCc(java.lang.String...)">addCc</a>, <a href="Email.html#addCc(java.lang.String,java.lang.String)">addCc</a>, <a href="Email.html#addCc(java.lang.String,java.lang.String,java.lang.String)">addCc</a>, <a href="Email.html#addHeader(java.lang.String,java.lang.String)">addHeader</a>, <a href="Email.html#addReplyTo(java.lang.String)">addReplyTo</a>, <a href="Email.html#addReplyTo(java.lang.String,java.lang.String)">addReplyTo</a>, <a href="Email.html#addReplyTo(java.lang.String,java.lang.String,java.lang.String)">addReplyTo</a>, <a href="Email.html#addTo(java.lang.String)">addTo</a>, <a href="Email.html#addTo(java.lang.Strin g...)">addTo</a>, <a href="Email.html#addTo(java.lang.String,java.lang.String)">addTo</a>, <a href="Email.html#addTo(java.lang.String,java.lang.String,java.lang.String)">addTo</a>, <a href="Email.html#createMimeMessage(javax.mail.Session)">createMimeMessage</a>, <a href="Email.html#getAuthenticator()">getAuthenticator</a>, <a href="Email.html#getBccAddresses()">getBccAddresses</a>, <a href="Email.html#getBounceAddress()">getBounceAddress</a>, <a href="Email.html#getCcAddresses()">getCcAddresses</a>, <a href="Email.html#getCharsetName()">getCharsetName</a>, <a href="Email.html#getContent()">getContent</a>, <a href="Email.html#getContentType()">getContentType</a>, <a href="Email.html#getEmailBody()">getEmailBody</a>, <a href="Email.html#getFromAddress()">getFromAddress</a>, <a href="Email.html#getHeader(java.lang.String)">getHeader</a>, <a href="Email.html#getHeaders()">getHeaders</a>, <a href="Email.html#getHostName()">getHostName</a>, <a href="Email.html#getMailSession()">getMailSes sion</a>, <a href="Email.html#getMessage()">getMessage</a>, <a href="Email.html#getMimeMessage()">getMimeMessage</a>, <a href="Email.html#getPopHost()">getPopHost</a>, <a href="Email.html#getPopPassword()">getPopPassword</a>, <a href="Email.html#getPopUserName()">getPopUserName</a>, <a href="Email.html#getReplyToAddresses()">getReplyToAddresses</a>, <a href="Email.html#getSentDate()">getSentDate</a>, <a href="Email.html#getSmtpPort()">getSmtpPort</a>, <a href="Email.html#getSocketConnectionTimeout()">getSocketConnectionTimeout</a>, <a href="Email.html#getSocketTimeout()">getSocketTimeout</a>, <a href="Email.html#getSslSmtpPort()">getSslSmtpPort</a>, <a href="Email.html#getSubject()">getSubject</a>, <a href="Email.html#getToAddresses()">getToAddresses</a>, <a href="Email.html#isDebug()">isDebug</a>, <a href="Email.html#isPopBeforeSmtp()">isPopBeforeSmtp</a>, <a href="Email.html#isSendPartial()">isSendPartial</a>, <a href="Email.html#isSSLCheckServerIdentity()">isSSLCheckServerIdentit y</a>, <a href="Email.html#isSSLOnConnect()">isSSLOnConnect</a>, <a href="Email.html#isStartTLSEnabled()">isStartTLSEnabled</a>, <a href="Email.html#isStartTLSRequired()">isStartTLSRequired</a>, <a href="Email.html#send()">send</a>, <a href="Email.html#sendMimeMessage()">sendMimeMessage</a>, <a href="Email.html#setAuthentication(java.lang.String,java.lang.String)">setAuthentication</a>, <a href="Email.html#setAuthenticator(javax.mail.Authenticator)">setAuthenticator</a>, <a href="Email.html#setBcc(java.util.Collection)">setBcc</a>, <a href="Email.html#setBounceAddress(java.lang.String)">setBounceAddress</a>, <a href="Email.html#setCc(java.util.Collection)">setCc</a>, <a href="Email.html#setCharset(java.lang.String)">setCharset</a>, <a href="Email.html#setContent(java.lang.Object)">setContent</a>, <a href="Email.html#setContent(java.lang.Object,java.lang.String)">setContent</a>, <a href="Email.html#setContent(javax.mail.internet.MimeMultipart)">setContent</a>, <a href="Email.html#set ContentType(java.lang.String)">setContentType</a>, <a href="Email.html#setDebug(boolean)">setDebug</a>, <a href="Email.html#setFrom(java.lang.String)">setFrom</a>, <a href="Email.html#setFrom(java.lang.String,java.lang.String)">setFrom</a>, <a href="Email.html#setFrom(java.lang.String,java.lang.String,java.lang.String)">setFrom</a>, <a href="Email.html#setFromAddress(javax.mail.internet.InternetAddress)">setFromAddress</a>, <a href="Email.html#setHeaders(java.util.Map)">setHeaders</a>, <a href="Email.html#setHostName(java.lang.String)">setHostName</a>, <a href="Email.html#setMailSession(javax.mail.Session)">setMailSession</a>, <a href="Email.html#setMailSessionFromJNDI(java.lang.String)">setMailSessionFromJNDI</a>, <a href="Email.html#setMessage(javax.mail.internet.MimeMessage)">setMessage</a>, <a href="Email.html#setPopBeforeSmtp(boolean)">setPopBeforeSmtp</a>, <a href="Email.html#setPopBeforeSmtp(boolean,java.lang.String,java.lang.String,java.lang.String)">setPopBeforeSmtp</a>, <a href="Email.html#setPopHost(java.lang.String)">setPopHost</a>, <a href="Email.html#setPopPassword(java.lang.String)">setPopPassword</a>, <a href="Email.html#setPopUsername(java.lang.String)">setPopUsername</a>, <a href="Email.html#setReplyTo(java.util.Collection)">setReplyTo</a>, <a href="Email.html#setSendPartial(boolean)">setSendPartial</a>, <a href="Email.html#setSentDate(java.util.Date)">setSentDate</a>, <a href="Email.html#setSmtpPort(int)">setSmtpPort</a>, <a href="Email.html#setSocketConnectionTimeout(java.time.Duration)">setSocketConnectionTimeout</a>, <a href="Email.html#setSocketTimeout(java.time.Duration)">setSocketTimeout</a>, <a href="Email.html#setSSLCheckServerIdentity(boolean)">setSSLCheckServerIdentity</a>, <a href="Email.html#setSSLOnConnect(boolean)">setSSLOnConnect</a>, <a href="Email.html#setSslSmtpPort(java.lang.String)">setSslSmtpPort</a>, <a href="Email.html#setStartTLSEnabled(boolean)">setStartTLSEnabled</a>, <a href="Email.html#setStartTLSRequired(boolean) ">setStartTLSRequired</a>, <a href="Email.html#setSubject(java.lang.String)">setSubject</a>, <a href="Email.html#setTo(java.util.Collection)">setTo</a>, <a href="Email.html#toInternetAddressArray(java.util.List)">toInternetAddressArray</a>, <a href="Email.html#updateContentType(java.lang.String)">updateContentType</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/en/java/javase/21/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/21/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/21/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/21/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/21/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/21/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/21/docs/api/java.base/java/lang/Objec t.html#notify()" title="class or interface in java.lang" class="external-link">notify</a>, <a href="https://docs.oracle.com/en/java/javase/21/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/21/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/21/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/21/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/21/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>MultiPartEmail</h3> +<div class="member-signature"><span class="modifiers">public</span> <span class="element-name"><a href="../../../../../src-html/org/apache/commons/mail2/javax/MultiPartEmail.html#line-76">MultiPartEmail</a></span>()</div> +<div class="block">Constructs a new instance.</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="addPart(javax.mail.internet.MimeMultipart)"> +<h3>addPart</h3> +<div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="Email.html" title="class in org.apache.commons.mail2.javax">Email</a></span> <span class="element-name"><a href="../../../../../src-html/org/apache/commons/mail2/javax/MultiPartEmail.html#line-88">addPart</a></span><wbr><span class="parameters">(<a href="https://docs.oracle.com/javaee/6/api/javax/mail/internet/MimeMultipart.html"; title="class or interface in javax.mail.internet" class="external-link">MimeMultipart</a> multipart)</span> + throws <span class="exceptions"><a href="https://commons.apache.org/proper/commons-email/commons-email2-core/apidocs/org/apache/commons/mail2/core/EmailException.html"; title="class or interface in org.apache.commons.mail2.core" class="external-link">EmailException</a></span></div> +<div class="block">Adds a new part to the email.</div> +<dl class="notes"> +<dt>Parameters:</dt> +<dd><code>multipart</code> - The MimeMultipart.</dd> +<dt>Returns:</dt> +<dd>An Email.</dd> +<dt>Throws:</dt> +<dd><code><a href="https://commons.apache.org/proper/commons-email/commons-email2-core/apidocs/org/apache/commons/mail2/core/EmailException.html"; title="class or interface in org.apache.commons.mail2.core" class="external-link">EmailException</a></code> - see javax.mail.internet.MimeBodyPart for definitions</dd> +<dt>Since:</dt> +<dd>1.0</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="addPart(javax.mail.internet.MimeMultipart,int)"> +<h3>addPart</h3> +<div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="Email.html" title="class in org.apache.commons.mail2.javax">Email</a></span> <span class="element-name"><a href="../../../../../src-html/org/apache/commons/mail2/javax/MultiPartEmail.html#line-105">addPart</a></span><wbr><span class="parameters">(<a href="https://docs.oracle.com/javaee/6/api/javax/mail/internet/MimeMultipart.html"; title="class or interface in javax.mail.internet" class="external-link">MimeMultipart</a> multipart, + int index)</span> + throws <span class="exceptions"><a href="https://commons.apache.org/proper/commons-email/commons-email2-core/apidocs/org/apache/commons/mail2/core/EmailException.html"; title="class or interface in org.apache.commons.mail2.core" class="external-link">EmailException</a></span></div> +<div class="block">Adds a new part to the email.</div> +<dl class="notes"> +<dt>Parameters:</dt> +<dd><code>multipart</code> - The part to add.</dd> +<dd><code>index</code> - The index to add at.</dd> +<dt>Returns:</dt> +<dd>The email.</dd> +<dt>Throws:</dt> +<dd><code><a href="https://commons.apache.org/proper/commons-email/commons-email2-core/apidocs/org/apache/commons/mail2/core/EmailException.html"; title="class or interface in org.apache.commons.mail2.core" class="external-link">EmailException</a></code> - An error occurred while adding the part.</dd> +<dt>Since:</dt> +<dd>1.0</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="addPart(java.lang.String,java.lang.String)"> +<h3>addPart</h3> +<div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="Email.html" title="class in org.apache.commons.mail2.javax">Email</a></span> <span class="element-name"><a href="../../../../../src-html/org/apache/commons/mail2/javax/MultiPartEmail.html#line-126">addPart</a></span><wbr><span class="parameters">(<a href="https://docs.oracle.com/en/java/javase/21/docs/api/java.base/java/lang/String.html"; title="class or interface in java.lang" class="external-link">String</a> partContent, + <a href="https://docs.oracle.com/en/java/javase/21/docs/api/java.base/java/lang/String.html"; title="class or interface in java.lang" class="external-link">String</a> partContentType)</span> + throws <span class="exceptions"><a href="https://commons.apache.org/proper/commons-email/commons-email2-core/apidocs/org/apache/commons/mail2/core/EmailException.html"; title="class or interface in org.apache.commons.mail2.core" class="external-link">EmailException</a></span></div> +<div class="block">Adds a new part to the email.</div> +<dl class="notes"> +<dt>Parameters:</dt> +<dd><code>partContent</code> - The content.</dd> +<dd><code>partContentType</code> - The content type.</dd> +<dt>Returns:</dt> +<dd>An Email.</dd> +<dt>Throws:</dt> +<dd><code><a href="https://commons.apache.org/proper/commons-email/commons-email2-core/apidocs/org/apache/commons/mail2/core/EmailException.html"; title="class or interface in org.apache.commons.mail2.core" class="external-link">EmailException</a></code> - see javax.mail.internet.MimeBodyPart for definitions</dd> +<dt>Since:</dt> +<dd>1.0</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="attach(javax.activation.DataSource,java.lang.String,java.lang.String)"> +<h3>attach</h3> +<div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="MultiPartEmail.html" title="class in org.apache.commons.mail2.javax">MultiPartEmail</a></span> <span class="element-name"><a href="../../../../../src-html/org/apache/commons/mail2/javax/MultiPartEmail.html#line-148">attach</a></span><wbr><span class="parameters">(<a href="https://docs.oracle.com/javase/8/docs/api/javax/activation/DataSource.html"; title="class or interface in javax.activation" class="external-link">DataSource</a> dataSource, + <a href="https://docs.oracle.com/en/java/javase/21/docs/api/java.base/java/lang/String.html"; title="class or interface in java.lang" class="external-link">String</a> name, + <a href="https://docs.oracle.com/en/java/javase/21/docs/api/java.base/java/lang/String.html"; title="class or interface in java.lang" class="external-link">String</a> description)</span> + throws <span class="exceptions"><a href="https://commons.apache.org/proper/commons-email/commons-email2-core/apidocs/org/apache/commons/mail2/core/EmailException.html"; title="class or interface in org.apache.commons.mail2.core" class="external-link">EmailException</a></span></div> +<div class="block">Attaches a file specified as a DataSource interface.</div> +<dl class="notes"> +<dt>Parameters:</dt> +<dd><code>dataSource</code> - A DataSource interface for the file.</dd> +<dd><code>name</code> - The name field for the attachment.</dd> +<dd><code>description</code> - A description for the attachment.</dd> +<dt>Returns:</dt> +<dd>A MultiPartEmail.</dd> +<dt>Throws:</dt> +<dd><code><a href="https://commons.apache.org/proper/commons-email/commons-email2-core/apidocs/org/apache/commons/mail2/core/EmailException.html"; title="class or interface in org.apache.commons.mail2.core" class="external-link">EmailException</a></code> - see javax.mail.internet.MimeBodyPart for definitions</dd> +<dt>Since:</dt> +<dd>1.0</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="attach(javax.activation.DataSource,java.lang.String,java.lang.String,java.lang.String)"> +<h3>attach</h3> +<div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="MultiPartEmail.html" title="class in org.apache.commons.mail2.javax">MultiPartEmail</a></span> <span class="element-name"><a href="../../../../../src-html/org/apache/commons/mail2/javax/MultiPartEmail.html#line-170">attach</a></span><wbr><span class="parameters">(<a href="https://docs.oracle.com/javase/8/docs/api/javax/activation/DataSource.html"; title="class or interface in javax.activation" class="external-link">DataSource</a> dataSource, + <a href="https://docs.oracle.com/en/java/javase/21/docs/api/java.base/java/lang/String.html"; title="class or interface in java.lang" class="external-link">String</a> name, + <a href="https://docs.oracle.com/en/java/javase/21/docs/api/java.base/java/lang/String.html"; title="class or interface in java.lang" class="external-link">String</a> description, + <a href="https://docs.oracle.com/en/java/javase/21/docs/api/java.base/java/lang/String.html"; title="class or interface in java.lang" class="external-link">String</a> disposition)</span> + throws <span class="exceptions"><a href="https://commons.apache.org/proper/commons-email/commons-email2-core/apidocs/org/apache/commons/mail2/core/EmailException.html"; title="class or interface in org.apache.commons.mail2.core" class="external-link">EmailException</a></span></div> +<div class="block">Attaches a file specified as a DataSource interface.</div> +<dl class="notes"> +<dt>Parameters:</dt> +<dd><code>dataSource</code> - A DataSource interface for the file.</dd> +<dd><code>name</code> - The name field for the attachment.</dd> +<dd><code>description</code> - A description for the attachment.</dd> +<dd><code>disposition</code> - Either mixed or inline.</dd> +<dt>Returns:</dt> +<dd>A MultiPartEmail.</dd> +<dt>Throws:</dt> +<dd><code><a href="https://commons.apache.org/proper/commons-email/commons-email2-core/apidocs/org/apache/commons/mail2/core/EmailException.html"; title="class or interface in org.apache.commons.mail2.core" class="external-link">EmailException</a></code> - see javax.mail.internet.MimeBodyPart for definitions</dd> +<dt>Since:</dt> +<dd>1.0</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="attach(org.apache.commons.mail2.javax.EmailAttachment)"> +<h3>attach</h3> +<div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="MultiPartEmail.html" title="class in org.apache.commons.mail2.javax">MultiPartEmail</a></span> <span class="element-name"><a href="../../../../../src-html/org/apache/commons/mail2/javax/MultiPartEmail.html#line-197">attach</a></span><wbr><span class="parameters">(<a href="EmailAttachment.html" title="class in org.apache.commons.mail2.javax">EmailAttachment</a> attachment)</span> + throws <span class="exceptions"><a href="https://commons.apache.org/proper/commons-email/commons-email2-core/apidocs/org/apache/commons/mail2/core/EmailException.html"; title="class or interface in org.apache.commons.mail2.core" class="external-link">EmailException</a></span></div> +<div class="block">Attaches an EmailAttachment.</div> +<dl class="notes"> +<dt>Parameters:</dt> +<dd><code>attachment</code> - An EmailAttachment.</dd> +<dt>Returns:</dt> +<dd>A MultiPartEmail.</dd> +<dt>Throws:</dt> +<dd><code><a href="https://commons.apache.org/proper/commons-email/commons-email2-core/apidocs/org/apache/commons/mail2/core/EmailException.html"; title="class or interface in org.apache.commons.mail2.core" class="external-link">EmailException</a></code> - see javax.mail.internet.MimeBodyPart for definitions</dd> +<dt>Since:</dt> +<dd>1.0</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="attach(java.io.File)"> +<h3>attach</h3> +<div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="MultiPartEmail.html" title="class in org.apache.commons.mail2.javax">MultiPartEmail</a></span> <span class="element-name"><a href="../../../../../src-html/org/apache/commons/mail2/javax/MultiPartEmail.html#line-227">attach</a></span><wbr><span class="parameters">(<a href="https://docs.oracle.com/en/java/javase/21/docs/api/java.base/java/io/File.html"; title="class or interface in java.io" class="external-link">File</a> file)</span> + throws <span class="exceptions"><a href="https://commons.apache.org/proper/commons-email/commons-email2-core/apidocs/org/apache/commons/mail2/core/EmailException.html"; title="class or interface in org.apache.commons.mail2.core" class="external-link">EmailException</a></span></div> +<div class="block">Attaches a file.</div> +<dl class="notes"> +<dt>Parameters:</dt> +<dd><code>file</code> - A file attachment</dd> +<dt>Returns:</dt> +<dd>A MultiPartEmail.</dd> +<dt>Throws:</dt> +<dd><code><a href="https://commons.apache.org/proper/commons-email/commons-email2-core/apidocs/org/apache/commons/mail2/core/EmailException.html"; title="class or interface in org.apache.commons.mail2.core" class="external-link">EmailException</a></code> - see javax.mail.internet.MimeBodyPart for definitions</dd> +<dt>Since:</dt> +<dd>1.3</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="attach(java.nio.file.Path,java.nio.file.OpenOption...)"> +<h3>attach</h3> +<div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="MultiPartEmail.html" title="class in org.apache.commons.mail2.javax">MultiPartEmail</a></span> <span class="element-name"><a href="../../../../../src-html/org/apache/commons/mail2/javax/MultiPartEmail.html#line-248">attach</a></span><wbr><span class="parameters">(<a href="https://docs.oracle.com/en/java/javase/21/docs/api/java.base/java/nio/file/Path.html"; title="class or interface in java.nio.file" class="external-link">Path</a> file, + <a href="https://docs.oracle.com/en/java/javase/21/docs/api/java.base/java/nio/file/OpenOption.html"; title="class or interface in java.nio.file" class="external-link">OpenOption</a>... options)</span> + throws <span class="exceptions"><a href="https://commons.apache.org/proper/commons-email/commons-email2-core/apidocs/org/apache/commons/mail2/core/EmailException.html"; title="class or interface in org.apache.commons.mail2.core" class="external-link">EmailException</a></span></div> +<div class="block">Attaches a path.</div> +<dl class="notes"> +<dt>Parameters:</dt> +<dd><code>file</code> - A file attachment.</dd> +<dd><code>options</code> - options for opening file streams.</dd> +<dt>Returns:</dt> +<dd>A MultiPartEmail.</dd> +<dt>Throws:</dt> +<dd><code><a href="https://commons.apache.org/proper/commons-email/commons-email2-core/apidocs/org/apache/commons/mail2/core/EmailException.html"; title="class or interface in org.apache.commons.mail2.core" class="external-link">EmailException</a></code> - see javax.mail.internet.MimeBodyPart for definitions</dd> +<dt>Since:</dt> +<dd>1.6.0</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="attach(java.net.URL,java.lang.String,java.lang.String)"> +<h3>attach</h3> +<div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="MultiPartEmail.html" title="class in org.apache.commons.mail2.javax">MultiPartEmail</a></span> <span class="element-name"><a href="../../../../../src-html/org/apache/commons/mail2/javax/MultiPartEmail.html#line-271">attach</a></span><wbr><span class="parameters">(<a href="https://docs.oracle.com/en/java/javase/21/docs/api/java.base/java/net/URL.html"; title="class or interface in java.net" class="external-link">URL</a> url, + <a href="https://docs.oracle.com/en/java/javase/21/docs/api/java.base/java/lang/String.html"; title="class or interface in java.lang" class="external-link">String</a> name, + <a href="https://docs.oracle.com/en/java/javase/21/docs/api/java.base/java/lang/String.html"; title="class or interface in java.lang" class="external-link">String</a> description)</span> + throws <span class="exceptions"><a href="https://commons.apache.org/proper/commons-email/commons-email2-core/apidocs/org/apache/commons/mail2/core/EmailException.html"; title="class or interface in org.apache.commons.mail2.core" class="external-link">EmailException</a></span></div> +<div class="block">Attaches a file located by its URL. The disposition of the file is set to mixed.</div> +<dl class="notes"> +<dt>Parameters:</dt> +<dd><code>url</code> - The URL of the file (may be any valid URL).</dd> +<dd><code>name</code> - The name field for the attachment.</dd> +<dd><code>description</code> - A description for the attachment.</dd> +<dt>Returns:</dt> +<dd>A MultiPartEmail.</dd> +<dt>Throws:</dt> +<dd><code><a href="https://commons.apache.org/proper/commons-email/commons-email2-core/apidocs/org/apache/commons/mail2/core/EmailException.html"; title="class or interface in org.apache.commons.mail2.core" class="external-link">EmailException</a></code> - see javax.mail.internet.MimeBodyPart for definitions</dd> +<dt>Since:</dt> +<dd>1.0</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="attach(java.net.URL,java.lang.String,java.lang.String,java.lang.String)"> +<h3>attach</h3> +<div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="MultiPartEmail.html" title="class in org.apache.commons.mail2.javax">MultiPartEmail</a></span> <span class="element-name"><a href="../../../../../src-html/org/apache/commons/mail2/javax/MultiPartEmail.html#line-286">attach</a></span><wbr><span class="parameters">(<a href="https://docs.oracle.com/en/java/javase/21/docs/api/java.base/java/net/URL.html"; title="class or interface in java.net" class="external-link">URL</a> url, + <a href="https://docs.oracle.com/en/java/javase/21/docs/api/java.base/java/lang/String.html"; title="class or interface in java.lang" class="external-link">String</a> name, + <a href="https://docs.oracle.com/en/java/javase/21/docs/api/java.base/java/lang/String.html"; title="class or interface in java.lang" class="external-link">String</a> description, + <a href="https://docs.oracle.com/en/java/javase/21/docs/api/java.base/java/lang/String.html"; title="class or interface in java.lang" class="external-link">String</a> disposition)</span> + throws <span class="exceptions"><a href="https://commons.apache.org/proper/commons-email/commons-email2-core/apidocs/org/apache/commons/mail2/core/EmailException.html"; title="class or interface in org.apache.commons.mail2.core" class="external-link">EmailException</a></span></div> +<div class="block">Attaches a file located by its URL.</div> +<dl class="notes"> +<dt>Parameters:</dt> +<dd><code>url</code> - The URL of the file (may be any valid URL).</dd> +<dd><code>name</code> - The name field for the attachment.</dd> +<dd><code>description</code> - A description for the attachment.</dd> +<dd><code>disposition</code> - Either mixed or inline.</dd> +<dt>Returns:</dt> +<dd>A MultiPartEmail.</dd> +<dt>Throws:</dt> +<dd><code><a href="https://commons.apache.org/proper/commons-email/commons-email2-core/apidocs/org/apache/commons/mail2/core/EmailException.html"; title="class or interface in org.apache.commons.mail2.core" class="external-link">EmailException</a></code> - see javax.mail.internet.MimeBodyPart for definitions</dd> +<dt>Since:</dt> +<dd>1.0</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="buildMimeMessage()"> +<h3>buildMimeMessage</h3> +<div class="member-signature"><span class="modifiers">public</span> <span class="return-type">void</span> <span class="element-name"><a href="../../../../../src-html/org/apache/commons/mail2/javax/MultiPartEmail.html#line-303">buildMimeMessage</a></span>() + throws <span class="exceptions"><a href="https://commons.apache.org/proper/commons-email/commons-email2-core/apidocs/org/apache/commons/mail2/core/EmailException.html"; title="class or interface in org.apache.commons.mail2.core" class="external-link">EmailException</a></span></div> +<div class="block">Builds the MimeMessage. Please note that a user rarely calls this method directly and only if he/she is interested in the sending the underlying + MimeMessage without commons-email.</div> +<dl class="notes"> +<dt>Overrides:</dt> +<dd><code><a href="Email.html#buildMimeMessage()">buildMimeMessage</a></code> in class <code><a href="Email.html" title="class in org.apache.commons.mail2.javax">Email</a></code></dd> +<dt>Throws:</dt> +<dd><code><a href="https://commons.apache.org/proper/commons-email/commons-email2-core/apidocs/org/apache/commons/mail2/core/EmailException.html"; title="class or interface in org.apache.commons.mail2.core" class="external-link">EmailException</a></code> - if there was an error.</dd> +<dt>Since:</dt> +<dd>1.0</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="createBodyPart()"> +<h3>createBodyPart</h3> +<div class="member-signature"><span class="modifiers">protected</span> <span class="return-type"><a href="https://docs.oracle.com/javaee/6/api/javax/mail/BodyPart.html"; title="class or interface in javax.mail" class="external-link">BodyPart</a></span> <span class="element-name"><a href="../../../../../src-html/org/apache/commons/mail2/javax/MultiPartEmail.html#line-337">createBodyPart</a></span>()</div> +<div class="block">Creates a body part object. Can be overridden if you don't want to create a BodyPart.</div> +<dl class="notes"> +<dt>Returns:</dt> +<dd>the created body part</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="createMimeMultipart()"> +<h3>createMimeMultipart</h3> +<div class="member-signature"><span class="modifiers">protected</span> <span class="return-type"><a href="https://docs.oracle.com/javaee/6/api/javax/mail/internet/MimeMultipart.html"; title="class or interface in javax.mail.internet" class="external-link">MimeMultipart</a></span> <span class="element-name"><a href="../../../../../src-html/org/apache/commons/mail2/javax/MultiPartEmail.html#line-346">createMimeMultipart</a></span>()</div> +<div class="block">Creates a mime multipart object.</div> +<dl class="notes"> +<dt>Returns:</dt> +<dd>the created mime part</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="getContainer()"> +<h3>getContainer</h3> +<div class="member-signature"><span class="modifiers">protected</span> <span class="return-type"><a href="https://docs.oracle.com/javaee/6/api/javax/mail/internet/MimeMultipart.html"; title="class or interface in javax.mail.internet" class="external-link">MimeMultipart</a></span> <span class="element-name"><a href="../../../../../src-html/org/apache/commons/mail2/javax/MultiPartEmail.html#line-356">getContainer</a></span>()</div> +<div class="block">Gets the message container.</div> +<dl class="notes"> +<dt>Returns:</dt> +<dd>The message container.</dd> +<dt>Since:</dt> +<dd>1.0</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="getPrimaryBodyPart()"> +<h3>getPrimaryBodyPart</h3> +<div class="member-signature"><span class="modifiers">protected</span> <span class="return-type"><a href="https://docs.oracle.com/javaee/6/api/javax/mail/BodyPart.html"; title="class or interface in javax.mail" class="external-link">BodyPart</a></span> <span class="element-name"><a href="../../../../../src-html/org/apache/commons/mail2/javax/MultiPartEmail.html#line-370">getPrimaryBodyPart</a></span>() + throws <span class="exceptions"><a href="https://docs.oracle.com/javaee/6/api/javax/mail/MessagingException.html"; title="class or interface in javax.mail" class="external-link">MessagingException</a></span></div> +<div class="block">Gets first body part of the message.</div> +<dl class="notes"> +<dt>Returns:</dt> +<dd>The primary body part.</dd> +<dt>Throws:</dt> +<dd><code><a href="https://docs.oracle.com/javaee/6/api/javax/mail/MessagingException.html"; title="class or interface in javax.mail" class="external-link">MessagingException</a></code> - An error occurred while getting the primary body part.</dd> +<dt>Since:</dt> +<dd>1.0</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="getSubType()"> +<h3>getSubType</h3> +<div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="https://docs.oracle.com/en/java/javase/21/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"><a href="../../../../../src-html/org/apache/commons/mail2/javax/MultiPartEmail.html#line-388">getSubType</a></span>()</div> +<div class="block">Gets the MIME subtype of the email.</div> +<dl class="notes"> +<dt>Returns:</dt> +<dd>MIME subtype of the email</dd> +<dt>Since:</dt> +<dd>1.0</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="init()"> +<h3>init</h3> +<div class="member-signature"><span class="modifiers">protected</span> <span class="return-type">void</span> <span class="element-name"><a href="../../../../../src-html/org/apache/commons/mail2/javax/MultiPartEmail.html#line-397">init</a></span>()</div> +<div class="block">Initialize the multipart email.</div> +<dl class="notes"> +<dt>Since:</dt> +<dd>1.0</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="isBoolHasAttachments()"> +<h3>isBoolHasAttachments</h3> +<div class="member-signature"><span class="modifiers">public</span> <span class="return-type">boolean</span> <span class="element-name"><a href="../../../../../src-html/org/apache/commons/mail2/javax/MultiPartEmail.html#line-412">isBoolHasAttachments</a></span>()</div> +<div class="block">Tests whether there are attachments.</div> +<dl class="notes"> +<dt>Returns:</dt> +<dd>true if there are attachments</dd> +<dt>Since:</dt> +<dd>1.0</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="isInitialized()"> +<h3>isInitialized</h3> +<div class="member-signature"><span class="modifiers">protected</span> <span class="return-type">boolean</span> <span class="element-name"><a href="../../../../../src-html/org/apache/commons/mail2/javax/MultiPartEmail.html#line-421">isInitialized</a></span>()</div> +<div class="block">Tests if this object is initialized.</div> +<dl class="notes"> +<dt>Returns:</dt> +<dd>true if initialized</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="setBoolHasAttachments(boolean)"> +<h3>setBoolHasAttachments</h3> +<div class="member-signature"><span class="modifiers">public</span> <span class="return-type">void</span> <span class="element-name"><a href="../../../../../src-html/org/apache/commons/mail2/javax/MultiPartEmail.html#line-431">setBoolHasAttachments</a></span><wbr><span class="parameters">(boolean hasAttachments)</span></div> +<div class="block">Sets whether there are attachments.</div> +<dl class="notes"> +<dt>Parameters:</dt> +<dd><code>hasAttachments</code> - the attachments flag</dd> +<dt>Since:</dt> +<dd>1.0</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="setInitialized(boolean)"> +<h3>setInitialized</h3> +<div class="member-signature"><span class="modifiers">protected</span> <span class="return-type">void</span> <span class="element-name"><a href="../../../../../src-html/org/apache/commons/mail2/javax/MultiPartEmail.html#line-440">setInitialized</a></span><wbr><span class="parameters">(boolean initialized)</span></div> +<div class="block">Sets the initialized status of this object.</div> +<dl class="notes"> +<dt>Parameters:</dt> +<dd><code>initialized</code> - the initialized status flag</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="setMsg(java.lang.String)"> +<h3>setMsg</h3> +<div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="Email.html" title="class in org.apache.commons.mail2.javax">Email</a></span> <span class="element-name"><a href="../../../../../src-html/org/apache/commons/mail2/javax/MultiPartEmail.html#line-452">setMsg</a></span><wbr><span class="parameters">(<a href="https://docs.oracle.com/en/java/javase/21/docs/api/java.base/java/lang/String.html"; title="class or interface in java.lang" class="external-link">String</a> msg)</span> + throws <span class="exceptions"><a href="https://commons.apache.org/proper/commons-email/commons-email2-core/apidocs/org/apache/commons/mail2/core/EmailException.html"; title="class or interface in org.apache.commons.mail2.core" class="external-link">EmailException</a></span></div> +<div class="block">Sets the message of the email.</div> +<dl class="notes"> +<dt>Specified by:</dt> +<dd><code><a href="Email.html#setMsg(java.lang.String)">setMsg</a></code> in class <code><a href="Email.html" title="class in org.apache.commons.mail2.javax">Email</a></code></dd> +<dt>Parameters:</dt> +<dd><code>msg</code> - A String.</dd> +<dt>Returns:</dt> +<dd>An Email.</dd> +<dt>Throws:</dt> +<dd><code><a href="https://commons.apache.org/proper/commons-email/commons-email2-core/apidocs/org/apache/commons/mail2/core/EmailException.html"; title="class or interface in org.apache.commons.mail2.core" class="external-link">EmailException</a></code> - see javax.mail.internet.MimeBodyPart for definitions</dd> +<dt>Since:</dt> +<dd>1.0</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="setSubType(java.lang.String)"> +<h3>setSubType</h3> +<div class="member-signature"><span class="modifiers">public</span> <span class="return-type">void</span> <span class="element-name"><a href="../../../../../src-html/org/apache/commons/mail2/javax/MultiPartEmail.html#line-474">setSubType</a></span><wbr><span class="parameters">(<a href="https://docs.oracle.com/en/java/javase/21/docs/api/java.base/java/lang/String.html"; title="class or interface in java.lang" class="external-link">String</a> subType)</span></div> +<div class="block">Sets the MIME subtype of the email.</div> +<dl class="notes"> +<dt>Parameters:</dt> +<dd><code>subType</code> - MIME subtype of the email</dd> +<dt>Since:</dt> +<dd>1.0</dd> +</dl> +</section> +</li> +</ul> +</section> +</li> +</ul> +</section> +<!-- ========= END OF CLASS DATA ========= --> +</main> +<footer role="contentinfo"> +<hr> +<p class="legal-copy"><small>Copyright © 2001–2024 <a href="https://www.apache.org/";>The Apache Software Foundation</a>. All rights reserved.</small></p> +</footer> +</div> +</div> +</body> +</html>
Added: dev/commons/email/2.0.0-M1-RC1/site/apidocs/org/apache/commons/mail2/javax/SimpleEmail.html ============================================================================== --- dev/commons/email/2.0.0-M1-RC1/site/apidocs/org/apache/commons/mail2/javax/SimpleEmail.html (added) +++ dev/commons/email/2.0.0-M1-RC1/site/apidocs/org/apache/commons/mail2/javax/SimpleEmail.html Sat Jun 15 15:07:30 2024 @@ -0,0 +1,191 @@ +<!DOCTYPE HTML> +<html lang="en"> +<head> +<!-- Generated by javadoc (17) --> +<title>SimpleEmail (Apache Commons Email for Javax 2.0.0-M1 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.commons.mail2.javax, class: SimpleEmail"> +<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/SimpleEmail.html">Use</a></li> +<li><a href="package-tree.html">Tree</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.commons.mail2.javax</a></div> +<h1 title="Class SimpleEmail" class="title">Class SimpleEmail</h1> +</div> +<div class="inheritance" title="Inheritance Tree"><a href="https://docs.oracle.com/en/java/javase/21/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"><a href="Email.html" title="class in org.apache.commons.mail2.javax">org.apache.commons.mail2.javax.Email</a> +<div class="inheritance">org.apache.commons.mail2.javax.SimpleEmail</div> +</div> +</div> +<section class="class-description" id="class-description"> +<hr> +<div class="type-signature"><span class="modifiers">public class </span><span class="element-name"><a href="../../../../../src-html/org/apache/commons/mail2/javax/SimpleEmail.html#line-27">SimpleEmail</a></span> +<span class="extends-implements">extends <a href="Email.html" title="class in org.apache.commons.mail2.javax">Email</a></span></div> +<div class="block">Sends simple Internet email messages without attachments.</div> +<dl class="notes"> +<dt>Since:</dt> +<dd>1.0</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">SimpleEmail</a>()</code></div> +<div class="col-last even-row-color"> +<div class="block">Constructs a new instance.</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><a href="Email.html" title="class in org.apache.commons.mail2.javax">Email</a></code></div> +<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#setMsg(java.lang.String)" class="member-name-link">setMsg</a><wbr>(<a href="https://docs.oracle.com/en/java/javase/21/docs/api/java.base/java/lang/String.html"; title="class or interface in java.lang" class="external-link">String</a> msg)</code></div> +<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> +<div class="block">Sets the content of the mail.</div> +</div> +</div> +</div> +</div> +<div class="inherited-list"> +<h3 id="methods-inherited-from-class-org.apache.commons.mail2.javax.Email">Methods inherited from class org.apache.commons.mail2.javax.<a href="Email.html" title="class in org.apache.commons.mail2.javax">Email</a></h3> +<code><a href="Email.html#addBcc(java.lang.String)">addBcc</a>, <a href="Email.html#addBcc(java.lang.String...)">addBcc</a>, <a href="Email.html#addBcc(java.lang.String,java.lang.String)">addBcc</a>, <a href="Email.html#addBcc(java.lang.String,java.lang.String,java.lang.String)">addBcc</a>, <a href="Email.html#addCc(java.lang.String)">addCc</a>, <a href="Email.html#addCc(java.lang.String...)">addCc</a>, <a href="Email.html#addCc(java.lang.String,java.lang.String)">addCc</a>, <a href="Email.html#addCc(java.lang.String,java.lang.String,java.lang.String)">addCc</a>, <a href="Email.html#addHeader(java.lang.String,java.lang.String)">addHeader</a>, <a href="Email.html#addReplyTo(java.lang.String)">addReplyTo</a>, <a href="Email.html#addReplyTo(java.lang.String,java.lang.String)">addReplyTo</a>, <a href="Email.html#addReplyTo(java.lang.String,java.lang.String,java.lang.String)">addReplyTo</a>, <a href="Email.html#addTo(java.lang.String)">addTo</a>, <a href="Email.html#addTo(java.lang.Strin g...)">addTo</a>, <a href="Email.html#addTo(java.lang.String,java.lang.String)">addTo</a>, <a href="Email.html#addTo(java.lang.String,java.lang.String,java.lang.String)">addTo</a>, <a href="Email.html#buildMimeMessage()">buildMimeMessage</a>, <a href="Email.html#createMimeMessage(javax.mail.Session)">createMimeMessage</a>, <a href="Email.html#getAuthenticator()">getAuthenticator</a>, <a href="Email.html#getBccAddresses()">getBccAddresses</a>, <a href="Email.html#getBounceAddress()">getBounceAddress</a>, <a href="Email.html#getCcAddresses()">getCcAddresses</a>, <a href="Email.html#getCharsetName()">getCharsetName</a>, <a href="Email.html#getContent()">getContent</a>, <a href="Email.html#getContentType()">getContentType</a>, <a href="Email.html#getEmailBody()">getEmailBody</a>, <a href="Email.html#getFromAddress()">getFromAddress</a>, <a href="Email.html#getHeader(java.lang.String)">getHeader</a>, <a href="Email.html#getHeaders()">getHeaders</a>, <a href="Email.html#getHostName()">get HostName</a>, <a href="Email.html#getMailSession()">getMailSession</a>, <a href="Email.html#getMessage()">getMessage</a>, <a href="Email.html#getMimeMessage()">getMimeMessage</a>, <a href="Email.html#getPopHost()">getPopHost</a>, <a href="Email.html#getPopPassword()">getPopPassword</a>, <a href="Email.html#getPopUserName()">getPopUserName</a>, <a href="Email.html#getReplyToAddresses()">getReplyToAddresses</a>, <a href="Email.html#getSentDate()">getSentDate</a>, <a href="Email.html#getSmtpPort()">getSmtpPort</a>, <a href="Email.html#getSocketConnectionTimeout()">getSocketConnectionTimeout</a>, <a href="Email.html#getSocketTimeout()">getSocketTimeout</a>, <a href="Email.html#getSslSmtpPort()">getSslSmtpPort</a>, <a href="Email.html#getSubject()">getSubject</a>, <a href="Email.html#getToAddresses()">getToAddresses</a>, <a href="Email.html#isDebug()">isDebug</a>, <a href="Email.html#isPopBeforeSmtp()">isPopBeforeSmtp</a>, <a href="Email.html#isSendPartial()">isSendPartial</a>, <a href=" Email.html#isSSLCheckServerIdentity()">isSSLCheckServerIdentity</a>, <a href="Email.html#isSSLOnConnect()">isSSLOnConnect</a>, <a href="Email.html#isStartTLSEnabled()">isStartTLSEnabled</a>, <a href="Email.html#isStartTLSRequired()">isStartTLSRequired</a>, <a href="Email.html#send()">send</a>, <a href="Email.html#sendMimeMessage()">sendMimeMessage</a>, <a href="Email.html#setAuthentication(java.lang.String,java.lang.String)">setAuthentication</a>, <a href="Email.html#setAuthenticator(javax.mail.Authenticator)">setAuthenticator</a>, <a href="Email.html#setBcc(java.util.Collection)">setBcc</a>, <a href="Email.html#setBounceAddress(java.lang.String)">setBounceAddress</a>, <a href="Email.html#setCc(java.util.Collection)">setCc</a>, <a href="Email.html#setCharset(java.lang.String)">setCharset</a>, <a href="Email.html#setContent(java.lang.Object)">setContent</a>, <a href="Email.html#setContent(java.lang.Object,java.lang.String)">setContent</a>, <a href="Email.html#setContent(javax.mail.in ternet.MimeMultipart)">setContent</a>, <a href="Email.html#setContentType(java.lang.String)">setContentType</a>, <a href="Email.html#setDebug(boolean)">setDebug</a>, <a href="Email.html#setFrom(java.lang.String)">setFrom</a>, <a href="Email.html#setFrom(java.lang.String,java.lang.String)">setFrom</a>, <a href="Email.html#setFrom(java.lang.String,java.lang.String,java.lang.String)">setFrom</a>, <a href="Email.html#setFromAddress(javax.mail.internet.InternetAddress)">setFromAddress</a>, <a href="Email.html#setHeaders(java.util.Map)">setHeaders</a>, <a href="Email.html#setHostName(java.lang.String)">setHostName</a>, <a href="Email.html#setMailSession(javax.mail.Session)">setMailSession</a>, <a href="Email.html#setMailSessionFromJNDI(java.lang.String)">setMailSessionFromJNDI</a>, <a href="Email.html#setMessage(javax.mail.internet.MimeMessage)">setMessage</a>, <a href="Email.html#setPopBeforeSmtp(boolean)">setPopBeforeSmtp</a>, <a href="Email.html#setPopBeforeSmtp(boolean,java.lang.Strin g,java.lang.String,java.lang.String)">setPopBeforeSmtp</a>, <a href="Email.html#setPopHost(java.lang.String)">setPopHost</a>, <a href="Email.html#setPopPassword(java.lang.String)">setPopPassword</a>, <a href="Email.html#setPopUsername(java.lang.String)">setPopUsername</a>, <a href="Email.html#setReplyTo(java.util.Collection)">setReplyTo</a>, <a href="Email.html#setSendPartial(boolean)">setSendPartial</a>, <a href="Email.html#setSentDate(java.util.Date)">setSentDate</a>, <a href="Email.html#setSmtpPort(int)">setSmtpPort</a>, <a href="Email.html#setSocketConnectionTimeout(java.time.Duration)">setSocketConnectionTimeout</a>, <a href="Email.html#setSocketTimeout(java.time.Duration)">setSocketTimeout</a>, <a href="Email.html#setSSLCheckServerIdentity(boolean)">setSSLCheckServerIdentity</a>, <a href="Email.html#setSSLOnConnect(boolean)">setSSLOnConnect</a>, <a href="Email.html#setSslSmtpPort(java.lang.String)">setSslSmtpPort</a>, <a href="Email.html#setStartTLSEnabled(boolean)">setStartTL SEnabled</a>, <a href="Email.html#setStartTLSRequired(boolean)">setStartTLSRequired</a>, <a href="Email.html#setSubject(java.lang.String)">setSubject</a>, <a href="Email.html#setTo(java.util.Collection)">setTo</a>, <a href="Email.html#toInternetAddressArray(java.util.List)">toInternetAddressArray</a>, <a href="Email.html#updateContentType(java.lang.String)">updateContentType</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/en/java/javase/21/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/21/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/21/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/21/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/21/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/21/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/21/docs/api/java.base/java/lang/Objec t.html#notify()" title="class or interface in java.lang" class="external-link">notify</a>, <a href="https://docs.oracle.com/en/java/javase/21/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/21/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/21/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/21/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/21/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>SimpleEmail</h3> +<div class="member-signature"><span class="modifiers">public</span> <span class="element-name"><a href="../../../../../src-html/org/apache/commons/mail2/javax/SimpleEmail.html#line-32">SimpleEmail</a></span>()</div> +<div class="block">Constructs a new instance.</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="setMsg(java.lang.String)"> +<h3>setMsg</h3> +<div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="Email.html" title="class in org.apache.commons.mail2.javax">Email</a></span> <span class="element-name"><a href="../../../../../src-html/org/apache/commons/mail2/javax/SimpleEmail.html#line-44">setMsg</a></span><wbr><span class="parameters">(<a href="https://docs.oracle.com/en/java/javase/21/docs/api/java.base/java/lang/String.html"; title="class or interface in java.lang" class="external-link">String</a> msg)</span> + throws <span class="exceptions"><a href="https://commons.apache.org/proper/commons-email/commons-email2-core/apidocs/org/apache/commons/mail2/core/EmailException.html"; title="class or interface in org.apache.commons.mail2.core" class="external-link">EmailException</a></span></div> +<div class="block">Sets the content of the mail.</div> +<dl class="notes"> +<dt>Specified by:</dt> +<dd><code><a href="Email.html#setMsg(java.lang.String)">setMsg</a></code> in class <code><a href="Email.html" title="class in org.apache.commons.mail2.javax">Email</a></code></dd> +<dt>Parameters:</dt> +<dd><code>msg</code> - A String.</dd> +<dt>Returns:</dt> +<dd>An Email.</dd> +<dt>Throws:</dt> +<dd><code><a href="https://commons.apache.org/proper/commons-email/commons-email2-core/apidocs/org/apache/commons/mail2/core/EmailException.html"; title="class or interface in org.apache.commons.mail2.core" class="external-link">EmailException</a></code> - see javax.mail.internet.MimeBodyPart for definitions</dd> +<dt>Since:</dt> +<dd>1.0</dd> +</dl> +</section> +</li> +</ul> +</section> +</li> +</ul> +</section> +<!-- ========= END OF CLASS DATA ========= --> +</main> +<footer role="contentinfo"> +<hr> +<p class="legal-copy"><small>Copyright © 2001–2024 <a href="https://www.apache.org/";>The Apache Software Foundation</a>. All rights reserved.</small></p> +</footer> +</div> +</div> +</body> +</html>
