|
@@ -0,0 +1,3555 @@
|
|
|
+<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
|
|
|
+<!-- NewPage -->
|
|
|
+<html lang="de">
|
|
|
+<head>
|
|
|
+<!-- Generated by javadoc -->
|
|
|
+<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
|
|
|
+<title>Email (Apache Commons Email 1.5 API)</title>
|
|
|
+<link rel="stylesheet" type="text/css" href="../../../../stylesheet.css" title="Style">
|
|
|
+<script type="text/javascript" src="../../../../script.js"></script>
|
|
|
+</head>
|
|
|
+<body>
|
|
|
+<script type="text/javascript"><!--
|
|
|
+ try {
|
|
|
+ if (location.href.indexOf('is-external=true') == -1) {
|
|
|
+ parent.document.title="Email (Apache Commons Email 1.5 API)";
|
|
|
+ }
|
|
|
+ }
|
|
|
+ catch(err) {
|
|
|
+ }
|
|
|
+//-->
|
|
|
+var methods = {"i0":10,"i1":10,"i2":10,"i3":10,"i4":10,"i5":10,"i6":10,"i7":10,"i8":10,"i9":10,"i10":10,"i11":10,"i12":10,"i13":10,"i14":10,"i15":10,"i16":10,"i17":10,"i18":10,"i19":10,"i20":10,"i21":10,"i22":10,"i23":10,"i24":10,"i25":10,"i26":10,"i27":10,"i28":10,"i29":10,"i30":10,"i31":10,"i32":10,"i33":10,"i34":10,"i35":10,"i36":42,"i37":10,"i38":10,"i39":10,"i40":10,"i41":42,"i42":10,"i43":10,"i44":10,"i45":10,"i46":10,"i47":10,"i48":10,"i49":10,"i50":10,"i51":10,"i52":10,"i53":10,"i54":10,"i55":10,"i56":10,"i57":10,"i58":10,"i59":10,"i60":6,"i61":10,"i62":10,"i63":10,"i64":10,"i65":10,"i66":10,"i67":10,"i68":42,"i69":10,"i70":10,"i71":10,"i72":10,"i73":10,"i74":10,"i75":42,"i76":10,"i77":10,"i78":10};
|
|
|
+var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],4:["t3","Abstract Methods"],8:["t4","Concrete Methods"],32:["t6","Deprecated Methods"]};
|
|
|
+var altColor = "altColor";
|
|
|
+var rowColor = "rowColor";
|
|
|
+var tableTab = "tableTab";
|
|
|
+var activeTableTab = "activeTableTab";
|
|
|
+</script>
|
|
|
+<noscript>
|
|
|
+<div>JavaScript is disabled on your browser.</div>
|
|
|
+</noscript>
|
|
|
+<!-- ========= START OF TOP NAVBAR ======= -->
|
|
|
+<div class="topNav"><a name="navbar.top">
|
|
|
+<!-- -->
|
|
|
+</a>
|
|
|
+<div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div>
|
|
|
+<a name="navbar.top.firstrow">
|
|
|
+<!-- -->
|
|
|
+</a>
|
|
|
+<ul class="navList" title="Navigation">
|
|
|
+<li><a href="../../../../overview-summary.html">Overview</a></li>
|
|
|
+<li><a href="package-summary.html">Package</a></li>
|
|
|
+<li class="navBarCell1Rev">Class</li>
|
|
|
+<li><a href="class-use/Email.html">Use</a></li>
|
|
|
+<li><a href="package-tree.html">Tree</a></li>
|
|
|
+<li><a href="../../../../deprecated-list.html">Deprecated</a></li>
|
|
|
+<li><a href="../../../../index-all.html">Index</a></li>
|
|
|
+<li><a href="../../../../help-doc.html">Help</a></li>
|
|
|
+</ul>
|
|
|
+</div>
|
|
|
+<div class="subNav">
|
|
|
+<ul class="navList">
|
|
|
+<li><a href="../../../../org/apache/commons/mail/DefaultAuthenticator.html" title="class in org.apache.commons.mail"><span class="typeNameLink">Prev Class</span></a></li>
|
|
|
+<li><a href="../../../../org/apache/commons/mail/EmailAttachment.html" title="class in org.apache.commons.mail"><span class="typeNameLink">Next Class</span></a></li>
|
|
|
+</ul>
|
|
|
+<ul class="navList">
|
|
|
+<li><a href="../../../../index.html?org/apache/commons/mail/Email.html" target="_top">Frames</a></li>
|
|
|
+<li><a href="Email.html" target="_top">No Frames</a></li>
|
|
|
+</ul>
|
|
|
+<ul class="navList" id="allclasses_navbar_top">
|
|
|
+<li><a href="../../../../allclasses-noframe.html">All Classes</a></li>
|
|
|
+</ul>
|
|
|
+<div>
|
|
|
+<script type="text/javascript"><!--
|
|
|
+ allClassesLink = document.getElementById("allclasses_navbar_top");
|
|
|
+ if(window==top) {
|
|
|
+ allClassesLink.style.display = "block";
|
|
|
+ }
|
|
|
+ else {
|
|
|
+ allClassesLink.style.display = "none";
|
|
|
+ }
|
|
|
+ //-->
|
|
|
+</script>
|
|
|
+</div>
|
|
|
+<div>
|
|
|
+<ul class="subNavList">
|
|
|
+<li>Summary: </li>
|
|
|
+<li>Nested | </li>
|
|
|
+<li><a href="#field.summary">Field</a> | </li>
|
|
|
+<li><a href="#constructor.summary">Constr</a> | </li>
|
|
|
+<li><a href="#method.summary">Method</a></li>
|
|
|
+</ul>
|
|
|
+<ul class="subNavList">
|
|
|
+<li>Detail: </li>
|
|
|
+<li><a href="#field.detail">Field</a> | </li>
|
|
|
+<li><a href="#constructor.detail">Constr</a> | </li>
|
|
|
+<li><a href="#method.detail">Method</a></li>
|
|
|
+</ul>
|
|
|
+</div>
|
|
|
+<a name="skip.navbar.top">
|
|
|
+<!-- -->
|
|
|
+</a></div>
|
|
|
+<!-- ========= END OF TOP NAVBAR ========= -->
|
|
|
+<!-- ======== START OF CLASS DATA ======== -->
|
|
|
+<div class="header">
|
|
|
+<div class="subTitle">org.apache.commons.mail</div>
|
|
|
+<h2 title="Class Email" class="title">Class Email</h2>
|
|
|
+</div>
|
|
|
+<div class="contentContainer">
|
|
|
+<ul class="inheritance">
|
|
|
+<li><a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">java.lang.Object</a></li>
|
|
|
+<li>
|
|
|
+<ul class="inheritance">
|
|
|
+<li>org.apache.commons.mail.Email</li>
|
|
|
+</ul>
|
|
|
+</li>
|
|
|
+</ul>
|
|
|
+<div class="description">
|
|
|
+<ul class="blockList">
|
|
|
+<li class="blockList">
|
|
|
+<dl>
|
|
|
+<dt>Direct Known Subclasses:</dt>
|
|
|
+<dd><a href="../../../../org/apache/commons/mail/MultiPartEmail.html" title="class in org.apache.commons.mail">MultiPartEmail</a>, <a href="../../../../org/apache/commons/mail/SimpleEmail.html" title="class in org.apache.commons.mail">SimpleEmail</a></dd>
|
|
|
+</dl>
|
|
|
+<hr>
|
|
|
+<br>
|
|
|
+<pre>public abstract class <span class="typeNameLabel">Email</span>
|
|
|
+extends <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a></pre>
|
|
|
+<div class="block">The base class for all email messages. This class sets the
|
|
|
+ sender's email & name, receiver's email & name, subject, and the
|
|
|
+ sent date.
|
|
|
+ <p>
|
|
|
+ Subclasses are responsible for setting the message body.</div>
|
|
|
+<dl>
|
|
|
+<dt><span class="simpleTagLabel">Since:</span></dt>
|
|
|
+<dd>1.0</dd>
|
|
|
+</dl>
|
|
|
+</li>
|
|
|
+</ul>
|
|
|
+</div>
|
|
|
+<div class="summary">
|
|
|
+<ul class="blockList">
|
|
|
+<li class="blockList">
|
|
|
+<!-- =========== FIELD SUMMARY =========== -->
|
|
|
+<ul class="blockList">
|
|
|
+<li class="blockList"><a name="field.summary">
|
|
|
+<!-- -->
|
|
|
+</a>
|
|
|
+<h3>Field Summary</h3>
|
|
|
+<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Field Summary table, listing fields, and an explanation">
|
|
|
+<caption><span>Fields</span><span class="tabEnd"> </span></caption>
|
|
|
+<tr>
|
|
|
+<th class="colFirst" scope="col">Modifier and Type</th>
|
|
|
+<th class="colLast" scope="col">Field and Description</th>
|
|
|
+</tr>
|
|
|
+<tr class="altColor">
|
|
|
+<td class="colFirst"><code>static <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a></code></td>
|
|
|
+<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/commons/mail/Email.html#ATTACHMENTS">ATTACHMENTS</a></span></code>
|
|
|
+<div class="block"><span class="deprecatedLabel">Deprecated.</span>
|
|
|
+<div class="block"><span class="deprecationComment">since 1.3, use <a href="../../../../org/apache/commons/mail/EmailConstants.html#ATTACHMENTS"><code>EmailConstants.ATTACHMENTS</code></a> instead</span></div>
|
|
|
+</div>
|
|
|
+</td>
|
|
|
+</tr>
|
|
|
+<tr class="rowColor">
|
|
|
+<td class="colFirst"><code>protected <a href="http://docs.oracle.com/javaee/6/api/javax/mail/Authenticator.html?is-external=true" title="class or interface in javax.mail">Authenticator</a></code></td>
|
|
|
+<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/commons/mail/Email.html#authenticator">authenticator</a></span></code>
|
|
|
+<div class="block">Instance of an <code>Authenticator</code> object that will be used
|
|
|
+ when authentication is requested from the mail server.</div>
|
|
|
+</td>
|
|
|
+</tr>
|
|
|
+<tr class="altColor">
|
|
|
+<td class="colFirst"><code>protected <a href="http://docs.oracle.com/javase/7/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</a><<a href="http://docs.oracle.com/javaee/6/api/javax/mail/internet/InternetAddress.html?is-external=true" title="class or interface in javax.mail.internet">InternetAddress</a>></code></td>
|
|
|
+<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/commons/mail/Email.html#bccList">bccList</a></span></code>
|
|
|
+<div class="block">List of "bcc" email addresses.</div>
|
|
|
+</td>
|
|
|
+</tr>
|
|
|
+<tr class="rowColor">
|
|
|
+<td class="colFirst"><code>protected <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a></code></td>
|
|
|
+<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/commons/mail/Email.html#bounceAddress">bounceAddress</a></span></code>
|
|
|
+<div class="block">Address to which undeliverable mail should be sent.</div>
|
|
|
+</td>
|
|
|
+</tr>
|
|
|
+<tr class="altColor">
|
|
|
+<td class="colFirst"><code>protected <a href="http://docs.oracle.com/javase/7/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</a><<a href="http://docs.oracle.com/javaee/6/api/javax/mail/internet/InternetAddress.html?is-external=true" title="class or interface in javax.mail.internet">InternetAddress</a>></code></td>
|
|
|
+<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/commons/mail/Email.html#ccList">ccList</a></span></code>
|
|
|
+<div class="block">List of "cc" email addresses.</div>
|
|
|
+</td>
|
|
|
+</tr>
|
|
|
+<tr class="rowColor">
|
|
|
+<td class="colFirst"><code>protected <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a></code></td>
|
|
|
+<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/commons/mail/Email.html#charset">charset</a></span></code>
|
|
|
+<div class="block">The charset to use for this message.</div>
|
|
|
+</td>
|
|
|
+</tr>
|
|
|
+<tr class="altColor">
|
|
|
+<td class="colFirst"><code>protected <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a></code></td>
|
|
|
+<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/commons/mail/Email.html#content">content</a></span></code>
|
|
|
+<div class="block">The content.</div>
|
|
|
+</td>
|
|
|
+</tr>
|
|
|
+<tr class="rowColor">
|
|
|
+<td class="colFirst"><code>static <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a></code></td>
|
|
|
+<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/commons/mail/Email.html#CONTENT_TYPE">CONTENT_TYPE</a></span></code>
|
|
|
+<div class="block"><span class="deprecatedLabel">Deprecated.</span>
|
|
|
+<div class="block"><span class="deprecationComment">since 1.3, use <a href="../../../../org/apache/commons/mail/EmailConstants.html#CONTENT_TYPE"><code>EmailConstants.CONTENT_TYPE</code></a> instead</span></div>
|
|
|
+</div>
|
|
|
+</td>
|
|
|
+</tr>
|
|
|
+<tr class="altColor">
|
|
|
+<td class="colFirst"><code>protected <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a></code></td>
|
|
|
+<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/commons/mail/Email.html#contentType">contentType</a></span></code>
|
|
|
+<div class="block">The content type.</div>
|
|
|
+</td>
|
|
|
+</tr>
|
|
|
+<tr class="rowColor">
|
|
|
+<td class="colFirst"><code>protected boolean</code></td>
|
|
|
+<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/commons/mail/Email.html#debug">debug</a></span></code>
|
|
|
+<div class="block">Set session debugging on or off.</div>
|
|
|
+</td>
|
|
|
+</tr>
|
|
|
+<tr class="altColor">
|
|
|
+<td class="colFirst"><code>static <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a></code></td>
|
|
|
+<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/commons/mail/Email.html#EMAIL_BODY">EMAIL_BODY</a></span></code>
|
|
|
+<div class="block"><span class="deprecatedLabel">Deprecated.</span>
|
|
|
+<div class="block"><span class="deprecationComment">since 1.3, use <a href="../../../../org/apache/commons/mail/EmailConstants.html#EMAIL_BODY"><code>EmailConstants.EMAIL_BODY</code></a> instead</span></div>
|
|
|
+</div>
|
|
|
+</td>
|
|
|
+</tr>
|
|
|
+<tr class="rowColor">
|
|
|
+<td class="colFirst"><code>static <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a></code></td>
|
|
|
+<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/commons/mail/Email.html#EMAIL_SUBJECT">EMAIL_SUBJECT</a></span></code>
|
|
|
+<div class="block"><span class="deprecatedLabel">Deprecated.</span>
|
|
|
+<div class="block"><span class="deprecationComment">since 1.3, use <a href="../../../../org/apache/commons/mail/EmailConstants.html#EMAIL_SUBJECT"><code>EmailConstants.EMAIL_SUBJECT</code></a> instead</span></div>
|
|
|
+</div>
|
|
|
+</td>
|
|
|
+</tr>
|
|
|
+<tr class="altColor">
|
|
|
+<td class="colFirst"><code>protected <a href="http://docs.oracle.com/javaee/6/api/javax/mail/internet/MimeMultipart.html?is-external=true" title="class or interface in javax.mail.internet">MimeMultipart</a></code></td>
|
|
|
+<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/commons/mail/Email.html#emailBody">emailBody</a></span></code>
|
|
|
+<div class="block">An attachment.</div>
|
|
|
+</td>
|
|
|
+</tr>
|
|
|
+<tr class="rowColor">
|
|
|
+<td class="colFirst"><code>static <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a></code></td>
|
|
|
+<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/commons/mail/Email.html#FILE_SERVER">FILE_SERVER</a></span></code>
|
|
|
+<div class="block"><span class="deprecatedLabel">Deprecated.</span>
|
|
|
+<div class="block"><span class="deprecationComment">since 1.3, use <a href="../../../../org/apache/commons/mail/EmailConstants.html#FILE_SERVER"><code>EmailConstants.FILE_SERVER</code></a> instead</span></div>
|
|
|
+</div>
|
|
|
+</td>
|
|
|
+</tr>
|
|
|
+<tr class="altColor">
|
|
|
+<td class="colFirst"><code>protected <a href="http://docs.oracle.com/javaee/6/api/javax/mail/internet/InternetAddress.html?is-external=true" title="class or interface in javax.mail.internet">InternetAddress</a></code></td>
|
|
|
+<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/commons/mail/Email.html#fromAddress">fromAddress</a></span></code>
|
|
|
+<div class="block">The Address of the sending party, mandatory.</div>
|
|
|
+</td>
|
|
|
+</tr>
|
|
|
+<tr class="rowColor">
|
|
|
+<td class="colFirst"><code>protected <a href="http://docs.oracle.com/javase/7/docs/api/java/util/Map.html?is-external=true" title="class or interface in java.util">Map</a><<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>,<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>></code></td>
|
|
|
+<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/commons/mail/Email.html#headers">headers</a></span></code>
|
|
|
+<div class="block">Used to specify the mail headers.</div>
|
|
|
+</td>
|
|
|
+</tr>
|
|
|
+<tr class="altColor">
|
|
|
+<td class="colFirst"><code>protected <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a></code></td>
|
|
|
+<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/commons/mail/Email.html#hostName">hostName</a></span></code>
|
|
|
+<div class="block">The hostname of the mail server with which to connect.</div>
|
|
|
+</td>
|
|
|
+</tr>
|
|
|
+<tr class="rowColor">
|
|
|
+<td class="colFirst"><code>static <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a></code></td>
|
|
|
+<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/commons/mail/Email.html#ISO_8859_1">ISO_8859_1</a></span></code>
|
|
|
+<div class="block"><span class="deprecatedLabel">Deprecated.</span>
|
|
|
+<div class="block"><span class="deprecationComment">since 1.3, use <a href="../../../../org/apache/commons/mail/EmailConstants.html#ISO_8859_1"><code>EmailConstants.ISO_8859_1</code></a> instead</span></div>
|
|
|
+</div>
|
|
|
+</td>
|
|
|
+</tr>
|
|
|
+<tr class="altColor">
|
|
|
+<td class="colFirst"><code>static <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a></code></td>
|
|
|
+<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/commons/mail/Email.html#KOI8_R">KOI8_R</a></span></code>
|
|
|
+<div class="block"><span class="deprecatedLabel">Deprecated.</span>
|
|
|
+<div class="block"><span class="deprecationComment">since 1.3, use <a href="../../../../org/apache/commons/mail/EmailConstants.html#KOI8_R"><code>EmailConstants.KOI8_R</code></a> instead</span></div>
|
|
|
+</div>
|
|
|
+</td>
|
|
|
+</tr>
|
|
|
+<tr class="rowColor">
|
|
|
+<td class="colFirst"><code>static <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a></code></td>
|
|
|
+<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/commons/mail/Email.html#MAIL_DEBUG">MAIL_DEBUG</a></span></code>
|
|
|
+<div class="block"><span class="deprecatedLabel">Deprecated.</span>
|
|
|
+<div class="block"><span class="deprecationComment">since 1.3, use <a href="../../../../org/apache/commons/mail/EmailConstants.html#MAIL_DEBUG"><code>EmailConstants.MAIL_DEBUG</code></a> instead</span></div>
|
|
|
+</div>
|
|
|
+</td>
|
|
|
+</tr>
|
|
|
+<tr class="altColor">
|
|
|
+<td class="colFirst"><code>static <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a></code></td>
|
|
|
+<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/commons/mail/Email.html#MAIL_HOST">MAIL_HOST</a></span></code>
|
|
|
+<div class="block"><span class="deprecatedLabel">Deprecated.</span>
|
|
|
+<div class="block"><span class="deprecationComment">since 1.3, use <a href="../../../../org/apache/commons/mail/EmailConstants.html#MAIL_HOST"><code>EmailConstants.MAIL_HOST</code></a> instead</span></div>
|
|
|
+</div>
|
|
|
+</td>
|
|
|
+</tr>
|
|
|
+<tr class="rowColor">
|
|
|
+<td class="colFirst"><code>static <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a></code></td>
|
|
|
+<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/commons/mail/Email.html#MAIL_PORT">MAIL_PORT</a></span></code>
|
|
|
+<div class="block"><span class="deprecatedLabel">Deprecated.</span>
|
|
|
+<div class="block"><span class="deprecationComment">since 1.3, use <a href="../../../../org/apache/commons/mail/EmailConstants.html#MAIL_PORT"><code>EmailConstants.MAIL_PORT</code></a> instead</span></div>
|
|
|
+</div>
|
|
|
+</td>
|
|
|
+</tr>
|
|
|
+<tr class="altColor">
|
|
|
+<td class="colFirst"><code>static <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a></code></td>
|
|
|
+<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/commons/mail/Email.html#MAIL_SMTP_AUTH">MAIL_SMTP_AUTH</a></span></code>
|
|
|
+<div class="block"><span class="deprecatedLabel">Deprecated.</span>
|
|
|
+<div class="block"><span class="deprecationComment">since 1.3, use <a href="../../../../org/apache/commons/mail/EmailConstants.html#MAIL_SMTP_AUTH"><code>EmailConstants.MAIL_SMTP_AUTH</code></a> instead</span></div>
|
|
|
+</div>
|
|
|
+</td>
|
|
|
+</tr>
|
|
|
+<tr class="rowColor">
|
|
|
+<td class="colFirst"><code>static <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a></code></td>
|
|
|
+<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/commons/mail/Email.html#MAIL_SMTP_CONNECTIONTIMEOUT">MAIL_SMTP_CONNECTIONTIMEOUT</a></span></code>
|
|
|
+<div class="block"><span class="deprecatedLabel">Deprecated.</span>
|
|
|
+<div class="block"><span class="deprecationComment">since 1.3, use <a href="../../../../org/apache/commons/mail/EmailConstants.html#MAIL_SMTP_CONNECTIONTIMEOUT"><code>EmailConstants.MAIL_SMTP_CONNECTIONTIMEOUT</code></a> instead</span></div>
|
|
|
+</div>
|
|
|
+</td>
|
|
|
+</tr>
|
|
|
+<tr class="altColor">
|
|
|
+<td class="colFirst"><code>static <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a></code></td>
|
|
|
+<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/commons/mail/Email.html#MAIL_SMTP_FROM">MAIL_SMTP_FROM</a></span></code>
|
|
|
+<div class="block"><span class="deprecatedLabel">Deprecated.</span>
|
|
|
+<div class="block"><span class="deprecationComment">since 1.3, use <a href="../../../../org/apache/commons/mail/EmailConstants.html#MAIL_SMTP_FROM"><code>EmailConstants.MAIL_SMTP_FROM</code></a> instead</span></div>
|
|
|
+</div>
|
|
|
+</td>
|
|
|
+</tr>
|
|
|
+<tr class="rowColor">
|
|
|
+<td class="colFirst"><code>static <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a></code></td>
|
|
|
+<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/commons/mail/Email.html#MAIL_SMTP_PASSWORD">MAIL_SMTP_PASSWORD</a></span></code>
|
|
|
+<div class="block"><span class="deprecatedLabel">Deprecated.</span>
|
|
|
+<div class="block"><span class="deprecationComment">since 1.3, use <a href="../../../../org/apache/commons/mail/EmailConstants.html#MAIL_SMTP_PASSWORD"><code>EmailConstants.MAIL_SMTP_PASSWORD</code></a> instead</span></div>
|
|
|
+</div>
|
|
|
+</td>
|
|
|
+</tr>
|
|
|
+<tr class="altColor">
|
|
|
+<td class="colFirst"><code>static <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a></code></td>
|
|
|
+<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/commons/mail/Email.html#MAIL_SMTP_SOCKET_FACTORY_CLASS">MAIL_SMTP_SOCKET_FACTORY_CLASS</a></span></code>
|
|
|
+<div class="block"><span class="deprecatedLabel">Deprecated.</span>
|
|
|
+<div class="block"><span class="deprecationComment">since 1.3, use <a href="../../../../org/apache/commons/mail/EmailConstants.html#MAIL_SMTP_SOCKET_FACTORY_CLASS"><code>EmailConstants.MAIL_SMTP_SOCKET_FACTORY_CLASS</code></a> instead</span></div>
|
|
|
+</div>
|
|
|
+</td>
|
|
|
+</tr>
|
|
|
+<tr class="rowColor">
|
|
|
+<td class="colFirst"><code>static <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a></code></td>
|
|
|
+<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/commons/mail/Email.html#MAIL_SMTP_SOCKET_FACTORY_FALLBACK">MAIL_SMTP_SOCKET_FACTORY_FALLBACK</a></span></code>
|
|
|
+<div class="block"><span class="deprecatedLabel">Deprecated.</span>
|
|
|
+<div class="block"><span class="deprecationComment">since 1.3, use <a href="../../../../org/apache/commons/mail/EmailConstants.html#MAIL_SMTP_SOCKET_FACTORY_FALLBACK"><code>EmailConstants.MAIL_SMTP_SOCKET_FACTORY_FALLBACK</code></a> instead</span></div>
|
|
|
+</div>
|
|
|
+</td>
|
|
|
+</tr>
|
|
|
+<tr class="altColor">
|
|
|
+<td class="colFirst"><code>static <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a></code></td>
|
|
|
+<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/commons/mail/Email.html#MAIL_SMTP_SOCKET_FACTORY_PORT">MAIL_SMTP_SOCKET_FACTORY_PORT</a></span></code>
|
|
|
+<div class="block"><span class="deprecatedLabel">Deprecated.</span>
|
|
|
+<div class="block"><span class="deprecationComment">since 1.3, use <a href="../../../../org/apache/commons/mail/EmailConstants.html#MAIL_SMTP_SOCKET_FACTORY_PORT"><code>EmailConstants.MAIL_SMTP_SOCKET_FACTORY_PORT</code></a> instead</span></div>
|
|
|
+</div>
|
|
|
+</td>
|
|
|
+</tr>
|
|
|
+<tr class="rowColor">
|
|
|
+<td class="colFirst"><code>static <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a></code></td>
|
|
|
+<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/commons/mail/Email.html#MAIL_SMTP_TIMEOUT">MAIL_SMTP_TIMEOUT</a></span></code>
|
|
|
+<div class="block"><span class="deprecatedLabel">Deprecated.</span>
|
|
|
+<div class="block"><span class="deprecationComment">since 1.3, use <a href="../../../../org/apache/commons/mail/EmailConstants.html#MAIL_SMTP_TIMEOUT"><code>EmailConstants.MAIL_SMTP_TIMEOUT</code></a> instead</span></div>
|
|
|
+</div>
|
|
|
+</td>
|
|
|
+</tr>
|
|
|
+<tr class="altColor">
|
|
|
+<td class="colFirst"><code>static <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a></code></td>
|
|
|
+<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/commons/mail/Email.html#MAIL_SMTP_USER">MAIL_SMTP_USER</a></span></code>
|
|
|
+<div class="block"><span class="deprecatedLabel">Deprecated.</span>
|
|
|
+<div class="block"><span class="deprecationComment">since 1.3, use <a href="../../../../org/apache/commons/mail/EmailConstants.html#MAIL_SMTP_USER"><code>EmailConstants.MAIL_SMTP_USER</code></a> instead</span></div>
|
|
|
+</div>
|
|
|
+</td>
|
|
|
+</tr>
|
|
|
+<tr class="rowColor">
|
|
|
+<td class="colFirst"><code>static <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a></code></td>
|
|
|
+<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/commons/mail/Email.html#MAIL_TRANSPORT_PROTOCOL">MAIL_TRANSPORT_PROTOCOL</a></span></code>
|
|
|
+<div class="block"><span class="deprecatedLabel">Deprecated.</span>
|
|
|
+<div class="block"><span class="deprecationComment">since 1.3, use <a href="../../../../org/apache/commons/mail/EmailConstants.html#MAIL_TRANSPORT_PROTOCOL"><code>EmailConstants.MAIL_TRANSPORT_PROTOCOL</code></a> instead</span></div>
|
|
|
+</div>
|
|
|
+</td>
|
|
|
+</tr>
|
|
|
+<tr class="altColor">
|
|
|
+<td class="colFirst"><code>static <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a></code></td>
|
|
|
+<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/commons/mail/Email.html#MAIL_TRANSPORT_TLS">MAIL_TRANSPORT_TLS</a></span></code>
|
|
|
+<div class="block"><span class="deprecatedLabel">Deprecated.</span>
|
|
|
+<div class="block"><span class="deprecationComment">since 1.3, use <a href="../../../../org/apache/commons/mail/EmailConstants.html#MAIL_TRANSPORT_TLS"><code>EmailConstants.MAIL_TRANSPORT_TLS</code></a> instead</span></div>
|
|
|
+</div>
|
|
|
+</td>
|
|
|
+</tr>
|
|
|
+<tr class="rowColor">
|
|
|
+<td class="colFirst"><code>protected <a href="http://docs.oracle.com/javaee/6/api/javax/mail/internet/MimeMessage.html?is-external=true" title="class or interface in javax.mail.internet">MimeMessage</a></code></td>
|
|
|
+<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/commons/mail/Email.html#message">message</a></span></code>
|
|
|
+<div class="block">The email message to send.</div>
|
|
|
+</td>
|
|
|
+</tr>
|
|
|
+<tr class="altColor">
|
|
|
+<td class="colFirst"><code>protected boolean</code></td>
|
|
|
+<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/commons/mail/Email.html#popBeforeSmtp">popBeforeSmtp</a></span></code>
|
|
|
+<div class="block">Used to determine whether to use pop3 before smtp, and if so the settings.</div>
|
|
|
+</td>
|
|
|
+</tr>
|
|
|
+<tr class="rowColor">
|
|
|
+<td class="colFirst"><code>protected <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a></code></td>
|
|
|
+<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/commons/mail/Email.html#popHost">popHost</a></span></code>
|
|
|
+<div class="block">the host name of the pop3 server.</div>
|
|
|
+</td>
|
|
|
+</tr>
|
|
|
+<tr class="altColor">
|
|
|
+<td class="colFirst"><code>protected <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a></code></td>
|
|
|
+<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/commons/mail/Email.html#popPassword">popPassword</a></span></code>
|
|
|
+<div class="block">the password to log into the pop3 server.</div>
|
|
|
+</td>
|
|
|
+</tr>
|
|
|
+<tr class="rowColor">
|
|
|
+<td class="colFirst"><code>protected <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a></code></td>
|
|
|
+<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/commons/mail/Email.html#popUsername">popUsername</a></span></code>
|
|
|
+<div class="block">the user name to log into the pop3 server.</div>
|
|
|
+</td>
|
|
|
+</tr>
|
|
|
+<tr class="altColor">
|
|
|
+<td class="colFirst"><code>static <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a></code></td>
|
|
|
+<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/commons/mail/Email.html#RECEIVER_EMAIL">RECEIVER_EMAIL</a></span></code>
|
|
|
+<div class="block"><span class="deprecatedLabel">Deprecated.</span>
|
|
|
+<div class="block"><span class="deprecationComment">since 1.3, use <a href="../../../../org/apache/commons/mail/EmailConstants.html#RECEIVER_EMAIL"><code>EmailConstants.RECEIVER_EMAIL</code></a> instead</span></div>
|
|
|
+</div>
|
|
|
+</td>
|
|
|
+</tr>
|
|
|
+<tr class="rowColor">
|
|
|
+<td class="colFirst"><code>static <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a></code></td>
|
|
|
+<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/commons/mail/Email.html#RECEIVER_NAME">RECEIVER_NAME</a></span></code>
|
|
|
+<div class="block"><span class="deprecatedLabel">Deprecated.</span>
|
|
|
+<div class="block"><span class="deprecationComment">since 1.3, use <a href="../../../../org/apache/commons/mail/EmailConstants.html#RECEIVER_NAME"><code>EmailConstants.RECEIVER_NAME</code></a> instead</span></div>
|
|
|
+</div>
|
|
|
+</td>
|
|
|
+</tr>
|
|
|
+<tr class="altColor">
|
|
|
+<td class="colFirst"><code>protected <a href="http://docs.oracle.com/javase/7/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</a><<a href="http://docs.oracle.com/javaee/6/api/javax/mail/internet/InternetAddress.html?is-external=true" title="class or interface in javax.mail.internet">InternetAddress</a>></code></td>
|
|
|
+<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/commons/mail/Email.html#replyList">replyList</a></span></code>
|
|
|
+<div class="block">List of "replyTo" email addresses.</div>
|
|
|
+</td>
|
|
|
+</tr>
|
|
|
+<tr class="rowColor">
|
|
|
+<td class="colFirst"><code>static <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a></code></td>
|
|
|
+<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/commons/mail/Email.html#SENDER_EMAIL">SENDER_EMAIL</a></span></code>
|
|
|
+<div class="block"><span class="deprecatedLabel">Deprecated.</span>
|
|
|
+<div class="block"><span class="deprecationComment">since 1.3, use <a href="../../../../org/apache/commons/mail/EmailConstants.html#SENDER_EMAIL"><code>EmailConstants.SENDER_EMAIL</code></a> instead</span></div>
|
|
|
+</div>
|
|
|
+</td>
|
|
|
+</tr>
|
|
|
+<tr class="altColor">
|
|
|
+<td class="colFirst"><code>static <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a></code></td>
|
|
|
+<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/commons/mail/Email.html#SENDER_NAME">SENDER_NAME</a></span></code>
|
|
|
+<div class="block"><span class="deprecatedLabel">Deprecated.</span>
|
|
|
+<div class="block"><span class="deprecationComment">since 1.3, use <a href="../../../../org/apache/commons/mail/EmailConstants.html#SENDER_NAME"><code>EmailConstants.SENDER_NAME</code></a> instead</span></div>
|
|
|
+</div>
|
|
|
+</td>
|
|
|
+</tr>
|
|
|
+<tr class="rowColor">
|
|
|
+<td class="colFirst"><code>protected <a href="http://docs.oracle.com/javase/7/docs/api/java/util/Date.html?is-external=true" title="class or interface in java.util">Date</a></code></td>
|
|
|
+<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/commons/mail/Email.html#sentDate">sentDate</a></span></code>
|
|
|
+<div class="block">Sent date.</div>
|
|
|
+</td>
|
|
|
+</tr>
|
|
|
+<tr class="altColor">
|
|
|
+<td class="colFirst"><code>static <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a></code></td>
|
|
|
+<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/commons/mail/Email.html#SMTP">SMTP</a></span></code>
|
|
|
+<div class="block"><span class="deprecatedLabel">Deprecated.</span>
|
|
|
+<div class="block"><span class="deprecationComment">since 1.3, use <a href="../../../../org/apache/commons/mail/EmailConstants.html#SMTP"><code>EmailConstants.SMTP</code></a> instead</span></div>
|
|
|
+</div>
|
|
|
+</td>
|
|
|
+</tr>
|
|
|
+<tr class="rowColor">
|
|
|
+<td class="colFirst"><code>protected <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a></code></td>
|
|
|
+<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/commons/mail/Email.html#smtpPort">smtpPort</a></span></code>
|
|
|
+<div class="block">The port number of the mail server to connect to.</div>
|
|
|
+</td>
|
|
|
+</tr>
|
|
|
+<tr class="altColor">
|
|
|
+<td class="colFirst"><code>protected int</code></td>
|
|
|
+<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/commons/mail/Email.html#socketConnectionTimeout">socketConnectionTimeout</a></span></code>
|
|
|
+<div class="block">socket connection timeout value in milliseconds.</div>
|
|
|
+</td>
|
|
|
+</tr>
|
|
|
+<tr class="rowColor">
|
|
|
+<td class="colFirst"><code>protected int</code></td>
|
|
|
+<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/commons/mail/Email.html#socketTimeout">socketTimeout</a></span></code>
|
|
|
+<div class="block">socket I/O timeout value in milliseconds.</div>
|
|
|
+</td>
|
|
|
+</tr>
|
|
|
+<tr class="altColor">
|
|
|
+<td class="colFirst"><code>protected boolean</code></td>
|
|
|
+<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/commons/mail/Email.html#ssl">ssl</a></span></code>
|
|
|
+<div class="block"><span class="deprecatedLabel">Deprecated.</span>
|
|
|
+<div class="block"><span class="deprecationComment">since 1.3, use setSSLOnConnect() instead</span></div>
|
|
|
+</div>
|
|
|
+</td>
|
|
|
+</tr>
|
|
|
+<tr class="rowColor">
|
|
|
+<td class="colFirst"><code>protected <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a></code></td>
|
|
|
+<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/commons/mail/Email.html#sslSmtpPort">sslSmtpPort</a></span></code>
|
|
|
+<div class="block">The port number of the SSL enabled SMTP server;
|
|
|
+ defaults to the standard port, 465.</div>
|
|
|
+</td>
|
|
|
+</tr>
|
|
|
+<tr class="altColor">
|
|
|
+<td class="colFirst"><code>protected <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a></code></td>
|
|
|
+<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/commons/mail/Email.html#subject">subject</a></span></code>
|
|
|
+<div class="block">The Subject.</div>
|
|
|
+</td>
|
|
|
+</tr>
|
|
|
+<tr class="rowColor">
|
|
|
+<td class="colFirst"><code>static <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a></code></td>
|
|
|
+<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/commons/mail/Email.html#TEXT_HTML">TEXT_HTML</a></span></code>
|
|
|
+<div class="block"><span class="deprecatedLabel">Deprecated.</span>
|
|
|
+<div class="block"><span class="deprecationComment">since 1.3, use <a href="../../../../org/apache/commons/mail/EmailConstants.html#TEXT_HTML"><code>EmailConstants.TEXT_HTML</code></a> instead</span></div>
|
|
|
+</div>
|
|
|
+</td>
|
|
|
+</tr>
|
|
|
+<tr class="altColor">
|
|
|
+<td class="colFirst"><code>static <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a></code></td>
|
|
|
+<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/commons/mail/Email.html#TEXT_PLAIN">TEXT_PLAIN</a></span></code>
|
|
|
+<div class="block"><span class="deprecatedLabel">Deprecated.</span>
|
|
|
+<div class="block"><span class="deprecationComment">since 1.3, use <a href="../../../../org/apache/commons/mail/EmailConstants.html#TEXT_PLAIN"><code>EmailConstants.TEXT_PLAIN</code></a> instead</span></div>
|
|
|
+</div>
|
|
|
+</td>
|
|
|
+</tr>
|
|
|
+<tr class="rowColor">
|
|
|
+<td class="colFirst"><code>protected boolean</code></td>
|
|
|
+<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/commons/mail/Email.html#tls">tls</a></span></code>
|
|
|
+<div class="block"><span class="deprecatedLabel">Deprecated.</span>
|
|
|
+<div class="block"><span class="deprecationComment">since 1.3, use setStartTLSEnabled() instead</span></div>
|
|
|
+</div>
|
|
|
+</td>
|
|
|
+</tr>
|
|
|
+<tr class="altColor">
|
|
|
+<td class="colFirst"><code>protected <a href="http://docs.oracle.com/javase/7/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</a><<a href="http://docs.oracle.com/javaee/6/api/javax/mail/internet/InternetAddress.html?is-external=true" title="class or interface in javax.mail.internet">InternetAddress</a>></code></td>
|
|
|
+<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/commons/mail/Email.html#toList">toList</a></span></code>
|
|
|
+<div class="block">List of "to" email addresses.</div>
|
|
|
+</td>
|
|
|
+</tr>
|
|
|
+<tr class="rowColor">
|
|
|
+<td class="colFirst"><code>static <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a></code></td>
|
|
|
+<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/commons/mail/Email.html#US_ASCII">US_ASCII</a></span></code>
|
|
|
+<div class="block"><span class="deprecatedLabel">Deprecated.</span>
|
|
|
+<div class="block"><span class="deprecationComment">since 1.3, use <a href="../../../../org/apache/commons/mail/EmailConstants.html#US_ASCII"><code>EmailConstants.US_ASCII</code></a> instead</span></div>
|
|
|
+</div>
|
|
|
+</td>
|
|
|
+</tr>
|
|
|
+</table>
|
|
|
+</li>
|
|
|
+</ul>
|
|
|
+<!-- ======== CONSTRUCTOR SUMMARY ======== -->
|
|
|
+<ul class="blockList">
|
|
|
+<li class="blockList"><a name="constructor.summary">
|
|
|
+<!-- -->
|
|
|
+</a>
|
|
|
+<h3>Constructor Summary</h3>
|
|
|
+<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Constructor Summary table, listing constructors, and an explanation">
|
|
|
+<caption><span>Constructors</span><span class="tabEnd"> </span></caption>
|
|
|
+<tr>
|
|
|
+<th class="colOne" scope="col">Constructor and Description</th>
|
|
|
+</tr>
|
|
|
+<tr class="altColor">
|
|
|
+<td class="colOne"><code><span class="memberNameLink"><a href="../../../../org/apache/commons/mail/Email.html#Email--">Email</a></span>()</code> </td>
|
|
|
+</tr>
|
|
|
+</table>
|
|
|
+</li>
|
|
|
+</ul>
|
|
|
+<!-- ========== METHOD SUMMARY =========== -->
|
|
|
+<ul class="blockList">
|
|
|
+<li class="blockList"><a name="method.summary">
|
|
|
+<!-- -->
|
|
|
+</a>
|
|
|
+<h3>Method Summary</h3>
|
|
|
+<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation">
|
|
|
+<caption><span id="t0" class="activeTableTab"><span>All Methods</span><span class="tabEnd"> </span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd"> </span></span><span id="t3" class="tableTab"><span><a href="javascript:show(4);">Abstract Methods</a></span><span class="tabEnd"> </span></span><span id="t4" class="tableTab"><span><a href="javascript:show(8);">Concrete Methods</a></span><span class="tabEnd"> </span></span><span id="t6" class="tableTab"><span><a href="javascript:show(32);">Deprecated Methods</a></span><span class="tabEnd"> </span></span></caption>
|
|
|
+<tr>
|
|
|
+<th class="colFirst" scope="col">Modifier and Type</th>
|
|
|
+<th class="colLast" scope="col">Method and Description</th>
|
|
|
+</tr>
|
|
|
+<tr id="i0" class="altColor">
|
|
|
+<td class="colFirst"><code><a href="../../../../org/apache/commons/mail/Email.html" title="class in org.apache.commons.mail">Email</a></code></td>
|
|
|
+<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/commons/mail/Email.html#addBcc-java.lang.String...-">addBcc</a></span>(<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>... emails)</code>
|
|
|
+<div class="block">Add an array of blind BCC recipients to the email.</div>
|
|
|
+</td>
|
|
|
+</tr>
|
|
|
+<tr id="i1" class="rowColor">
|
|
|
+<td class="colFirst"><code><a href="../../../../org/apache/commons/mail/Email.html" title="class in org.apache.commons.mail">Email</a></code></td>
|
|
|
+<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/commons/mail/Email.html#addBcc-java.lang.String-">addBcc</a></span>(<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> email)</code>
|
|
|
+<div class="block">Add a blind BCC recipient to the email.</div>
|
|
|
+</td>
|
|
|
+</tr>
|
|
|
+<tr id="i2" class="altColor">
|
|
|
+<td class="colFirst"><code><a href="../../../../org/apache/commons/mail/Email.html" title="class in org.apache.commons.mail">Email</a></code></td>
|
|
|
+<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/commons/mail/Email.html#addBcc-java.lang.String-java.lang.String-">addBcc</a></span>(<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> email,
|
|
|
+ <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> name)</code>
|
|
|
+<div class="block">Add a blind BCC recipient to the email using the specified address and
|
|
|
+ the specified personal name.</div>
|
|
|
+</td>
|
|
|
+</tr>
|
|
|
+<tr id="i3" class="rowColor">
|
|
|
+<td class="colFirst"><code><a href="../../../../org/apache/commons/mail/Email.html" title="class in org.apache.commons.mail">Email</a></code></td>
|
|
|
+<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/commons/mail/Email.html#addBcc-java.lang.String-java.lang.String-java.lang.String-">addBcc</a></span>(<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> email,
|
|
|
+ <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> name,
|
|
|
+ <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> charset)</code>
|
|
|
+<div class="block">Add a blind BCC recipient to the email using the specified address,
|
|
|
+ personal name, and charset encoding for the name.</div>
|
|
|
+</td>
|
|
|
+</tr>
|
|
|
+<tr id="i4" class="altColor">
|
|
|
+<td class="colFirst"><code><a href="../../../../org/apache/commons/mail/Email.html" title="class in org.apache.commons.mail">Email</a></code></td>
|
|
|
+<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/commons/mail/Email.html#addCc-java.lang.String...-">addCc</a></span>(<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>... emails)</code>
|
|
|
+<div class="block">Add an array of CC recipients to the email.</div>
|
|
|
+</td>
|
|
|
+</tr>
|
|
|
+<tr id="i5" class="rowColor">
|
|
|
+<td class="colFirst"><code><a href="../../../../org/apache/commons/mail/Email.html" title="class in org.apache.commons.mail">Email</a></code></td>
|
|
|
+<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/commons/mail/Email.html#addCc-java.lang.String-">addCc</a></span>(<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> email)</code>
|
|
|
+<div class="block">Add a recipient CC to the email.</div>
|
|
|
+</td>
|
|
|
+</tr>
|
|
|
+<tr id="i6" class="altColor">
|
|
|
+<td class="colFirst"><code><a href="../../../../org/apache/commons/mail/Email.html" title="class in org.apache.commons.mail">Email</a></code></td>
|
|
|
+<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/commons/mail/Email.html#addCc-java.lang.String-java.lang.String-">addCc</a></span>(<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> email,
|
|
|
+ <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> name)</code>
|
|
|
+<div class="block">Add a recipient CC to the email using the specified address and the
|
|
|
+ specified personal name.</div>
|
|
|
+</td>
|
|
|
+</tr>
|
|
|
+<tr id="i7" class="rowColor">
|
|
|
+<td class="colFirst"><code><a href="../../../../org/apache/commons/mail/Email.html" title="class in org.apache.commons.mail">Email</a></code></td>
|
|
|
+<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/commons/mail/Email.html#addCc-java.lang.String-java.lang.String-java.lang.String-">addCc</a></span>(<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> email,
|
|
|
+ <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> name,
|
|
|
+ <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> charset)</code>
|
|
|
+<div class="block">Add a recipient CC to the email using the specified address, personal
|
|
|
+ name, and charset encoding for the name.</div>
|
|
|
+</td>
|
|
|
+</tr>
|
|
|
+<tr id="i8" class="altColor">
|
|
|
+<td class="colFirst"><code>void</code></td>
|
|
|
+<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/commons/mail/Email.html#addHeader-java.lang.String-java.lang.String-">addHeader</a></span>(<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> name,
|
|
|
+ <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> value)</code>
|
|
|
+<div class="block">Adds a header ( name, value ) to the headers Map.</div>
|
|
|
+</td>
|
|
|
+</tr>
|
|
|
+<tr id="i9" class="rowColor">
|
|
|
+<td class="colFirst"><code><a href="../../../../org/apache/commons/mail/Email.html" title="class in org.apache.commons.mail">Email</a></code></td>
|
|
|
+<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/commons/mail/Email.html#addReplyTo-java.lang.String-">addReplyTo</a></span>(<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> email)</code>
|
|
|
+<div class="block">Add a reply to address to the email.</div>
|
|
|
+</td>
|
|
|
+</tr>
|
|
|
+<tr id="i10" class="altColor">
|
|
|
+<td class="colFirst"><code><a href="../../../../org/apache/commons/mail/Email.html" title="class in org.apache.commons.mail">Email</a></code></td>
|
|
|
+<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/commons/mail/Email.html#addReplyTo-java.lang.String-java.lang.String-">addReplyTo</a></span>(<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> email,
|
|
|
+ <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> name)</code>
|
|
|
+<div class="block">Add a reply to address to the email using the specified address and
|
|
|
+ the specified personal name.</div>
|
|
|
+</td>
|
|
|
+</tr>
|
|
|
+<tr id="i11" class="rowColor">
|
|
|
+<td class="colFirst"><code><a href="../../../../org/apache/commons/mail/Email.html" title="class in org.apache.commons.mail">Email</a></code></td>
|
|
|
+<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/commons/mail/Email.html#addReplyTo-java.lang.String-java.lang.String-java.lang.String-">addReplyTo</a></span>(<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> email,
|
|
|
+ <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> name,
|
|
|
+ <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> charset)</code>
|
|
|
+<div class="block">Add a reply to address to the email using the specified address,
|
|
|
+ personal name, and charset encoding for the name.</div>
|
|
|
+</td>
|
|
|
+</tr>
|
|
|
+<tr id="i12" class="altColor">
|
|
|
+<td class="colFirst"><code><a href="../../../../org/apache/commons/mail/Email.html" title="class in org.apache.commons.mail">Email</a></code></td>
|
|
|
+<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/commons/mail/Email.html#addTo-java.lang.String...-">addTo</a></span>(<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>... emails)</code>
|
|
|
+<div class="block">Add a list of TO recipients to the email.</div>
|
|
|
+</td>
|
|
|
+</tr>
|
|
|
+<tr id="i13" class="rowColor">
|
|
|
+<td class="colFirst"><code><a href="../../../../org/apache/commons/mail/Email.html" title="class in org.apache.commons.mail">Email</a></code></td>
|
|
|
+<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/commons/mail/Email.html#addTo-java.lang.String-">addTo</a></span>(<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> email)</code>
|
|
|
+<div class="block">Add a recipient TO to the email.</div>
|
|
|
+</td>
|
|
|
+</tr>
|
|
|
+<tr id="i14" class="altColor">
|
|
|
+<td class="colFirst"><code><a href="../../../../org/apache/commons/mail/Email.html" title="class in org.apache.commons.mail">Email</a></code></td>
|
|
|
+<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/commons/mail/Email.html#addTo-java.lang.String-java.lang.String-">addTo</a></span>(<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> email,
|
|
|
+ <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> name)</code>
|
|
|
+<div class="block">Add a recipient TO to the email using the specified address and the
|
|
|
+ specified personal name.</div>
|
|
|
+</td>
|
|
|
+</tr>
|
|
|
+<tr id="i15" class="rowColor">
|
|
|
+<td class="colFirst"><code><a href="../../../../org/apache/commons/mail/Email.html" title="class in org.apache.commons.mail">Email</a></code></td>
|
|
|
+<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/commons/mail/Email.html#addTo-java.lang.String-java.lang.String-java.lang.String-">addTo</a></span>(<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> email,
|
|
|
+ <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> name,
|
|
|
+ <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> charset)</code>
|
|
|
+<div class="block">Add a recipient TO to the email using the specified address, personal
|
|
|
+ name, and charset encoding for the name.</div>
|
|
|
+</td>
|
|
|
+</tr>
|
|
|
+<tr id="i16" class="altColor">
|
|
|
+<td class="colFirst"><code>void</code></td>
|
|
|
+<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/commons/mail/Email.html#buildMimeMessage--">buildMimeMessage</a></span>()</code>
|
|
|
+<div class="block">Does the work of actually building the MimeMessage.</div>
|
|
|
+</td>
|
|
|
+</tr>
|
|
|
+<tr id="i17" class="rowColor">
|
|
|
+<td class="colFirst"><code>protected <a href="http://docs.oracle.com/javaee/6/api/javax/mail/internet/MimeMessage.html?is-external=true" title="class or interface in javax.mail.internet">MimeMessage</a></code></td>
|
|
|
+<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/commons/mail/Email.html#createMimeMessage-javax.mail.Session-">createMimeMessage</a></span>(<a href="http://docs.oracle.com/javaee/6/api/javax/mail/Session.html?is-external=true" title="class or interface in javax.mail">Session</a> aSession)</code>
|
|
|
+<div class="block">Factory method to create a customized MimeMessage which can be
|
|
|
+ implemented by a derived class, e.g. to set the message id.</div>
|
|
|
+</td>
|
|
|
+</tr>
|
|
|
+<tr id="i18" class="altColor">
|
|
|
+<td class="colFirst"><code><a href="http://docs.oracle.com/javase/7/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</a><<a href="http://docs.oracle.com/javaee/6/api/javax/mail/internet/InternetAddress.html?is-external=true" title="class or interface in javax.mail.internet">InternetAddress</a>></code></td>
|
|
|
+<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/commons/mail/Email.html#getBccAddresses--">getBccAddresses</a></span>()</code>
|
|
|
+<div class="block">Get the list of "Bcc" addresses.</div>
|
|
|
+</td>
|
|
|
+</tr>
|
|
|
+<tr id="i19" class="rowColor">
|
|
|
+<td class="colFirst"><code><a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a></code></td>
|
|
|
+<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/commons/mail/Email.html#getBounceAddress--">getBounceAddress</a></span>()</code>
|
|
|
+<div class="block">Gets the "bounce address" of this email.</div>
|
|
|
+</td>
|
|
|
+</tr>
|
|
|
+<tr id="i20" class="altColor">
|
|
|
+<td class="colFirst"><code><a href="http://docs.oracle.com/javase/7/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</a><<a href="http://docs.oracle.com/javaee/6/api/javax/mail/internet/InternetAddress.html?is-external=true" title="class or interface in javax.mail.internet">InternetAddress</a>></code></td>
|
|
|
+<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/commons/mail/Email.html#getCcAddresses--">getCcAddresses</a></span>()</code>
|
|
|
+<div class="block">Get the list of "CC" addresses.</div>
|
|
|
+</td>
|
|
|
+</tr>
|
|
|
+<tr id="i21" class="rowColor">
|
|
|
+<td class="colFirst"><code><a href="http://docs.oracle.com/javaee/6/api/javax/mail/internet/InternetAddress.html?is-external=true" title="class or interface in javax.mail.internet">InternetAddress</a></code></td>
|
|
|
+<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/commons/mail/Email.html#getFromAddress--">getFromAddress</a></span>()</code>
|
|
|
+<div class="block">Gets the sender of the email.</div>
|
|
|
+</td>
|
|
|
+</tr>
|
|
|
+<tr id="i22" class="altColor">
|
|
|
+<td class="colFirst"><code><a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a></code></td>
|
|
|
+<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/commons/mail/Email.html#getHeader-java.lang.String-">getHeader</a></span>(<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> header)</code>
|
|
|
+<div class="block">Gets the specified header.</div>
|
|
|
+</td>
|
|
|
+</tr>
|
|
|
+<tr id="i23" class="rowColor">
|
|
|
+<td class="colFirst"><code><a href="http://docs.oracle.com/javase/7/docs/api/java/util/Map.html?is-external=true" title="class or interface in java.util">Map</a><<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>,<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>></code></td>
|
|
|
+<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/commons/mail/Email.html#getHeaders--">getHeaders</a></span>()</code>
|
|
|
+<div class="block">Gets all headers on an Email.</div>
|
|
|
+</td>
|
|
|
+</tr>
|
|
|
+<tr id="i24" class="altColor">
|
|
|
+<td class="colFirst"><code><a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a></code></td>
|
|
|
+<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/commons/mail/Email.html#getHostName--">getHostName</a></span>()</code>
|
|
|
+<div class="block">Gets the host name of the SMTP server,</div>
|
|
|
+</td>
|
|
|
+</tr>
|
|
|
+<tr id="i25" class="rowColor">
|
|
|
+<td class="colFirst"><code><a href="http://docs.oracle.com/javaee/6/api/javax/mail/Session.html?is-external=true" title="class or interface in javax.mail">Session</a></code></td>
|
|
|
+<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/commons/mail/Email.html#getMailSession--">getMailSession</a></span>()</code>
|
|
|
+<div class="block">Determines the mail session used when sending this Email, creating
|
|
|
+ the Session if necessary.</div>
|
|
|
+</td>
|
|
|
+</tr>
|
|
|
+<tr id="i26" class="altColor">
|
|
|
+<td class="colFirst"><code><a href="http://docs.oracle.com/javaee/6/api/javax/mail/internet/MimeMessage.html?is-external=true" title="class or interface in javax.mail.internet">MimeMessage</a></code></td>
|
|
|
+<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/commons/mail/Email.html#getMimeMessage--">getMimeMessage</a></span>()</code>
|
|
|
+<div class="block">Returns the internal MimeMessage.</div>
|
|
|
+</td>
|
|
|
+</tr>
|
|
|
+<tr id="i27" class="rowColor">
|
|
|
+<td class="colFirst"><code><a href="http://docs.oracle.com/javase/7/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</a><<a href="http://docs.oracle.com/javaee/6/api/javax/mail/internet/InternetAddress.html?is-external=true" title="class or interface in javax.mail.internet">InternetAddress</a>></code></td>
|
|
|
+<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/commons/mail/Email.html#getReplyToAddresses--">getReplyToAddresses</a></span>()</code>
|
|
|
+<div class="block">Get the list of "Reply-To" addresses.</div>
|
|
|
+</td>
|
|
|
+</tr>
|
|
|
+<tr id="i28" class="altColor">
|
|
|
+<td class="colFirst"><code><a href="http://docs.oracle.com/javase/7/docs/api/java/util/Date.html?is-external=true" title="class or interface in java.util">Date</a></code></td>
|
|
|
+<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/commons/mail/Email.html#getSentDate--">getSentDate</a></span>()</code>
|
|
|
+<div class="block">Gets the sent date for the email.</div>
|
|
|
+</td>
|
|
|
+</tr>
|
|
|
+<tr id="i29" class="rowColor">
|
|
|
+<td class="colFirst"><code><a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a></code></td>
|
|
|
+<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/commons/mail/Email.html#getSmtpPort--">getSmtpPort</a></span>()</code>
|
|
|
+<div class="block">Gets the listening port of the SMTP server.</div>
|
|
|
+</td>
|
|
|
+</tr>
|
|
|
+<tr id="i30" class="altColor">
|
|
|
+<td class="colFirst"><code>int</code></td>
|
|
|
+<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/commons/mail/Email.html#getSocketConnectionTimeout--">getSocketConnectionTimeout</a></span>()</code>
|
|
|
+<div class="block">Get the socket connection timeout value in milliseconds.</div>
|
|
|
+</td>
|
|
|
+</tr>
|
|
|
+<tr id="i31" class="rowColor">
|
|
|
+<td class="colFirst"><code>int</code></td>
|
|
|
+<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/commons/mail/Email.html#getSocketTimeout--">getSocketTimeout</a></span>()</code>
|
|
|
+<div class="block">Get the socket I/O timeout value in milliseconds.</div>
|
|
|
+</td>
|
|
|
+</tr>
|
|
|
+<tr id="i32" class="altColor">
|
|
|
+<td class="colFirst"><code><a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a></code></td>
|
|
|
+<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/commons/mail/Email.html#getSslSmtpPort--">getSslSmtpPort</a></span>()</code>
|
|
|
+<div class="block">Returns the current SSL port used by the SMTP transport.</div>
|
|
|
+</td>
|
|
|
+</tr>
|
|
|
+<tr id="i33" class="rowColor">
|
|
|
+<td class="colFirst"><code><a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a></code></td>
|
|
|
+<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/commons/mail/Email.html#getSubject--">getSubject</a></span>()</code>
|
|
|
+<div class="block">Gets the subject of the email.</div>
|
|
|
+</td>
|
|
|
+</tr>
|
|
|
+<tr id="i34" class="altColor">
|
|
|
+<td class="colFirst"><code><a href="http://docs.oracle.com/javase/7/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</a><<a href="http://docs.oracle.com/javaee/6/api/javax/mail/internet/InternetAddress.html?is-external=true" title="class or interface in javax.mail.internet">InternetAddress</a>></code></td>
|
|
|
+<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/commons/mail/Email.html#getToAddresses--">getToAddresses</a></span>()</code>
|
|
|
+<div class="block">Get the list of "To" addresses.</div>
|
|
|
+</td>
|
|
|
+</tr>
|
|
|
+<tr id="i35" class="rowColor">
|
|
|
+<td class="colFirst"><code>boolean</code></td>
|
|
|
+<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/commons/mail/Email.html#isSendPartial--">isSendPartial</a></span>()</code>
|
|
|
+<div class="block">If partial sending of email enabled.</div>
|
|
|
+</td>
|
|
|
+</tr>
|
|
|
+<tr id="i36" class="altColor">
|
|
|
+<td class="colFirst"><code>boolean</code></td>
|
|
|
+<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/commons/mail/Email.html#isSSL--">isSSL</a></span>()</code>
|
|
|
+<div class="block"><span class="deprecatedLabel">Deprecated.</span>
|
|
|
+<div class="block"><span class="deprecationComment">since 1.3, use isSSLOnConnect() instead</span></div>
|
|
|
+</div>
|
|
|
+</td>
|
|
|
+</tr>
|
|
|
+<tr id="i37" class="rowColor">
|
|
|
+<td class="colFirst"><code>boolean</code></td>
|
|
|
+<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/commons/mail/Email.html#isSSLCheckServerIdentity--">isSSLCheckServerIdentity</a></span>()</code>
|
|
|
+<div class="block">Is the server identity checked as specified by RFC 2595</div>
|
|
|
+</td>
|
|
|
+</tr>
|
|
|
+<tr id="i38" class="altColor">
|
|
|
+<td class="colFirst"><code>boolean</code></td>
|
|
|
+<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/commons/mail/Email.html#isSSLOnConnect--">isSSLOnConnect</a></span>()</code>
|
|
|
+<div class="block">Returns whether SSL/TLS encryption for the transport is currently enabled (SMTPS/POPS).</div>
|
|
|
+</td>
|
|
|
+</tr>
|
|
|
+<tr id="i39" class="rowColor">
|
|
|
+<td class="colFirst"><code>boolean</code></td>
|
|
|
+<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/commons/mail/Email.html#isStartTLSEnabled--">isStartTLSEnabled</a></span>()</code>
|
|
|
+<div class="block">Gets whether the client is configured to try to enable STARTTLS.</div>
|
|
|
+</td>
|
|
|
+</tr>
|
|
|
+<tr id="i40" class="altColor">
|
|
|
+<td class="colFirst"><code>boolean</code></td>
|
|
|
+<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/commons/mail/Email.html#isStartTLSRequired--">isStartTLSRequired</a></span>()</code>
|
|
|
+<div class="block">Gets whether the client is configured to require STARTTLS.</div>
|
|
|
+</td>
|
|
|
+</tr>
|
|
|
+<tr id="i41" class="rowColor">
|
|
|
+<td class="colFirst"><code>boolean</code></td>
|
|
|
+<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/commons/mail/Email.html#isTLS--">isTLS</a></span>()</code>
|
|
|
+<div class="block"><span class="deprecatedLabel">Deprecated.</span>
|
|
|
+<div class="block"><span class="deprecationComment">since 1.3, use isStartTLSEnabled() instead</span></div>
|
|
|
+</div>
|
|
|
+</td>
|
|
|
+</tr>
|
|
|
+<tr id="i42" class="altColor">
|
|
|
+<td class="colFirst"><code><a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a></code></td>
|
|
|
+<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/commons/mail/Email.html#send--">send</a></span>()</code>
|
|
|
+<div class="block">Sends the email.</div>
|
|
|
+</td>
|
|
|
+</tr>
|
|
|
+<tr id="i43" class="rowColor">
|
|
|
+<td class="colFirst"><code><a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a></code></td>
|
|
|
+<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/commons/mail/Email.html#sendMimeMessage--">sendMimeMessage</a></span>()</code>
|
|
|
+<div class="block">Sends the previously created MimeMessage to the SMTP server.</div>
|
|
|
+</td>
|
|
|
+</tr>
|
|
|
+<tr id="i44" class="altColor">
|
|
|
+<td class="colFirst"><code>void</code></td>
|
|
|
+<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/commons/mail/Email.html#setAuthentication-java.lang.String-java.lang.String-">setAuthentication</a></span>(<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> userName,
|
|
|
+ <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> password)</code>
|
|
|
+<div class="block">Sets the userName and password if authentication is needed.</div>
|
|
|
+</td>
|
|
|
+</tr>
|
|
|
+<tr id="i45" class="rowColor">
|
|
|
+<td class="colFirst"><code>void</code></td>
|
|
|
+<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/commons/mail/Email.html#setAuthenticator-javax.mail.Authenticator-">setAuthenticator</a></span>(<a href="http://docs.oracle.com/javaee/6/api/javax/mail/Authenticator.html?is-external=true" title="class or interface in javax.mail">Authenticator</a> newAuthenticator)</code>
|
|
|
+<div class="block">Sets the <code>Authenticator</code> to be used when authentication
|
|
|
+ is requested from the mail server.</div>
|
|
|
+</td>
|
|
|
+</tr>
|
|
|
+<tr id="i46" class="altColor">
|
|
|
+<td class="colFirst"><code><a href="../../../../org/apache/commons/mail/Email.html" title="class in org.apache.commons.mail">Email</a></code></td>
|
|
|
+<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/commons/mail/Email.html#setBcc-java.util.Collection-">setBcc</a></span>(<a href="http://docs.oracle.com/javase/7/docs/api/java/util/Collection.html?is-external=true" title="class or interface in java.util">Collection</a><<a href="http://docs.oracle.com/javaee/6/api/javax/mail/internet/InternetAddress.html?is-external=true" title="class or interface in javax.mail.internet">InternetAddress</a>> aCollection)</code>
|
|
|
+<div class="block">Set a list of "BCC" addresses.</div>
|
|
|
+</td>
|
|
|
+</tr>
|
|
|
+<tr id="i47" class="rowColor">
|
|
|
+<td class="colFirst"><code><a href="../../../../org/apache/commons/mail/Email.html" title="class in org.apache.commons.mail">Email</a></code></td>
|
|
|
+<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/commons/mail/Email.html#setBounceAddress-java.lang.String-">setBounceAddress</a></span>(<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> email)</code>
|
|
|
+<div class="block">Set the "bounce address" - the address to which undeliverable messages
|
|
|
+ will be returned.</div>
|
|
|
+</td>
|
|
|
+</tr>
|
|
|
+<tr id="i48" class="altColor">
|
|
|
+<td class="colFirst"><code><a href="../../../../org/apache/commons/mail/Email.html" title="class in org.apache.commons.mail">Email</a></code></td>
|
|
|
+<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/commons/mail/Email.html#setCc-java.util.Collection-">setCc</a></span>(<a href="http://docs.oracle.com/javase/7/docs/api/java/util/Collection.html?is-external=true" title="class or interface in java.util">Collection</a><<a href="http://docs.oracle.com/javaee/6/api/javax/mail/internet/InternetAddress.html?is-external=true" title="class or interface in javax.mail.internet">InternetAddress</a>> aCollection)</code>
|
|
|
+<div class="block">Set a list of "CC" addresses.</div>
|
|
|
+</td>
|
|
|
+</tr>
|
|
|
+<tr id="i49" class="rowColor">
|
|
|
+<td class="colFirst"><code>void</code></td>
|
|
|
+<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/commons/mail/Email.html#setCharset-java.lang.String-">setCharset</a></span>(<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> newCharset)</code>
|
|
|
+<div class="block">Set the charset of the message.</div>
|
|
|
+</td>
|
|
|
+</tr>
|
|
|
+<tr id="i50" class="altColor">
|
|
|
+<td class="colFirst"><code>void</code></td>
|
|
|
+<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/commons/mail/Email.html#setContent-javax.mail.internet.MimeMultipart-">setContent</a></span>(<a href="http://docs.oracle.com/javaee/6/api/javax/mail/internet/MimeMultipart.html?is-external=true" title="class or interface in javax.mail.internet">MimeMultipart</a> aMimeMultipart)</code>
|
|
|
+<div class="block">Set the emailBody to a MimeMultiPart</div>
|
|
|
+</td>
|
|
|
+</tr>
|
|
|
+<tr id="i51" class="rowColor">
|
|
|
+<td class="colFirst"><code>void</code></td>
|
|
|
+<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/commons/mail/Email.html#setContent-java.lang.Object-java.lang.String-">setContent</a></span>(<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a> aObject,
|
|
|
+ <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> aContentType)</code>
|
|
|
+<div class="block">Set the content and contentType.</div>
|
|
|
+</td>
|
|
|
+</tr>
|
|
|
+<tr id="i52" class="altColor">
|
|
|
+<td class="colFirst"><code>void</code></td>
|
|
|
+<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/commons/mail/Email.html#setDebug-boolean-">setDebug</a></span>(boolean d)</code>
|
|
|
+<div class="block">Setting to true will enable the display of debug information.</div>
|
|
|
+</td>
|
|
|
+</tr>
|
|
|
+<tr id="i53" class="rowColor">
|
|
|
+<td class="colFirst"><code><a href="../../../../org/apache/commons/mail/Email.html" title="class in org.apache.commons.mail">Email</a></code></td>
|
|
|
+<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/commons/mail/Email.html#setFrom-java.lang.String-">setFrom</a></span>(<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> email)</code>
|
|
|
+<div class="block">Set the FROM field of the email to use the specified address.</div>
|
|
|
+</td>
|
|
|
+</tr>
|
|
|
+<tr id="i54" class="altColor">
|
|
|
+<td class="colFirst"><code><a href="../../../../org/apache/commons/mail/Email.html" title="class in org.apache.commons.mail">Email</a></code></td>
|
|
|
+<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/commons/mail/Email.html#setFrom-java.lang.String-java.lang.String-">setFrom</a></span>(<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> email,
|
|
|
+ <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> name)</code>
|
|
|
+<div class="block">Set the FROM field of the email to use the specified address and the
|
|
|
+ specified personal name.</div>
|
|
|
+</td>
|
|
|
+</tr>
|
|
|
+<tr id="i55" class="rowColor">
|
|
|
+<td class="colFirst"><code><a href="../../../../org/apache/commons/mail/Email.html" title="class in org.apache.commons.mail">Email</a></code></td>
|
|
|
+<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/commons/mail/Email.html#setFrom-java.lang.String-java.lang.String-java.lang.String-">setFrom</a></span>(<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> email,
|
|
|
+ <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> name,
|
|
|
+ <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> charset)</code>
|
|
|
+<div class="block">Set the FROM field of the email to use the specified address, personal
|
|
|
+ name, and charset encoding for the name.</div>
|
|
|
+</td>
|
|
|
+</tr>
|
|
|
+<tr id="i56" class="altColor">
|
|
|
+<td class="colFirst"><code>void</code></td>
|
|
|
+<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/commons/mail/Email.html#setHeaders-java.util.Map-">setHeaders</a></span>(<a href="http://docs.oracle.com/javase/7/docs/api/java/util/Map.html?is-external=true" title="class or interface in java.util">Map</a><<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>,<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>> map)</code>
|
|
|
+<div class="block">Used to specify the mail headers.</div>
|
|
|
+</td>
|
|
|
+</tr>
|
|
|
+<tr id="i57" class="rowColor">
|
|
|
+<td class="colFirst"><code>void</code></td>
|
|
|
+<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/commons/mail/Email.html#setHostName-java.lang.String-">setHostName</a></span>(<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> aHostName)</code>
|
|
|
+<div class="block">Set the hostname of the outgoing mail server.</div>
|
|
|
+</td>
|
|
|
+</tr>
|
|
|
+<tr id="i58" class="altColor">
|
|
|
+<td class="colFirst"><code>void</code></td>
|
|
|
+<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/commons/mail/Email.html#setMailSession-javax.mail.Session-">setMailSession</a></span>(<a href="http://docs.oracle.com/javaee/6/api/javax/mail/Session.html?is-external=true" title="class or interface in javax.mail">Session</a> aSession)</code>
|
|
|
+<div class="block">Supply a mail Session object to use.</div>
|
|
|
+</td>
|
|
|
+</tr>
|
|
|
+<tr id="i59" class="rowColor">
|
|
|
+<td class="colFirst"><code>void</code></td>
|
|
|
+<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/commons/mail/Email.html#setMailSessionFromJNDI-java.lang.String-">setMailSessionFromJNDI</a></span>(<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> jndiName)</code>
|
|
|
+<div class="block">Supply a mail Session object from a JNDI directory.</div>
|
|
|
+</td>
|
|
|
+</tr>
|
|
|
+<tr id="i60" class="altColor">
|
|
|
+<td class="colFirst"><code>abstract <a href="../../../../org/apache/commons/mail/Email.html" title="class in org.apache.commons.mail">Email</a></code></td>
|
|
|
+<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/commons/mail/Email.html#setMsg-java.lang.String-">setMsg</a></span>(<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> msg)</code>
|
|
|
+<div class="block">Define the content of the mail.</div>
|
|
|
+</td>
|
|
|
+</tr>
|
|
|
+<tr id="i61" class="rowColor">
|
|
|
+<td class="colFirst"><code>void</code></td>
|
|
|
+<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/commons/mail/Email.html#setPopBeforeSmtp-boolean-java.lang.String-java.lang.String-java.lang.String-">setPopBeforeSmtp</a></span>(boolean newPopBeforeSmtp,
|
|
|
+ <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> newPopHost,
|
|
|
+ <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> newPopUsername,
|
|
|
+ <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> newPopPassword)</code>
|
|
|
+<div class="block">Set details regarding "pop3 before smtp" authentication.</div>
|
|
|
+</td>
|
|
|
+</tr>
|
|
|
+<tr id="i62" class="altColor">
|
|
|
+<td class="colFirst"><code><a href="../../../../org/apache/commons/mail/Email.html" title="class in org.apache.commons.mail">Email</a></code></td>
|
|
|
+<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/commons/mail/Email.html#setReplyTo-java.util.Collection-">setReplyTo</a></span>(<a href="http://docs.oracle.com/javase/7/docs/api/java/util/Collection.html?is-external=true" title="class or interface in java.util">Collection</a><<a href="http://docs.oracle.com/javaee/6/api/javax/mail/internet/InternetAddress.html?is-external=true" title="class or interface in javax.mail.internet">InternetAddress</a>> aCollection)</code>
|
|
|
+<div class="block">Set a list of reply to addresses.</div>
|
|
|
+</td>
|
|
|
+</tr>
|
|
|
+<tr id="i63" class="rowColor">
|
|
|
+<td class="colFirst"><code><a href="../../../../org/apache/commons/mail/Email.html" title="class in org.apache.commons.mail">Email</a></code></td>
|
|
|
+<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/commons/mail/Email.html#setSendPartial-boolean-">setSendPartial</a></span>(boolean sendPartial)</code>
|
|
|
+<div class="block">Sets whether the email is partially send in case of invalid addresses.</div>
|
|
|
+</td>
|
|
|
+</tr>
|
|
|
+<tr id="i64" class="altColor">
|
|
|
+<td class="colFirst"><code>void</code></td>
|
|
|
+<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/commons/mail/Email.html#setSentDate-java.util.Date-">setSentDate</a></span>(<a href="http://docs.oracle.com/javase/7/docs/api/java/util/Date.html?is-external=true" title="class or interface in java.util">Date</a> date)</code>
|
|
|
+<div class="block">Sets the sent date for the email.</div>
|
|
|
+</td>
|
|
|
+</tr>
|
|
|
+<tr id="i65" class="rowColor">
|
|
|
+<td class="colFirst"><code>void</code></td>
|
|
|
+<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/commons/mail/Email.html#setSmtpPort-int-">setSmtpPort</a></span>(int aPortNumber)</code>
|
|
|
+<div class="block">Set the non-SSL port number of the outgoing mail server.</div>
|
|
|
+</td>
|
|
|
+</tr>
|
|
|
+<tr id="i66" class="altColor">
|
|
|
+<td class="colFirst"><code>void</code></td>
|
|
|
+<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/commons/mail/Email.html#setSocketConnectionTimeout-int-">setSocketConnectionTimeout</a></span>(int socketConnectionTimeout)</code>
|
|
|
+<div class="block">Set the socket connection timeout value in milliseconds.</div>
|
|
|
+</td>
|
|
|
+</tr>
|
|
|
+<tr id="i67" class="rowColor">
|
|
|
+<td class="colFirst"><code>void</code></td>
|
|
|
+<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/commons/mail/Email.html#setSocketTimeout-int-">setSocketTimeout</a></span>(int socketTimeout)</code>
|
|
|
+<div class="block">Set the socket I/O timeout value in milliseconds.</div>
|
|
|
+</td>
|
|
|
+</tr>
|
|
|
+<tr id="i68" class="altColor">
|
|
|
+<td class="colFirst"><code>void</code></td>
|
|
|
+<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/commons/mail/Email.html#setSSL-boolean-">setSSL</a></span>(boolean ssl)</code>
|
|
|
+<div class="block"><span class="deprecatedLabel">Deprecated.</span>
|
|
|
+<div class="block"><span class="deprecationComment">since 1.3, use setSSLOnConnect() instead</span></div>
|
|
|
+</div>
|
|
|
+</td>
|
|
|
+</tr>
|
|
|
+<tr id="i69" class="rowColor">
|
|
|
+<td class="colFirst"><code><a href="../../../../org/apache/commons/mail/Email.html" title="class in org.apache.commons.mail">Email</a></code></td>
|
|
|
+<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/commons/mail/Email.html#setSSLCheckServerIdentity-boolean-">setSSLCheckServerIdentity</a></span>(boolean sslCheckServerIdentity)</code>
|
|
|
+<div class="block">Sets whether the server identity is checked as specified by RFC 2595</div>
|
|
|
+</td>
|
|
|
+</tr>
|
|
|
+<tr id="i70" class="altColor">
|
|
|
+<td class="colFirst"><code><a href="../../../../org/apache/commons/mail/Email.html" title="class in org.apache.commons.mail">Email</a></code></td>
|
|
|
+<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/commons/mail/Email.html#setSSLOnConnect-boolean-">setSSLOnConnect</a></span>(boolean ssl)</code>
|
|
|
+<div class="block">Sets whether SSL/TLS encryption should be enabled for the SMTP transport upon connection (SMTPS/POPS).</div>
|
|
|
+</td>
|
|
|
+</tr>
|
|
|
+<tr id="i71" class="rowColor">
|
|
|
+<td class="colFirst"><code>void</code></td>
|
|
|
+<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/commons/mail/Email.html#setSslSmtpPort-java.lang.String-">setSslSmtpPort</a></span>(<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> sslSmtpPort)</code>
|
|
|
+<div class="block">Sets the SSL port to use for the SMTP transport.</div>
|
|
|
+</td>
|
|
|
+</tr>
|
|
|
+<tr id="i72" class="altColor">
|
|
|
+<td class="colFirst"><code><a href="../../../../org/apache/commons/mail/Email.html" title="class in org.apache.commons.mail">Email</a></code></td>
|
|
|
+<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/commons/mail/Email.html#setStartTLSEnabled-boolean-">setStartTLSEnabled</a></span>(boolean startTlsEnabled)</code>
|
|
|
+<div class="block">Set or disable the STARTTLS encryption.</div>
|
|
|
+</td>
|
|
|
+</tr>
|
|
|
+<tr id="i73" class="rowColor">
|
|
|
+<td class="colFirst"><code><a href="../../../../org/apache/commons/mail/Email.html" title="class in org.apache.commons.mail">Email</a></code></td>
|
|
|
+<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/commons/mail/Email.html#setStartTLSRequired-boolean-">setStartTLSRequired</a></span>(boolean startTlsRequired)</code>
|
|
|
+<div class="block">Set or disable the required STARTTLS encryption.</div>
|
|
|
+</td>
|
|
|
+</tr>
|
|
|
+<tr id="i74" class="altColor">
|
|
|
+<td class="colFirst"><code><a href="../../../../org/apache/commons/mail/Email.html" title="class in org.apache.commons.mail">Email</a></code></td>
|
|
|
+<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/commons/mail/Email.html#setSubject-java.lang.String-">setSubject</a></span>(<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> aSubject)</code>
|
|
|
+<div class="block">Sets the email subject.</div>
|
|
|
+</td>
|
|
|
+</tr>
|
|
|
+<tr id="i75" class="rowColor">
|
|
|
+<td class="colFirst"><code>void</code></td>
|
|
|
+<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/commons/mail/Email.html#setTLS-boolean-">setTLS</a></span>(boolean withTLS)</code>
|
|
|
+<div class="block"><span class="deprecatedLabel">Deprecated.</span>
|
|
|
+<div class="block"><span class="deprecationComment">since 1.3, use setStartTLSEnabled() instead</span></div>
|
|
|
+</div>
|
|
|
+</td>
|
|
|
+</tr>
|
|
|
+<tr id="i76" class="altColor">
|
|
|
+<td class="colFirst"><code><a href="../../../../org/apache/commons/mail/Email.html" title="class in org.apache.commons.mail">Email</a></code></td>
|
|
|
+<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/commons/mail/Email.html#setTo-java.util.Collection-">setTo</a></span>(<a href="http://docs.oracle.com/javase/7/docs/api/java/util/Collection.html?is-external=true" title="class or interface in java.util">Collection</a><<a href="http://docs.oracle.com/javaee/6/api/javax/mail/internet/InternetAddress.html?is-external=true" title="class or interface in javax.mail.internet">InternetAddress</a>> aCollection)</code>
|
|
|
+<div class="block">Set a list of "TO" addresses.</div>
|
|
|
+</td>
|
|
|
+</tr>
|
|
|
+<tr id="i77" class="rowColor">
|
|
|
+<td class="colFirst"><code>protected <a href="http://docs.oracle.com/javaee/6/api/javax/mail/internet/InternetAddress.html?is-external=true" title="class or interface in javax.mail.internet">InternetAddress</a>[]</code></td>
|
|
|
+<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/commons/mail/Email.html#toInternetAddressArray-java.util.List-">toInternetAddressArray</a></span>(<a href="http://docs.oracle.com/javase/7/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</a><<a href="http://docs.oracle.com/javaee/6/api/javax/mail/internet/InternetAddress.html?is-external=true" title="class or interface in javax.mail.internet">InternetAddress</a>> list)</code>
|
|
|
+<div class="block">Utility to copy List of known InternetAddress objects into an
|
|
|
+ array.</div>
|
|
|
+</td>
|
|
|
+</tr>
|
|
|
+<tr id="i78" class="altColor">
|
|
|
+<td class="colFirst"><code>void</code></td>
|
|
|
+<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/commons/mail/Email.html#updateContentType-java.lang.String-">updateContentType</a></span>(<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> aContentType)</code>
|
|
|
+<div class="block">Update the contentType.</div>
|
|
|
+</td>
|
|
|
+</tr>
|
|
|
+</table>
|
|
|
+<ul class="blockList">
|
|
|
+<li class="blockList"><a name="methods.inherited.from.class.java.lang.Object">
|
|
|
+<!-- -->
|
|
|
+</a>
|
|
|
+<h3>Methods inherited from class java.lang.<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a></h3>
|
|
|
+<code><a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#clone--" title="class or interface in java.lang">clone</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#equals-java.lang.Object-" title="class or interface in java.lang">equals</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#finalize--" title="class or interface in java.lang">finalize</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#getClass--" title="class or interface in java.lang">getClass</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#hashCode--" title="class or interface in java.lang">hashCode</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#notify--" title="class or interface in java.lang">notify</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#notifyAll--" title="class or interface in java.lang">notifyAll</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#toString--" title="class or interface in java.lang">toString</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#wait--" title="class or interface in java.lang">wait</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#wait-long-" title="class or interface in java.lang">wait</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#wait-long-int-" title="class or interface in java.lang">wait</a></code></li>
|
|
|
+</ul>
|
|
|
+</li>
|
|
|
+</ul>
|
|
|
+</li>
|
|
|
+</ul>
|
|
|
+</div>
|
|
|
+<div class="details">
|
|
|
+<ul class="blockList">
|
|
|
+<li class="blockList">
|
|
|
+<!-- ============ FIELD DETAIL =========== -->
|
|
|
+<ul class="blockList">
|
|
|
+<li class="blockList"><a name="field.detail">
|
|
|
+<!-- -->
|
|
|
+</a>
|
|
|
+<h3>Field Detail</h3>
|
|
|
+<a name="SENDER_EMAIL">
|
|
|
+<!-- -->
|
|
|
+</a>
|
|
|
+<ul class="blockList">
|
|
|
+<li class="blockList">
|
|
|
+<h4>SENDER_EMAIL</h4>
|
|
|
+<pre><a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Deprecated.html?is-external=true" title="class or interface in java.lang">@Deprecated</a>
|
|
|
+public static final <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> SENDER_EMAIL</pre>
|
|
|
+<div class="block"><span class="deprecatedLabel">Deprecated.</span> <span class="deprecationComment">since 1.3, use <a href="../../../../org/apache/commons/mail/EmailConstants.html#SENDER_EMAIL"><code>EmailConstants.SENDER_EMAIL</code></a> instead</span></div>
|
|
|
+<dl>
|
|
|
+<dt><span class="seeLabel">See Also:</span></dt>
|
|
|
+<dd><a href="../../../../constant-values.html#org.apache.commons.mail.Email.SENDER_EMAIL">Constant Field Values</a></dd>
|
|
|
+</dl>
|
|
|
+</li>
|
|
|
+</ul>
|
|
|
+<a name="SENDER_NAME">
|
|
|
+<!-- -->
|
|
|
+</a>
|
|
|
+<ul class="blockList">
|
|
|
+<li class="blockList">
|
|
|
+<h4>SENDER_NAME</h4>
|
|
|
+<pre><a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Deprecated.html?is-external=true" title="class or interface in java.lang">@Deprecated</a>
|
|
|
+public static final <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> SENDER_NAME</pre>
|
|
|
+<div class="block"><span class="deprecatedLabel">Deprecated.</span> <span class="deprecationComment">since 1.3, use <a href="../../../../org/apache/commons/mail/EmailConstants.html#SENDER_NAME"><code>EmailConstants.SENDER_NAME</code></a> instead</span></div>
|
|
|
+<dl>
|
|
|
+<dt><span class="seeLabel">See Also:</span></dt>
|
|
|
+<dd><a href="../../../../constant-values.html#org.apache.commons.mail.Email.SENDER_NAME">Constant Field Values</a></dd>
|
|
|
+</dl>
|
|
|
+</li>
|
|
|
+</ul>
|
|
|
+<a name="RECEIVER_EMAIL">
|
|
|
+<!-- -->
|
|
|
+</a>
|
|
|
+<ul class="blockList">
|
|
|
+<li class="blockList">
|
|
|
+<h4>RECEIVER_EMAIL</h4>
|
|
|
+<pre><a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Deprecated.html?is-external=true" title="class or interface in java.lang">@Deprecated</a>
|
|
|
+public static final <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> RECEIVER_EMAIL</pre>
|
|
|
+<div class="block"><span class="deprecatedLabel">Deprecated.</span> <span class="deprecationComment">since 1.3, use <a href="../../../../org/apache/commons/mail/EmailConstants.html#RECEIVER_EMAIL"><code>EmailConstants.RECEIVER_EMAIL</code></a> instead</span></div>
|
|
|
+<dl>
|
|
|
+<dt><span class="seeLabel">See Also:</span></dt>
|
|
|
+<dd><a href="../../../../constant-values.html#org.apache.commons.mail.Email.RECEIVER_EMAIL">Constant Field Values</a></dd>
|
|
|
+</dl>
|
|
|
+</li>
|
|
|
+</ul>
|
|
|
+<a name="RECEIVER_NAME">
|
|
|
+<!-- -->
|
|
|
+</a>
|
|
|
+<ul class="blockList">
|
|
|
+<li class="blockList">
|
|
|
+<h4>RECEIVER_NAME</h4>
|
|
|
+<pre><a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Deprecated.html?is-external=true" title="class or interface in java.lang">@Deprecated</a>
|
|
|
+public static final <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> RECEIVER_NAME</pre>
|
|
|
+<div class="block"><span class="deprecatedLabel">Deprecated.</span> <span class="deprecationComment">since 1.3, use <a href="../../../../org/apache/commons/mail/EmailConstants.html#RECEIVER_NAME"><code>EmailConstants.RECEIVER_NAME</code></a> instead</span></div>
|
|
|
+<dl>
|
|
|
+<dt><span class="seeLabel">See Also:</span></dt>
|
|
|
+<dd><a href="../../../../constant-values.html#org.apache.commons.mail.Email.RECEIVER_NAME">Constant Field Values</a></dd>
|
|
|
+</dl>
|
|
|
+</li>
|
|
|
+</ul>
|
|
|
+<a name="EMAIL_SUBJECT">
|
|
|
+<!-- -->
|
|
|
+</a>
|
|
|
+<ul class="blockList">
|
|
|
+<li class="blockList">
|
|
|
+<h4>EMAIL_SUBJECT</h4>
|
|
|
+<pre><a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Deprecated.html?is-external=true" title="class or interface in java.lang">@Deprecated</a>
|
|
|
+public static final <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> EMAIL_SUBJECT</pre>
|
|
|
+<div class="block"><span class="deprecatedLabel">Deprecated.</span> <span class="deprecationComment">since 1.3, use <a href="../../../../org/apache/commons/mail/EmailConstants.html#EMAIL_SUBJECT"><code>EmailConstants.EMAIL_SUBJECT</code></a> instead</span></div>
|
|
|
+<dl>
|
|
|
+<dt><span class="seeLabel">See Also:</span></dt>
|
|
|
+<dd><a href="../../../../constant-values.html#org.apache.commons.mail.Email.EMAIL_SUBJECT">Constant Field Values</a></dd>
|
|
|
+</dl>
|
|
|
+</li>
|
|
|
+</ul>
|
|
|
+<a name="EMAIL_BODY">
|
|
|
+<!-- -->
|
|
|
+</a>
|
|
|
+<ul class="blockList">
|
|
|
+<li class="blockList">
|
|
|
+<h4>EMAIL_BODY</h4>
|
|
|
+<pre><a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Deprecated.html?is-external=true" title="class or interface in java.lang">@Deprecated</a>
|
|
|
+public static final <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> EMAIL_BODY</pre>
|
|
|
+<div class="block"><span class="deprecatedLabel">Deprecated.</span> <span class="deprecationComment">since 1.3, use <a href="../../../../org/apache/commons/mail/EmailConstants.html#EMAIL_BODY"><code>EmailConstants.EMAIL_BODY</code></a> instead</span></div>
|
|
|
+<dl>
|
|
|
+<dt><span class="seeLabel">See Also:</span></dt>
|
|
|
+<dd><a href="../../../../constant-values.html#org.apache.commons.mail.Email.EMAIL_BODY">Constant Field Values</a></dd>
|
|
|
+</dl>
|
|
|
+</li>
|
|
|
+</ul>
|
|
|
+<a name="CONTENT_TYPE">
|
|
|
+<!-- -->
|
|
|
+</a>
|
|
|
+<ul class="blockList">
|
|
|
+<li class="blockList">
|
|
|
+<h4>CONTENT_TYPE</h4>
|
|
|
+<pre><a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Deprecated.html?is-external=true" title="class or interface in java.lang">@Deprecated</a>
|
|
|
+public static final <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> CONTENT_TYPE</pre>
|
|
|
+<div class="block"><span class="deprecatedLabel">Deprecated.</span> <span class="deprecationComment">since 1.3, use <a href="../../../../org/apache/commons/mail/EmailConstants.html#CONTENT_TYPE"><code>EmailConstants.CONTENT_TYPE</code></a> instead</span></div>
|
|
|
+<dl>
|
|
|
+<dt><span class="seeLabel">See Also:</span></dt>
|
|
|
+<dd><a href="../../../../constant-values.html#org.apache.commons.mail.Email.CONTENT_TYPE">Constant Field Values</a></dd>
|
|
|
+</dl>
|
|
|
+</li>
|
|
|
+</ul>
|
|
|
+<a name="ATTACHMENTS">
|
|
|
+<!-- -->
|
|
|
+</a>
|
|
|
+<ul class="blockList">
|
|
|
+<li class="blockList">
|
|
|
+<h4>ATTACHMENTS</h4>
|
|
|
+<pre><a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Deprecated.html?is-external=true" title="class or interface in java.lang">@Deprecated</a>
|
|
|
+public static final <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> ATTACHMENTS</pre>
|
|
|
+<div class="block"><span class="deprecatedLabel">Deprecated.</span> <span class="deprecationComment">since 1.3, use <a href="../../../../org/apache/commons/mail/EmailConstants.html#ATTACHMENTS"><code>EmailConstants.ATTACHMENTS</code></a> instead</span></div>
|
|
|
+<dl>
|
|
|
+<dt><span class="seeLabel">See Also:</span></dt>
|
|
|
+<dd><a href="../../../../constant-values.html#org.apache.commons.mail.Email.ATTACHMENTS">Constant Field Values</a></dd>
|
|
|
+</dl>
|
|
|
+</li>
|
|
|
+</ul>
|
|
|
+<a name="FILE_SERVER">
|
|
|
+<!-- -->
|
|
|
+</a>
|
|
|
+<ul class="blockList">
|
|
|
+<li class="blockList">
|
|
|
+<h4>FILE_SERVER</h4>
|
|
|
+<pre><a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Deprecated.html?is-external=true" title="class or interface in java.lang">@Deprecated</a>
|
|
|
+public static final <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> FILE_SERVER</pre>
|
|
|
+<div class="block"><span class="deprecatedLabel">Deprecated.</span> <span class="deprecationComment">since 1.3, use <a href="../../../../org/apache/commons/mail/EmailConstants.html#FILE_SERVER"><code>EmailConstants.FILE_SERVER</code></a> instead</span></div>
|
|
|
+<dl>
|
|
|
+<dt><span class="seeLabel">See Also:</span></dt>
|
|
|
+<dd><a href="../../../../constant-values.html#org.apache.commons.mail.Email.FILE_SERVER">Constant Field Values</a></dd>
|
|
|
+</dl>
|
|
|
+</li>
|
|
|
+</ul>
|
|
|
+<a name="KOI8_R">
|
|
|
+<!-- -->
|
|
|
+</a>
|
|
|
+<ul class="blockList">
|
|
|
+<li class="blockList">
|
|
|
+<h4>KOI8_R</h4>
|
|
|
+<pre><a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Deprecated.html?is-external=true" title="class or interface in java.lang">@Deprecated</a>
|
|
|
+public static final <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> KOI8_R</pre>
|
|
|
+<div class="block"><span class="deprecatedLabel">Deprecated.</span> <span class="deprecationComment">since 1.3, use <a href="../../../../org/apache/commons/mail/EmailConstants.html#KOI8_R"><code>EmailConstants.KOI8_R</code></a> instead</span></div>
|
|
|
+<dl>
|
|
|
+<dt><span class="seeLabel">See Also:</span></dt>
|
|
|
+<dd><a href="../../../../constant-values.html#org.apache.commons.mail.Email.KOI8_R">Constant Field Values</a></dd>
|
|
|
+</dl>
|
|
|
+</li>
|
|
|
+</ul>
|
|
|
+<a name="ISO_8859_1">
|
|
|
+<!-- -->
|
|
|
+</a>
|
|
|
+<ul class="blockList">
|
|
|
+<li class="blockList">
|
|
|
+<h4>ISO_8859_1</h4>
|
|
|
+<pre><a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Deprecated.html?is-external=true" title="class or interface in java.lang">@Deprecated</a>
|
|
|
+public static final <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> ISO_8859_1</pre>
|
|
|
+<div class="block"><span class="deprecatedLabel">Deprecated.</span> <span class="deprecationComment">since 1.3, use <a href="../../../../org/apache/commons/mail/EmailConstants.html#ISO_8859_1"><code>EmailConstants.ISO_8859_1</code></a> instead</span></div>
|
|
|
+<dl>
|
|
|
+<dt><span class="seeLabel">See Also:</span></dt>
|
|
|
+<dd><a href="../../../../constant-values.html#org.apache.commons.mail.Email.ISO_8859_1">Constant Field Values</a></dd>
|
|
|
+</dl>
|
|
|
+</li>
|
|
|
+</ul>
|
|
|
+<a name="US_ASCII">
|
|
|
+<!-- -->
|
|
|
+</a>
|
|
|
+<ul class="blockList">
|
|
|
+<li class="blockList">
|
|
|
+<h4>US_ASCII</h4>
|
|
|
+<pre><a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Deprecated.html?is-external=true" title="class or interface in java.lang">@Deprecated</a>
|
|
|
+public static final <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> US_ASCII</pre>
|
|
|
+<div class="block"><span class="deprecatedLabel">Deprecated.</span> <span class="deprecationComment">since 1.3, use <a href="../../../../org/apache/commons/mail/EmailConstants.html#US_ASCII"><code>EmailConstants.US_ASCII</code></a> instead</span></div>
|
|
|
+<dl>
|
|
|
+<dt><span class="seeLabel">See Also:</span></dt>
|
|
|
+<dd><a href="../../../../constant-values.html#org.apache.commons.mail.Email.US_ASCII">Constant Field Values</a></dd>
|
|
|
+</dl>
|
|
|
+</li>
|
|
|
+</ul>
|
|
|
+<a name="MAIL_DEBUG">
|
|
|
+<!-- -->
|
|
|
+</a>
|
|
|
+<ul class="blockList">
|
|
|
+<li class="blockList">
|
|
|
+<h4>MAIL_DEBUG</h4>
|
|
|
+<pre><a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Deprecated.html?is-external=true" title="class or interface in java.lang">@Deprecated</a>
|
|
|
+public static final <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> MAIL_DEBUG</pre>
|
|
|
+<div class="block"><span class="deprecatedLabel">Deprecated.</span> <span class="deprecationComment">since 1.3, use <a href="../../../../org/apache/commons/mail/EmailConstants.html#MAIL_DEBUG"><code>EmailConstants.MAIL_DEBUG</code></a> instead</span></div>
|
|
|
+<dl>
|
|
|
+<dt><span class="seeLabel">See Also:</span></dt>
|
|
|
+<dd><a href="../../../../constant-values.html#org.apache.commons.mail.Email.MAIL_DEBUG">Constant Field Values</a></dd>
|
|
|
+</dl>
|
|
|
+</li>
|
|
|
+</ul>
|
|
|
+<a name="MAIL_HOST">
|
|
|
+<!-- -->
|
|
|
+</a>
|
|
|
+<ul class="blockList">
|
|
|
+<li class="blockList">
|
|
|
+<h4>MAIL_HOST</h4>
|
|
|
+<pre><a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Deprecated.html?is-external=true" title="class or interface in java.lang">@Deprecated</a>
|
|
|
+public static final <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> MAIL_HOST</pre>
|
|
|
+<div class="block"><span class="deprecatedLabel">Deprecated.</span> <span class="deprecationComment">since 1.3, use <a href="../../../../org/apache/commons/mail/EmailConstants.html#MAIL_HOST"><code>EmailConstants.MAIL_HOST</code></a> instead</span></div>
|
|
|
+<dl>
|
|
|
+<dt><span class="seeLabel">See Also:</span></dt>
|
|
|
+<dd><a href="../../../../constant-values.html#org.apache.commons.mail.Email.MAIL_HOST">Constant Field Values</a></dd>
|
|
|
+</dl>
|
|
|
+</li>
|
|
|
+</ul>
|
|
|
+<a name="MAIL_PORT">
|
|
|
+<!-- -->
|
|
|
+</a>
|
|
|
+<ul class="blockList">
|
|
|
+<li class="blockList">
|
|
|
+<h4>MAIL_PORT</h4>
|
|
|
+<pre><a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Deprecated.html?is-external=true" title="class or interface in java.lang">@Deprecated</a>
|
|
|
+public static final <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> MAIL_PORT</pre>
|
|
|
+<div class="block"><span class="deprecatedLabel">Deprecated.</span> <span class="deprecationComment">since 1.3, use <a href="../../../../org/apache/commons/mail/EmailConstants.html#MAIL_PORT"><code>EmailConstants.MAIL_PORT</code></a> instead</span></div>
|
|
|
+<dl>
|
|
|
+<dt><span class="seeLabel">See Also:</span></dt>
|
|
|
+<dd><a href="../../../../constant-values.html#org.apache.commons.mail.Email.MAIL_PORT">Constant Field Values</a></dd>
|
|
|
+</dl>
|
|
|
+</li>
|
|
|
+</ul>
|
|
|
+<a name="MAIL_SMTP_FROM">
|
|
|
+<!-- -->
|
|
|
+</a>
|
|
|
+<ul class="blockList">
|
|
|
+<li class="blockList">
|
|
|
+<h4>MAIL_SMTP_FROM</h4>
|
|
|
+<pre><a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Deprecated.html?is-external=true" title="class or interface in java.lang">@Deprecated</a>
|
|
|
+public static final <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> MAIL_SMTP_FROM</pre>
|
|
|
+<div class="block"><span class="deprecatedLabel">Deprecated.</span> <span class="deprecationComment">since 1.3, use <a href="../../../../org/apache/commons/mail/EmailConstants.html#MAIL_SMTP_FROM"><code>EmailConstants.MAIL_SMTP_FROM</code></a> instead</span></div>
|
|
|
+<dl>
|
|
|
+<dt><span class="seeLabel">See Also:</span></dt>
|
|
|
+<dd><a href="../../../../constant-values.html#org.apache.commons.mail.Email.MAIL_SMTP_FROM">Constant Field Values</a></dd>
|
|
|
+</dl>
|
|
|
+</li>
|
|
|
+</ul>
|
|
|
+<a name="MAIL_SMTP_AUTH">
|
|
|
+<!-- -->
|
|
|
+</a>
|
|
|
+<ul class="blockList">
|
|
|
+<li class="blockList">
|
|
|
+<h4>MAIL_SMTP_AUTH</h4>
|
|
|
+<pre><a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Deprecated.html?is-external=true" title="class or interface in java.lang">@Deprecated</a>
|
|
|
+public static final <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> MAIL_SMTP_AUTH</pre>
|
|
|
+<div class="block"><span class="deprecatedLabel">Deprecated.</span> <span class="deprecationComment">since 1.3, use <a href="../../../../org/apache/commons/mail/EmailConstants.html#MAIL_SMTP_AUTH"><code>EmailConstants.MAIL_SMTP_AUTH</code></a> instead</span></div>
|
|
|
+<dl>
|
|
|
+<dt><span class="seeLabel">See Also:</span></dt>
|
|
|
+<dd><a href="../../../../constant-values.html#org.apache.commons.mail.Email.MAIL_SMTP_AUTH">Constant Field Values</a></dd>
|
|
|
+</dl>
|
|
|
+</li>
|
|
|
+</ul>
|
|
|
+<a name="MAIL_SMTP_USER">
|
|
|
+<!-- -->
|
|
|
+</a>
|
|
|
+<ul class="blockList">
|
|
|
+<li class="blockList">
|
|
|
+<h4>MAIL_SMTP_USER</h4>
|
|
|
+<pre><a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Deprecated.html?is-external=true" title="class or interface in java.lang">@Deprecated</a>
|
|
|
+public static final <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> MAIL_SMTP_USER</pre>
|
|
|
+<div class="block"><span class="deprecatedLabel">Deprecated.</span> <span class="deprecationComment">since 1.3, use <a href="../../../../org/apache/commons/mail/EmailConstants.html#MAIL_SMTP_USER"><code>EmailConstants.MAIL_SMTP_USER</code></a> instead</span></div>
|
|
|
+<dl>
|
|
|
+<dt><span class="seeLabel">See Also:</span></dt>
|
|
|
+<dd><a href="../../../../constant-values.html#org.apache.commons.mail.Email.MAIL_SMTP_USER">Constant Field Values</a></dd>
|
|
|
+</dl>
|
|
|
+</li>
|
|
|
+</ul>
|
|
|
+<a name="MAIL_SMTP_PASSWORD">
|
|
|
+<!-- -->
|
|
|
+</a>
|
|
|
+<ul class="blockList">
|
|
|
+<li class="blockList">
|
|
|
+<h4>MAIL_SMTP_PASSWORD</h4>
|
|
|
+<pre><a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Deprecated.html?is-external=true" title="class or interface in java.lang">@Deprecated</a>
|
|
|
+public static final <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> MAIL_SMTP_PASSWORD</pre>
|
|
|
+<div class="block"><span class="deprecatedLabel">Deprecated.</span> <span class="deprecationComment">since 1.3, use <a href="../../../../org/apache/commons/mail/EmailConstants.html#MAIL_SMTP_PASSWORD"><code>EmailConstants.MAIL_SMTP_PASSWORD</code></a> instead</span></div>
|
|
|
+<dl>
|
|
|
+<dt><span class="seeLabel">See Also:</span></dt>
|
|
|
+<dd><a href="../../../../constant-values.html#org.apache.commons.mail.Email.MAIL_SMTP_PASSWORD">Constant Field Values</a></dd>
|
|
|
+</dl>
|
|
|
+</li>
|
|
|
+</ul>
|
|
|
+<a name="MAIL_TRANSPORT_PROTOCOL">
|
|
|
+<!-- -->
|
|
|
+</a>
|
|
|
+<ul class="blockList">
|
|
|
+<li class="blockList">
|
|
|
+<h4>MAIL_TRANSPORT_PROTOCOL</h4>
|
|
|
+<pre><a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Deprecated.html?is-external=true" title="class or interface in java.lang">@Deprecated</a>
|
|
|
+public static final <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> MAIL_TRANSPORT_PROTOCOL</pre>
|
|
|
+<div class="block"><span class="deprecatedLabel">Deprecated.</span> <span class="deprecationComment">since 1.3, use <a href="../../../../org/apache/commons/mail/EmailConstants.html#MAIL_TRANSPORT_PROTOCOL"><code>EmailConstants.MAIL_TRANSPORT_PROTOCOL</code></a> instead</span></div>
|
|
|
+<dl>
|
|
|
+<dt><span class="seeLabel">See Also:</span></dt>
|
|
|
+<dd><a href="../../../../constant-values.html#org.apache.commons.mail.Email.MAIL_TRANSPORT_PROTOCOL">Constant Field Values</a></dd>
|
|
|
+</dl>
|
|
|
+</li>
|
|
|
+</ul>
|
|
|
+<a name="SMTP">
|
|
|
+<!-- -->
|
|
|
+</a>
|
|
|
+<ul class="blockList">
|
|
|
+<li class="blockList">
|
|
|
+<h4>SMTP</h4>
|
|
|
+<pre><a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Deprecated.html?is-external=true" title="class or interface in java.lang">@Deprecated</a>
|
|
|
+public static final <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> SMTP</pre>
|
|
|
+<div class="block"><span class="deprecatedLabel">Deprecated.</span> <span class="deprecationComment">since 1.3, use <a href="../../../../org/apache/commons/mail/EmailConstants.html#SMTP"><code>EmailConstants.SMTP</code></a> instead</span></div>
|
|
|
+<dl>
|
|
|
+<dt><span class="seeLabel">See Also:</span></dt>
|
|
|
+<dd><a href="../../../../constant-values.html#org.apache.commons.mail.Email.SMTP">Constant Field Values</a></dd>
|
|
|
+</dl>
|
|
|
+</li>
|
|
|
+</ul>
|
|
|
+<a name="TEXT_HTML">
|
|
|
+<!-- -->
|
|
|
+</a>
|
|
|
+<ul class="blockList">
|
|
|
+<li class="blockList">
|
|
|
+<h4>TEXT_HTML</h4>
|
|
|
+<pre><a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Deprecated.html?is-external=true" title="class or interface in java.lang">@Deprecated</a>
|
|
|
+public static final <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> TEXT_HTML</pre>
|
|
|
+<div class="block"><span class="deprecatedLabel">Deprecated.</span> <span class="deprecationComment">since 1.3, use <a href="../../../../org/apache/commons/mail/EmailConstants.html#TEXT_HTML"><code>EmailConstants.TEXT_HTML</code></a> instead</span></div>
|
|
|
+<dl>
|
|
|
+<dt><span class="seeLabel">See Also:</span></dt>
|
|
|
+<dd><a href="../../../../constant-values.html#org.apache.commons.mail.Email.TEXT_HTML">Constant Field Values</a></dd>
|
|
|
+</dl>
|
|
|
+</li>
|
|
|
+</ul>
|
|
|
+<a name="TEXT_PLAIN">
|
|
|
+<!-- -->
|
|
|
+</a>
|
|
|
+<ul class="blockList">
|
|
|
+<li class="blockList">
|
|
|
+<h4>TEXT_PLAIN</h4>
|
|
|
+<pre><a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Deprecated.html?is-external=true" title="class or interface in java.lang">@Deprecated</a>
|
|
|
+public static final <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> TEXT_PLAIN</pre>
|
|
|
+<div class="block"><span class="deprecatedLabel">Deprecated.</span> <span class="deprecationComment">since 1.3, use <a href="../../../../org/apache/commons/mail/EmailConstants.html#TEXT_PLAIN"><code>EmailConstants.TEXT_PLAIN</code></a> instead</span></div>
|
|
|
+<dl>
|
|
|
+<dt><span class="seeLabel">See Also:</span></dt>
|
|
|
+<dd><a href="../../../../constant-values.html#org.apache.commons.mail.Email.TEXT_PLAIN">Constant Field Values</a></dd>
|
|
|
+</dl>
|
|
|
+</li>
|
|
|
+</ul>
|
|
|
+<a name="MAIL_TRANSPORT_TLS">
|
|
|
+<!-- -->
|
|
|
+</a>
|
|
|
+<ul class="blockList">
|
|
|
+<li class="blockList">
|
|
|
+<h4>MAIL_TRANSPORT_TLS</h4>
|
|
|
+<pre><a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Deprecated.html?is-external=true" title="class or interface in java.lang">@Deprecated</a>
|
|
|
+public static final <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> MAIL_TRANSPORT_TLS</pre>
|
|
|
+<div class="block"><span class="deprecatedLabel">Deprecated.</span> <span class="deprecationComment">since 1.3, use <a href="../../../../org/apache/commons/mail/EmailConstants.html#MAIL_TRANSPORT_TLS"><code>EmailConstants.MAIL_TRANSPORT_TLS</code></a> instead</span></div>
|
|
|
+<dl>
|
|
|
+<dt><span class="seeLabel">See Also:</span></dt>
|
|
|
+<dd><a href="../../../../constant-values.html#org.apache.commons.mail.Email.MAIL_TRANSPORT_TLS">Constant Field Values</a></dd>
|
|
|
+</dl>
|
|
|
+</li>
|
|
|
+</ul>
|
|
|
+<a name="MAIL_SMTP_SOCKET_FACTORY_FALLBACK">
|
|
|
+<!-- -->
|
|
|
+</a>
|
|
|
+<ul class="blockList">
|
|
|
+<li class="blockList">
|
|
|
+<h4>MAIL_SMTP_SOCKET_FACTORY_FALLBACK</h4>
|
|
|
+<pre><a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Deprecated.html?is-external=true" title="class or interface in java.lang">@Deprecated</a>
|
|
|
+public static final <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> MAIL_SMTP_SOCKET_FACTORY_FALLBACK</pre>
|
|
|
+<div class="block"><span class="deprecatedLabel">Deprecated.</span> <span class="deprecationComment">since 1.3, use <a href="../../../../org/apache/commons/mail/EmailConstants.html#MAIL_SMTP_SOCKET_FACTORY_FALLBACK"><code>EmailConstants.MAIL_SMTP_SOCKET_FACTORY_FALLBACK</code></a> instead</span></div>
|
|
|
+<dl>
|
|
|
+<dt><span class="seeLabel">See Also:</span></dt>
|
|
|
+<dd><a href="../../../../constant-values.html#org.apache.commons.mail.Email.MAIL_SMTP_SOCKET_FACTORY_FALLBACK">Constant Field Values</a></dd>
|
|
|
+</dl>
|
|
|
+</li>
|
|
|
+</ul>
|
|
|
+<a name="MAIL_SMTP_SOCKET_FACTORY_CLASS">
|
|
|
+<!-- -->
|
|
|
+</a>
|
|
|
+<ul class="blockList">
|
|
|
+<li class="blockList">
|
|
|
+<h4>MAIL_SMTP_SOCKET_FACTORY_CLASS</h4>
|
|
|
+<pre><a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Deprecated.html?is-external=true" title="class or interface in java.lang">@Deprecated</a>
|
|
|
+public static final <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> MAIL_SMTP_SOCKET_FACTORY_CLASS</pre>
|
|
|
+<div class="block"><span class="deprecatedLabel">Deprecated.</span> <span class="deprecationComment">since 1.3, use <a href="../../../../org/apache/commons/mail/EmailConstants.html#MAIL_SMTP_SOCKET_FACTORY_CLASS"><code>EmailConstants.MAIL_SMTP_SOCKET_FACTORY_CLASS</code></a> instead</span></div>
|
|
|
+<dl>
|
|
|
+<dt><span class="seeLabel">See Also:</span></dt>
|
|
|
+<dd><a href="../../../../constant-values.html#org.apache.commons.mail.Email.MAIL_SMTP_SOCKET_FACTORY_CLASS">Constant Field Values</a></dd>
|
|
|
+</dl>
|
|
|
+</li>
|
|
|
+</ul>
|
|
|
+<a name="MAIL_SMTP_SOCKET_FACTORY_PORT">
|
|
|
+<!-- -->
|
|
|
+</a>
|
|
|
+<ul class="blockList">
|
|
|
+<li class="blockList">
|
|
|
+<h4>MAIL_SMTP_SOCKET_FACTORY_PORT</h4>
|
|
|
+<pre><a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Deprecated.html?is-external=true" title="class or interface in java.lang">@Deprecated</a>
|
|
|
+public static final <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> MAIL_SMTP_SOCKET_FACTORY_PORT</pre>
|
|
|
+<div class="block"><span class="deprecatedLabel">Deprecated.</span> <span class="deprecationComment">since 1.3, use <a href="../../../../org/apache/commons/mail/EmailConstants.html#MAIL_SMTP_SOCKET_FACTORY_PORT"><code>EmailConstants.MAIL_SMTP_SOCKET_FACTORY_PORT</code></a> instead</span></div>
|
|
|
+<dl>
|
|
|
+<dt><span class="seeLabel">See Also:</span></dt>
|
|
|
+<dd><a href="../../../../constant-values.html#org.apache.commons.mail.Email.MAIL_SMTP_SOCKET_FACTORY_PORT">Constant Field Values</a></dd>
|
|
|
+</dl>
|
|
|
+</li>
|
|
|
+</ul>
|
|
|
+<a name="MAIL_SMTP_CONNECTIONTIMEOUT">
|
|
|
+<!-- -->
|
|
|
+</a>
|
|
|
+<ul class="blockList">
|
|
|
+<li class="blockList">
|
|
|
+<h4>MAIL_SMTP_CONNECTIONTIMEOUT</h4>
|
|
|
+<pre><a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Deprecated.html?is-external=true" title="class or interface in java.lang">@Deprecated</a>
|
|
|
+public static final <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> MAIL_SMTP_CONNECTIONTIMEOUT</pre>
|
|
|
+<div class="block"><span class="deprecatedLabel">Deprecated.</span> <span class="deprecationComment">since 1.3, use <a href="../../../../org/apache/commons/mail/EmailConstants.html#MAIL_SMTP_CONNECTIONTIMEOUT"><code>EmailConstants.MAIL_SMTP_CONNECTIONTIMEOUT</code></a> instead</span></div>
|
|
|
+<dl>
|
|
|
+<dt><span class="seeLabel">See Also:</span></dt>
|
|
|
+<dd><a href="../../../../constant-values.html#org.apache.commons.mail.Email.MAIL_SMTP_CONNECTIONTIMEOUT">Constant Field Values</a></dd>
|
|
|
+</dl>
|
|
|
+</li>
|
|
|
+</ul>
|
|
|
+<a name="MAIL_SMTP_TIMEOUT">
|
|
|
+<!-- -->
|
|
|
+</a>
|
|
|
+<ul class="blockList">
|
|
|
+<li class="blockList">
|
|
|
+<h4>MAIL_SMTP_TIMEOUT</h4>
|
|
|
+<pre><a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Deprecated.html?is-external=true" title="class or interface in java.lang">@Deprecated</a>
|
|
|
+public static final <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> MAIL_SMTP_TIMEOUT</pre>
|
|
|
+<div class="block"><span class="deprecatedLabel">Deprecated.</span> <span class="deprecationComment">since 1.3, use <a href="../../../../org/apache/commons/mail/EmailConstants.html#MAIL_SMTP_TIMEOUT"><code>EmailConstants.MAIL_SMTP_TIMEOUT</code></a> instead</span></div>
|
|
|
+<dl>
|
|
|
+<dt><span class="seeLabel">See Also:</span></dt>
|
|
|
+<dd><a href="../../../../constant-values.html#org.apache.commons.mail.Email.MAIL_SMTP_TIMEOUT">Constant Field Values</a></dd>
|
|
|
+</dl>
|
|
|
+</li>
|
|
|
+</ul>
|
|
|
+<a name="message">
|
|
|
+<!-- -->
|
|
|
+</a>
|
|
|
+<ul class="blockList">
|
|
|
+<li class="blockList">
|
|
|
+<h4>message</h4>
|
|
|
+<pre>protected <a href="http://docs.oracle.com/javaee/6/api/javax/mail/internet/MimeMessage.html?is-external=true" title="class or interface in javax.mail.internet">MimeMessage</a> message</pre>
|
|
|
+<div class="block">The email message to send.</div>
|
|
|
+</li>
|
|
|
+</ul>
|
|
|
+<a name="charset">
|
|
|
+<!-- -->
|
|
|
+</a>
|
|
|
+<ul class="blockList">
|
|
|
+<li class="blockList">
|
|
|
+<h4>charset</h4>
|
|
|
+<pre>protected <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> charset</pre>
|
|
|
+<div class="block">The charset to use for this message.</div>
|
|
|
+</li>
|
|
|
+</ul>
|
|
|
+<a name="fromAddress">
|
|
|
+<!-- -->
|
|
|
+</a>
|
|
|
+<ul class="blockList">
|
|
|
+<li class="blockList">
|
|
|
+<h4>fromAddress</h4>
|
|
|
+<pre>protected <a href="http://docs.oracle.com/javaee/6/api/javax/mail/internet/InternetAddress.html?is-external=true" title="class or interface in javax.mail.internet">InternetAddress</a> fromAddress</pre>
|
|
|
+<div class="block">The Address of the sending party, mandatory.</div>
|
|
|
+</li>
|
|
|
+</ul>
|
|
|
+<a name="subject">
|
|
|
+<!-- -->
|
|
|
+</a>
|
|
|
+<ul class="blockList">
|
|
|
+<li class="blockList">
|
|
|
+<h4>subject</h4>
|
|
|
+<pre>protected <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> subject</pre>
|
|
|
+<div class="block">The Subject.</div>
|
|
|
+</li>
|
|
|
+</ul>
|
|
|
+<a name="emailBody">
|
|
|
+<!-- -->
|
|
|
+</a>
|
|
|
+<ul class="blockList">
|
|
|
+<li class="blockList">
|
|
|
+<h4>emailBody</h4>
|
|
|
+<pre>protected <a href="http://docs.oracle.com/javaee/6/api/javax/mail/internet/MimeMultipart.html?is-external=true" title="class or interface in javax.mail.internet">MimeMultipart</a> emailBody</pre>
|
|
|
+<div class="block">An attachment.</div>
|
|
|
+</li>
|
|
|
+</ul>
|
|
|
+<a name="content">
|
|
|
+<!-- -->
|
|
|
+</a>
|
|
|
+<ul class="blockList">
|
|
|
+<li class="blockList">
|
|
|
+<h4>content</h4>
|
|
|
+<pre>protected <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a> content</pre>
|
|
|
+<div class="block">The content.</div>
|
|
|
+</li>
|
|
|
+</ul>
|
|
|
+<a name="contentType">
|
|
|
+<!-- -->
|
|
|
+</a>
|
|
|
+<ul class="blockList">
|
|
|
+<li class="blockList">
|
|
|
+<h4>contentType</h4>
|
|
|
+<pre>protected <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> contentType</pre>
|
|
|
+<div class="block">The content type.</div>
|
|
|
+</li>
|
|
|
+</ul>
|
|
|
+<a name="debug">
|
|
|
+<!-- -->
|
|
|
+</a>
|
|
|
+<ul class="blockList">
|
|
|
+<li class="blockList">
|
|
|
+<h4>debug</h4>
|
|
|
+<pre>protected boolean debug</pre>
|
|
|
+<div class="block">Set session debugging on or off.</div>
|
|
|
+</li>
|
|
|
+</ul>
|
|
|
+<a name="sentDate">
|
|
|
+<!-- -->
|
|
|
+</a>
|
|
|
+<ul class="blockList">
|
|
|
+<li class="blockList">
|
|
|
+<h4>sentDate</h4>
|
|
|
+<pre>protected <a href="http://docs.oracle.com/javase/7/docs/api/java/util/Date.html?is-external=true" title="class or interface in java.util">Date</a> sentDate</pre>
|
|
|
+<div class="block">Sent date.</div>
|
|
|
+</li>
|
|
|
+</ul>
|
|
|
+<a name="authenticator">
|
|
|
+<!-- -->
|
|
|
+</a>
|
|
|
+<ul class="blockList">
|
|
|
+<li class="blockList">
|
|
|
+<h4>authenticator</h4>
|
|
|
+<pre>protected <a href="http://docs.oracle.com/javaee/6/api/javax/mail/Authenticator.html?is-external=true" title="class or interface in javax.mail">Authenticator</a> authenticator</pre>
|
|
|
+<div class="block">Instance of an <code>Authenticator</code> object that will be used
|
|
|
+ when authentication is requested from the mail server.</div>
|
|
|
+</li>
|
|
|
+</ul>
|
|
|
+<a name="hostName">
|
|
|
+<!-- -->
|
|
|
+</a>
|
|
|
+<ul class="blockList">
|
|
|
+<li class="blockList">
|
|
|
+<h4>hostName</h4>
|
|
|
+<pre>protected <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> hostName</pre>
|
|
|
+<div class="block">The hostname of the mail server with which to connect. If null will try
|
|
|
+ to get property from system.properties. If still null, quit.</div>
|
|
|
+</li>
|
|
|
+</ul>
|
|
|
+<a name="smtpPort">
|
|
|
+<!-- -->
|
|
|
+</a>
|
|
|
+<ul class="blockList">
|
|
|
+<li class="blockList">
|
|
|
+<h4>smtpPort</h4>
|
|
|
+<pre>protected <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> smtpPort</pre>
|
|
|
+<div class="block">The port number of the mail server to connect to.
|
|
|
+ Defaults to the standard port ( 25 ).</div>
|
|
|
+</li>
|
|
|
+</ul>
|
|
|
+<a name="sslSmtpPort">
|
|
|
+<!-- -->
|
|
|
+</a>
|
|
|
+<ul class="blockList">
|
|
|
+<li class="blockList">
|
|
|
+<h4>sslSmtpPort</h4>
|
|
|
+<pre>protected <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> sslSmtpPort</pre>
|
|
|
+<div class="block">The port number of the SSL enabled SMTP server;
|
|
|
+ defaults to the standard port, 465.</div>
|
|
|
+</li>
|
|
|
+</ul>
|
|
|
+<a name="toList">
|
|
|
+<!-- -->
|
|
|
+</a>
|
|
|
+<ul class="blockList">
|
|
|
+<li class="blockList">
|
|
|
+<h4>toList</h4>
|
|
|
+<pre>protected <a href="http://docs.oracle.com/javase/7/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</a><<a href="http://docs.oracle.com/javaee/6/api/javax/mail/internet/InternetAddress.html?is-external=true" title="class or interface in javax.mail.internet">InternetAddress</a>> toList</pre>
|
|
|
+<div class="block">List of "to" email addresses.</div>
|
|
|
+</li>
|
|
|
+</ul>
|
|
|
+<a name="ccList">
|
|
|
+<!-- -->
|
|
|
+</a>
|
|
|
+<ul class="blockList">
|
|
|
+<li class="blockList">
|
|
|
+<h4>ccList</h4>
|
|
|
+<pre>protected <a href="http://docs.oracle.com/javase/7/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</a><<a href="http://docs.oracle.com/javaee/6/api/javax/mail/internet/InternetAddress.html?is-external=true" title="class or interface in javax.mail.internet">InternetAddress</a>> ccList</pre>
|
|
|
+<div class="block">List of "cc" email addresses.</div>
|
|
|
+</li>
|
|
|
+</ul>
|
|
|
+<a name="bccList">
|
|
|
+<!-- -->
|
|
|
+</a>
|
|
|
+<ul class="blockList">
|
|
|
+<li class="blockList">
|
|
|
+<h4>bccList</h4>
|
|
|
+<pre>protected <a href="http://docs.oracle.com/javase/7/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</a><<a href="http://docs.oracle.com/javaee/6/api/javax/mail/internet/InternetAddress.html?is-external=true" title="class or interface in javax.mail.internet">InternetAddress</a>> bccList</pre>
|
|
|
+<div class="block">List of "bcc" email addresses.</div>
|
|
|
+</li>
|
|
|
+</ul>
|
|
|
+<a name="replyList">
|
|
|
+<!-- -->
|
|
|
+</a>
|
|
|
+<ul class="blockList">
|
|
|
+<li class="blockList">
|
|
|
+<h4>replyList</h4>
|
|
|
+<pre>protected <a href="http://docs.oracle.com/javase/7/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</a><<a href="http://docs.oracle.com/javaee/6/api/javax/mail/internet/InternetAddress.html?is-external=true" title="class or interface in javax.mail.internet">InternetAddress</a>> replyList</pre>
|
|
|
+<div class="block">List of "replyTo" email addresses.</div>
|
|
|
+</li>
|
|
|
+</ul>
|
|
|
+<a name="bounceAddress">
|
|
|
+<!-- -->
|
|
|
+</a>
|
|
|
+<ul class="blockList">
|
|
|
+<li class="blockList">
|
|
|
+<h4>bounceAddress</h4>
|
|
|
+<pre>protected <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> bounceAddress</pre>
|
|
|
+<div class="block">Address to which undeliverable mail should be sent.
|
|
|
+ Because this is handled by JavaMail as a String property
|
|
|
+ in the mail session, this property is of type <code>String</code>
|
|
|
+ rather than <code>InternetAddress</code>.</div>
|
|
|
+</li>
|
|
|
+</ul>
|
|
|
+<a name="headers">
|
|
|
+<!-- -->
|
|
|
+</a>
|
|
|
+<ul class="blockList">
|
|
|
+<li class="blockList">
|
|
|
+<h4>headers</h4>
|
|
|
+<pre>protected <a href="http://docs.oracle.com/javase/7/docs/api/java/util/Map.html?is-external=true" title="class or interface in java.util">Map</a><<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>,<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>> headers</pre>
|
|
|
+<div class="block">Used to specify the mail headers. Example:
|
|
|
+
|
|
|
+ X-Mailer: Sendmail, X-Priority: 1( highest )
|
|
|
+ or 2( high ) 3( normal ) 4( low ) and 5( lowest )
|
|
|
+ Disposition-Notification-To: user@domain.net</div>
|
|
|
+</li>
|
|
|
+</ul>
|
|
|
+<a name="popBeforeSmtp">
|
|
|
+<!-- -->
|
|
|
+</a>
|
|
|
+<ul class="blockList">
|
|
|
+<li class="blockList">
|
|
|
+<h4>popBeforeSmtp</h4>
|
|
|
+<pre>protected boolean popBeforeSmtp</pre>
|
|
|
+<div class="block">Used to determine whether to use pop3 before smtp, and if so the settings.</div>
|
|
|
+</li>
|
|
|
+</ul>
|
|
|
+<a name="popHost">
|
|
|
+<!-- -->
|
|
|
+</a>
|
|
|
+<ul class="blockList">
|
|
|
+<li class="blockList">
|
|
|
+<h4>popHost</h4>
|
|
|
+<pre>protected <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> popHost</pre>
|
|
|
+<div class="block">the host name of the pop3 server.</div>
|
|
|
+</li>
|
|
|
+</ul>
|
|
|
+<a name="popUsername">
|
|
|
+<!-- -->
|
|
|
+</a>
|
|
|
+<ul class="blockList">
|
|
|
+<li class="blockList">
|
|
|
+<h4>popUsername</h4>
|
|
|
+<pre>protected <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> popUsername</pre>
|
|
|
+<div class="block">the user name to log into the pop3 server.</div>
|
|
|
+</li>
|
|
|
+</ul>
|
|
|
+<a name="popPassword">
|
|
|
+<!-- -->
|
|
|
+</a>
|
|
|
+<ul class="blockList">
|
|
|
+<li class="blockList">
|
|
|
+<h4>popPassword</h4>
|
|
|
+<pre>protected <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> popPassword</pre>
|
|
|
+<div class="block">the password to log into the pop3 server.</div>
|
|
|
+</li>
|
|
|
+</ul>
|
|
|
+<a name="tls">
|
|
|
+<!-- -->
|
|
|
+</a>
|
|
|
+<ul class="blockList">
|
|
|
+<li class="blockList">
|
|
|
+<h4>tls</h4>
|
|
|
+<pre><a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Deprecated.html?is-external=true" title="class or interface in java.lang">@Deprecated</a>
|
|
|
+protected boolean tls</pre>
|
|
|
+<div class="block"><span class="deprecatedLabel">Deprecated.</span> <span class="deprecationComment">since 1.3, use setStartTLSEnabled() instead</span></div>
|
|
|
+<div class="block">Does server require TLS encryption for authentication?</div>
|
|
|
+</li>
|
|
|
+</ul>
|
|
|
+<a name="ssl">
|
|
|
+<!-- -->
|
|
|
+</a>
|
|
|
+<ul class="blockList">
|
|
|
+<li class="blockList">
|
|
|
+<h4>ssl</h4>
|
|
|
+<pre><a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Deprecated.html?is-external=true" title="class or interface in java.lang">@Deprecated</a>
|
|
|
+protected boolean ssl</pre>
|
|
|
+<div class="block"><span class="deprecatedLabel">Deprecated.</span> <span class="deprecationComment">since 1.3, use setSSLOnConnect() instead</span></div>
|
|
|
+<div class="block">Does the current transport use SSL/TLS encryption upon connection?</div>
|
|
|
+</li>
|
|
|
+</ul>
|
|
|
+<a name="socketTimeout">
|
|
|
+<!-- -->
|
|
|
+</a>
|
|
|
+<ul class="blockList">
|
|
|
+<li class="blockList">
|
|
|
+<h4>socketTimeout</h4>
|
|
|
+<pre>protected int socketTimeout</pre>
|
|
|
+<div class="block">socket I/O timeout value in milliseconds.</div>
|
|
|
+</li>
|
|
|
+</ul>
|
|
|
+<a name="socketConnectionTimeout">
|
|
|
+<!-- -->
|
|
|
+</a>
|
|
|
+<ul class="blockListLast">
|
|
|
+<li class="blockList">
|
|
|
+<h4>socketConnectionTimeout</h4>
|
|
|
+<pre>protected int socketConnectionTimeout</pre>
|
|
|
+<div class="block">socket connection timeout value in milliseconds.</div>
|
|
|
+</li>
|
|
|
+</ul>
|
|
|
+</li>
|
|
|
+</ul>
|
|
|
+<!-- ========= CONSTRUCTOR DETAIL ======== -->
|
|
|
+<ul class="blockList">
|
|
|
+<li class="blockList"><a name="constructor.detail">
|
|
|
+<!-- -->
|
|
|
+</a>
|
|
|
+<h3>Constructor Detail</h3>
|
|
|
+<a name="Email--">
|
|
|
+<!-- -->
|
|
|
+</a>
|
|
|
+<ul class="blockListLast">
|
|
|
+<li class="blockList">
|
|
|
+<h4>Email</h4>
|
|
|
+<pre>public Email()</pre>
|
|
|
+</li>
|
|
|
+</ul>
|
|
|
+</li>
|
|
|
+</ul>
|
|
|
+<!-- ============ METHOD DETAIL ========== -->
|
|
|
+<ul class="blockList">
|
|
|
+<li class="blockList"><a name="method.detail">
|
|
|
+<!-- -->
|
|
|
+</a>
|
|
|
+<h3>Method Detail</h3>
|
|
|
+<a name="setDebug-boolean-">
|
|
|
+<!-- -->
|
|
|
+</a>
|
|
|
+<ul class="blockList">
|
|
|
+<li class="blockList">
|
|
|
+<h4>setDebug</h4>
|
|
|
+<pre>public void setDebug(boolean d)</pre>
|
|
|
+<div class="block">Setting to true will enable the display of debug information.</div>
|
|
|
+<dl>
|
|
|
+<dt><span class="paramLabel">Parameters:</span></dt>
|
|
|
+<dd><code>d</code> - A boolean.</dd>
|
|
|
+<dt><span class="simpleTagLabel">Since:</span></dt>
|
|
|
+<dd>1.0</dd>
|
|
|
+</dl>
|
|
|
+</li>
|
|
|
+</ul>
|
|
|
+<a name="setAuthentication-java.lang.String-java.lang.String-">
|
|
|
+<!-- -->
|
|
|
+</a>
|
|
|
+<ul class="blockList">
|
|
|
+<li class="blockList">
|
|
|
+<h4>setAuthentication</h4>
|
|
|
+<pre>public void setAuthentication(<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> userName,
|
|
|
+ <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> password)</pre>
|
|
|
+<div class="block">Sets the userName and password if authentication is needed. If this
|
|
|
+ method is not used, no authentication will be performed.
|
|
|
+ <p>
|
|
|
+ This method will create a new instance of
|
|
|
+ <code>DefaultAuthenticator</code> using the supplied parameters.</div>
|
|
|
+<dl>
|
|
|
+<dt><span class="paramLabel">Parameters:</span></dt>
|
|
|
+<dd><code>userName</code> - User name for the SMTP server</dd>
|
|
|
+<dd><code>password</code> - password for the SMTP server</dd>
|
|
|
+<dt><span class="simpleTagLabel">Since:</span></dt>
|
|
|
+<dd>1.0</dd>
|
|
|
+<dt><span class="seeLabel">See Also:</span></dt>
|
|
|
+<dd><a href="../../../../org/apache/commons/mail/DefaultAuthenticator.html" title="class in org.apache.commons.mail"><code>DefaultAuthenticator</code></a>,
|
|
|
+<a href="../../../../org/apache/commons/mail/Email.html#setAuthenticator-javax.mail.Authenticator-"><code>setAuthenticator(javax.mail.Authenticator)</code></a></dd>
|
|
|
+</dl>
|
|
|
+</li>
|
|
|
+</ul>
|
|
|
+<a name="setAuthenticator-javax.mail.Authenticator-">
|
|
|
+<!-- -->
|
|
|
+</a>
|
|
|
+<ul class="blockList">
|
|
|
+<li class="blockList">
|
|
|
+<h4>setAuthenticator</h4>
|
|
|
+<pre>public void setAuthenticator(<a href="http://docs.oracle.com/javaee/6/api/javax/mail/Authenticator.html?is-external=true" title="class or interface in javax.mail">Authenticator</a> newAuthenticator)</pre>
|
|
|
+<div class="block">Sets the <code>Authenticator</code> to be used when authentication
|
|
|
+ is requested from the mail server.
|
|
|
+ <p>
|
|
|
+ This method should be used when your outgoing mail server requires
|
|
|
+ authentication. Your mail server must also support RFC2554.</div>
|
|
|
+<dl>
|
|
|
+<dt><span class="paramLabel">Parameters:</span></dt>
|
|
|
+<dd><code>newAuthenticator</code> - the <code>Authenticator</code> object.</dd>
|
|
|
+<dt><span class="simpleTagLabel">Since:</span></dt>
|
|
|
+<dd>1.0</dd>
|
|
|
+<dt><span class="seeLabel">See Also:</span></dt>
|
|
|
+<dd><a href="http://docs.oracle.com/javaee/6/api/javax/mail/Authenticator.html?is-external=true" title="class or interface in javax.mail"><code>Authenticator</code></a></dd>
|
|
|
+</dl>
|
|
|
+</li>
|
|
|
+</ul>
|
|
|
+<a name="setCharset-java.lang.String-">
|
|
|
+<!-- -->
|
|
|
+</a>
|
|
|
+<ul class="blockList">
|
|
|
+<li class="blockList">
|
|
|
+<h4>setCharset</h4>
|
|
|
+<pre>public void setCharset(<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> newCharset)</pre>
|
|
|
+<div class="block">Set the charset of the message. Please note that you should set the charset before
|
|
|
+ adding the message content.</div>
|
|
|
+<dl>
|
|
|
+<dt><span class="paramLabel">Parameters:</span></dt>
|
|
|
+<dd><code>newCharset</code> - A String.</dd>
|
|
|
+<dt><span class="throwsLabel">Throws:</span></dt>
|
|
|
+<dd><code><a href="http://docs.oracle.com/javase/7/docs/api/java/nio/charset/IllegalCharsetNameException.html?is-external=true" title="class or interface in java.nio.charset">IllegalCharsetNameException</a></code> - if the charset name is invalid</dd>
|
|
|
+<dd><code><a href="http://docs.oracle.com/javase/7/docs/api/java/nio/charset/UnsupportedCharsetException.html?is-external=true" title="class or interface in java.nio.charset">UnsupportedCharsetException</a></code> - if no support for the named charset
|
|
|
+ exists in the current JVM</dd>
|
|
|
+<dt><span class="simpleTagLabel">Since:</span></dt>
|
|
|
+<dd>1.0</dd>
|
|
|
+</dl>
|
|
|
+</li>
|
|
|
+</ul>
|
|
|
+<a name="setContent-javax.mail.internet.MimeMultipart-">
|
|
|
+<!-- -->
|
|
|
+</a>
|
|
|
+<ul class="blockList">
|
|
|
+<li class="blockList">
|
|
|
+<h4>setContent</h4>
|
|
|
+<pre>public void setContent(<a href="http://docs.oracle.com/javaee/6/api/javax/mail/internet/MimeMultipart.html?is-external=true" title="class or interface in javax.mail.internet">MimeMultipart</a> aMimeMultipart)</pre>
|
|
|
+<div class="block">Set the emailBody to a MimeMultiPart</div>
|
|
|
+<dl>
|
|
|
+<dt><span class="paramLabel">Parameters:</span></dt>
|
|
|
+<dd><code>aMimeMultipart</code> - aMimeMultipart</dd>
|
|
|
+<dt><span class="simpleTagLabel">Since:</span></dt>
|
|
|
+<dd>1.0</dd>
|
|
|
+</dl>
|
|
|
+</li>
|
|
|
+</ul>
|
|
|
+<a name="setContent-java.lang.Object-java.lang.String-">
|
|
|
+<!-- -->
|
|
|
+</a>
|
|
|
+<ul class="blockList">
|
|
|
+<li class="blockList">
|
|
|
+<h4>setContent</h4>
|
|
|
+<pre>public void setContent(<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a> aObject,
|
|
|
+ <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> aContentType)</pre>
|
|
|
+<div class="block">Set the content and contentType.</div>
|
|
|
+<dl>
|
|
|
+<dt><span class="paramLabel">Parameters:</span></dt>
|
|
|
+<dd><code>aObject</code> - aObject</dd>
|
|
|
+<dd><code>aContentType</code> - aContentType</dd>
|
|
|
+<dt><span class="simpleTagLabel">Since:</span></dt>
|
|
|
+<dd>1.0</dd>
|
|
|
+</dl>
|
|
|
+</li>
|
|
|
+</ul>
|
|
|
+<a name="updateContentType-java.lang.String-">
|
|
|
+<!-- -->
|
|
|
+</a>
|
|
|
+<ul class="blockList">
|
|
|
+<li class="blockList">
|
|
|
+<h4>updateContentType</h4>
|
|
|
+<pre>public void updateContentType(<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> aContentType)</pre>
|
|
|
+<div class="block">Update the contentType.</div>
|
|
|
+<dl>
|
|
|
+<dt><span class="paramLabel">Parameters:</span></dt>
|
|
|
+<dd><code>aContentType</code> - aContentType</dd>
|
|
|
+<dt><span class="simpleTagLabel">Since:</span></dt>
|
|
|
+<dd>1.2</dd>
|
|
|
+</dl>
|
|
|
+</li>
|
|
|
+</ul>
|
|
|
+<a name="setHostName-java.lang.String-">
|
|
|
+<!-- -->
|
|
|
+</a>
|
|
|
+<ul class="blockList">
|
|
|
+<li class="blockList">
|
|
|
+<h4>setHostName</h4>
|
|
|
+<pre>public void setHostName(<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> aHostName)</pre>
|
|
|
+<div class="block">Set the hostname of the outgoing mail server.</div>
|
|
|
+<dl>
|
|
|
+<dt><span class="paramLabel">Parameters:</span></dt>
|
|
|
+<dd><code>aHostName</code> - aHostName</dd>
|
|
|
+<dt><span class="throwsLabel">Throws:</span></dt>
|
|
|
+<dd><code><a href="http://docs.oracle.com/javase/7/docs/api/java/lang/IllegalStateException.html?is-external=true" title="class or interface in java.lang">IllegalStateException</a></code> - if the mail session is already initialized</dd>
|
|
|
+<dt><span class="simpleTagLabel">Since:</span></dt>
|
|
|
+<dd>1.0</dd>
|
|
|
+</dl>
|
|
|
+</li>
|
|
|
+</ul>
|
|
|
+<a name="setTLS-boolean-">
|
|
|
+<!-- -->
|
|
|
+</a>
|
|
|
+<ul class="blockList">
|
|
|
+<li class="blockList">
|
|
|
+<h4>setTLS</h4>
|
|
|
+<pre><a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Deprecated.html?is-external=true" title="class or interface in java.lang">@Deprecated</a>
|
|
|
+public void setTLS(boolean withTLS)</pre>
|
|
|
+<div class="block"><span class="deprecatedLabel">Deprecated.</span> <span class="deprecationComment">since 1.3, use setStartTLSEnabled() instead</span></div>
|
|
|
+<div class="block">Set or disable the STARTTLS encryption. Please see EMAIL-105
|
|
|
+ for the reasons of deprecation.</div>
|
|
|
+<dl>
|
|
|
+<dt><span class="paramLabel">Parameters:</span></dt>
|
|
|
+<dd><code>withTLS</code> - true if STARTTLS requested, false otherwise</dd>
|
|
|
+<dt><span class="simpleTagLabel">Since:</span></dt>
|
|
|
+<dd>1.1</dd>
|
|
|
+</dl>
|
|
|
+</li>
|
|
|
+</ul>
|
|
|
+<a name="setStartTLSEnabled-boolean-">
|
|
|
+<!-- -->
|
|
|
+</a>
|
|
|
+<ul class="blockList">
|
|
|
+<li class="blockList">
|
|
|
+<h4>setStartTLSEnabled</h4>
|
|
|
+<pre>public <a href="../../../../org/apache/commons/mail/Email.html" title="class in org.apache.commons.mail">Email</a> setStartTLSEnabled(boolean startTlsEnabled)</pre>
|
|
|
+<div class="block">Set or disable the STARTTLS encryption.</div>
|
|
|
+<dl>
|
|
|
+<dt><span class="paramLabel">Parameters:</span></dt>
|
|
|
+<dd><code>startTlsEnabled</code> - true if STARTTLS requested, false otherwise</dd>
|
|
|
+<dt><span class="returnLabel">Returns:</span></dt>
|
|
|
+<dd>An Email.</dd>
|
|
|
+<dt><span class="throwsLabel">Throws:</span></dt>
|
|
|
+<dd><code><a href="http://docs.oracle.com/javase/7/docs/api/java/lang/IllegalStateException.html?is-external=true" title="class or interface in java.lang">IllegalStateException</a></code> - if the mail session is already initialized</dd>
|
|
|
+<dt><span class="simpleTagLabel">Since:</span></dt>
|
|
|
+<dd>1.3</dd>
|
|
|
+</dl>
|
|
|
+</li>
|
|
|
+</ul>
|
|
|
+<a name="setStartTLSRequired-boolean-">
|
|
|
+<!-- -->
|
|
|
+</a>
|
|
|
+<ul class="blockList">
|
|
|
+<li class="blockList">
|
|
|
+<h4>setStartTLSRequired</h4>
|
|
|
+<pre>public <a href="../../../../org/apache/commons/mail/Email.html" title="class in org.apache.commons.mail">Email</a> setStartTLSRequired(boolean startTlsRequired)</pre>
|
|
|
+<div class="block">Set or disable the required STARTTLS encryption.
|
|
|
+ <p>
|
|
|
+ Defaults to <a href="../../../../org/apache/commons/mail/Email.html#smtpPort"><code>smtpPort</code></a>; can be overridden by using <a href="../../../../org/apache/commons/mail/Email.html#setSmtpPort-int-"><code>setSmtpPort(int)</code></a></div>
|
|
|
+<dl>
|
|
|
+<dt><span class="paramLabel">Parameters:</span></dt>
|
|
|
+<dd><code>startTlsRequired</code> - true if STARTTLS requested, false otherwise</dd>
|
|
|
+<dt><span class="returnLabel">Returns:</span></dt>
|
|
|
+<dd>An Email.</dd>
|
|
|
+<dt><span class="throwsLabel">Throws:</span></dt>
|
|
|
+<dd><code><a href="http://docs.oracle.com/javase/7/docs/api/java/lang/IllegalStateException.html?is-external=true" title="class or interface in java.lang">IllegalStateException</a></code> - if the mail session is already initialized</dd>
|
|
|
+<dt><span class="simpleTagLabel">Since:</span></dt>
|
|
|
+<dd>1.3</dd>
|
|
|
+</dl>
|
|
|
+</li>
|
|
|
+</ul>
|
|
|
+<a name="setSmtpPort-int-">
|
|
|
+<!-- -->
|
|
|
+</a>
|
|
|
+<ul class="blockList">
|
|
|
+<li class="blockList">
|
|
|
+<h4>setSmtpPort</h4>
|
|
|
+<pre>public void setSmtpPort(int aPortNumber)</pre>
|
|
|
+<div class="block">Set the non-SSL port number of the outgoing mail server.</div>
|
|
|
+<dl>
|
|
|
+<dt><span class="paramLabel">Parameters:</span></dt>
|
|
|
+<dd><code>aPortNumber</code> - aPortNumber</dd>
|
|
|
+<dt><span class="throwsLabel">Throws:</span></dt>
|
|
|
+<dd><code><a href="http://docs.oracle.com/javase/7/docs/api/java/lang/IllegalArgumentException.html?is-external=true" title="class or interface in java.lang">IllegalArgumentException</a></code> - if the port number is < 1</dd>
|
|
|
+<dd><code><a href="http://docs.oracle.com/javase/7/docs/api/java/lang/IllegalStateException.html?is-external=true" title="class or interface in java.lang">IllegalStateException</a></code> - if the mail session is already initialized</dd>
|
|
|
+<dt><span class="simpleTagLabel">Since:</span></dt>
|
|
|
+<dd>1.0</dd>
|
|
|
+<dt><span class="seeLabel">See Also:</span></dt>
|
|
|
+<dd><a href="../../../../org/apache/commons/mail/Email.html#setSslSmtpPort-java.lang.String-"><code>setSslSmtpPort(String)</code></a></dd>
|
|
|
+</dl>
|
|
|
+</li>
|
|
|
+</ul>
|
|
|
+<a name="setMailSession-javax.mail.Session-">
|
|
|
+<!-- -->
|
|
|
+</a>
|
|
|
+<ul class="blockList">
|
|
|
+<li class="blockList">
|
|
|
+<h4>setMailSession</h4>
|
|
|
+<pre>public void setMailSession(<a href="http://docs.oracle.com/javaee/6/api/javax/mail/Session.html?is-external=true" title="class or interface in javax.mail">Session</a> aSession)</pre>
|
|
|
+<div class="block">Supply a mail Session object to use. Please note that passing
|
|
|
+ a user name and password (in the case of mail authentication) will
|
|
|
+ create a new mail session with a DefaultAuthenticator. This is a
|
|
|
+ convenience but might come unexpected.
|
|
|
+
|
|
|
+ If mail authentication is used but NO username and password
|
|
|
+ is supplied the implementation assumes that you have set a
|
|
|
+ authenticator and will use the existing mail session (as expected).</div>
|
|
|
+<dl>
|
|
|
+<dt><span class="paramLabel">Parameters:</span></dt>
|
|
|
+<dd><code>aSession</code> - mail session to be used</dd>
|
|
|
+<dt><span class="throwsLabel">Throws:</span></dt>
|
|
|
+<dd><code><a href="http://docs.oracle.com/javase/7/docs/api/java/lang/IllegalArgumentException.html?is-external=true" title="class or interface in java.lang">IllegalArgumentException</a></code> - if the session is <code>null</code></dd>
|
|
|
+<dt><span class="simpleTagLabel">Since:</span></dt>
|
|
|
+<dd>1.0</dd>
|
|
|
+</dl>
|
|
|
+</li>
|
|
|
+</ul>
|
|
|
+<a name="setMailSessionFromJNDI-java.lang.String-">
|
|
|
+<!-- -->
|
|
|
+</a>
|
|
|
+<ul class="blockList">
|
|
|
+<li class="blockList">
|
|
|
+<h4>setMailSessionFromJNDI</h4>
|
|
|
+<pre>public void setMailSessionFromJNDI(<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> jndiName)
|
|
|
+ throws <a href="http://docs.oracle.com/javase/7/docs/api/javax/naming/NamingException.html?is-external=true" title="class or interface in javax.naming">NamingException</a></pre>
|
|
|
+<div class="block">Supply a mail Session object from a JNDI directory.</div>
|
|
|
+<dl>
|
|
|
+<dt><span class="paramLabel">Parameters:</span></dt>
|
|
|
+<dd><code>jndiName</code> - name of JNDI resource (javax.mail.Session type), resource
|
|
|
+ if searched in java:comp/env if name does not start with "java:"</dd>
|
|
|
+<dt><span class="throwsLabel">Throws:</span></dt>
|
|
|
+<dd><code><a href="http://docs.oracle.com/javase/7/docs/api/java/lang/IllegalArgumentException.html?is-external=true" title="class or interface in java.lang">IllegalArgumentException</a></code> - if the JNDI name is null or empty</dd>
|
|
|
+<dd><code><a href="http://docs.oracle.com/javase/7/docs/api/javax/naming/NamingException.html?is-external=true" title="class or interface in javax.naming">NamingException</a></code> - if the resource cannot be retrieved from JNDI directory</dd>
|
|
|
+<dt><span class="simpleTagLabel">Since:</span></dt>
|
|
|
+<dd>1.1</dd>
|
|
|
+</dl>
|
|
|
+</li>
|
|
|
+</ul>
|
|
|
+<a name="getMailSession--">
|
|
|
+<!-- -->
|
|
|
+</a>
|
|
|
+<ul class="blockList">
|
|
|
+<li class="blockList">
|
|
|
+<h4>getMailSession</h4>
|
|
|
+<pre>public <a href="http://docs.oracle.com/javaee/6/api/javax/mail/Session.html?is-external=true" title="class or interface in javax.mail">Session</a> getMailSession()
|
|
|
+ throws <a href="../../../../org/apache/commons/mail/EmailException.html" title="class in org.apache.commons.mail">EmailException</a></pre>
|
|
|
+<div class="block">Determines the mail session used when sending this Email, creating
|
|
|
+ the Session if necessary. When a mail session is already
|
|
|
+ initialized setting the session related properties will cause
|
|
|
+ an IllegalStateException.</div>
|
|
|
+<dl>
|
|
|
+<dt><span class="returnLabel">Returns:</span></dt>
|
|
|
+<dd>A Session.</dd>
|
|
|
+<dt><span class="throwsLabel">Throws:</span></dt>
|
|
|
+<dd><code><a href="../../../../org/apache/commons/mail/EmailException.html" title="class in org.apache.commons.mail">EmailException</a></code> - if the host name was not set</dd>
|
|
|
+<dt><span class="simpleTagLabel">Since:</span></dt>
|
|
|
+<dd>1.0</dd>
|
|
|
+</dl>
|
|
|
+</li>
|
|
|
+</ul>
|
|
|
+<a name="setFrom-java.lang.String-">
|
|
|
+<!-- -->
|
|
|
+</a>
|
|
|
+<ul class="blockList">
|
|
|
+<li class="blockList">
|
|
|
+<h4>setFrom</h4>
|
|
|
+<pre>public <a href="../../../../org/apache/commons/mail/Email.html" title="class in org.apache.commons.mail">Email</a> setFrom(<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> email)
|
|
|
+ throws <a href="../../../../org/apache/commons/mail/EmailException.html" title="class in org.apache.commons.mail">EmailException</a></pre>
|
|
|
+<div class="block">Set the FROM field of the email to use the specified address. The email
|
|
|
+ address will also be used as the personal name.
|
|
|
+ The name will be encoded by the charset of <a href="../../../../org/apache/commons/mail/Email.html#setCharset-java.lang.String-"><code>setCharset()</code></a>.
|
|
|
+ If it is not set, it will be encoded using
|
|
|
+ the Java platform's default charset (UTF-16) if it contains
|
|
|
+ non-ASCII characters; otherwise, it is used as is.</div>
|
|
|
+<dl>
|
|
|
+<dt><span class="paramLabel">Parameters:</span></dt>
|
|
|
+<dd><code>email</code> - A String.</dd>
|
|
|
+<dt><span class="returnLabel">Returns:</span></dt>
|
|
|
+<dd>An Email.</dd>
|
|
|
+<dt><span class="throwsLabel">Throws:</span></dt>
|
|
|
+<dd><code><a href="../../../../org/apache/commons/mail/EmailException.html" title="class in org.apache.commons.mail">EmailException</a></code> - Indicates an invalid email address.</dd>
|
|
|
+<dt><span class="simpleTagLabel">Since:</span></dt>
|
|
|
+<dd>1.0</dd>
|
|
|
+</dl>
|
|
|
+</li>
|
|
|
+</ul>
|
|
|
+<a name="setFrom-java.lang.String-java.lang.String-">
|
|
|
+<!-- -->
|
|
|
+</a>
|
|
|
+<ul class="blockList">
|
|
|
+<li class="blockList">
|
|
|
+<h4>setFrom</h4>
|
|
|
+<pre>public <a href="../../../../org/apache/commons/mail/Email.html" title="class in org.apache.commons.mail">Email</a> setFrom(<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> email,
|
|
|
+ <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> name)
|
|
|
+ throws <a href="../../../../org/apache/commons/mail/EmailException.html" title="class in org.apache.commons.mail">EmailException</a></pre>
|
|
|
+<div class="block">Set the FROM field of the email to use the specified address and the
|
|
|
+ specified personal name.
|
|
|
+ The name will be encoded by the charset of <a href="../../../../org/apache/commons/mail/Email.html#setCharset-java.lang.String-"><code>setCharset()</code></a>.
|
|
|
+ If it is not set, it will be encoded using
|
|
|
+ the Java platform's default charset (UTF-16) if it contains
|
|
|
+ non-ASCII characters; otherwise, it is used as is.</div>
|
|
|
+<dl>
|
|
|
+<dt><span class="paramLabel">Parameters:</span></dt>
|
|
|
+<dd><code>email</code> - A String.</dd>
|
|
|
+<dd><code>name</code> - A String.</dd>
|
|
|
+<dt><span class="returnLabel">Returns:</span></dt>
|
|
|
+<dd>An Email.</dd>
|
|
|
+<dt><span class="throwsLabel">Throws:</span></dt>
|
|
|
+<dd><code><a href="../../../../org/apache/commons/mail/EmailException.html" title="class in org.apache.commons.mail">EmailException</a></code> - Indicates an invalid email address.</dd>
|
|
|
+<dt><span class="simpleTagLabel">Since:</span></dt>
|
|
|
+<dd>1.0</dd>
|
|
|
+</dl>
|
|
|
+</li>
|
|
|
+</ul>
|
|
|
+<a name="setFrom-java.lang.String-java.lang.String-java.lang.String-">
|
|
|
+<!-- -->
|
|
|
+</a>
|
|
|
+<ul class="blockList">
|
|
|
+<li class="blockList">
|
|
|
+<h4>setFrom</h4>
|
|
|
+<pre>public <a href="../../../../org/apache/commons/mail/Email.html" title="class in org.apache.commons.mail">Email</a> setFrom(<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> email,
|
|
|
+ <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> name,
|
|
|
+ <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> charset)
|
|
|
+ throws <a href="../../../../org/apache/commons/mail/EmailException.html" title="class in org.apache.commons.mail">EmailException</a></pre>
|
|
|
+<div class="block">Set the FROM field of the email to use the specified address, personal
|
|
|
+ name, and charset encoding for the name.</div>
|
|
|
+<dl>
|
|
|
+<dt><span class="paramLabel">Parameters:</span></dt>
|
|
|
+<dd><code>email</code> - A String.</dd>
|
|
|
+<dd><code>name</code> - A String.</dd>
|
|
|
+<dd><code>charset</code> - The charset to encode the name with.</dd>
|
|
|
+<dt><span class="returnLabel">Returns:</span></dt>
|
|
|
+<dd>An Email.</dd>
|
|
|
+<dt><span class="throwsLabel">Throws:</span></dt>
|
|
|
+<dd><code><a href="../../../../org/apache/commons/mail/EmailException.html" title="class in org.apache.commons.mail">EmailException</a></code> - Indicates an invalid email address or charset.</dd>
|
|
|
+<dt><span class="simpleTagLabel">Since:</span></dt>
|
|
|
+<dd>1.1</dd>
|
|
|
+</dl>
|
|
|
+</li>
|
|
|
+</ul>
|
|
|
+<a name="addTo-java.lang.String-">
|
|
|
+<!-- -->
|
|
|
+</a>
|
|
|
+<ul class="blockList">
|
|
|
+<li class="blockList">
|
|
|
+<h4>addTo</h4>
|
|
|
+<pre>public <a href="../../../../org/apache/commons/mail/Email.html" title="class in org.apache.commons.mail">Email</a> addTo(<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> email)
|
|
|
+ throws <a href="../../../../org/apache/commons/mail/EmailException.html" title="class in org.apache.commons.mail">EmailException</a></pre>
|
|
|
+<div class="block">Add a recipient TO to the email. The email
|
|
|
+ address will also be used as the personal name.
|
|
|
+ The name will be encoded by the charset of
|
|
|
+ <a href="../../../../org/apache/commons/mail/Email.html#setCharset-java.lang.String-"><code>setCharset()</code></a>.
|
|
|
+ If it is not set, it will be encoded using
|
|
|
+ the Java platform's default charset (UTF-16) if it contains
|
|
|
+ non-ASCII characters; otherwise, it is used as is.</div>
|
|
|
+<dl>
|
|
|
+<dt><span class="paramLabel">Parameters:</span></dt>
|
|
|
+<dd><code>email</code> - A String.</dd>
|
|
|
+<dt><span class="returnLabel">Returns:</span></dt>
|
|
|
+<dd>An Email.</dd>
|
|
|
+<dt><span class="throwsLabel">Throws:</span></dt>
|
|
|
+<dd><code><a href="../../../../org/apache/commons/mail/EmailException.html" title="class in org.apache.commons.mail">EmailException</a></code> - Indicates an invalid email address.</dd>
|
|
|
+<dt><span class="simpleTagLabel">Since:</span></dt>
|
|
|
+<dd>1.0</dd>
|
|
|
+</dl>
|
|
|
+</li>
|
|
|
+</ul>
|
|
|
+<a name="addTo-java.lang.String...-">
|
|
|
+<!-- -->
|
|
|
+</a>
|
|
|
+<ul class="blockList">
|
|
|
+<li class="blockList">
|
|
|
+<h4>addTo</h4>
|
|
|
+<pre>public <a href="../../../../org/apache/commons/mail/Email.html" title="class in org.apache.commons.mail">Email</a> addTo(<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>... emails)
|
|
|
+ throws <a href="../../../../org/apache/commons/mail/EmailException.html" title="class in org.apache.commons.mail">EmailException</a></pre>
|
|
|
+<div class="block">Add a list of TO recipients to the email. The email
|
|
|
+ addresses will also be used as the personal names.
|
|
|
+ The names will be encoded by the charset of
|
|
|
+ <a href="../../../../org/apache/commons/mail/Email.html#setCharset-java.lang.String-"><code>setCharset()</code></a>.
|
|
|
+ If it is not set, it will be encoded using
|
|
|
+ the Java platform's default charset (UTF-16) if it contains
|
|
|
+ non-ASCII characters; otherwise, it is used as is.</div>
|
|
|
+<dl>
|
|
|
+<dt><span class="paramLabel">Parameters:</span></dt>
|
|
|
+<dd><code>emails</code> - A String array.</dd>
|
|
|
+<dt><span class="returnLabel">Returns:</span></dt>
|
|
|
+<dd>An Email.</dd>
|
|
|
+<dt><span class="throwsLabel">Throws:</span></dt>
|
|
|
+<dd><code><a href="../../../../org/apache/commons/mail/EmailException.html" title="class in org.apache.commons.mail">EmailException</a></code> - Indicates an invalid email address.</dd>
|
|
|
+<dt><span class="simpleTagLabel">Since:</span></dt>
|
|
|
+<dd>1.3</dd>
|
|
|
+</dl>
|
|
|
+</li>
|
|
|
+</ul>
|
|
|
+<a name="addTo-java.lang.String-java.lang.String-">
|
|
|
+<!-- -->
|
|
|
+</a>
|
|
|
+<ul class="blockList">
|
|
|
+<li class="blockList">
|
|
|
+<h4>addTo</h4>
|
|
|
+<pre>public <a href="../../../../org/apache/commons/mail/Email.html" title="class in org.apache.commons.mail">Email</a> addTo(<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> email,
|
|
|
+ <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> name)
|
|
|
+ throws <a href="../../../../org/apache/commons/mail/EmailException.html" title="class in org.apache.commons.mail">EmailException</a></pre>
|
|
|
+<div class="block">Add a recipient TO to the email using the specified address and the
|
|
|
+ specified personal name.
|
|
|
+ The name will be encoded by the charset of
|
|
|
+ <a href="../../../../org/apache/commons/mail/Email.html#setCharset-java.lang.String-"><code>setCharset()</code></a>.
|
|
|
+ If it is not set, it will be encoded using
|
|
|
+ the Java platform's default charset (UTF-16) if it contains
|
|
|
+ non-ASCII characters; otherwise, it is used as is.</div>
|
|
|
+<dl>
|
|
|
+<dt><span class="paramLabel">Parameters:</span></dt>
|
|
|
+<dd><code>email</code> - A String.</dd>
|
|
|
+<dd><code>name</code> - A String.</dd>
|
|
|
+<dt><span class="returnLabel">Returns:</span></dt>
|
|
|
+<dd>An Email.</dd>
|
|
|
+<dt><span class="throwsLabel">Throws:</span></dt>
|
|
|
+<dd><code><a href="../../../../org/apache/commons/mail/EmailException.html" title="class in org.apache.commons.mail">EmailException</a></code> - Indicates an invalid email address.</dd>
|
|
|
+<dt><span class="simpleTagLabel">Since:</span></dt>
|
|
|
+<dd>1.0</dd>
|
|
|
+</dl>
|
|
|
+</li>
|
|
|
+</ul>
|
|
|
+<a name="addTo-java.lang.String-java.lang.String-java.lang.String-">
|
|
|
+<!-- -->
|
|
|
+</a>
|
|
|
+<ul class="blockList">
|
|
|
+<li class="blockList">
|
|
|
+<h4>addTo</h4>
|
|
|
+<pre>public <a href="../../../../org/apache/commons/mail/Email.html" title="class in org.apache.commons.mail">Email</a> addTo(<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> email,
|
|
|
+ <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> name,
|
|
|
+ <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> charset)
|
|
|
+ throws <a href="../../../../org/apache/commons/mail/EmailException.html" title="class in org.apache.commons.mail">EmailException</a></pre>
|
|
|
+<div class="block">Add a recipient TO to the email using the specified address, personal
|
|
|
+ name, and charset encoding for the name.</div>
|
|
|
+<dl>
|
|
|
+<dt><span class="paramLabel">Parameters:</span></dt>
|
|
|
+<dd><code>email</code> - A String.</dd>
|
|
|
+<dd><code>name</code> - A String.</dd>
|
|
|
+<dd><code>charset</code> - The charset to encode the name with.</dd>
|
|
|
+<dt><span class="returnLabel">Returns:</span></dt>
|
|
|
+<dd>An Email.</dd>
|
|
|
+<dt><span class="throwsLabel">Throws:</span></dt>
|
|
|
+<dd><code><a href="../../../../org/apache/commons/mail/EmailException.html" title="class in org.apache.commons.mail">EmailException</a></code> - Indicates an invalid email address or charset.</dd>
|
|
|
+<dt><span class="simpleTagLabel">Since:</span></dt>
|
|
|
+<dd>1.1</dd>
|
|
|
+</dl>
|
|
|
+</li>
|
|
|
+</ul>
|
|
|
+<a name="setTo-java.util.Collection-">
|
|
|
+<!-- -->
|
|
|
+</a>
|
|
|
+<ul class="blockList">
|
|
|
+<li class="blockList">
|
|
|
+<h4>setTo</h4>
|
|
|
+<pre>public <a href="../../../../org/apache/commons/mail/Email.html" title="class in org.apache.commons.mail">Email</a> setTo(<a href="http://docs.oracle.com/javase/7/docs/api/java/util/Collection.html?is-external=true" title="class or interface in java.util">Collection</a><<a href="http://docs.oracle.com/javaee/6/api/javax/mail/internet/InternetAddress.html?is-external=true" title="class or interface in javax.mail.internet">InternetAddress</a>> aCollection)
|
|
|
+ throws <a href="../../../../org/apache/commons/mail/EmailException.html" title="class in org.apache.commons.mail">EmailException</a></pre>
|
|
|
+<div class="block">Set a list of "TO" addresses. All elements in the specified
|
|
|
+ <code>Collection</code> are expected to be of type
|
|
|
+ <code>java.mail.internet.InternetAddress</code>.</div>
|
|
|
+<dl>
|
|
|
+<dt><span class="paramLabel">Parameters:</span></dt>
|
|
|
+<dd><code>aCollection</code> - collection of <code>InternetAddress</code> objects.</dd>
|
|
|
+<dt><span class="returnLabel">Returns:</span></dt>
|
|
|
+<dd>An Email.</dd>
|
|
|
+<dt><span class="throwsLabel">Throws:</span></dt>
|
|
|
+<dd><code><a href="../../../../org/apache/commons/mail/EmailException.html" title="class in org.apache.commons.mail">EmailException</a></code> - Indicates an invalid email address.</dd>
|
|
|
+<dt><span class="simpleTagLabel">Since:</span></dt>
|
|
|
+<dd>1.0</dd>
|
|
|
+<dt><span class="seeLabel">See Also:</span></dt>
|
|
|
+<dd><a href="http://docs.oracle.com/javaee/6/api/javax/mail/internet/InternetAddress.html?is-external=true" title="class or interface in javax.mail.internet"><code>InternetAddress</code></a></dd>
|
|
|
+</dl>
|
|
|
+</li>
|
|
|
+</ul>
|
|
|
+<a name="addCc-java.lang.String-">
|
|
|
+<!-- -->
|
|
|
+</a>
|
|
|
+<ul class="blockList">
|
|
|
+<li class="blockList">
|
|
|
+<h4>addCc</h4>
|
|
|
+<pre>public <a href="../../../../org/apache/commons/mail/Email.html" title="class in org.apache.commons.mail">Email</a> addCc(<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> email)
|
|
|
+ throws <a href="../../../../org/apache/commons/mail/EmailException.html" title="class in org.apache.commons.mail">EmailException</a></pre>
|
|
|
+<div class="block">Add a recipient CC to the email. The email
|
|
|
+ address will also be used as the personal name.
|
|
|
+ The name will be encoded by the charset of <a href="../../../../org/apache/commons/mail/Email.html#setCharset-java.lang.String-"><code>setCharset()</code></a>.
|
|
|
+ If it is not set, it will be encoded using
|
|
|
+ the Java platform's default charset (UTF-16) if it contains
|
|
|
+ non-ASCII characters; otherwise, it is used as is.</div>
|
|
|
+<dl>
|
|
|
+<dt><span class="paramLabel">Parameters:</span></dt>
|
|
|
+<dd><code>email</code> - A String.</dd>
|
|
|
+<dt><span class="returnLabel">Returns:</span></dt>
|
|
|
+<dd>An Email.</dd>
|
|
|
+<dt><span class="throwsLabel">Throws:</span></dt>
|
|
|
+<dd><code><a href="../../../../org/apache/commons/mail/EmailException.html" title="class in org.apache.commons.mail">EmailException</a></code> - Indicates an invalid email address.</dd>
|
|
|
+<dt><span class="simpleTagLabel">Since:</span></dt>
|
|
|
+<dd>1.0</dd>
|
|
|
+</dl>
|
|
|
+</li>
|
|
|
+</ul>
|
|
|
+<a name="addCc-java.lang.String...-">
|
|
|
+<!-- -->
|
|
|
+</a>
|
|
|
+<ul class="blockList">
|
|
|
+<li class="blockList">
|
|
|
+<h4>addCc</h4>
|
|
|
+<pre>public <a href="../../../../org/apache/commons/mail/Email.html" title="class in org.apache.commons.mail">Email</a> addCc(<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>... emails)
|
|
|
+ throws <a href="../../../../org/apache/commons/mail/EmailException.html" title="class in org.apache.commons.mail">EmailException</a></pre>
|
|
|
+<div class="block">Add an array of CC recipients to the email. The email
|
|
|
+ addresses will also be used as the personal name.
|
|
|
+ The names will be encoded by the charset of
|
|
|
+ <a href="../../../../org/apache/commons/mail/Email.html#setCharset-java.lang.String-"><code>setCharset()</code></a>.
|
|
|
+ If it is not set, it will be encoded using
|
|
|
+ the Java platform's default charset (UTF-16) if it contains
|
|
|
+ non-ASCII characters; otherwise, it is used as is.</div>
|
|
|
+<dl>
|
|
|
+<dt><span class="paramLabel">Parameters:</span></dt>
|
|
|
+<dd><code>emails</code> - A String array.</dd>
|
|
|
+<dt><span class="returnLabel">Returns:</span></dt>
|
|
|
+<dd>An Email.</dd>
|
|
|
+<dt><span class="throwsLabel">Throws:</span></dt>
|
|
|
+<dd><code><a href="../../../../org/apache/commons/mail/EmailException.html" title="class in org.apache.commons.mail">EmailException</a></code> - Indicates an invalid email address.</dd>
|
|
|
+<dt><span class="simpleTagLabel">Since:</span></dt>
|
|
|
+<dd>1.3</dd>
|
|
|
+</dl>
|
|
|
+</li>
|
|
|
+</ul>
|
|
|
+<a name="addCc-java.lang.String-java.lang.String-">
|
|
|
+<!-- -->
|
|
|
+</a>
|
|
|
+<ul class="blockList">
|
|
|
+<li class="blockList">
|
|
|
+<h4>addCc</h4>
|
|
|
+<pre>public <a href="../../../../org/apache/commons/mail/Email.html" title="class in org.apache.commons.mail">Email</a> addCc(<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> email,
|
|
|
+ <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> name)
|
|
|
+ throws <a href="../../../../org/apache/commons/mail/EmailException.html" title="class in org.apache.commons.mail">EmailException</a></pre>
|
|
|
+<div class="block">Add a recipient CC to the email using the specified address and the
|
|
|
+ specified personal name.
|
|
|
+ The name will be encoded by the charset of <a href="../../../../org/apache/commons/mail/Email.html#setCharset-java.lang.String-"><code>setCharset()</code></a>.
|
|
|
+ If it is not set, it will be encoded using
|
|
|
+ the Java platform's default charset (UTF-16) if it contains
|
|
|
+ non-ASCII characters; otherwise, it is used as is.</div>
|
|
|
+<dl>
|
|
|
+<dt><span class="paramLabel">Parameters:</span></dt>
|
|
|
+<dd><code>email</code> - A String.</dd>
|
|
|
+<dd><code>name</code> - A String.</dd>
|
|
|
+<dt><span class="returnLabel">Returns:</span></dt>
|
|
|
+<dd>An Email.</dd>
|
|
|
+<dt><span class="throwsLabel">Throws:</span></dt>
|
|
|
+<dd><code><a href="../../../../org/apache/commons/mail/EmailException.html" title="class in org.apache.commons.mail">EmailException</a></code> - Indicates an invalid email address.</dd>
|
|
|
+<dt><span class="simpleTagLabel">Since:</span></dt>
|
|
|
+<dd>1.0</dd>
|
|
|
+</dl>
|
|
|
+</li>
|
|
|
+</ul>
|
|
|
+<a name="addCc-java.lang.String-java.lang.String-java.lang.String-">
|
|
|
+<!-- -->
|
|
|
+</a>
|
|
|
+<ul class="blockList">
|
|
|
+<li class="blockList">
|
|
|
+<h4>addCc</h4>
|
|
|
+<pre>public <a href="../../../../org/apache/commons/mail/Email.html" title="class in org.apache.commons.mail">Email</a> addCc(<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> email,
|
|
|
+ <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> name,
|
|
|
+ <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> charset)
|
|
|
+ throws <a href="../../../../org/apache/commons/mail/EmailException.html" title="class in org.apache.commons.mail">EmailException</a></pre>
|
|
|
+<div class="block">Add a recipient CC to the email using the specified address, personal
|
|
|
+ name, and charset encoding for the name.</div>
|
|
|
+<dl>
|
|
|
+<dt><span class="paramLabel">Parameters:</span></dt>
|
|
|
+<dd><code>email</code> - A String.</dd>
|
|
|
+<dd><code>name</code> - A String.</dd>
|
|
|
+<dd><code>charset</code> - The charset to encode the name with.</dd>
|
|
|
+<dt><span class="returnLabel">Returns:</span></dt>
|
|
|
+<dd>An Email.</dd>
|
|
|
+<dt><span class="throwsLabel">Throws:</span></dt>
|
|
|
+<dd><code><a href="../../../../org/apache/commons/mail/EmailException.html" title="class in org.apache.commons.mail">EmailException</a></code> - Indicates an invalid email address or charset.</dd>
|
|
|
+<dt><span class="simpleTagLabel">Since:</span></dt>
|
|
|
+<dd>1.1</dd>
|
|
|
+</dl>
|
|
|
+</li>
|
|
|
+</ul>
|
|
|
+<a name="setCc-java.util.Collection-">
|
|
|
+<!-- -->
|
|
|
+</a>
|
|
|
+<ul class="blockList">
|
|
|
+<li class="blockList">
|
|
|
+<h4>setCc</h4>
|
|
|
+<pre>public <a href="../../../../org/apache/commons/mail/Email.html" title="class in org.apache.commons.mail">Email</a> setCc(<a href="http://docs.oracle.com/javase/7/docs/api/java/util/Collection.html?is-external=true" title="class or interface in java.util">Collection</a><<a href="http://docs.oracle.com/javaee/6/api/javax/mail/internet/InternetAddress.html?is-external=true" title="class or interface in javax.mail.internet">InternetAddress</a>> aCollection)
|
|
|
+ throws <a href="../../../../org/apache/commons/mail/EmailException.html" title="class in org.apache.commons.mail">EmailException</a></pre>
|
|
|
+<div class="block">Set a list of "CC" addresses. All elements in the specified
|
|
|
+ <code>Collection</code> are expected to be of type
|
|
|
+ <code>java.mail.internet.InternetAddress</code>.</div>
|
|
|
+<dl>
|
|
|
+<dt><span class="paramLabel">Parameters:</span></dt>
|
|
|
+<dd><code>aCollection</code> - collection of <code>InternetAddress</code> objects.</dd>
|
|
|
+<dt><span class="returnLabel">Returns:</span></dt>
|
|
|
+<dd>An Email.</dd>
|
|
|
+<dt><span class="throwsLabel">Throws:</span></dt>
|
|
|
+<dd><code><a href="../../../../org/apache/commons/mail/EmailException.html" title="class in org.apache.commons.mail">EmailException</a></code> - Indicates an invalid email address.</dd>
|
|
|
+<dt><span class="simpleTagLabel">Since:</span></dt>
|
|
|
+<dd>1.0</dd>
|
|
|
+<dt><span class="seeLabel">See Also:</span></dt>
|
|
|
+<dd><a href="http://docs.oracle.com/javaee/6/api/javax/mail/internet/InternetAddress.html?is-external=true" title="class or interface in javax.mail.internet"><code>InternetAddress</code></a></dd>
|
|
|
+</dl>
|
|
|
+</li>
|
|
|
+</ul>
|
|
|
+<a name="addBcc-java.lang.String-">
|
|
|
+<!-- -->
|
|
|
+</a>
|
|
|
+<ul class="blockList">
|
|
|
+<li class="blockList">
|
|
|
+<h4>addBcc</h4>
|
|
|
+<pre>public <a href="../../../../org/apache/commons/mail/Email.html" title="class in org.apache.commons.mail">Email</a> addBcc(<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> email)
|
|
|
+ throws <a href="../../../../org/apache/commons/mail/EmailException.html" title="class in org.apache.commons.mail">EmailException</a></pre>
|
|
|
+<div class="block">Add a blind BCC recipient to the email. The email
|
|
|
+ address will also be used as the personal name.
|
|
|
+ The name will be encoded by the charset of <a href="../../../../org/apache/commons/mail/Email.html#setCharset-java.lang.String-"><code>setCharset()</code></a>.
|
|
|
+ If it is not set, it will be encoded using
|
|
|
+ the Java platform's default charset (UTF-16) if it contains
|
|
|
+ non-ASCII characters; otherwise, it is used as is.</div>
|
|
|
+<dl>
|
|
|
+<dt><span class="paramLabel">Parameters:</span></dt>
|
|
|
+<dd><code>email</code> - A String.</dd>
|
|
|
+<dt><span class="returnLabel">Returns:</span></dt>
|
|
|
+<dd>An Email.</dd>
|
|
|
+<dt><span class="throwsLabel">Throws:</span></dt>
|
|
|
+<dd><code><a href="../../../../org/apache/commons/mail/EmailException.html" title="class in org.apache.commons.mail">EmailException</a></code> - Indicates an invalid email address</dd>
|
|
|
+<dt><span class="simpleTagLabel">Since:</span></dt>
|
|
|
+<dd>1.0</dd>
|
|
|
+</dl>
|
|
|
+</li>
|
|
|
+</ul>
|
|
|
+<a name="addBcc-java.lang.String...-">
|
|
|
+<!-- -->
|
|
|
+</a>
|
|
|
+<ul class="blockList">
|
|
|
+<li class="blockList">
|
|
|
+<h4>addBcc</h4>
|
|
|
+<pre>public <a href="../../../../org/apache/commons/mail/Email.html" title="class in org.apache.commons.mail">Email</a> addBcc(<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>... emails)
|
|
|
+ throws <a href="../../../../org/apache/commons/mail/EmailException.html" title="class in org.apache.commons.mail">EmailException</a></pre>
|
|
|
+<div class="block">Add an array of blind BCC recipients to the email. The email
|
|
|
+ addresses will also be used as the personal name.
|
|
|
+ The names will be encoded by the charset of
|
|
|
+ <a href="../../../../org/apache/commons/mail/Email.html#setCharset-java.lang.String-"><code>setCharset()</code></a>.
|
|
|
+ If it is not set, it will be encoded using
|
|
|
+ the Java platform's default charset (UTF-16) if it contains
|
|
|
+ non-ASCII characters; otherwise, it is used as is.</div>
|
|
|
+<dl>
|
|
|
+<dt><span class="paramLabel">Parameters:</span></dt>
|
|
|
+<dd><code>emails</code> - A String array.</dd>
|
|
|
+<dt><span class="returnLabel">Returns:</span></dt>
|
|
|
+<dd>An Email.</dd>
|
|
|
+<dt><span class="throwsLabel">Throws:</span></dt>
|
|
|
+<dd><code><a href="../../../../org/apache/commons/mail/EmailException.html" title="class in org.apache.commons.mail">EmailException</a></code> - Indicates an invalid email address</dd>
|
|
|
+<dt><span class="simpleTagLabel">Since:</span></dt>
|
|
|
+<dd>1.3</dd>
|
|
|
+</dl>
|
|
|
+</li>
|
|
|
+</ul>
|
|
|
+<a name="addBcc-java.lang.String-java.lang.String-">
|
|
|
+<!-- -->
|
|
|
+</a>
|
|
|
+<ul class="blockList">
|
|
|
+<li class="blockList">
|
|
|
+<h4>addBcc</h4>
|
|
|
+<pre>public <a href="../../../../org/apache/commons/mail/Email.html" title="class in org.apache.commons.mail">Email</a> addBcc(<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> email,
|
|
|
+ <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> name)
|
|
|
+ throws <a href="../../../../org/apache/commons/mail/EmailException.html" title="class in org.apache.commons.mail">EmailException</a></pre>
|
|
|
+<div class="block">Add a blind BCC recipient to the email using the specified address and
|
|
|
+ the specified personal name.
|
|
|
+ The name will be encoded by the charset of <a href="../../../../org/apache/commons/mail/Email.html#setCharset-java.lang.String-"><code>setCharset()</code></a>.
|
|
|
+ If it is not set, it will be encoded using
|
|
|
+ the Java platform's default charset (UTF-16) if it contains
|
|
|
+ non-ASCII characters; otherwise, it is used as is.</div>
|
|
|
+<dl>
|
|
|
+<dt><span class="paramLabel">Parameters:</span></dt>
|
|
|
+<dd><code>email</code> - A String.</dd>
|
|
|
+<dd><code>name</code> - A String.</dd>
|
|
|
+<dt><span class="returnLabel">Returns:</span></dt>
|
|
|
+<dd>An Email.</dd>
|
|
|
+<dt><span class="throwsLabel">Throws:</span></dt>
|
|
|
+<dd><code><a href="../../../../org/apache/commons/mail/EmailException.html" title="class in org.apache.commons.mail">EmailException</a></code> - Indicates an invalid email address</dd>
|
|
|
+<dt><span class="simpleTagLabel">Since:</span></dt>
|
|
|
+<dd>1.0</dd>
|
|
|
+</dl>
|
|
|
+</li>
|
|
|
+</ul>
|
|
|
+<a name="addBcc-java.lang.String-java.lang.String-java.lang.String-">
|
|
|
+<!-- -->
|
|
|
+</a>
|
|
|
+<ul class="blockList">
|
|
|
+<li class="blockList">
|
|
|
+<h4>addBcc</h4>
|
|
|
+<pre>public <a href="../../../../org/apache/commons/mail/Email.html" title="class in org.apache.commons.mail">Email</a> addBcc(<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> email,
|
|
|
+ <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> name,
|
|
|
+ <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> charset)
|
|
|
+ throws <a href="../../../../org/apache/commons/mail/EmailException.html" title="class in org.apache.commons.mail">EmailException</a></pre>
|
|
|
+<div class="block">Add a blind BCC recipient to the email using the specified address,
|
|
|
+ personal name, and charset encoding for the name.</div>
|
|
|
+<dl>
|
|
|
+<dt><span class="paramLabel">Parameters:</span></dt>
|
|
|
+<dd><code>email</code> - A String.</dd>
|
|
|
+<dd><code>name</code> - A String.</dd>
|
|
|
+<dd><code>charset</code> - The charset to encode the name with.</dd>
|
|
|
+<dt><span class="returnLabel">Returns:</span></dt>
|
|
|
+<dd>An Email.</dd>
|
|
|
+<dt><span class="throwsLabel">Throws:</span></dt>
|
|
|
+<dd><code><a href="../../../../org/apache/commons/mail/EmailException.html" title="class in org.apache.commons.mail">EmailException</a></code> - Indicates an invalid email address</dd>
|
|
|
+<dt><span class="simpleTagLabel">Since:</span></dt>
|
|
|
+<dd>1.1</dd>
|
|
|
+</dl>
|
|
|
+</li>
|
|
|
+</ul>
|
|
|
+<a name="setBcc-java.util.Collection-">
|
|
|
+<!-- -->
|
|
|
+</a>
|
|
|
+<ul class="blockList">
|
|
|
+<li class="blockList">
|
|
|
+<h4>setBcc</h4>
|
|
|
+<pre>public <a href="../../../../org/apache/commons/mail/Email.html" title="class in org.apache.commons.mail">Email</a> setBcc(<a href="http://docs.oracle.com/javase/7/docs/api/java/util/Collection.html?is-external=true" title="class or interface in java.util">Collection</a><<a href="http://docs.oracle.com/javaee/6/api/javax/mail/internet/InternetAddress.html?is-external=true" title="class or interface in javax.mail.internet">InternetAddress</a>> aCollection)
|
|
|
+ throws <a href="../../../../org/apache/commons/mail/EmailException.html" title="class in org.apache.commons.mail">EmailException</a></pre>
|
|
|
+<div class="block">Set a list of "BCC" addresses. All elements in the specified
|
|
|
+ <code>Collection</code> are expected to be of type
|
|
|
+ <code>java.mail.internet.InternetAddress</code>.</div>
|
|
|
+<dl>
|
|
|
+<dt><span class="paramLabel">Parameters:</span></dt>
|
|
|
+<dd><code>aCollection</code> - collection of <code>InternetAddress</code> objects</dd>
|
|
|
+<dt><span class="returnLabel">Returns:</span></dt>
|
|
|
+<dd>An Email.</dd>
|
|
|
+<dt><span class="throwsLabel">Throws:</span></dt>
|
|
|
+<dd><code><a href="../../../../org/apache/commons/mail/EmailException.html" title="class in org.apache.commons.mail">EmailException</a></code> - Indicates an invalid email address</dd>
|
|
|
+<dt><span class="simpleTagLabel">Since:</span></dt>
|
|
|
+<dd>1.0</dd>
|
|
|
+<dt><span class="seeLabel">See Also:</span></dt>
|
|
|
+<dd><a href="http://docs.oracle.com/javaee/6/api/javax/mail/internet/InternetAddress.html?is-external=true" title="class or interface in javax.mail.internet"><code>InternetAddress</code></a></dd>
|
|
|
+</dl>
|
|
|
+</li>
|
|
|
+</ul>
|
|
|
+<a name="addReplyTo-java.lang.String-">
|
|
|
+<!-- -->
|
|
|
+</a>
|
|
|
+<ul class="blockList">
|
|
|
+<li class="blockList">
|
|
|
+<h4>addReplyTo</h4>
|
|
|
+<pre>public <a href="../../../../org/apache/commons/mail/Email.html" title="class in org.apache.commons.mail">Email</a> addReplyTo(<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> email)
|
|
|
+ throws <a href="../../../../org/apache/commons/mail/EmailException.html" title="class in org.apache.commons.mail">EmailException</a></pre>
|
|
|
+<div class="block">Add a reply to address to the email. The email
|
|
|
+ address will also be used as the personal name.
|
|
|
+ The name will be encoded by the charset of <a href="../../../../org/apache/commons/mail/Email.html#setCharset-java.lang.String-"><code>setCharset()</code></a>.
|
|
|
+ If it is not set, it will be encoded using
|
|
|
+ the Java platform's default charset (UTF-16) if it contains
|
|
|
+ non-ASCII characters; otherwise, it is used as is.</div>
|
|
|
+<dl>
|
|
|
+<dt><span class="paramLabel">Parameters:</span></dt>
|
|
|
+<dd><code>email</code> - A String.</dd>
|
|
|
+<dt><span class="returnLabel">Returns:</span></dt>
|
|
|
+<dd>An Email.</dd>
|
|
|
+<dt><span class="throwsLabel">Throws:</span></dt>
|
|
|
+<dd><code><a href="../../../../org/apache/commons/mail/EmailException.html" title="class in org.apache.commons.mail">EmailException</a></code> - Indicates an invalid email address</dd>
|
|
|
+<dt><span class="simpleTagLabel">Since:</span></dt>
|
|
|
+<dd>1.0</dd>
|
|
|
+</dl>
|
|
|
+</li>
|
|
|
+</ul>
|
|
|
+<a name="addReplyTo-java.lang.String-java.lang.String-">
|
|
|
+<!-- -->
|
|
|
+</a>
|
|
|
+<ul class="blockList">
|
|
|
+<li class="blockList">
|
|
|
+<h4>addReplyTo</h4>
|
|
|
+<pre>public <a href="../../../../org/apache/commons/mail/Email.html" title="class in org.apache.commons.mail">Email</a> addReplyTo(<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> email,
|
|
|
+ <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> name)
|
|
|
+ throws <a href="../../../../org/apache/commons/mail/EmailException.html" title="class in org.apache.commons.mail">EmailException</a></pre>
|
|
|
+<div class="block">Add a reply to address to the email using the specified address and
|
|
|
+ the specified personal name.
|
|
|
+ The name will be encoded by the charset of <a href="../../../../org/apache/commons/mail/Email.html#setCharset-java.lang.String-"><code>setCharset()</code></a>.
|
|
|
+ If it is not set, it will be encoded using
|
|
|
+ the Java platform's default charset (UTF-16) if it contains
|
|
|
+ non-ASCII characters; otherwise, it is used as is.</div>
|
|
|
+<dl>
|
|
|
+<dt><span class="paramLabel">Parameters:</span></dt>
|
|
|
+<dd><code>email</code> - A String.</dd>
|
|
|
+<dd><code>name</code> - A String.</dd>
|
|
|
+<dt><span class="returnLabel">Returns:</span></dt>
|
|
|
+<dd>An Email.</dd>
|
|
|
+<dt><span class="throwsLabel">Throws:</span></dt>
|
|
|
+<dd><code><a href="../../../../org/apache/commons/mail/EmailException.html" title="class in org.apache.commons.mail">EmailException</a></code> - Indicates an invalid email address</dd>
|
|
|
+<dt><span class="simpleTagLabel">Since:</span></dt>
|
|
|
+<dd>1.0</dd>
|
|
|
+</dl>
|
|
|
+</li>
|
|
|
+</ul>
|
|
|
+<a name="addReplyTo-java.lang.String-java.lang.String-java.lang.String-">
|
|
|
+<!-- -->
|
|
|
+</a>
|
|
|
+<ul class="blockList">
|
|
|
+<li class="blockList">
|
|
|
+<h4>addReplyTo</h4>
|
|
|
+<pre>public <a href="../../../../org/apache/commons/mail/Email.html" title="class in org.apache.commons.mail">Email</a> addReplyTo(<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> email,
|
|
|
+ <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> name,
|
|
|
+ <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> charset)
|
|
|
+ throws <a href="../../../../org/apache/commons/mail/EmailException.html" title="class in org.apache.commons.mail">EmailException</a></pre>
|
|
|
+<div class="block">Add a reply to address to the email using the specified address,
|
|
|
+ personal name, and charset encoding for the name.</div>
|
|
|
+<dl>
|
|
|
+<dt><span class="paramLabel">Parameters:</span></dt>
|
|
|
+<dd><code>email</code> - A String.</dd>
|
|
|
+<dd><code>name</code> - A String.</dd>
|
|
|
+<dd><code>charset</code> - The charset to encode the name with.</dd>
|
|
|
+<dt><span class="returnLabel">Returns:</span></dt>
|
|
|
+<dd>An Email.</dd>
|
|
|
+<dt><span class="throwsLabel">Throws:</span></dt>
|
|
|
+<dd><code><a href="../../../../org/apache/commons/mail/EmailException.html" title="class in org.apache.commons.mail">EmailException</a></code> - Indicates an invalid email address or charset.</dd>
|
|
|
+<dt><span class="simpleTagLabel">Since:</span></dt>
|
|
|
+<dd>1.1</dd>
|
|
|
+</dl>
|
|
|
+</li>
|
|
|
+</ul>
|
|
|
+<a name="setReplyTo-java.util.Collection-">
|
|
|
+<!-- -->
|
|
|
+</a>
|
|
|
+<ul class="blockList">
|
|
|
+<li class="blockList">
|
|
|
+<h4>setReplyTo</h4>
|
|
|
+<pre>public <a href="../../../../org/apache/commons/mail/Email.html" title="class in org.apache.commons.mail">Email</a> setReplyTo(<a href="http://docs.oracle.com/javase/7/docs/api/java/util/Collection.html?is-external=true" title="class or interface in java.util">Collection</a><<a href="http://docs.oracle.com/javaee/6/api/javax/mail/internet/InternetAddress.html?is-external=true" title="class or interface in javax.mail.internet">InternetAddress</a>> aCollection)
|
|
|
+ throws <a href="../../../../org/apache/commons/mail/EmailException.html" title="class in org.apache.commons.mail">EmailException</a></pre>
|
|
|
+<div class="block">Set a list of reply to addresses. All elements in the specified
|
|
|
+ <code>Collection</code> are expected to be of type
|
|
|
+ <code>java.mail.internet.InternetAddress</code>.</div>
|
|
|
+<dl>
|
|
|
+<dt><span class="paramLabel">Parameters:</span></dt>
|
|
|
+<dd><code>aCollection</code> - collection of <code>InternetAddress</code> objects</dd>
|
|
|
+<dt><span class="returnLabel">Returns:</span></dt>
|
|
|
+<dd>An Email.</dd>
|
|
|
+<dt><span class="throwsLabel">Throws:</span></dt>
|
|
|
+<dd><code><a href="../../../../org/apache/commons/mail/EmailException.html" title="class in org.apache.commons.mail">EmailException</a></code> - Indicates an invalid email address</dd>
|
|
|
+<dt><span class="simpleTagLabel">Since:</span></dt>
|
|
|
+<dd>1.1</dd>
|
|
|
+<dt><span class="seeLabel">See Also:</span></dt>
|
|
|
+<dd><a href="http://docs.oracle.com/javaee/6/api/javax/mail/internet/InternetAddress.html?is-external=true" title="class or interface in javax.mail.internet"><code>InternetAddress</code></a></dd>
|
|
|
+</dl>
|
|
|
+</li>
|
|
|
+</ul>
|
|
|
+<a name="setHeaders-java.util.Map-">
|
|
|
+<!-- -->
|
|
|
+</a>
|
|
|
+<ul class="blockList">
|
|
|
+<li class="blockList">
|
|
|
+<h4>setHeaders</h4>
|
|
|
+<pre>public void setHeaders(<a href="http://docs.oracle.com/javase/7/docs/api/java/util/Map.html?is-external=true" title="class or interface in java.util">Map</a><<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>,<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>> map)</pre>
|
|
|
+<div class="block">Used to specify the mail headers. Example:
|
|
|
+
|
|
|
+ X-Mailer: Sendmail, X-Priority: 1( highest )
|
|
|
+ or 2( high ) 3( normal ) 4( low ) and 5( lowest )
|
|
|
+ Disposition-Notification-To: user@domain.net</div>
|
|
|
+<dl>
|
|
|
+<dt><span class="paramLabel">Parameters:</span></dt>
|
|
|
+<dd><code>map</code> - A Map.</dd>
|
|
|
+<dt><span class="throwsLabel">Throws:</span></dt>
|
|
|
+<dd><code><a href="http://docs.oracle.com/javase/7/docs/api/java/lang/IllegalArgumentException.html?is-external=true" title="class or interface in java.lang">IllegalArgumentException</a></code> - if either of the provided header / value is null or empty</dd>
|
|
|
+<dt><span class="simpleTagLabel">Since:</span></dt>
|
|
|
+<dd>1.0</dd>
|
|
|
+</dl>
|
|
|
+</li>
|
|
|
+</ul>
|
|
|
+<a name="addHeader-java.lang.String-java.lang.String-">
|
|
|
+<!-- -->
|
|
|
+</a>
|
|
|
+<ul class="blockList">
|
|
|
+<li class="blockList">
|
|
|
+<h4>addHeader</h4>
|
|
|
+<pre>public void addHeader(<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> name,
|
|
|
+ <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> value)</pre>
|
|
|
+<div class="block">Adds a header ( name, value ) to the headers Map.</div>
|
|
|
+<dl>
|
|
|
+<dt><span class="paramLabel">Parameters:</span></dt>
|
|
|
+<dd><code>name</code> - A String with the name.</dd>
|
|
|
+<dd><code>value</code> - A String with the value.</dd>
|
|
|
+<dt><span class="throwsLabel">Throws:</span></dt>
|
|
|
+<dd><code><a href="http://docs.oracle.com/javase/7/docs/api/java/lang/IllegalArgumentException.html?is-external=true" title="class or interface in java.lang">IllegalArgumentException</a></code> - if either <code>name</code> or <code>value</code> is null or empty</dd>
|
|
|
+<dt><span class="simpleTagLabel">Since:</span></dt>
|
|
|
+<dd>1.0</dd>
|
|
|
+</dl>
|
|
|
+</li>
|
|
|
+</ul>
|
|
|
+<a name="getHeader-java.lang.String-">
|
|
|
+<!-- -->
|
|
|
+</a>
|
|
|
+<ul class="blockList">
|
|
|
+<li class="blockList">
|
|
|
+<h4>getHeader</h4>
|
|
|
+<pre>public <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> getHeader(<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> header)</pre>
|
|
|
+<div class="block">Gets the specified header.</div>
|
|
|
+<dl>
|
|
|
+<dt><span class="paramLabel">Parameters:</span></dt>
|
|
|
+<dd><code>header</code> - A string with the header.</dd>
|
|
|
+<dt><span class="returnLabel">Returns:</span></dt>
|
|
|
+<dd>The value of the header, or null if no such header.</dd>
|
|
|
+<dt><span class="simpleTagLabel">Since:</span></dt>
|
|
|
+<dd>1.5</dd>
|
|
|
+</dl>
|
|
|
+</li>
|
|
|
+</ul>
|
|
|
+<a name="getHeaders--">
|
|
|
+<!-- -->
|
|
|
+</a>
|
|
|
+<ul class="blockList">
|
|
|
+<li class="blockList">
|
|
|
+<h4>getHeaders</h4>
|
|
|
+<pre>public <a href="http://docs.oracle.com/javase/7/docs/api/java/util/Map.html?is-external=true" title="class or interface in java.util">Map</a><<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>,<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>> getHeaders()</pre>
|
|
|
+<div class="block">Gets all headers on an Email.</div>
|
|
|
+<dl>
|
|
|
+<dt><span class="returnLabel">Returns:</span></dt>
|
|
|
+<dd>a Map of all headers.</dd>
|
|
|
+<dt><span class="simpleTagLabel">Since:</span></dt>
|
|
|
+<dd>1.5</dd>
|
|
|
+</dl>
|
|
|
+</li>
|
|
|
+</ul>
|
|
|
+<a name="setSubject-java.lang.String-">
|
|
|
+<!-- -->
|
|
|
+</a>
|
|
|
+<ul class="blockList">
|
|
|
+<li class="blockList">
|
|
|
+<h4>setSubject</h4>
|
|
|
+<pre>public <a href="../../../../org/apache/commons/mail/Email.html" title="class in org.apache.commons.mail">Email</a> setSubject(<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> aSubject)</pre>
|
|
|
+<div class="block">Sets the email subject. Replaces end-of-line characters with spaces.</div>
|
|
|
+<dl>
|
|
|
+<dt><span class="paramLabel">Parameters:</span></dt>
|
|
|
+<dd><code>aSubject</code> - A String.</dd>
|
|
|
+<dt><span class="returnLabel">Returns:</span></dt>
|
|
|
+<dd>An Email.</dd>
|
|
|
+<dt><span class="simpleTagLabel">Since:</span></dt>
|
|
|
+<dd>1.0</dd>
|
|
|
+</dl>
|
|
|
+</li>
|
|
|
+</ul>
|
|
|
+<a name="getBounceAddress--">
|
|
|
+<!-- -->
|
|
|
+</a>
|
|
|
+<ul class="blockList">
|
|
|
+<li class="blockList">
|
|
|
+<h4>getBounceAddress</h4>
|
|
|
+<pre>public <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> getBounceAddress()</pre>
|
|
|
+<div class="block">Gets the "bounce address" of this email.</div>
|
|
|
+<dl>
|
|
|
+<dt><span class="returnLabel">Returns:</span></dt>
|
|
|
+<dd>the bounce address as string</dd>
|
|
|
+<dt><span class="simpleTagLabel">Since:</span></dt>
|
|
|
+<dd>1.4</dd>
|
|
|
+</dl>
|
|
|
+</li>
|
|
|
+</ul>
|
|
|
+<a name="setBounceAddress-java.lang.String-">
|
|
|
+<!-- -->
|
|
|
+</a>
|
|
|
+<ul class="blockList">
|
|
|
+<li class="blockList">
|
|
|
+<h4>setBounceAddress</h4>
|
|
|
+<pre>public <a href="../../../../org/apache/commons/mail/Email.html" title="class in org.apache.commons.mail">Email</a> setBounceAddress(<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> email)</pre>
|
|
|
+<div class="block">Set the "bounce address" - the address to which undeliverable messages
|
|
|
+ will be returned. If this value is never set, then the message will be
|
|
|
+ sent to the address specified with the System property "mail.smtp.from",
|
|
|
+ or if that value is not set, then to the "from" address.</div>
|
|
|
+<dl>
|
|
|
+<dt><span class="paramLabel">Parameters:</span></dt>
|
|
|
+<dd><code>email</code> - A String.</dd>
|
|
|
+<dt><span class="returnLabel">Returns:</span></dt>
|
|
|
+<dd>An Email.</dd>
|
|
|
+<dt><span class="throwsLabel">Throws:</span></dt>
|
|
|
+<dd><code><a href="http://docs.oracle.com/javase/7/docs/api/java/lang/IllegalStateException.html?is-external=true" title="class or interface in java.lang">IllegalStateException</a></code> - if the mail session is already initialized</dd>
|
|
|
+<dt><span class="simpleTagLabel">Since:</span></dt>
|
|
|
+<dd>1.0</dd>
|
|
|
+</dl>
|
|
|
+</li>
|
|
|
+</ul>
|
|
|
+<a name="setMsg-java.lang.String-">
|
|
|
+<!-- -->
|
|
|
+</a>
|
|
|
+<ul class="blockList">
|
|
|
+<li class="blockList">
|
|
|
+<h4>setMsg</h4>
|
|
|
+<pre>public abstract <a href="../../../../org/apache/commons/mail/Email.html" title="class in org.apache.commons.mail">Email</a> setMsg(<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> msg)
|
|
|
+ throws <a href="../../../../org/apache/commons/mail/EmailException.html" title="class in org.apache.commons.mail">EmailException</a></pre>
|
|
|
+<div class="block">Define the content of the mail. It should be overridden by the
|
|
|
+ subclasses.</div>
|
|
|
+<dl>
|
|
|
+<dt><span class="paramLabel">Parameters:</span></dt>
|
|
|
+<dd><code>msg</code> - A String.</dd>
|
|
|
+<dt><span class="returnLabel">Returns:</span></dt>
|
|
|
+<dd>An Email.</dd>
|
|
|
+<dt><span class="throwsLabel">Throws:</span></dt>
|
|
|
+<dd><code><a href="../../../../org/apache/commons/mail/EmailException.html" title="class in org.apache.commons.mail">EmailException</a></code> - generic exception.</dd>
|
|
|
+<dt><span class="simpleTagLabel">Since:</span></dt>
|
|
|
+<dd>1.0</dd>
|
|
|
+</dl>
|
|
|
+</li>
|
|
|
+</ul>
|
|
|
+<a name="buildMimeMessage--">
|
|
|
+<!-- -->
|
|
|
+</a>
|
|
|
+<ul class="blockList">
|
|
|
+<li class="blockList">
|
|
|
+<h4>buildMimeMessage</h4>
|
|
|
+<pre>public void buildMimeMessage()
|
|
|
+ throws <a href="../../../../org/apache/commons/mail/EmailException.html" title="class in org.apache.commons.mail">EmailException</a></pre>
|
|
|
+<div class="block">Does the work of actually building 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>
|
|
|
+<dt><span class="throwsLabel">Throws:</span></dt>
|
|
|
+<dd><code><a href="http://docs.oracle.com/javase/7/docs/api/java/lang/IllegalStateException.html?is-external=true" title="class or interface in java.lang">IllegalStateException</a></code> - if the MimeMessage was already built</dd>
|
|
|
+<dd><code><a href="../../../../org/apache/commons/mail/EmailException.html" title="class in org.apache.commons.mail">EmailException</a></code> - if there was an error.</dd>
|
|
|
+<dt><span class="simpleTagLabel">Since:</span></dt>
|
|
|
+<dd>1.0</dd>
|
|
|
+</dl>
|
|
|
+</li>
|
|
|
+</ul>
|
|
|
+<a name="sendMimeMessage--">
|
|
|
+<!-- -->
|
|
|
+</a>
|
|
|
+<ul class="blockList">
|
|
|
+<li class="blockList">
|
|
|
+<h4>sendMimeMessage</h4>
|
|
|
+<pre>public <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> sendMimeMessage()
|
|
|
+ throws <a href="../../../../org/apache/commons/mail/EmailException.html" title="class in org.apache.commons.mail">EmailException</a></pre>
|
|
|
+<div class="block">Sends the previously created MimeMessage to the SMTP server.</div>
|
|
|
+<dl>
|
|
|
+<dt><span class="returnLabel">Returns:</span></dt>
|
|
|
+<dd>the message id of the underlying MimeMessage</dd>
|
|
|
+<dt><span class="throwsLabel">Throws:</span></dt>
|
|
|
+<dd><code><a href="http://docs.oracle.com/javase/7/docs/api/java/lang/IllegalArgumentException.html?is-external=true" title="class or interface in java.lang">IllegalArgumentException</a></code> - if the MimeMessage has not been created</dd>
|
|
|
+<dd><code><a href="../../../../org/apache/commons/mail/EmailException.html" title="class in org.apache.commons.mail">EmailException</a></code> - the sending failed</dd>
|
|
|
+</dl>
|
|
|
+</li>
|
|
|
+</ul>
|
|
|
+<a name="getMimeMessage--">
|
|
|
+<!-- -->
|
|
|
+</a>
|
|
|
+<ul class="blockList">
|
|
|
+<li class="blockList">
|
|
|
+<h4>getMimeMessage</h4>
|
|
|
+<pre>public <a href="http://docs.oracle.com/javaee/6/api/javax/mail/internet/MimeMessage.html?is-external=true" title="class or interface in javax.mail.internet">MimeMessage</a> getMimeMessage()</pre>
|
|
|
+<div class="block">Returns the internal MimeMessage. Please note that the
|
|
|
+ MimeMessage is built by the buildMimeMessage() method.</div>
|
|
|
+<dl>
|
|
|
+<dt><span class="returnLabel">Returns:</span></dt>
|
|
|
+<dd>the MimeMessage</dd>
|
|
|
+</dl>
|
|
|
+</li>
|
|
|
+</ul>
|
|
|
+<a name="send--">
|
|
|
+<!-- -->
|
|
|
+</a>
|
|
|
+<ul class="blockList">
|
|
|
+<li class="blockList">
|
|
|
+<h4>send</h4>
|
|
|
+<pre>public <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> send()
|
|
|
+ throws <a href="../../../../org/apache/commons/mail/EmailException.html" title="class in org.apache.commons.mail">EmailException</a></pre>
|
|
|
+<div class="block">Sends the email. Internally we build a MimeMessage
|
|
|
+ which is afterwards sent to the SMTP server.</div>
|
|
|
+<dl>
|
|
|
+<dt><span class="returnLabel">Returns:</span></dt>
|
|
|
+<dd>the message id of the underlying MimeMessage</dd>
|
|
|
+<dt><span class="throwsLabel">Throws:</span></dt>
|
|
|
+<dd><code><a href="http://docs.oracle.com/javase/7/docs/api/java/lang/IllegalStateException.html?is-external=true" title="class or interface in java.lang">IllegalStateException</a></code> - if the MimeMessage was already built, ie <a href="../../../../org/apache/commons/mail/Email.html#buildMimeMessage--"><code>buildMimeMessage()</code></a>
|
|
|
+ was already called</dd>
|
|
|
+<dd><code><a href="../../../../org/apache/commons/mail/EmailException.html" title="class in org.apache.commons.mail">EmailException</a></code> - the sending failed</dd>
|
|
|
+</dl>
|
|
|
+</li>
|
|
|
+</ul>
|
|
|
+<a name="setSentDate-java.util.Date-">
|
|
|
+<!-- -->
|
|
|
+</a>
|
|
|
+<ul class="blockList">
|
|
|
+<li class="blockList">
|
|
|
+<h4>setSentDate</h4>
|
|
|
+<pre>public void setSentDate(<a href="http://docs.oracle.com/javase/7/docs/api/java/util/Date.html?is-external=true" title="class or interface in java.util">Date</a> date)</pre>
|
|
|
+<div class="block">Sets the sent date for the email. The sent date will default to the
|
|
|
+ current date if not explicitly set.</div>
|
|
|
+<dl>
|
|
|
+<dt><span class="paramLabel">Parameters:</span></dt>
|
|
|
+<dd><code>date</code> - Date to use as the sent date on the email</dd>
|
|
|
+<dt><span class="simpleTagLabel">Since:</span></dt>
|
|
|
+<dd>1.0</dd>
|
|
|
+</dl>
|
|
|
+</li>
|
|
|
+</ul>
|
|
|
+<a name="getSentDate--">
|
|
|
+<!-- -->
|
|
|
+</a>
|
|
|
+<ul class="blockList">
|
|
|
+<li class="blockList">
|
|
|
+<h4>getSentDate</h4>
|
|
|
+<pre>public <a href="http://docs.oracle.com/javase/7/docs/api/java/util/Date.html?is-external=true" title="class or interface in java.util">Date</a> getSentDate()</pre>
|
|
|
+<div class="block">Gets the sent date for the email.</div>
|
|
|
+<dl>
|
|
|
+<dt><span class="returnLabel">Returns:</span></dt>
|
|
|
+<dd>date to be used as the sent date for the email</dd>
|
|
|
+<dt><span class="simpleTagLabel">Since:</span></dt>
|
|
|
+<dd>1.0</dd>
|
|
|
+</dl>
|
|
|
+</li>
|
|
|
+</ul>
|
|
|
+<a name="getSubject--">
|
|
|
+<!-- -->
|
|
|
+</a>
|
|
|
+<ul class="blockList">
|
|
|
+<li class="blockList">
|
|
|
+<h4>getSubject</h4>
|
|
|
+<pre>public <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> getSubject()</pre>
|
|
|
+<div class="block">Gets the subject of the email.</div>
|
|
|
+<dl>
|
|
|
+<dt><span class="returnLabel">Returns:</span></dt>
|
|
|
+<dd>email subject</dd>
|
|
|
+</dl>
|
|
|
+</li>
|
|
|
+</ul>
|
|
|
+<a name="getFromAddress--">
|
|
|
+<!-- -->
|
|
|
+</a>
|
|
|
+<ul class="blockList">
|
|
|
+<li class="blockList">
|
|
|
+<h4>getFromAddress</h4>
|
|
|
+<pre>public <a href="http://docs.oracle.com/javaee/6/api/javax/mail/internet/InternetAddress.html?is-external=true" title="class or interface in javax.mail.internet">InternetAddress</a> getFromAddress()</pre>
|
|
|
+<div class="block">Gets the sender of the email.</div>
|
|
|
+<dl>
|
|
|
+<dt><span class="returnLabel">Returns:</span></dt>
|
|
|
+<dd>from address</dd>
|
|
|
+</dl>
|
|
|
+</li>
|
|
|
+</ul>
|
|
|
+<a name="getHostName--">
|
|
|
+<!-- -->
|
|
|
+</a>
|
|
|
+<ul class="blockList">
|
|
|
+<li class="blockList">
|
|
|
+<h4>getHostName</h4>
|
|
|
+<pre>public <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> getHostName()</pre>
|
|
|
+<div class="block">Gets the host name of the SMTP server,</div>
|
|
|
+<dl>
|
|
|
+<dt><span class="returnLabel">Returns:</span></dt>
|
|
|
+<dd>host name</dd>
|
|
|
+</dl>
|
|
|
+</li>
|
|
|
+</ul>
|
|
|
+<a name="getSmtpPort--">
|
|
|
+<!-- -->
|
|
|
+</a>
|
|
|
+<ul class="blockList">
|
|
|
+<li class="blockList">
|
|
|
+<h4>getSmtpPort</h4>
|
|
|
+<pre>public <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> getSmtpPort()</pre>
|
|
|
+<div class="block">Gets the listening port of the SMTP server.</div>
|
|
|
+<dl>
|
|
|
+<dt><span class="returnLabel">Returns:</span></dt>
|
|
|
+<dd>smtp port</dd>
|
|
|
+</dl>
|
|
|
+</li>
|
|
|
+</ul>
|
|
|
+<a name="isStartTLSRequired--">
|
|
|
+<!-- -->
|
|
|
+</a>
|
|
|
+<ul class="blockList">
|
|
|
+<li class="blockList">
|
|
|
+<h4>isStartTLSRequired</h4>
|
|
|
+<pre>public boolean isStartTLSRequired()</pre>
|
|
|
+<div class="block">Gets whether the client is configured to require STARTTLS.</div>
|
|
|
+<dl>
|
|
|
+<dt><span class="returnLabel">Returns:</span></dt>
|
|
|
+<dd>true if using STARTTLS for authentication, false otherwise</dd>
|
|
|
+<dt><span class="simpleTagLabel">Since:</span></dt>
|
|
|
+<dd>1.3</dd>
|
|
|
+</dl>
|
|
|
+</li>
|
|
|
+</ul>
|
|
|
+<a name="isStartTLSEnabled--">
|
|
|
+<!-- -->
|
|
|
+</a>
|
|
|
+<ul class="blockList">
|
|
|
+<li class="blockList">
|
|
|
+<h4>isStartTLSEnabled</h4>
|
|
|
+<pre>public boolean isStartTLSEnabled()</pre>
|
|
|
+<div class="block">Gets whether the client is configured to try to enable STARTTLS.</div>
|
|
|
+<dl>
|
|
|
+<dt><span class="returnLabel">Returns:</span></dt>
|
|
|
+<dd>true if using STARTTLS for authentication, false otherwise</dd>
|
|
|
+<dt><span class="simpleTagLabel">Since:</span></dt>
|
|
|
+<dd>1.3</dd>
|
|
|
+</dl>
|
|
|
+</li>
|
|
|
+</ul>
|
|
|
+<a name="isTLS--">
|
|
|
+<!-- -->
|
|
|
+</a>
|
|
|
+<ul class="blockList">
|
|
|
+<li class="blockList">
|
|
|
+<h4>isTLS</h4>
|
|
|
+<pre><a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Deprecated.html?is-external=true" title="class or interface in java.lang">@Deprecated</a>
|
|
|
+public boolean isTLS()</pre>
|
|
|
+<div class="block"><span class="deprecatedLabel">Deprecated.</span> <span class="deprecationComment">since 1.3, use isStartTLSEnabled() instead</span></div>
|
|
|
+<div class="block">Gets whether the client is configured to try to enable STARTTLS.
|
|
|
+ See EMAIL-105 for reason of deprecation.</div>
|
|
|
+<dl>
|
|
|
+<dt><span class="returnLabel">Returns:</span></dt>
|
|
|
+<dd>true if using STARTTLS for authentication, false otherwise</dd>
|
|
|
+<dt><span class="simpleTagLabel">Since:</span></dt>
|
|
|
+<dd>1.1</dd>
|
|
|
+</dl>
|
|
|
+</li>
|
|
|
+</ul>
|
|
|
+<a name="toInternetAddressArray-java.util.List-">
|
|
|
+<!-- -->
|
|
|
+</a>
|
|
|
+<ul class="blockList">
|
|
|
+<li class="blockList">
|
|
|
+<h4>toInternetAddressArray</h4>
|
|
|
+<pre>protected <a href="http://docs.oracle.com/javaee/6/api/javax/mail/internet/InternetAddress.html?is-external=true" title="class or interface in javax.mail.internet">InternetAddress</a>[] toInternetAddressArray(<a href="http://docs.oracle.com/javase/7/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</a><<a href="http://docs.oracle.com/javaee/6/api/javax/mail/internet/InternetAddress.html?is-external=true" title="class or interface in javax.mail.internet">InternetAddress</a>> list)</pre>
|
|
|
+<div class="block">Utility to copy List of known InternetAddress objects into an
|
|
|
+ array.</div>
|
|
|
+<dl>
|
|
|
+<dt><span class="paramLabel">Parameters:</span></dt>
|
|
|
+<dd><code>list</code> - A List.</dd>
|
|
|
+<dt><span class="returnLabel">Returns:</span></dt>
|
|
|
+<dd>An InternetAddress[].</dd>
|
|
|
+<dt><span class="simpleTagLabel">Since:</span></dt>
|
|
|
+<dd>1.0</dd>
|
|
|
+</dl>
|
|
|
+</li>
|
|
|
+</ul>
|
|
|
+<a name="setPopBeforeSmtp-boolean-java.lang.String-java.lang.String-java.lang.String-">
|
|
|
+<!-- -->
|
|
|
+</a>
|
|
|
+<ul class="blockList">
|
|
|
+<li class="blockList">
|
|
|
+<h4>setPopBeforeSmtp</h4>
|
|
|
+<pre>public void setPopBeforeSmtp(boolean newPopBeforeSmtp,
|
|
|
+ <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> newPopHost,
|
|
|
+ <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> newPopUsername,
|
|
|
+ <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> newPopPassword)</pre>
|
|
|
+<div class="block">Set details regarding "pop3 before smtp" authentication.</div>
|
|
|
+<dl>
|
|
|
+<dt><span class="paramLabel">Parameters:</span></dt>
|
|
|
+<dd><code>newPopBeforeSmtp</code> - Whether or not to log into pop3 server before sending mail.</dd>
|
|
|
+<dd><code>newPopHost</code> - The pop3 host to use.</dd>
|
|
|
+<dd><code>newPopUsername</code> - The pop3 username.</dd>
|
|
|
+<dd><code>newPopPassword</code> - The pop3 password.</dd>
|
|
|
+<dt><span class="simpleTagLabel">Since:</span></dt>
|
|
|
+<dd>1.0</dd>
|
|
|
+</dl>
|
|
|
+</li>
|
|
|
+</ul>
|
|
|
+<a name="isSSL--">
|
|
|
+<!-- -->
|
|
|
+</a>
|
|
|
+<ul class="blockList">
|
|
|
+<li class="blockList">
|
|
|
+<h4>isSSL</h4>
|
|
|
+<pre><a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Deprecated.html?is-external=true" title="class or interface in java.lang">@Deprecated</a>
|
|
|
+public boolean isSSL()</pre>
|
|
|
+<div class="block"><span class="deprecatedLabel">Deprecated.</span> <span class="deprecationComment">since 1.3, use isSSLOnConnect() instead</span></div>
|
|
|
+<div class="block">Returns whether SSL/TLS encryption for the transport is currently enabled (SMTPS/POPS).
|
|
|
+ See EMAIL-105 for reason of deprecation.</div>
|
|
|
+<dl>
|
|
|
+<dt><span class="returnLabel">Returns:</span></dt>
|
|
|
+<dd>true if SSL enabled for the transport</dd>
|
|
|
+</dl>
|
|
|
+</li>
|
|
|
+</ul>
|
|
|
+<a name="isSSLOnConnect--">
|
|
|
+<!-- -->
|
|
|
+</a>
|
|
|
+<ul class="blockList">
|
|
|
+<li class="blockList">
|
|
|
+<h4>isSSLOnConnect</h4>
|
|
|
+<pre>public boolean isSSLOnConnect()</pre>
|
|
|
+<div class="block">Returns whether SSL/TLS encryption for the transport is currently enabled (SMTPS/POPS).</div>
|
|
|
+<dl>
|
|
|
+<dt><span class="returnLabel">Returns:</span></dt>
|
|
|
+<dd>true if SSL enabled for the transport</dd>
|
|
|
+<dt><span class="simpleTagLabel">Since:</span></dt>
|
|
|
+<dd>1.3</dd>
|
|
|
+</dl>
|
|
|
+</li>
|
|
|
+</ul>
|
|
|
+<a name="setSSL-boolean-">
|
|
|
+<!-- -->
|
|
|
+</a>
|
|
|
+<ul class="blockList">
|
|
|
+<li class="blockList">
|
|
|
+<h4>setSSL</h4>
|
|
|
+<pre><a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Deprecated.html?is-external=true" title="class or interface in java.lang">@Deprecated</a>
|
|
|
+public void setSSL(boolean ssl)</pre>
|
|
|
+<div class="block"><span class="deprecatedLabel">Deprecated.</span> <span class="deprecationComment">since 1.3, use setSSLOnConnect() instead</span></div>
|
|
|
+<div class="block">Sets whether SSL/TLS encryption should be enabled for the SMTP transport upon connection (SMTPS/POPS).
|
|
|
+ See EMAIL-105 for reason of deprecation.</div>
|
|
|
+<dl>
|
|
|
+<dt><span class="paramLabel">Parameters:</span></dt>
|
|
|
+<dd><code>ssl</code> - whether to enable the SSL transport</dd>
|
|
|
+</dl>
|
|
|
+</li>
|
|
|
+</ul>
|
|
|
+<a name="setSSLOnConnect-boolean-">
|
|
|
+<!-- -->
|
|
|
+</a>
|
|
|
+<ul class="blockList">
|
|
|
+<li class="blockList">
|
|
|
+<h4>setSSLOnConnect</h4>
|
|
|
+<pre>public <a href="../../../../org/apache/commons/mail/Email.html" title="class in org.apache.commons.mail">Email</a> setSSLOnConnect(boolean ssl)</pre>
|
|
|
+<div class="block">Sets whether SSL/TLS encryption should be enabled for the SMTP transport upon connection (SMTPS/POPS).
|
|
|
+ Takes precedence over <a href="../../../../org/apache/commons/mail/Email.html#setStartTLSRequired-boolean-"><code>setStartTLSRequired(boolean)</code></a>
|
|
|
+ <p>
|
|
|
+ Defaults to <a href="../../../../org/apache/commons/mail/Email.html#sslSmtpPort"><code>sslSmtpPort</code></a>; can be overridden by using <a href="../../../../org/apache/commons/mail/Email.html#setSslSmtpPort-java.lang.String-"><code>setSslSmtpPort(String)</code></a></div>
|
|
|
+<dl>
|
|
|
+<dt><span class="paramLabel">Parameters:</span></dt>
|
|
|
+<dd><code>ssl</code> - whether to enable the SSL transport</dd>
|
|
|
+<dt><span class="returnLabel">Returns:</span></dt>
|
|
|
+<dd>An Email.</dd>
|
|
|
+<dt><span class="throwsLabel">Throws:</span></dt>
|
|
|
+<dd><code><a href="http://docs.oracle.com/javase/7/docs/api/java/lang/IllegalStateException.html?is-external=true" title="class or interface in java.lang">IllegalStateException</a></code> - if the mail session is already initialized</dd>
|
|
|
+<dt><span class="simpleTagLabel">Since:</span></dt>
|
|
|
+<dd>1.3</dd>
|
|
|
+</dl>
|
|
|
+</li>
|
|
|
+</ul>
|
|
|
+<a name="isSSLCheckServerIdentity--">
|
|
|
+<!-- -->
|
|
|
+</a>
|
|
|
+<ul class="blockList">
|
|
|
+<li class="blockList">
|
|
|
+<h4>isSSLCheckServerIdentity</h4>
|
|
|
+<pre>public boolean isSSLCheckServerIdentity()</pre>
|
|
|
+<div class="block">Is the server identity checked as specified by RFC 2595</div>
|
|
|
+<dl>
|
|
|
+<dt><span class="returnLabel">Returns:</span></dt>
|
|
|
+<dd>true if the server identity is checked</dd>
|
|
|
+<dt><span class="simpleTagLabel">Since:</span></dt>
|
|
|
+<dd>1.3</dd>
|
|
|
+</dl>
|
|
|
+</li>
|
|
|
+</ul>
|
|
|
+<a name="setSSLCheckServerIdentity-boolean-">
|
|
|
+<!-- -->
|
|
|
+</a>
|
|
|
+<ul class="blockList">
|
|
|
+<li class="blockList">
|
|
|
+<h4>setSSLCheckServerIdentity</h4>
|
|
|
+<pre>public <a href="../../../../org/apache/commons/mail/Email.html" title="class in org.apache.commons.mail">Email</a> setSSLCheckServerIdentity(boolean sslCheckServerIdentity)</pre>
|
|
|
+<div class="block">Sets whether the server identity is checked as specified by RFC 2595</div>
|
|
|
+<dl>
|
|
|
+<dt><span class="paramLabel">Parameters:</span></dt>
|
|
|
+<dd><code>sslCheckServerIdentity</code> - whether to enable server identity check</dd>
|
|
|
+<dt><span class="returnLabel">Returns:</span></dt>
|
|
|
+<dd>An Email.</dd>
|
|
|
+<dt><span class="throwsLabel">Throws:</span></dt>
|
|
|
+<dd><code><a href="http://docs.oracle.com/javase/7/docs/api/java/lang/IllegalStateException.html?is-external=true" title="class or interface in java.lang">IllegalStateException</a></code> - if the mail session is already initialized</dd>
|
|
|
+<dt><span class="simpleTagLabel">Since:</span></dt>
|
|
|
+<dd>1.3</dd>
|
|
|
+</dl>
|
|
|
+</li>
|
|
|
+</ul>
|
|
|
+<a name="getSslSmtpPort--">
|
|
|
+<!-- -->
|
|
|
+</a>
|
|
|
+<ul class="blockList">
|
|
|
+<li class="blockList">
|
|
|
+<h4>getSslSmtpPort</h4>
|
|
|
+<pre>public <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> getSslSmtpPort()</pre>
|
|
|
+<div class="block">Returns the current SSL port used by the SMTP transport.</div>
|
|
|
+<dl>
|
|
|
+<dt><span class="returnLabel">Returns:</span></dt>
|
|
|
+<dd>the current SSL port used by the SMTP transport</dd>
|
|
|
+</dl>
|
|
|
+</li>
|
|
|
+</ul>
|
|
|
+<a name="setSslSmtpPort-java.lang.String-">
|
|
|
+<!-- -->
|
|
|
+</a>
|
|
|
+<ul class="blockList">
|
|
|
+<li class="blockList">
|
|
|
+<h4>setSslSmtpPort</h4>
|
|
|
+<pre>public void setSslSmtpPort(<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> sslSmtpPort)</pre>
|
|
|
+<div class="block">Sets the SSL port to use for the SMTP transport. Defaults to the standard
|
|
|
+ port, 465.</div>
|
|
|
+<dl>
|
|
|
+<dt><span class="paramLabel">Parameters:</span></dt>
|
|
|
+<dd><code>sslSmtpPort</code> - the SSL port to use for the SMTP transport</dd>
|
|
|
+<dt><span class="throwsLabel">Throws:</span></dt>
|
|
|
+<dd><code><a href="http://docs.oracle.com/javase/7/docs/api/java/lang/IllegalStateException.html?is-external=true" title="class or interface in java.lang">IllegalStateException</a></code> - if the mail session is already initialized</dd>
|
|
|
+<dt><span class="seeLabel">See Also:</span></dt>
|
|
|
+<dd><a href="../../../../org/apache/commons/mail/Email.html#setSmtpPort-int-"><code>setSmtpPort(int)</code></a></dd>
|
|
|
+</dl>
|
|
|
+</li>
|
|
|
+</ul>
|
|
|
+<a name="isSendPartial--">
|
|
|
+<!-- -->
|
|
|
+</a>
|
|
|
+<ul class="blockList">
|
|
|
+<li class="blockList">
|
|
|
+<h4>isSendPartial</h4>
|
|
|
+<pre>public boolean isSendPartial()</pre>
|
|
|
+<div class="block">If partial sending of email enabled.</div>
|
|
|
+<dl>
|
|
|
+<dt><span class="returnLabel">Returns:</span></dt>
|
|
|
+<dd>true if sending partial email is enabled</dd>
|
|
|
+<dt><span class="simpleTagLabel">Since:</span></dt>
|
|
|
+<dd>1.3.2</dd>
|
|
|
+</dl>
|
|
|
+</li>
|
|
|
+</ul>
|
|
|
+<a name="setSendPartial-boolean-">
|
|
|
+<!-- -->
|
|
|
+</a>
|
|
|
+<ul class="blockList">
|
|
|
+<li class="blockList">
|
|
|
+<h4>setSendPartial</h4>
|
|
|
+<pre>public <a href="../../../../org/apache/commons/mail/Email.html" title="class in org.apache.commons.mail">Email</a> setSendPartial(boolean sendPartial)</pre>
|
|
|
+<div class="block">Sets whether the email is partially send in case of invalid addresses.
|
|
|
+ <p>
|
|
|
+ In case the mail server rejects an address as invalid, the call to <a href="../../../../org/apache/commons/mail/Email.html#send--"><code>send()</code></a>
|
|
|
+ may throw a <a href="http://docs.oracle.com/javaee/6/api/javax/mail/SendFailedException.html?is-external=true" title="class or interface in javax.mail"><code>SendFailedException</code></a>, even if partial send mode is enabled (emails
|
|
|
+ to valid addresses will be transmitted). In case the email server does not reject
|
|
|
+ invalid addresses immediately, but return a bounce message, no exception will be thrown
|
|
|
+ by the <a href="../../../../org/apache/commons/mail/Email.html#send--"><code>send()</code></a> method.</div>
|
|
|
+<dl>
|
|
|
+<dt><span class="paramLabel">Parameters:</span></dt>
|
|
|
+<dd><code>sendPartial</code> - whether to enable partial send mode</dd>
|
|
|
+<dt><span class="returnLabel">Returns:</span></dt>
|
|
|
+<dd>An Email.</dd>
|
|
|
+<dt><span class="throwsLabel">Throws:</span></dt>
|
|
|
+<dd><code><a href="http://docs.oracle.com/javase/7/docs/api/java/lang/IllegalStateException.html?is-external=true" title="class or interface in java.lang">IllegalStateException</a></code> - if the mail session is already initialized</dd>
|
|
|
+<dt><span class="simpleTagLabel">Since:</span></dt>
|
|
|
+<dd>1.3.2</dd>
|
|
|
+</dl>
|
|
|
+</li>
|
|
|
+</ul>
|
|
|
+<a name="getToAddresses--">
|
|
|
+<!-- -->
|
|
|
+</a>
|
|
|
+<ul class="blockList">
|
|
|
+<li class="blockList">
|
|
|
+<h4>getToAddresses</h4>
|
|
|
+<pre>public <a href="http://docs.oracle.com/javase/7/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</a><<a href="http://docs.oracle.com/javaee/6/api/javax/mail/internet/InternetAddress.html?is-external=true" title="class or interface in javax.mail.internet">InternetAddress</a>> getToAddresses()</pre>
|
|
|
+<div class="block">Get the list of "To" addresses.</div>
|
|
|
+<dl>
|
|
|
+<dt><span class="returnLabel">Returns:</span></dt>
|
|
|
+<dd>List addresses</dd>
|
|
|
+</dl>
|
|
|
+</li>
|
|
|
+</ul>
|
|
|
+<a name="getCcAddresses--">
|
|
|
+<!-- -->
|
|
|
+</a>
|
|
|
+<ul class="blockList">
|
|
|
+<li class="blockList">
|
|
|
+<h4>getCcAddresses</h4>
|
|
|
+<pre>public <a href="http://docs.oracle.com/javase/7/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</a><<a href="http://docs.oracle.com/javaee/6/api/javax/mail/internet/InternetAddress.html?is-external=true" title="class or interface in javax.mail.internet">InternetAddress</a>> getCcAddresses()</pre>
|
|
|
+<div class="block">Get the list of "CC" addresses.</div>
|
|
|
+<dl>
|
|
|
+<dt><span class="returnLabel">Returns:</span></dt>
|
|
|
+<dd>List addresses</dd>
|
|
|
+</dl>
|
|
|
+</li>
|
|
|
+</ul>
|
|
|
+<a name="getBccAddresses--">
|
|
|
+<!-- -->
|
|
|
+</a>
|
|
|
+<ul class="blockList">
|
|
|
+<li class="blockList">
|
|
|
+<h4>getBccAddresses</h4>
|
|
|
+<pre>public <a href="http://docs.oracle.com/javase/7/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</a><<a href="http://docs.oracle.com/javaee/6/api/javax/mail/internet/InternetAddress.html?is-external=true" title="class or interface in javax.mail.internet">InternetAddress</a>> getBccAddresses()</pre>
|
|
|
+<div class="block">Get the list of "Bcc" addresses.</div>
|
|
|
+<dl>
|
|
|
+<dt><span class="returnLabel">Returns:</span></dt>
|
|
|
+<dd>List addresses</dd>
|
|
|
+</dl>
|
|
|
+</li>
|
|
|
+</ul>
|
|
|
+<a name="getReplyToAddresses--">
|
|
|
+<!-- -->
|
|
|
+</a>
|
|
|
+<ul class="blockList">
|
|
|
+<li class="blockList">
|
|
|
+<h4>getReplyToAddresses</h4>
|
|
|
+<pre>public <a href="http://docs.oracle.com/javase/7/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</a><<a href="http://docs.oracle.com/javaee/6/api/javax/mail/internet/InternetAddress.html?is-external=true" title="class or interface in javax.mail.internet">InternetAddress</a>> getReplyToAddresses()</pre>
|
|
|
+<div class="block">Get the list of "Reply-To" addresses.</div>
|
|
|
+<dl>
|
|
|
+<dt><span class="returnLabel">Returns:</span></dt>
|
|
|
+<dd>List addresses</dd>
|
|
|
+</dl>
|
|
|
+</li>
|
|
|
+</ul>
|
|
|
+<a name="getSocketConnectionTimeout--">
|
|
|
+<!-- -->
|
|
|
+</a>
|
|
|
+<ul class="blockList">
|
|
|
+<li class="blockList">
|
|
|
+<h4>getSocketConnectionTimeout</h4>
|
|
|
+<pre>public int getSocketConnectionTimeout()</pre>
|
|
|
+<div class="block">Get the socket connection timeout value in milliseconds.</div>
|
|
|
+<dl>
|
|
|
+<dt><span class="returnLabel">Returns:</span></dt>
|
|
|
+<dd>the timeout in milliseconds.</dd>
|
|
|
+<dt><span class="simpleTagLabel">Since:</span></dt>
|
|
|
+<dd>1.2</dd>
|
|
|
+</dl>
|
|
|
+</li>
|
|
|
+</ul>
|
|
|
+<a name="setSocketConnectionTimeout-int-">
|
|
|
+<!-- -->
|
|
|
+</a>
|
|
|
+<ul class="blockList">
|
|
|
+<li class="blockList">
|
|
|
+<h4>setSocketConnectionTimeout</h4>
|
|
|
+<pre>public void setSocketConnectionTimeout(int socketConnectionTimeout)</pre>
|
|
|
+<div class="block">Set the socket connection timeout value in milliseconds.
|
|
|
+ Default is a 60 second timeout.</div>
|
|
|
+<dl>
|
|
|
+<dt><span class="paramLabel">Parameters:</span></dt>
|
|
|
+<dd><code>socketConnectionTimeout</code> - the connection timeout</dd>
|
|
|
+<dt><span class="throwsLabel">Throws:</span></dt>
|
|
|
+<dd><code><a href="http://docs.oracle.com/javase/7/docs/api/java/lang/IllegalStateException.html?is-external=true" title="class or interface in java.lang">IllegalStateException</a></code> - if the mail session is already initialized</dd>
|
|
|
+<dt><span class="simpleTagLabel">Since:</span></dt>
|
|
|
+<dd>1.2</dd>
|
|
|
+</dl>
|
|
|
+</li>
|
|
|
+</ul>
|
|
|
+<a name="getSocketTimeout--">
|
|
|
+<!-- -->
|
|
|
+</a>
|
|
|
+<ul class="blockList">
|
|
|
+<li class="blockList">
|
|
|
+<h4>getSocketTimeout</h4>
|
|
|
+<pre>public int getSocketTimeout()</pre>
|
|
|
+<div class="block">Get the socket I/O timeout value in milliseconds.</div>
|
|
|
+<dl>
|
|
|
+<dt><span class="returnLabel">Returns:</span></dt>
|
|
|
+<dd>the socket I/O timeout</dd>
|
|
|
+<dt><span class="simpleTagLabel">Since:</span></dt>
|
|
|
+<dd>1.2</dd>
|
|
|
+</dl>
|
|
|
+</li>
|
|
|
+</ul>
|
|
|
+<a name="setSocketTimeout-int-">
|
|
|
+<!-- -->
|
|
|
+</a>
|
|
|
+<ul class="blockList">
|
|
|
+<li class="blockList">
|
|
|
+<h4>setSocketTimeout</h4>
|
|
|
+<pre>public void setSocketTimeout(int socketTimeout)</pre>
|
|
|
+<div class="block">Set the socket I/O timeout value in milliseconds.
|
|
|
+ Default is 60 second timeout.</div>
|
|
|
+<dl>
|
|
|
+<dt><span class="paramLabel">Parameters:</span></dt>
|
|
|
+<dd><code>socketTimeout</code> - the socket I/O timeout</dd>
|
|
|
+<dt><span class="throwsLabel">Throws:</span></dt>
|
|
|
+<dd><code><a href="http://docs.oracle.com/javase/7/docs/api/java/lang/IllegalStateException.html?is-external=true" title="class or interface in java.lang">IllegalStateException</a></code> - if the mail session is already initialized</dd>
|
|
|
+<dt><span class="simpleTagLabel">Since:</span></dt>
|
|
|
+<dd>1.2</dd>
|
|
|
+</dl>
|
|
|
+</li>
|
|
|
+</ul>
|
|
|
+<a name="createMimeMessage-javax.mail.Session-">
|
|
|
+<!-- -->
|
|
|
+</a>
|
|
|
+<ul class="blockListLast">
|
|
|
+<li class="blockList">
|
|
|
+<h4>createMimeMessage</h4>
|
|
|
+<pre>protected <a href="http://docs.oracle.com/javaee/6/api/javax/mail/internet/MimeMessage.html?is-external=true" title="class or interface in javax.mail.internet">MimeMessage</a> createMimeMessage(<a href="http://docs.oracle.com/javaee/6/api/javax/mail/Session.html?is-external=true" title="class or interface in javax.mail">Session</a> aSession)</pre>
|
|
|
+<div class="block">Factory method to create a customized MimeMessage which can be
|
|
|
+ implemented by a derived class, e.g. to set the message id.</div>
|
|
|
+<dl>
|
|
|
+<dt><span class="paramLabel">Parameters:</span></dt>
|
|
|
+<dd><code>aSession</code> - mail session to be used</dd>
|
|
|
+<dt><span class="returnLabel">Returns:</span></dt>
|
|
|
+<dd>the newly created message</dd>
|
|
|
+</dl>
|
|
|
+</li>
|
|
|
+</ul>
|
|
|
+</li>
|
|
|
+</ul>
|
|
|
+</li>
|
|
|
+</ul>
|
|
|
+</div>
|
|
|
+</div>
|
|
|
+<!-- ========= END OF CLASS DATA ========= -->
|
|
|
+<!-- ======= START OF BOTTOM NAVBAR ====== -->
|
|
|
+<div class="bottomNav"><a name="navbar.bottom">
|
|
|
+<!-- -->
|
|
|
+</a>
|
|
|
+<div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div>
|
|
|
+<a name="navbar.bottom.firstrow">
|
|
|
+<!-- -->
|
|
|
+</a>
|
|
|
+<ul class="navList" title="Navigation">
|
|
|
+<li><a href="../../../../overview-summary.html">Overview</a></li>
|
|
|
+<li><a href="package-summary.html">Package</a></li>
|
|
|
+<li class="navBarCell1Rev">Class</li>
|
|
|
+<li><a href="class-use/Email.html">Use</a></li>
|
|
|
+<li><a href="package-tree.html">Tree</a></li>
|
|
|
+<li><a href="../../../../deprecated-list.html">Deprecated</a></li>
|
|
|
+<li><a href="../../../../index-all.html">Index</a></li>
|
|
|
+<li><a href="../../../../help-doc.html">Help</a></li>
|
|
|
+</ul>
|
|
|
+</div>
|
|
|
+<div class="subNav">
|
|
|
+<ul class="navList">
|
|
|
+<li><a href="../../../../org/apache/commons/mail/DefaultAuthenticator.html" title="class in org.apache.commons.mail"><span class="typeNameLink">Prev Class</span></a></li>
|
|
|
+<li><a href="../../../../org/apache/commons/mail/EmailAttachment.html" title="class in org.apache.commons.mail"><span class="typeNameLink">Next Class</span></a></li>
|
|
|
+</ul>
|
|
|
+<ul class="navList">
|
|
|
+<li><a href="../../../../index.html?org/apache/commons/mail/Email.html" target="_top">Frames</a></li>
|
|
|
+<li><a href="Email.html" target="_top">No Frames</a></li>
|
|
|
+</ul>
|
|
|
+<ul class="navList" id="allclasses_navbar_bottom">
|
|
|
+<li><a href="../../../../allclasses-noframe.html">All Classes</a></li>
|
|
|
+</ul>
|
|
|
+<div>
|
|
|
+<script type="text/javascript"><!--
|
|
|
+ allClassesLink = document.getElementById("allclasses_navbar_bottom");
|
|
|
+ if(window==top) {
|
|
|
+ allClassesLink.style.display = "block";
|
|
|
+ }
|
|
|
+ else {
|
|
|
+ allClassesLink.style.display = "none";
|
|
|
+ }
|
|
|
+ //-->
|
|
|
+</script>
|
|
|
+</div>
|
|
|
+<div>
|
|
|
+<ul class="subNavList">
|
|
|
+<li>Summary: </li>
|
|
|
+<li>Nested | </li>
|
|
|
+<li><a href="#field.summary">Field</a> | </li>
|
|
|
+<li><a href="#constructor.summary">Constr</a> | </li>
|
|
|
+<li><a href="#method.summary">Method</a></li>
|
|
|
+</ul>
|
|
|
+<ul class="subNavList">
|
|
|
+<li>Detail: </li>
|
|
|
+<li><a href="#field.detail">Field</a> | </li>
|
|
|
+<li><a href="#constructor.detail">Constr</a> | </li>
|
|
|
+<li><a href="#method.detail">Method</a></li>
|
|
|
+</ul>
|
|
|
+</div>
|
|
|
+<a name="skip.navbar.bottom">
|
|
|
+<!-- -->
|
|
|
+</a></div>
|
|
|
+<!-- ======== END OF BOTTOM NAVBAR ======= -->
|
|
|
+<p class="legalCopy"><small>Copyright © 2001–2017 <a href="http://www.apache.org/">The Apache Software Foundation</a>. All rights reserved.</small></p>
|
|
|
+</body>
|
|
|
+</html>
|