Email.html 208 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889890891892893894895896897898899900901902903904905906907908909910911912913914915916917918919920921922923924925926927928929930931932933934935936937938939940941942943944945946947948949950951952953954955956957958959960961962963964965966967968969970971972973974975976977978979980981982983984985986987988989990991992993994995996997998999100010011002100310041005100610071008100910101011101210131014101510161017101810191020102110221023102410251026102710281029103010311032103310341035103610371038103910401041104210431044104510461047104810491050105110521053105410551056105710581059106010611062106310641065106610671068106910701071107210731074107510761077107810791080108110821083108410851086108710881089109010911092109310941095109610971098109911001101110211031104110511061107110811091110111111121113111411151116111711181119112011211122112311241125112611271128112911301131113211331134113511361137113811391140114111421143114411451146114711481149115011511152115311541155115611571158115911601161116211631164116511661167116811691170117111721173117411751176117711781179118011811182118311841185118611871188118911901191119211931194119511961197119811991200120112021203120412051206120712081209121012111212121312141215121612171218121912201221122212231224122512261227122812291230123112321233123412351236123712381239124012411242124312441245124612471248124912501251125212531254125512561257125812591260126112621263126412651266126712681269127012711272127312741275127612771278127912801281128212831284128512861287128812891290129112921293129412951296129712981299130013011302130313041305130613071308130913101311131213131314131513161317131813191320132113221323132413251326132713281329133013311332133313341335133613371338133913401341134213431344134513461347134813491350135113521353135413551356135713581359136013611362136313641365136613671368136913701371137213731374137513761377137813791380138113821383138413851386138713881389139013911392139313941395139613971398139914001401140214031404140514061407140814091410141114121413141414151416141714181419142014211422142314241425142614271428142914301431143214331434143514361437143814391440144114421443144414451446144714481449145014511452145314541455145614571458145914601461146214631464146514661467146814691470147114721473147414751476147714781479148014811482148314841485148614871488148914901491149214931494149514961497149814991500150115021503150415051506150715081509151015111512151315141515151615171518151915201521152215231524152515261527152815291530153115321533153415351536153715381539154015411542154315441545154615471548154915501551155215531554155515561557155815591560156115621563156415651566156715681569157015711572157315741575157615771578157915801581158215831584158515861587158815891590159115921593159415951596159715981599160016011602160316041605160616071608160916101611161216131614161516161617161816191620162116221623162416251626162716281629163016311632163316341635163616371638163916401641164216431644164516461647164816491650165116521653165416551656165716581659166016611662166316641665166616671668166916701671167216731674167516761677167816791680168116821683168416851686168716881689169016911692169316941695169616971698169917001701170217031704170517061707170817091710171117121713171417151716171717181719172017211722172317241725172617271728172917301731173217331734173517361737173817391740174117421743174417451746174717481749175017511752175317541755175617571758175917601761176217631764176517661767176817691770177117721773177417751776177717781779178017811782178317841785178617871788178917901791179217931794179517961797179817991800180118021803180418051806180718081809181018111812181318141815181618171818181918201821182218231824182518261827182818291830183118321833183418351836183718381839184018411842184318441845184618471848184918501851185218531854185518561857185818591860186118621863186418651866186718681869187018711872187318741875187618771878187918801881188218831884188518861887188818891890189118921893189418951896189718981899190019011902190319041905190619071908190919101911191219131914191519161917191819191920192119221923192419251926192719281929193019311932193319341935193619371938193919401941194219431944194519461947194819491950195119521953195419551956195719581959196019611962196319641965196619671968196919701971197219731974197519761977197819791980198119821983198419851986198719881989199019911992199319941995199619971998199920002001200220032004200520062007200820092010201120122013201420152016201720182019202020212022202320242025202620272028202920302031203220332034203520362037203820392040204120422043204420452046204720482049205020512052205320542055205620572058205920602061206220632064206520662067206820692070207120722073207420752076207720782079208020812082208320842085208620872088208920902091209220932094209520962097209820992100210121022103210421052106210721082109211021112112211321142115211621172118211921202121212221232124212521262127212821292130213121322133213421352136213721382139214021412142214321442145214621472148214921502151215221532154215521562157215821592160216121622163216421652166216721682169217021712172217321742175217621772178217921802181218221832184218521862187218821892190219121922193219421952196219721982199220022012202220322042205220622072208220922102211221222132214221522162217221822192220222122222223222422252226222722282229223022312232223322342235223622372238223922402241224222432244224522462247224822492250225122522253225422552256225722582259226022612262226322642265226622672268226922702271227222732274227522762277227822792280228122822283228422852286228722882289229022912292229322942295229622972298229923002301230223032304230523062307230823092310231123122313231423152316231723182319232023212322232323242325232623272328232923302331233223332334233523362337233823392340234123422343234423452346234723482349235023512352235323542355235623572358235923602361236223632364236523662367236823692370237123722373237423752376237723782379238023812382238323842385238623872388238923902391239223932394239523962397239823992400240124022403240424052406240724082409241024112412241324142415241624172418241924202421242224232424242524262427242824292430243124322433243424352436243724382439244024412442244324442445244624472448244924502451245224532454245524562457245824592460246124622463246424652466246724682469247024712472247324742475247624772478247924802481248224832484248524862487248824892490249124922493249424952496249724982499250025012502250325042505250625072508250925102511251225132514251525162517251825192520252125222523252425252526252725282529253025312532253325342535253625372538253925402541254225432544254525462547254825492550255125522553255425552556255725582559256025612562256325642565256625672568256925702571257225732574257525762577257825792580258125822583258425852586258725882589259025912592259325942595259625972598259926002601260226032604260526062607260826092610261126122613261426152616261726182619262026212622262326242625262626272628262926302631263226332634263526362637263826392640264126422643264426452646264726482649265026512652265326542655265626572658265926602661266226632664266526662667266826692670267126722673267426752676267726782679268026812682268326842685268626872688268926902691269226932694269526962697269826992700270127022703270427052706270727082709271027112712271327142715271627172718271927202721272227232724272527262727272827292730273127322733273427352736273727382739274027412742274327442745274627472748274927502751275227532754275527562757275827592760276127622763276427652766276727682769277027712772277327742775277627772778277927802781278227832784278527862787278827892790279127922793279427952796279727982799280028012802280328042805280628072808280928102811281228132814281528162817281828192820282128222823282428252826282728282829283028312832283328342835283628372838283928402841284228432844284528462847284828492850285128522853285428552856285728582859286028612862286328642865286628672868286928702871287228732874287528762877287828792880288128822883288428852886288728882889289028912892289328942895289628972898289929002901290229032904290529062907290829092910291129122913291429152916291729182919292029212922292329242925292629272928292929302931293229332934293529362937293829392940294129422943294429452946294729482949295029512952295329542955295629572958295929602961296229632964296529662967296829692970297129722973297429752976297729782979298029812982298329842985298629872988298929902991299229932994299529962997299829993000300130023003300430053006300730083009301030113012301330143015301630173018301930203021302230233024302530263027302830293030303130323033303430353036303730383039304030413042304330443045304630473048304930503051305230533054305530563057305830593060306130623063306430653066306730683069307030713072307330743075307630773078307930803081308230833084308530863087308830893090309130923093309430953096309730983099310031013102310331043105310631073108310931103111311231133114311531163117311831193120312131223123312431253126312731283129313031313132313331343135313631373138313931403141314231433144314531463147314831493150315131523153315431553156315731583159316031613162316331643165316631673168316931703171317231733174317531763177317831793180318131823183318431853186318731883189319031913192319331943195319631973198319932003201320232033204320532063207320832093210321132123213321432153216321732183219322032213222322332243225322632273228322932303231323232333234323532363237323832393240324132423243324432453246324732483249325032513252325332543255325632573258325932603261326232633264326532663267326832693270327132723273327432753276327732783279328032813282328332843285328632873288328932903291329232933294329532963297329832993300330133023303330433053306330733083309331033113312331333143315331633173318331933203321332233233324332533263327332833293330333133323333333433353336333733383339334033413342334333443345334633473348334933503351335233533354335533563357335833593360336133623363336433653366336733683369337033713372337333743375337633773378337933803381338233833384338533863387338833893390339133923393339433953396339733983399340034013402340334043405340634073408340934103411341234133414341534163417341834193420342134223423342434253426342734283429343034313432343334343435343634373438343934403441344234433444344534463447344834493450345134523453345434553456345734583459346034613462346334643465346634673468346934703471347234733474347534763477347834793480348134823483348434853486348734883489349034913492349334943495349634973498349935003501350235033504350535063507350835093510351135123513351435153516351735183519352035213522352335243525352635273528352935303531353235333534353535363537353835393540354135423543354435453546354735483549355035513552355335543555
  1. <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
  2. <!-- NewPage -->
  3. <html lang="de">
  4. <head>
  5. <!-- Generated by javadoc -->
  6. <meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
  7. <title>Email (Apache Commons Email 1.5 API)</title>
  8. <link rel="stylesheet" type="text/css" href="../../../../stylesheet.css" title="Style">
  9. <script type="text/javascript" src="../../../../script.js"></script>
  10. </head>
  11. <body>
  12. <script type="text/javascript"><!--
  13. try {
  14. if (location.href.indexOf('is-external=true') == -1) {
  15. parent.document.title="Email (Apache Commons Email 1.5 API)";
  16. }
  17. }
  18. catch(err) {
  19. }
  20. //-->
  21. 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};
  22. var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],4:["t3","Abstract Methods"],8:["t4","Concrete Methods"],32:["t6","Deprecated Methods"]};
  23. var altColor = "altColor";
  24. var rowColor = "rowColor";
  25. var tableTab = "tableTab";
  26. var activeTableTab = "activeTableTab";
  27. </script>
  28. <noscript>
  29. <div>JavaScript is disabled on your browser.</div>
  30. </noscript>
  31. <!-- ========= START OF TOP NAVBAR ======= -->
  32. <div class="topNav"><a name="navbar.top">
  33. <!-- -->
  34. </a>
  35. <div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div>
  36. <a name="navbar.top.firstrow">
  37. <!-- -->
  38. </a>
  39. <ul class="navList" title="Navigation">
  40. <li><a href="../../../../overview-summary.html">Overview</a></li>
  41. <li><a href="package-summary.html">Package</a></li>
  42. <li class="navBarCell1Rev">Class</li>
  43. <li><a href="class-use/Email.html">Use</a></li>
  44. <li><a href="package-tree.html">Tree</a></li>
  45. <li><a href="../../../../deprecated-list.html">Deprecated</a></li>
  46. <li><a href="../../../../index-all.html">Index</a></li>
  47. <li><a href="../../../../help-doc.html">Help</a></li>
  48. </ul>
  49. </div>
  50. <div class="subNav">
  51. <ul class="navList">
  52. <li><a href="../../../../org/apache/commons/mail/DefaultAuthenticator.html" title="class in org.apache.commons.mail"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
  53. <li><a href="../../../../org/apache/commons/mail/EmailAttachment.html" title="class in org.apache.commons.mail"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
  54. </ul>
  55. <ul class="navList">
  56. <li><a href="../../../../index.html?org/apache/commons/mail/Email.html" target="_top">Frames</a></li>
  57. <li><a href="Email.html" target="_top">No&nbsp;Frames</a></li>
  58. </ul>
  59. <ul class="navList" id="allclasses_navbar_top">
  60. <li><a href="../../../../allclasses-noframe.html">All&nbsp;Classes</a></li>
  61. </ul>
  62. <div>
  63. <script type="text/javascript"><!--
  64. allClassesLink = document.getElementById("allclasses_navbar_top");
  65. if(window==top) {
  66. allClassesLink.style.display = "block";
  67. }
  68. else {
  69. allClassesLink.style.display = "none";
  70. }
  71. //-->
  72. </script>
  73. </div>
  74. <div>
  75. <ul class="subNavList">
  76. <li>Summary:&nbsp;</li>
  77. <li>Nested&nbsp;|&nbsp;</li>
  78. <li><a href="#field.summary">Field</a>&nbsp;|&nbsp;</li>
  79. <li><a href="#constructor.summary">Constr</a>&nbsp;|&nbsp;</li>
  80. <li><a href="#method.summary">Method</a></li>
  81. </ul>
  82. <ul class="subNavList">
  83. <li>Detail:&nbsp;</li>
  84. <li><a href="#field.detail">Field</a>&nbsp;|&nbsp;</li>
  85. <li><a href="#constructor.detail">Constr</a>&nbsp;|&nbsp;</li>
  86. <li><a href="#method.detail">Method</a></li>
  87. </ul>
  88. </div>
  89. <a name="skip.navbar.top">
  90. <!-- -->
  91. </a></div>
  92. <!-- ========= END OF TOP NAVBAR ========= -->
  93. <!-- ======== START OF CLASS DATA ======== -->
  94. <div class="header">
  95. <div class="subTitle">org.apache.commons.mail</div>
  96. <h2 title="Class Email" class="title">Class Email</h2>
  97. </div>
  98. <div class="contentContainer">
  99. <ul class="inheritance">
  100. <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>
  101. <li>
  102. <ul class="inheritance">
  103. <li>org.apache.commons.mail.Email</li>
  104. </ul>
  105. </li>
  106. </ul>
  107. <div class="description">
  108. <ul class="blockList">
  109. <li class="blockList">
  110. <dl>
  111. <dt>Direct Known Subclasses:</dt>
  112. <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>
  113. </dl>
  114. <hr>
  115. <br>
  116. <pre>public abstract class <span class="typeNameLabel">Email</span>
  117. 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>
  118. <div class="block">The base class for all email messages. This class sets the
  119. sender's email &amp; name, receiver's email &amp; name, subject, and the
  120. sent date.
  121. <p>
  122. Subclasses are responsible for setting the message body.</div>
  123. <dl>
  124. <dt><span class="simpleTagLabel">Since:</span></dt>
  125. <dd>1.0</dd>
  126. </dl>
  127. </li>
  128. </ul>
  129. </div>
  130. <div class="summary">
  131. <ul class="blockList">
  132. <li class="blockList">
  133. <!-- =========== FIELD SUMMARY =========== -->
  134. <ul class="blockList">
  135. <li class="blockList"><a name="field.summary">
  136. <!-- -->
  137. </a>
  138. <h3>Field Summary</h3>
  139. <table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Field Summary table, listing fields, and an explanation">
  140. <caption><span>Fields</span><span class="tabEnd">&nbsp;</span></caption>
  141. <tr>
  142. <th class="colFirst" scope="col">Modifier and Type</th>
  143. <th class="colLast" scope="col">Field and Description</th>
  144. </tr>
  145. <tr class="altColor">
  146. <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>
  147. <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/commons/mail/Email.html#ATTACHMENTS">ATTACHMENTS</a></span></code>
  148. <div class="block"><span class="deprecatedLabel">Deprecated.</span>&nbsp;
  149. <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>
  150. </div>
  151. </td>
  152. </tr>
  153. <tr class="rowColor">
  154. <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>
  155. <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/commons/mail/Email.html#authenticator">authenticator</a></span></code>
  156. <div class="block">Instance of an <code>Authenticator</code> object that will be used
  157. when authentication is requested from the mail server.</div>
  158. </td>
  159. </tr>
  160. <tr class="altColor">
  161. <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>&lt;<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>&gt;</code></td>
  162. <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/commons/mail/Email.html#bccList">bccList</a></span></code>
  163. <div class="block">List of "bcc" email addresses.</div>
  164. </td>
  165. </tr>
  166. <tr class="rowColor">
  167. <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>
  168. <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/commons/mail/Email.html#bounceAddress">bounceAddress</a></span></code>
  169. <div class="block">Address to which undeliverable mail should be sent.</div>
  170. </td>
  171. </tr>
  172. <tr class="altColor">
  173. <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>&lt;<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>&gt;</code></td>
  174. <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/commons/mail/Email.html#ccList">ccList</a></span></code>
  175. <div class="block">List of "cc" email addresses.</div>
  176. </td>
  177. </tr>
  178. <tr class="rowColor">
  179. <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>
  180. <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/commons/mail/Email.html#charset">charset</a></span></code>
  181. <div class="block">The charset to use for this message.</div>
  182. </td>
  183. </tr>
  184. <tr class="altColor">
  185. <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>
  186. <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/commons/mail/Email.html#content">content</a></span></code>
  187. <div class="block">The content.</div>
  188. </td>
  189. </tr>
  190. <tr class="rowColor">
  191. <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>
  192. <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/commons/mail/Email.html#CONTENT_TYPE">CONTENT_TYPE</a></span></code>
  193. <div class="block"><span class="deprecatedLabel">Deprecated.</span>&nbsp;
  194. <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>
  195. </div>
  196. </td>
  197. </tr>
  198. <tr class="altColor">
  199. <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>
  200. <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/commons/mail/Email.html#contentType">contentType</a></span></code>
  201. <div class="block">The content type.</div>
  202. </td>
  203. </tr>
  204. <tr class="rowColor">
  205. <td class="colFirst"><code>protected boolean</code></td>
  206. <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/commons/mail/Email.html#debug">debug</a></span></code>
  207. <div class="block">Set session debugging on or off.</div>
  208. </td>
  209. </tr>
  210. <tr class="altColor">
  211. <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>
  212. <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/commons/mail/Email.html#EMAIL_BODY">EMAIL_BODY</a></span></code>
  213. <div class="block"><span class="deprecatedLabel">Deprecated.</span>&nbsp;
  214. <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>
  215. </div>
  216. </td>
  217. </tr>
  218. <tr class="rowColor">
  219. <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>
  220. <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/commons/mail/Email.html#EMAIL_SUBJECT">EMAIL_SUBJECT</a></span></code>
  221. <div class="block"><span class="deprecatedLabel">Deprecated.</span>&nbsp;
  222. <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>
  223. </div>
  224. </td>
  225. </tr>
  226. <tr class="altColor">
  227. <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>
  228. <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/commons/mail/Email.html#emailBody">emailBody</a></span></code>
  229. <div class="block">An attachment.</div>
  230. </td>
  231. </tr>
  232. <tr class="rowColor">
  233. <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>
  234. <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/commons/mail/Email.html#FILE_SERVER">FILE_SERVER</a></span></code>
  235. <div class="block"><span class="deprecatedLabel">Deprecated.</span>&nbsp;
  236. <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>
  237. </div>
  238. </td>
  239. </tr>
  240. <tr class="altColor">
  241. <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>
  242. <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/commons/mail/Email.html#fromAddress">fromAddress</a></span></code>
  243. <div class="block">The Address of the sending party, mandatory.</div>
  244. </td>
  245. </tr>
  246. <tr class="rowColor">
  247. <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>&lt;<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>&gt;</code></td>
  248. <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/commons/mail/Email.html#headers">headers</a></span></code>
  249. <div class="block">Used to specify the mail headers.</div>
  250. </td>
  251. </tr>
  252. <tr class="altColor">
  253. <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>
  254. <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/commons/mail/Email.html#hostName">hostName</a></span></code>
  255. <div class="block">The hostname of the mail server with which to connect.</div>
  256. </td>
  257. </tr>
  258. <tr class="rowColor">
  259. <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>
  260. <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/commons/mail/Email.html#ISO_8859_1">ISO_8859_1</a></span></code>
  261. <div class="block"><span class="deprecatedLabel">Deprecated.</span>&nbsp;
  262. <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>
  263. </div>
  264. </td>
  265. </tr>
  266. <tr class="altColor">
  267. <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>
  268. <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/commons/mail/Email.html#KOI8_R">KOI8_R</a></span></code>
  269. <div class="block"><span class="deprecatedLabel">Deprecated.</span>&nbsp;
  270. <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>
  271. </div>
  272. </td>
  273. </tr>
  274. <tr class="rowColor">
  275. <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>
  276. <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/commons/mail/Email.html#MAIL_DEBUG">MAIL_DEBUG</a></span></code>
  277. <div class="block"><span class="deprecatedLabel">Deprecated.</span>&nbsp;
  278. <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>
  279. </div>
  280. </td>
  281. </tr>
  282. <tr class="altColor">
  283. <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>
  284. <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/commons/mail/Email.html#MAIL_HOST">MAIL_HOST</a></span></code>
  285. <div class="block"><span class="deprecatedLabel">Deprecated.</span>&nbsp;
  286. <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>
  287. </div>
  288. </td>
  289. </tr>
  290. <tr class="rowColor">
  291. <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>
  292. <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/commons/mail/Email.html#MAIL_PORT">MAIL_PORT</a></span></code>
  293. <div class="block"><span class="deprecatedLabel">Deprecated.</span>&nbsp;
  294. <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>
  295. </div>
  296. </td>
  297. </tr>
  298. <tr class="altColor">
  299. <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>
  300. <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/commons/mail/Email.html#MAIL_SMTP_AUTH">MAIL_SMTP_AUTH</a></span></code>
  301. <div class="block"><span class="deprecatedLabel">Deprecated.</span>&nbsp;
  302. <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>
  303. </div>
  304. </td>
  305. </tr>
  306. <tr class="rowColor">
  307. <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>
  308. <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/commons/mail/Email.html#MAIL_SMTP_CONNECTIONTIMEOUT">MAIL_SMTP_CONNECTIONTIMEOUT</a></span></code>
  309. <div class="block"><span class="deprecatedLabel">Deprecated.</span>&nbsp;
  310. <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>
  311. </div>
  312. </td>
  313. </tr>
  314. <tr class="altColor">
  315. <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>
  316. <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/commons/mail/Email.html#MAIL_SMTP_FROM">MAIL_SMTP_FROM</a></span></code>
  317. <div class="block"><span class="deprecatedLabel">Deprecated.</span>&nbsp;
  318. <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>
  319. </div>
  320. </td>
  321. </tr>
  322. <tr class="rowColor">
  323. <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>
  324. <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/commons/mail/Email.html#MAIL_SMTP_PASSWORD">MAIL_SMTP_PASSWORD</a></span></code>
  325. <div class="block"><span class="deprecatedLabel">Deprecated.</span>&nbsp;
  326. <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>
  327. </div>
  328. </td>
  329. </tr>
  330. <tr class="altColor">
  331. <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>
  332. <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>
  333. <div class="block"><span class="deprecatedLabel">Deprecated.</span>&nbsp;
  334. <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>
  335. </div>
  336. </td>
  337. </tr>
  338. <tr class="rowColor">
  339. <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>
  340. <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>
  341. <div class="block"><span class="deprecatedLabel">Deprecated.</span>&nbsp;
  342. <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>
  343. </div>
  344. </td>
  345. </tr>
  346. <tr class="altColor">
  347. <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>
  348. <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>
  349. <div class="block"><span class="deprecatedLabel">Deprecated.</span>&nbsp;
  350. <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>
  351. </div>
  352. </td>
  353. </tr>
  354. <tr class="rowColor">
  355. <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>
  356. <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/commons/mail/Email.html#MAIL_SMTP_TIMEOUT">MAIL_SMTP_TIMEOUT</a></span></code>
  357. <div class="block"><span class="deprecatedLabel">Deprecated.</span>&nbsp;
  358. <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>
  359. </div>
  360. </td>
  361. </tr>
  362. <tr class="altColor">
  363. <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>
  364. <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/commons/mail/Email.html#MAIL_SMTP_USER">MAIL_SMTP_USER</a></span></code>
  365. <div class="block"><span class="deprecatedLabel">Deprecated.</span>&nbsp;
  366. <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>
  367. </div>
  368. </td>
  369. </tr>
  370. <tr class="rowColor">
  371. <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>
  372. <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/commons/mail/Email.html#MAIL_TRANSPORT_PROTOCOL">MAIL_TRANSPORT_PROTOCOL</a></span></code>
  373. <div class="block"><span class="deprecatedLabel">Deprecated.</span>&nbsp;
  374. <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>
  375. </div>
  376. </td>
  377. </tr>
  378. <tr class="altColor">
  379. <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>
  380. <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/commons/mail/Email.html#MAIL_TRANSPORT_TLS">MAIL_TRANSPORT_TLS</a></span></code>
  381. <div class="block"><span class="deprecatedLabel">Deprecated.</span>&nbsp;
  382. <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>
  383. </div>
  384. </td>
  385. </tr>
  386. <tr class="rowColor">
  387. <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>
  388. <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/commons/mail/Email.html#message">message</a></span></code>
  389. <div class="block">The email message to send.</div>
  390. </td>
  391. </tr>
  392. <tr class="altColor">
  393. <td class="colFirst"><code>protected boolean</code></td>
  394. <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/commons/mail/Email.html#popBeforeSmtp">popBeforeSmtp</a></span></code>
  395. <div class="block">Used to determine whether to use pop3 before smtp, and if so the settings.</div>
  396. </td>
  397. </tr>
  398. <tr class="rowColor">
  399. <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>
  400. <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/commons/mail/Email.html#popHost">popHost</a></span></code>
  401. <div class="block">the host name of the pop3 server.</div>
  402. </td>
  403. </tr>
  404. <tr class="altColor">
  405. <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>
  406. <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/commons/mail/Email.html#popPassword">popPassword</a></span></code>
  407. <div class="block">the password to log into the pop3 server.</div>
  408. </td>
  409. </tr>
  410. <tr class="rowColor">
  411. <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>
  412. <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/commons/mail/Email.html#popUsername">popUsername</a></span></code>
  413. <div class="block">the user name to log into the pop3 server.</div>
  414. </td>
  415. </tr>
  416. <tr class="altColor">
  417. <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>
  418. <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/commons/mail/Email.html#RECEIVER_EMAIL">RECEIVER_EMAIL</a></span></code>
  419. <div class="block"><span class="deprecatedLabel">Deprecated.</span>&nbsp;
  420. <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>
  421. </div>
  422. </td>
  423. </tr>
  424. <tr class="rowColor">
  425. <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>
  426. <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/commons/mail/Email.html#RECEIVER_NAME">RECEIVER_NAME</a></span></code>
  427. <div class="block"><span class="deprecatedLabel">Deprecated.</span>&nbsp;
  428. <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>
  429. </div>
  430. </td>
  431. </tr>
  432. <tr class="altColor">
  433. <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>&lt;<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>&gt;</code></td>
  434. <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/commons/mail/Email.html#replyList">replyList</a></span></code>
  435. <div class="block">List of "replyTo" email addresses.</div>
  436. </td>
  437. </tr>
  438. <tr class="rowColor">
  439. <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>
  440. <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/commons/mail/Email.html#SENDER_EMAIL">SENDER_EMAIL</a></span></code>
  441. <div class="block"><span class="deprecatedLabel">Deprecated.</span>&nbsp;
  442. <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>
  443. </div>
  444. </td>
  445. </tr>
  446. <tr class="altColor">
  447. <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>
  448. <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/commons/mail/Email.html#SENDER_NAME">SENDER_NAME</a></span></code>
  449. <div class="block"><span class="deprecatedLabel">Deprecated.</span>&nbsp;
  450. <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>
  451. </div>
  452. </td>
  453. </tr>
  454. <tr class="rowColor">
  455. <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>
  456. <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/commons/mail/Email.html#sentDate">sentDate</a></span></code>
  457. <div class="block">Sent date.</div>
  458. </td>
  459. </tr>
  460. <tr class="altColor">
  461. <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>
  462. <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/commons/mail/Email.html#SMTP">SMTP</a></span></code>
  463. <div class="block"><span class="deprecatedLabel">Deprecated.</span>&nbsp;
  464. <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>
  465. </div>
  466. </td>
  467. </tr>
  468. <tr class="rowColor">
  469. <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>
  470. <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/commons/mail/Email.html#smtpPort">smtpPort</a></span></code>
  471. <div class="block">The port number of the mail server to connect to.</div>
  472. </td>
  473. </tr>
  474. <tr class="altColor">
  475. <td class="colFirst"><code>protected int</code></td>
  476. <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/commons/mail/Email.html#socketConnectionTimeout">socketConnectionTimeout</a></span></code>
  477. <div class="block">socket connection timeout value in milliseconds.</div>
  478. </td>
  479. </tr>
  480. <tr class="rowColor">
  481. <td class="colFirst"><code>protected int</code></td>
  482. <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/commons/mail/Email.html#socketTimeout">socketTimeout</a></span></code>
  483. <div class="block">socket I/O timeout value in milliseconds.</div>
  484. </td>
  485. </tr>
  486. <tr class="altColor">
  487. <td class="colFirst"><code>protected boolean</code></td>
  488. <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/commons/mail/Email.html#ssl">ssl</a></span></code>
  489. <div class="block"><span class="deprecatedLabel">Deprecated.</span>&nbsp;
  490. <div class="block"><span class="deprecationComment">since 1.3, use setSSLOnConnect() instead</span></div>
  491. </div>
  492. </td>
  493. </tr>
  494. <tr class="rowColor">
  495. <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>
  496. <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/commons/mail/Email.html#sslSmtpPort">sslSmtpPort</a></span></code>
  497. <div class="block">The port number of the SSL enabled SMTP server;
  498. defaults to the standard port, 465.</div>
  499. </td>
  500. </tr>
  501. <tr class="altColor">
  502. <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>
  503. <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/commons/mail/Email.html#subject">subject</a></span></code>
  504. <div class="block">The Subject.</div>
  505. </td>
  506. </tr>
  507. <tr class="rowColor">
  508. <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>
  509. <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/commons/mail/Email.html#TEXT_HTML">TEXT_HTML</a></span></code>
  510. <div class="block"><span class="deprecatedLabel">Deprecated.</span>&nbsp;
  511. <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>
  512. </div>
  513. </td>
  514. </tr>
  515. <tr class="altColor">
  516. <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>
  517. <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/commons/mail/Email.html#TEXT_PLAIN">TEXT_PLAIN</a></span></code>
  518. <div class="block"><span class="deprecatedLabel">Deprecated.</span>&nbsp;
  519. <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>
  520. </div>
  521. </td>
  522. </tr>
  523. <tr class="rowColor">
  524. <td class="colFirst"><code>protected boolean</code></td>
  525. <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/commons/mail/Email.html#tls">tls</a></span></code>
  526. <div class="block"><span class="deprecatedLabel">Deprecated.</span>&nbsp;
  527. <div class="block"><span class="deprecationComment">since 1.3, use setStartTLSEnabled() instead</span></div>
  528. </div>
  529. </td>
  530. </tr>
  531. <tr class="altColor">
  532. <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>&lt;<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>&gt;</code></td>
  533. <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/commons/mail/Email.html#toList">toList</a></span></code>
  534. <div class="block">List of "to" email addresses.</div>
  535. </td>
  536. </tr>
  537. <tr class="rowColor">
  538. <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>
  539. <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/commons/mail/Email.html#US_ASCII">US_ASCII</a></span></code>
  540. <div class="block"><span class="deprecatedLabel">Deprecated.</span>&nbsp;
  541. <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>
  542. </div>
  543. </td>
  544. </tr>
  545. </table>
  546. </li>
  547. </ul>
  548. <!-- ======== CONSTRUCTOR SUMMARY ======== -->
  549. <ul class="blockList">
  550. <li class="blockList"><a name="constructor.summary">
  551. <!-- -->
  552. </a>
  553. <h3>Constructor Summary</h3>
  554. <table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Constructor Summary table, listing constructors, and an explanation">
  555. <caption><span>Constructors</span><span class="tabEnd">&nbsp;</span></caption>
  556. <tr>
  557. <th class="colOne" scope="col">Constructor and Description</th>
  558. </tr>
  559. <tr class="altColor">
  560. <td class="colOne"><code><span class="memberNameLink"><a href="../../../../org/apache/commons/mail/Email.html#Email--">Email</a></span>()</code>&nbsp;</td>
  561. </tr>
  562. </table>
  563. </li>
  564. </ul>
  565. <!-- ========== METHOD SUMMARY =========== -->
  566. <ul class="blockList">
  567. <li class="blockList"><a name="method.summary">
  568. <!-- -->
  569. </a>
  570. <h3>Method Summary</h3>
  571. <table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation">
  572. <caption><span id="t0" class="activeTableTab"><span>All Methods</span><span class="tabEnd">&nbsp;</span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd">&nbsp;</span></span><span id="t3" class="tableTab"><span><a href="javascript:show(4);">Abstract Methods</a></span><span class="tabEnd">&nbsp;</span></span><span id="t4" class="tableTab"><span><a href="javascript:show(8);">Concrete Methods</a></span><span class="tabEnd">&nbsp;</span></span><span id="t6" class="tableTab"><span><a href="javascript:show(32);">Deprecated Methods</a></span><span class="tabEnd">&nbsp;</span></span></caption>
  573. <tr>
  574. <th class="colFirst" scope="col">Modifier and Type</th>
  575. <th class="colLast" scope="col">Method and Description</th>
  576. </tr>
  577. <tr id="i0" class="altColor">
  578. <td class="colFirst"><code><a href="../../../../org/apache/commons/mail/Email.html" title="class in org.apache.commons.mail">Email</a></code></td>
  579. <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>...&nbsp;emails)</code>
  580. <div class="block">Add an array of blind BCC recipients to the email.</div>
  581. </td>
  582. </tr>
  583. <tr id="i1" class="rowColor">
  584. <td class="colFirst"><code><a href="../../../../org/apache/commons/mail/Email.html" title="class in org.apache.commons.mail">Email</a></code></td>
  585. <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>&nbsp;email)</code>
  586. <div class="block">Add a blind BCC recipient to the email.</div>
  587. </td>
  588. </tr>
  589. <tr id="i2" class="altColor">
  590. <td class="colFirst"><code><a href="../../../../org/apache/commons/mail/Email.html" title="class in org.apache.commons.mail">Email</a></code></td>
  591. <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>&nbsp;email,
  592. <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>&nbsp;name)</code>
  593. <div class="block">Add a blind BCC recipient to the email using the specified address and
  594. the specified personal name.</div>
  595. </td>
  596. </tr>
  597. <tr id="i3" class="rowColor">
  598. <td class="colFirst"><code><a href="../../../../org/apache/commons/mail/Email.html" title="class in org.apache.commons.mail">Email</a></code></td>
  599. <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>&nbsp;email,
  600. <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>&nbsp;name,
  601. <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>&nbsp;charset)</code>
  602. <div class="block">Add a blind BCC recipient to the email using the specified address,
  603. personal name, and charset encoding for the name.</div>
  604. </td>
  605. </tr>
  606. <tr id="i4" class="altColor">
  607. <td class="colFirst"><code><a href="../../../../org/apache/commons/mail/Email.html" title="class in org.apache.commons.mail">Email</a></code></td>
  608. <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>...&nbsp;emails)</code>
  609. <div class="block">Add an array of CC recipients to the email.</div>
  610. </td>
  611. </tr>
  612. <tr id="i5" class="rowColor">
  613. <td class="colFirst"><code><a href="../../../../org/apache/commons/mail/Email.html" title="class in org.apache.commons.mail">Email</a></code></td>
  614. <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>&nbsp;email)</code>
  615. <div class="block">Add a recipient CC to the email.</div>
  616. </td>
  617. </tr>
  618. <tr id="i6" class="altColor">
  619. <td class="colFirst"><code><a href="../../../../org/apache/commons/mail/Email.html" title="class in org.apache.commons.mail">Email</a></code></td>
  620. <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>&nbsp;email,
  621. <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>&nbsp;name)</code>
  622. <div class="block">Add a recipient CC to the email using the specified address and the
  623. specified personal name.</div>
  624. </td>
  625. </tr>
  626. <tr id="i7" class="rowColor">
  627. <td class="colFirst"><code><a href="../../../../org/apache/commons/mail/Email.html" title="class in org.apache.commons.mail">Email</a></code></td>
  628. <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>&nbsp;email,
  629. <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>&nbsp;name,
  630. <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>&nbsp;charset)</code>
  631. <div class="block">Add a recipient CC to the email using the specified address, personal
  632. name, and charset encoding for the name.</div>
  633. </td>
  634. </tr>
  635. <tr id="i8" class="altColor">
  636. <td class="colFirst"><code>void</code></td>
  637. <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>&nbsp;name,
  638. <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>&nbsp;value)</code>
  639. <div class="block">Adds a header ( name, value ) to the headers Map.</div>
  640. </td>
  641. </tr>
  642. <tr id="i9" class="rowColor">
  643. <td class="colFirst"><code><a href="../../../../org/apache/commons/mail/Email.html" title="class in org.apache.commons.mail">Email</a></code></td>
  644. <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>&nbsp;email)</code>
  645. <div class="block">Add a reply to address to the email.</div>
  646. </td>
  647. </tr>
  648. <tr id="i10" class="altColor">
  649. <td class="colFirst"><code><a href="../../../../org/apache/commons/mail/Email.html" title="class in org.apache.commons.mail">Email</a></code></td>
  650. <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>&nbsp;email,
  651. <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>&nbsp;name)</code>
  652. <div class="block">Add a reply to address to the email using the specified address and
  653. the specified personal name.</div>
  654. </td>
  655. </tr>
  656. <tr id="i11" class="rowColor">
  657. <td class="colFirst"><code><a href="../../../../org/apache/commons/mail/Email.html" title="class in org.apache.commons.mail">Email</a></code></td>
  658. <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>&nbsp;email,
  659. <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>&nbsp;name,
  660. <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>&nbsp;charset)</code>
  661. <div class="block">Add a reply to address to the email using the specified address,
  662. personal name, and charset encoding for the name.</div>
  663. </td>
  664. </tr>
  665. <tr id="i12" class="altColor">
  666. <td class="colFirst"><code><a href="../../../../org/apache/commons/mail/Email.html" title="class in org.apache.commons.mail">Email</a></code></td>
  667. <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>...&nbsp;emails)</code>
  668. <div class="block">Add a list of TO recipients to the email.</div>
  669. </td>
  670. </tr>
  671. <tr id="i13" class="rowColor">
  672. <td class="colFirst"><code><a href="../../../../org/apache/commons/mail/Email.html" title="class in org.apache.commons.mail">Email</a></code></td>
  673. <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>&nbsp;email)</code>
  674. <div class="block">Add a recipient TO to the email.</div>
  675. </td>
  676. </tr>
  677. <tr id="i14" class="altColor">
  678. <td class="colFirst"><code><a href="../../../../org/apache/commons/mail/Email.html" title="class in org.apache.commons.mail">Email</a></code></td>
  679. <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>&nbsp;email,
  680. <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>&nbsp;name)</code>
  681. <div class="block">Add a recipient TO to the email using the specified address and the
  682. specified personal name.</div>
  683. </td>
  684. </tr>
  685. <tr id="i15" class="rowColor">
  686. <td class="colFirst"><code><a href="../../../../org/apache/commons/mail/Email.html" title="class in org.apache.commons.mail">Email</a></code></td>
  687. <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>&nbsp;email,
  688. <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>&nbsp;name,
  689. <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>&nbsp;charset)</code>
  690. <div class="block">Add a recipient TO to the email using the specified address, personal
  691. name, and charset encoding for the name.</div>
  692. </td>
  693. </tr>
  694. <tr id="i16" class="altColor">
  695. <td class="colFirst"><code>void</code></td>
  696. <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/commons/mail/Email.html#buildMimeMessage--">buildMimeMessage</a></span>()</code>
  697. <div class="block">Does the work of actually building the MimeMessage.</div>
  698. </td>
  699. </tr>
  700. <tr id="i17" class="rowColor">
  701. <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>
  702. <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>&nbsp;aSession)</code>
  703. <div class="block">Factory method to create a customized MimeMessage which can be
  704. implemented by a derived class, e.g. to set the message id.</div>
  705. </td>
  706. </tr>
  707. <tr id="i18" class="altColor">
  708. <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>&lt;<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>&gt;</code></td>
  709. <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/commons/mail/Email.html#getBccAddresses--">getBccAddresses</a></span>()</code>
  710. <div class="block">Get the list of "Bcc" addresses.</div>
  711. </td>
  712. </tr>
  713. <tr id="i19" class="rowColor">
  714. <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>
  715. <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/commons/mail/Email.html#getBounceAddress--">getBounceAddress</a></span>()</code>
  716. <div class="block">Gets the "bounce address" of this email.</div>
  717. </td>
  718. </tr>
  719. <tr id="i20" class="altColor">
  720. <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>&lt;<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>&gt;</code></td>
  721. <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/commons/mail/Email.html#getCcAddresses--">getCcAddresses</a></span>()</code>
  722. <div class="block">Get the list of "CC" addresses.</div>
  723. </td>
  724. </tr>
  725. <tr id="i21" class="rowColor">
  726. <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>
  727. <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/commons/mail/Email.html#getFromAddress--">getFromAddress</a></span>()</code>
  728. <div class="block">Gets the sender of the email.</div>
  729. </td>
  730. </tr>
  731. <tr id="i22" class="altColor">
  732. <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>
  733. <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>&nbsp;header)</code>
  734. <div class="block">Gets the specified header.</div>
  735. </td>
  736. </tr>
  737. <tr id="i23" class="rowColor">
  738. <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>&lt;<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>&gt;</code></td>
  739. <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/commons/mail/Email.html#getHeaders--">getHeaders</a></span>()</code>
  740. <div class="block">Gets all headers on an Email.</div>
  741. </td>
  742. </tr>
  743. <tr id="i24" class="altColor">
  744. <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>
  745. <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/commons/mail/Email.html#getHostName--">getHostName</a></span>()</code>
  746. <div class="block">Gets the host name of the SMTP server,</div>
  747. </td>
  748. </tr>
  749. <tr id="i25" class="rowColor">
  750. <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>
  751. <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/commons/mail/Email.html#getMailSession--">getMailSession</a></span>()</code>
  752. <div class="block">Determines the mail session used when sending this Email, creating
  753. the Session if necessary.</div>
  754. </td>
  755. </tr>
  756. <tr id="i26" class="altColor">
  757. <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>
  758. <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/commons/mail/Email.html#getMimeMessage--">getMimeMessage</a></span>()</code>
  759. <div class="block">Returns the internal MimeMessage.</div>
  760. </td>
  761. </tr>
  762. <tr id="i27" class="rowColor">
  763. <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>&lt;<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>&gt;</code></td>
  764. <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/commons/mail/Email.html#getReplyToAddresses--">getReplyToAddresses</a></span>()</code>
  765. <div class="block">Get the list of "Reply-To" addresses.</div>
  766. </td>
  767. </tr>
  768. <tr id="i28" class="altColor">
  769. <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>
  770. <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/commons/mail/Email.html#getSentDate--">getSentDate</a></span>()</code>
  771. <div class="block">Gets the sent date for the email.</div>
  772. </td>
  773. </tr>
  774. <tr id="i29" class="rowColor">
  775. <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>
  776. <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/commons/mail/Email.html#getSmtpPort--">getSmtpPort</a></span>()</code>
  777. <div class="block">Gets the listening port of the SMTP server.</div>
  778. </td>
  779. </tr>
  780. <tr id="i30" class="altColor">
  781. <td class="colFirst"><code>int</code></td>
  782. <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/commons/mail/Email.html#getSocketConnectionTimeout--">getSocketConnectionTimeout</a></span>()</code>
  783. <div class="block">Get the socket connection timeout value in milliseconds.</div>
  784. </td>
  785. </tr>
  786. <tr id="i31" class="rowColor">
  787. <td class="colFirst"><code>int</code></td>
  788. <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/commons/mail/Email.html#getSocketTimeout--">getSocketTimeout</a></span>()</code>
  789. <div class="block">Get the socket I/O timeout value in milliseconds.</div>
  790. </td>
  791. </tr>
  792. <tr id="i32" class="altColor">
  793. <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>
  794. <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/commons/mail/Email.html#getSslSmtpPort--">getSslSmtpPort</a></span>()</code>
  795. <div class="block">Returns the current SSL port used by the SMTP transport.</div>
  796. </td>
  797. </tr>
  798. <tr id="i33" class="rowColor">
  799. <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>
  800. <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/commons/mail/Email.html#getSubject--">getSubject</a></span>()</code>
  801. <div class="block">Gets the subject of the email.</div>
  802. </td>
  803. </tr>
  804. <tr id="i34" class="altColor">
  805. <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>&lt;<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>&gt;</code></td>
  806. <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/commons/mail/Email.html#getToAddresses--">getToAddresses</a></span>()</code>
  807. <div class="block">Get the list of "To" addresses.</div>
  808. </td>
  809. </tr>
  810. <tr id="i35" class="rowColor">
  811. <td class="colFirst"><code>boolean</code></td>
  812. <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/commons/mail/Email.html#isSendPartial--">isSendPartial</a></span>()</code>
  813. <div class="block">If partial sending of email enabled.</div>
  814. </td>
  815. </tr>
  816. <tr id="i36" class="altColor">
  817. <td class="colFirst"><code>boolean</code></td>
  818. <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/commons/mail/Email.html#isSSL--">isSSL</a></span>()</code>
  819. <div class="block"><span class="deprecatedLabel">Deprecated.</span>&nbsp;
  820. <div class="block"><span class="deprecationComment">since 1.3, use isSSLOnConnect() instead</span></div>
  821. </div>
  822. </td>
  823. </tr>
  824. <tr id="i37" class="rowColor">
  825. <td class="colFirst"><code>boolean</code></td>
  826. <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/commons/mail/Email.html#isSSLCheckServerIdentity--">isSSLCheckServerIdentity</a></span>()</code>
  827. <div class="block">Is the server identity checked as specified by RFC 2595</div>
  828. </td>
  829. </tr>
  830. <tr id="i38" class="altColor">
  831. <td class="colFirst"><code>boolean</code></td>
  832. <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/commons/mail/Email.html#isSSLOnConnect--">isSSLOnConnect</a></span>()</code>
  833. <div class="block">Returns whether SSL/TLS encryption for the transport is currently enabled (SMTPS/POPS).</div>
  834. </td>
  835. </tr>
  836. <tr id="i39" class="rowColor">
  837. <td class="colFirst"><code>boolean</code></td>
  838. <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/commons/mail/Email.html#isStartTLSEnabled--">isStartTLSEnabled</a></span>()</code>
  839. <div class="block">Gets whether the client is configured to try to enable STARTTLS.</div>
  840. </td>
  841. </tr>
  842. <tr id="i40" class="altColor">
  843. <td class="colFirst"><code>boolean</code></td>
  844. <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/commons/mail/Email.html#isStartTLSRequired--">isStartTLSRequired</a></span>()</code>
  845. <div class="block">Gets whether the client is configured to require STARTTLS.</div>
  846. </td>
  847. </tr>
  848. <tr id="i41" class="rowColor">
  849. <td class="colFirst"><code>boolean</code></td>
  850. <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/commons/mail/Email.html#isTLS--">isTLS</a></span>()</code>
  851. <div class="block"><span class="deprecatedLabel">Deprecated.</span>&nbsp;
  852. <div class="block"><span class="deprecationComment">since 1.3, use isStartTLSEnabled() instead</span></div>
  853. </div>
  854. </td>
  855. </tr>
  856. <tr id="i42" class="altColor">
  857. <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>
  858. <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/commons/mail/Email.html#send--">send</a></span>()</code>
  859. <div class="block">Sends the email.</div>
  860. </td>
  861. </tr>
  862. <tr id="i43" class="rowColor">
  863. <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>
  864. <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/commons/mail/Email.html#sendMimeMessage--">sendMimeMessage</a></span>()</code>
  865. <div class="block">Sends the previously created MimeMessage to the SMTP server.</div>
  866. </td>
  867. </tr>
  868. <tr id="i44" class="altColor">
  869. <td class="colFirst"><code>void</code></td>
  870. <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>&nbsp;userName,
  871. <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>&nbsp;password)</code>
  872. <div class="block">Sets the userName and password if authentication is needed.</div>
  873. </td>
  874. </tr>
  875. <tr id="i45" class="rowColor">
  876. <td class="colFirst"><code>void</code></td>
  877. <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>&nbsp;newAuthenticator)</code>
  878. <div class="block">Sets the <code>Authenticator</code> to be used when authentication
  879. is requested from the mail server.</div>
  880. </td>
  881. </tr>
  882. <tr id="i46" class="altColor">
  883. <td class="colFirst"><code><a href="../../../../org/apache/commons/mail/Email.html" title="class in org.apache.commons.mail">Email</a></code></td>
  884. <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>&lt;<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>&gt;&nbsp;aCollection)</code>
  885. <div class="block">Set a list of "BCC" addresses.</div>
  886. </td>
  887. </tr>
  888. <tr id="i47" class="rowColor">
  889. <td class="colFirst"><code><a href="../../../../org/apache/commons/mail/Email.html" title="class in org.apache.commons.mail">Email</a></code></td>
  890. <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>&nbsp;email)</code>
  891. <div class="block">Set the "bounce address" - the address to which undeliverable messages
  892. will be returned.</div>
  893. </td>
  894. </tr>
  895. <tr id="i48" class="altColor">
  896. <td class="colFirst"><code><a href="../../../../org/apache/commons/mail/Email.html" title="class in org.apache.commons.mail">Email</a></code></td>
  897. <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>&lt;<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>&gt;&nbsp;aCollection)</code>
  898. <div class="block">Set a list of "CC" addresses.</div>
  899. </td>
  900. </tr>
  901. <tr id="i49" class="rowColor">
  902. <td class="colFirst"><code>void</code></td>
  903. <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>&nbsp;newCharset)</code>
  904. <div class="block">Set the charset of the message.</div>
  905. </td>
  906. </tr>
  907. <tr id="i50" class="altColor">
  908. <td class="colFirst"><code>void</code></td>
  909. <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>&nbsp;aMimeMultipart)</code>
  910. <div class="block">Set the emailBody to a MimeMultiPart</div>
  911. </td>
  912. </tr>
  913. <tr id="i51" class="rowColor">
  914. <td class="colFirst"><code>void</code></td>
  915. <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>&nbsp;aObject,
  916. <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>&nbsp;aContentType)</code>
  917. <div class="block">Set the content and contentType.</div>
  918. </td>
  919. </tr>
  920. <tr id="i52" class="altColor">
  921. <td class="colFirst"><code>void</code></td>
  922. <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/commons/mail/Email.html#setDebug-boolean-">setDebug</a></span>(boolean&nbsp;d)</code>
  923. <div class="block">Setting to true will enable the display of debug information.</div>
  924. </td>
  925. </tr>
  926. <tr id="i53" class="rowColor">
  927. <td class="colFirst"><code><a href="../../../../org/apache/commons/mail/Email.html" title="class in org.apache.commons.mail">Email</a></code></td>
  928. <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>&nbsp;email)</code>
  929. <div class="block">Set the FROM field of the email to use the specified address.</div>
  930. </td>
  931. </tr>
  932. <tr id="i54" class="altColor">
  933. <td class="colFirst"><code><a href="../../../../org/apache/commons/mail/Email.html" title="class in org.apache.commons.mail">Email</a></code></td>
  934. <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>&nbsp;email,
  935. <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>&nbsp;name)</code>
  936. <div class="block">Set the FROM field of the email to use the specified address and the
  937. specified personal name.</div>
  938. </td>
  939. </tr>
  940. <tr id="i55" class="rowColor">
  941. <td class="colFirst"><code><a href="../../../../org/apache/commons/mail/Email.html" title="class in org.apache.commons.mail">Email</a></code></td>
  942. <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>&nbsp;email,
  943. <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>&nbsp;name,
  944. <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>&nbsp;charset)</code>
  945. <div class="block">Set the FROM field of the email to use the specified address, personal
  946. name, and charset encoding for the name.</div>
  947. </td>
  948. </tr>
  949. <tr id="i56" class="altColor">
  950. <td class="colFirst"><code>void</code></td>
  951. <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>&lt;<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>&gt;&nbsp;map)</code>
  952. <div class="block">Used to specify the mail headers.</div>
  953. </td>
  954. </tr>
  955. <tr id="i57" class="rowColor">
  956. <td class="colFirst"><code>void</code></td>
  957. <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>&nbsp;aHostName)</code>
  958. <div class="block">Set the hostname of the outgoing mail server.</div>
  959. </td>
  960. </tr>
  961. <tr id="i58" class="altColor">
  962. <td class="colFirst"><code>void</code></td>
  963. <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>&nbsp;aSession)</code>
  964. <div class="block">Supply a mail Session object to use.</div>
  965. </td>
  966. </tr>
  967. <tr id="i59" class="rowColor">
  968. <td class="colFirst"><code>void</code></td>
  969. <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>&nbsp;jndiName)</code>
  970. <div class="block">Supply a mail Session object from a JNDI directory.</div>
  971. </td>
  972. </tr>
  973. <tr id="i60" class="altColor">
  974. <td class="colFirst"><code>abstract <a href="../../../../org/apache/commons/mail/Email.html" title="class in org.apache.commons.mail">Email</a></code></td>
  975. <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>&nbsp;msg)</code>
  976. <div class="block">Define the content of the mail.</div>
  977. </td>
  978. </tr>
  979. <tr id="i61" class="rowColor">
  980. <td class="colFirst"><code>void</code></td>
  981. <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&nbsp;newPopBeforeSmtp,
  982. <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>&nbsp;newPopHost,
  983. <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>&nbsp;newPopUsername,
  984. <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>&nbsp;newPopPassword)</code>
  985. <div class="block">Set details regarding "pop3 before smtp" authentication.</div>
  986. </td>
  987. </tr>
  988. <tr id="i62" class="altColor">
  989. <td class="colFirst"><code><a href="../../../../org/apache/commons/mail/Email.html" title="class in org.apache.commons.mail">Email</a></code></td>
  990. <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>&lt;<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>&gt;&nbsp;aCollection)</code>
  991. <div class="block">Set a list of reply to addresses.</div>
  992. </td>
  993. </tr>
  994. <tr id="i63" class="rowColor">
  995. <td class="colFirst"><code><a href="../../../../org/apache/commons/mail/Email.html" title="class in org.apache.commons.mail">Email</a></code></td>
  996. <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/commons/mail/Email.html#setSendPartial-boolean-">setSendPartial</a></span>(boolean&nbsp;sendPartial)</code>
  997. <div class="block">Sets whether the email is partially send in case of invalid addresses.</div>
  998. </td>
  999. </tr>
  1000. <tr id="i64" class="altColor">
  1001. <td class="colFirst"><code>void</code></td>
  1002. <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>&nbsp;date)</code>
  1003. <div class="block">Sets the sent date for the email.</div>
  1004. </td>
  1005. </tr>
  1006. <tr id="i65" class="rowColor">
  1007. <td class="colFirst"><code>void</code></td>
  1008. <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/commons/mail/Email.html#setSmtpPort-int-">setSmtpPort</a></span>(int&nbsp;aPortNumber)</code>
  1009. <div class="block">Set the non-SSL port number of the outgoing mail server.</div>
  1010. </td>
  1011. </tr>
  1012. <tr id="i66" class="altColor">
  1013. <td class="colFirst"><code>void</code></td>
  1014. <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/commons/mail/Email.html#setSocketConnectionTimeout-int-">setSocketConnectionTimeout</a></span>(int&nbsp;socketConnectionTimeout)</code>
  1015. <div class="block">Set the socket connection timeout value in milliseconds.</div>
  1016. </td>
  1017. </tr>
  1018. <tr id="i67" class="rowColor">
  1019. <td class="colFirst"><code>void</code></td>
  1020. <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/commons/mail/Email.html#setSocketTimeout-int-">setSocketTimeout</a></span>(int&nbsp;socketTimeout)</code>
  1021. <div class="block">Set the socket I/O timeout value in milliseconds.</div>
  1022. </td>
  1023. </tr>
  1024. <tr id="i68" class="altColor">
  1025. <td class="colFirst"><code>void</code></td>
  1026. <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/commons/mail/Email.html#setSSL-boolean-">setSSL</a></span>(boolean&nbsp;ssl)</code>
  1027. <div class="block"><span class="deprecatedLabel">Deprecated.</span>&nbsp;
  1028. <div class="block"><span class="deprecationComment">since 1.3, use setSSLOnConnect() instead</span></div>
  1029. </div>
  1030. </td>
  1031. </tr>
  1032. <tr id="i69" class="rowColor">
  1033. <td class="colFirst"><code><a href="../../../../org/apache/commons/mail/Email.html" title="class in org.apache.commons.mail">Email</a></code></td>
  1034. <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/commons/mail/Email.html#setSSLCheckServerIdentity-boolean-">setSSLCheckServerIdentity</a></span>(boolean&nbsp;sslCheckServerIdentity)</code>
  1035. <div class="block">Sets whether the server identity is checked as specified by RFC 2595</div>
  1036. </td>
  1037. </tr>
  1038. <tr id="i70" class="altColor">
  1039. <td class="colFirst"><code><a href="../../../../org/apache/commons/mail/Email.html" title="class in org.apache.commons.mail">Email</a></code></td>
  1040. <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/commons/mail/Email.html#setSSLOnConnect-boolean-">setSSLOnConnect</a></span>(boolean&nbsp;ssl)</code>
  1041. <div class="block">Sets whether SSL/TLS encryption should be enabled for the SMTP transport upon connection (SMTPS/POPS).</div>
  1042. </td>
  1043. </tr>
  1044. <tr id="i71" class="rowColor">
  1045. <td class="colFirst"><code>void</code></td>
  1046. <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>&nbsp;sslSmtpPort)</code>
  1047. <div class="block">Sets the SSL port to use for the SMTP transport.</div>
  1048. </td>
  1049. </tr>
  1050. <tr id="i72" class="altColor">
  1051. <td class="colFirst"><code><a href="../../../../org/apache/commons/mail/Email.html" title="class in org.apache.commons.mail">Email</a></code></td>
  1052. <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/commons/mail/Email.html#setStartTLSEnabled-boolean-">setStartTLSEnabled</a></span>(boolean&nbsp;startTlsEnabled)</code>
  1053. <div class="block">Set or disable the STARTTLS encryption.</div>
  1054. </td>
  1055. </tr>
  1056. <tr id="i73" class="rowColor">
  1057. <td class="colFirst"><code><a href="../../../../org/apache/commons/mail/Email.html" title="class in org.apache.commons.mail">Email</a></code></td>
  1058. <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/commons/mail/Email.html#setStartTLSRequired-boolean-">setStartTLSRequired</a></span>(boolean&nbsp;startTlsRequired)</code>
  1059. <div class="block">Set or disable the required STARTTLS encryption.</div>
  1060. </td>
  1061. </tr>
  1062. <tr id="i74" class="altColor">
  1063. <td class="colFirst"><code><a href="../../../../org/apache/commons/mail/Email.html" title="class in org.apache.commons.mail">Email</a></code></td>
  1064. <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>&nbsp;aSubject)</code>
  1065. <div class="block">Sets the email subject.</div>
  1066. </td>
  1067. </tr>
  1068. <tr id="i75" class="rowColor">
  1069. <td class="colFirst"><code>void</code></td>
  1070. <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/commons/mail/Email.html#setTLS-boolean-">setTLS</a></span>(boolean&nbsp;withTLS)</code>
  1071. <div class="block"><span class="deprecatedLabel">Deprecated.</span>&nbsp;
  1072. <div class="block"><span class="deprecationComment">since 1.3, use setStartTLSEnabled() instead</span></div>
  1073. </div>
  1074. </td>
  1075. </tr>
  1076. <tr id="i76" class="altColor">
  1077. <td class="colFirst"><code><a href="../../../../org/apache/commons/mail/Email.html" title="class in org.apache.commons.mail">Email</a></code></td>
  1078. <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>&lt;<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>&gt;&nbsp;aCollection)</code>
  1079. <div class="block">Set a list of "TO" addresses.</div>
  1080. </td>
  1081. </tr>
  1082. <tr id="i77" class="rowColor">
  1083. <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>
  1084. <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>&lt;<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>&gt;&nbsp;list)</code>
  1085. <div class="block">Utility to copy List of known InternetAddress objects into an
  1086. array.</div>
  1087. </td>
  1088. </tr>
  1089. <tr id="i78" class="altColor">
  1090. <td class="colFirst"><code>void</code></td>
  1091. <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>&nbsp;aContentType)</code>
  1092. <div class="block">Update the contentType.</div>
  1093. </td>
  1094. </tr>
  1095. </table>
  1096. <ul class="blockList">
  1097. <li class="blockList"><a name="methods.inherited.from.class.java.lang.Object">
  1098. <!-- -->
  1099. </a>
  1100. <h3>Methods inherited from class&nbsp;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>
  1101. <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>
  1102. </ul>
  1103. </li>
  1104. </ul>
  1105. </li>
  1106. </ul>
  1107. </div>
  1108. <div class="details">
  1109. <ul class="blockList">
  1110. <li class="blockList">
  1111. <!-- ============ FIELD DETAIL =========== -->
  1112. <ul class="blockList">
  1113. <li class="blockList"><a name="field.detail">
  1114. <!-- -->
  1115. </a>
  1116. <h3>Field Detail</h3>
  1117. <a name="SENDER_EMAIL">
  1118. <!-- -->
  1119. </a>
  1120. <ul class="blockList">
  1121. <li class="blockList">
  1122. <h4>SENDER_EMAIL</h4>
  1123. <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>
  1124. public static final&nbsp;<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>
  1125. <div class="block"><span class="deprecatedLabel">Deprecated.</span>&nbsp;<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>
  1126. <dl>
  1127. <dt><span class="seeLabel">See Also:</span></dt>
  1128. <dd><a href="../../../../constant-values.html#org.apache.commons.mail.Email.SENDER_EMAIL">Constant Field Values</a></dd>
  1129. </dl>
  1130. </li>
  1131. </ul>
  1132. <a name="SENDER_NAME">
  1133. <!-- -->
  1134. </a>
  1135. <ul class="blockList">
  1136. <li class="blockList">
  1137. <h4>SENDER_NAME</h4>
  1138. <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>
  1139. public static final&nbsp;<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>
  1140. <div class="block"><span class="deprecatedLabel">Deprecated.</span>&nbsp;<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>
  1141. <dl>
  1142. <dt><span class="seeLabel">See Also:</span></dt>
  1143. <dd><a href="../../../../constant-values.html#org.apache.commons.mail.Email.SENDER_NAME">Constant Field Values</a></dd>
  1144. </dl>
  1145. </li>
  1146. </ul>
  1147. <a name="RECEIVER_EMAIL">
  1148. <!-- -->
  1149. </a>
  1150. <ul class="blockList">
  1151. <li class="blockList">
  1152. <h4>RECEIVER_EMAIL</h4>
  1153. <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>
  1154. public static final&nbsp;<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>
  1155. <div class="block"><span class="deprecatedLabel">Deprecated.</span>&nbsp;<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>
  1156. <dl>
  1157. <dt><span class="seeLabel">See Also:</span></dt>
  1158. <dd><a href="../../../../constant-values.html#org.apache.commons.mail.Email.RECEIVER_EMAIL">Constant Field Values</a></dd>
  1159. </dl>
  1160. </li>
  1161. </ul>
  1162. <a name="RECEIVER_NAME">
  1163. <!-- -->
  1164. </a>
  1165. <ul class="blockList">
  1166. <li class="blockList">
  1167. <h4>RECEIVER_NAME</h4>
  1168. <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>
  1169. public static final&nbsp;<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>
  1170. <div class="block"><span class="deprecatedLabel">Deprecated.</span>&nbsp;<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>
  1171. <dl>
  1172. <dt><span class="seeLabel">See Also:</span></dt>
  1173. <dd><a href="../../../../constant-values.html#org.apache.commons.mail.Email.RECEIVER_NAME">Constant Field Values</a></dd>
  1174. </dl>
  1175. </li>
  1176. </ul>
  1177. <a name="EMAIL_SUBJECT">
  1178. <!-- -->
  1179. </a>
  1180. <ul class="blockList">
  1181. <li class="blockList">
  1182. <h4>EMAIL_SUBJECT</h4>
  1183. <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>
  1184. public static final&nbsp;<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>
  1185. <div class="block"><span class="deprecatedLabel">Deprecated.</span>&nbsp;<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>
  1186. <dl>
  1187. <dt><span class="seeLabel">See Also:</span></dt>
  1188. <dd><a href="../../../../constant-values.html#org.apache.commons.mail.Email.EMAIL_SUBJECT">Constant Field Values</a></dd>
  1189. </dl>
  1190. </li>
  1191. </ul>
  1192. <a name="EMAIL_BODY">
  1193. <!-- -->
  1194. </a>
  1195. <ul class="blockList">
  1196. <li class="blockList">
  1197. <h4>EMAIL_BODY</h4>
  1198. <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>
  1199. public static final&nbsp;<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>
  1200. <div class="block"><span class="deprecatedLabel">Deprecated.</span>&nbsp;<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>
  1201. <dl>
  1202. <dt><span class="seeLabel">See Also:</span></dt>
  1203. <dd><a href="../../../../constant-values.html#org.apache.commons.mail.Email.EMAIL_BODY">Constant Field Values</a></dd>
  1204. </dl>
  1205. </li>
  1206. </ul>
  1207. <a name="CONTENT_TYPE">
  1208. <!-- -->
  1209. </a>
  1210. <ul class="blockList">
  1211. <li class="blockList">
  1212. <h4>CONTENT_TYPE</h4>
  1213. <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>
  1214. public static final&nbsp;<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>
  1215. <div class="block"><span class="deprecatedLabel">Deprecated.</span>&nbsp;<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>
  1216. <dl>
  1217. <dt><span class="seeLabel">See Also:</span></dt>
  1218. <dd><a href="../../../../constant-values.html#org.apache.commons.mail.Email.CONTENT_TYPE">Constant Field Values</a></dd>
  1219. </dl>
  1220. </li>
  1221. </ul>
  1222. <a name="ATTACHMENTS">
  1223. <!-- -->
  1224. </a>
  1225. <ul class="blockList">
  1226. <li class="blockList">
  1227. <h4>ATTACHMENTS</h4>
  1228. <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>
  1229. public static final&nbsp;<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>
  1230. <div class="block"><span class="deprecatedLabel">Deprecated.</span>&nbsp;<span class="deprecationComment">since 1.3, use <a href="../../../../org/apache/commons/mail/EmailConstants.html#ATTACHMENTS"><code>EmailConstants.ATTACHMENTS</code></a> instead</span></div>
  1231. <dl>
  1232. <dt><span class="seeLabel">See Also:</span></dt>
  1233. <dd><a href="../../../../constant-values.html#org.apache.commons.mail.Email.ATTACHMENTS">Constant Field Values</a></dd>
  1234. </dl>
  1235. </li>
  1236. </ul>
  1237. <a name="FILE_SERVER">
  1238. <!-- -->
  1239. </a>
  1240. <ul class="blockList">
  1241. <li class="blockList">
  1242. <h4>FILE_SERVER</h4>
  1243. <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>
  1244. public static final&nbsp;<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>
  1245. <div class="block"><span class="deprecatedLabel">Deprecated.</span>&nbsp;<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>
  1246. <dl>
  1247. <dt><span class="seeLabel">See Also:</span></dt>
  1248. <dd><a href="../../../../constant-values.html#org.apache.commons.mail.Email.FILE_SERVER">Constant Field Values</a></dd>
  1249. </dl>
  1250. </li>
  1251. </ul>
  1252. <a name="KOI8_R">
  1253. <!-- -->
  1254. </a>
  1255. <ul class="blockList">
  1256. <li class="blockList">
  1257. <h4>KOI8_R</h4>
  1258. <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>
  1259. public static final&nbsp;<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>
  1260. <div class="block"><span class="deprecatedLabel">Deprecated.</span>&nbsp;<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>
  1261. <dl>
  1262. <dt><span class="seeLabel">See Also:</span></dt>
  1263. <dd><a href="../../../../constant-values.html#org.apache.commons.mail.Email.KOI8_R">Constant Field Values</a></dd>
  1264. </dl>
  1265. </li>
  1266. </ul>
  1267. <a name="ISO_8859_1">
  1268. <!-- -->
  1269. </a>
  1270. <ul class="blockList">
  1271. <li class="blockList">
  1272. <h4>ISO_8859_1</h4>
  1273. <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>
  1274. public static final&nbsp;<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>
  1275. <div class="block"><span class="deprecatedLabel">Deprecated.</span>&nbsp;<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>
  1276. <dl>
  1277. <dt><span class="seeLabel">See Also:</span></dt>
  1278. <dd><a href="../../../../constant-values.html#org.apache.commons.mail.Email.ISO_8859_1">Constant Field Values</a></dd>
  1279. </dl>
  1280. </li>
  1281. </ul>
  1282. <a name="US_ASCII">
  1283. <!-- -->
  1284. </a>
  1285. <ul class="blockList">
  1286. <li class="blockList">
  1287. <h4>US_ASCII</h4>
  1288. <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>
  1289. public static final&nbsp;<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>
  1290. <div class="block"><span class="deprecatedLabel">Deprecated.</span>&nbsp;<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>
  1291. <dl>
  1292. <dt><span class="seeLabel">See Also:</span></dt>
  1293. <dd><a href="../../../../constant-values.html#org.apache.commons.mail.Email.US_ASCII">Constant Field Values</a></dd>
  1294. </dl>
  1295. </li>
  1296. </ul>
  1297. <a name="MAIL_DEBUG">
  1298. <!-- -->
  1299. </a>
  1300. <ul class="blockList">
  1301. <li class="blockList">
  1302. <h4>MAIL_DEBUG</h4>
  1303. <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>
  1304. public static final&nbsp;<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>
  1305. <div class="block"><span class="deprecatedLabel">Deprecated.</span>&nbsp;<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>
  1306. <dl>
  1307. <dt><span class="seeLabel">See Also:</span></dt>
  1308. <dd><a href="../../../../constant-values.html#org.apache.commons.mail.Email.MAIL_DEBUG">Constant Field Values</a></dd>
  1309. </dl>
  1310. </li>
  1311. </ul>
  1312. <a name="MAIL_HOST">
  1313. <!-- -->
  1314. </a>
  1315. <ul class="blockList">
  1316. <li class="blockList">
  1317. <h4>MAIL_HOST</h4>
  1318. <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>
  1319. public static final&nbsp;<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>
  1320. <div class="block"><span class="deprecatedLabel">Deprecated.</span>&nbsp;<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>
  1321. <dl>
  1322. <dt><span class="seeLabel">See Also:</span></dt>
  1323. <dd><a href="../../../../constant-values.html#org.apache.commons.mail.Email.MAIL_HOST">Constant Field Values</a></dd>
  1324. </dl>
  1325. </li>
  1326. </ul>
  1327. <a name="MAIL_PORT">
  1328. <!-- -->
  1329. </a>
  1330. <ul class="blockList">
  1331. <li class="blockList">
  1332. <h4>MAIL_PORT</h4>
  1333. <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>
  1334. public static final&nbsp;<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>
  1335. <div class="block"><span class="deprecatedLabel">Deprecated.</span>&nbsp;<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>
  1336. <dl>
  1337. <dt><span class="seeLabel">See Also:</span></dt>
  1338. <dd><a href="../../../../constant-values.html#org.apache.commons.mail.Email.MAIL_PORT">Constant Field Values</a></dd>
  1339. </dl>
  1340. </li>
  1341. </ul>
  1342. <a name="MAIL_SMTP_FROM">
  1343. <!-- -->
  1344. </a>
  1345. <ul class="blockList">
  1346. <li class="blockList">
  1347. <h4>MAIL_SMTP_FROM</h4>
  1348. <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>
  1349. public static final&nbsp;<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>
  1350. <div class="block"><span class="deprecatedLabel">Deprecated.</span>&nbsp;<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>
  1351. <dl>
  1352. <dt><span class="seeLabel">See Also:</span></dt>
  1353. <dd><a href="../../../../constant-values.html#org.apache.commons.mail.Email.MAIL_SMTP_FROM">Constant Field Values</a></dd>
  1354. </dl>
  1355. </li>
  1356. </ul>
  1357. <a name="MAIL_SMTP_AUTH">
  1358. <!-- -->
  1359. </a>
  1360. <ul class="blockList">
  1361. <li class="blockList">
  1362. <h4>MAIL_SMTP_AUTH</h4>
  1363. <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>
  1364. public static final&nbsp;<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>
  1365. <div class="block"><span class="deprecatedLabel">Deprecated.</span>&nbsp;<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>
  1366. <dl>
  1367. <dt><span class="seeLabel">See Also:</span></dt>
  1368. <dd><a href="../../../../constant-values.html#org.apache.commons.mail.Email.MAIL_SMTP_AUTH">Constant Field Values</a></dd>
  1369. </dl>
  1370. </li>
  1371. </ul>
  1372. <a name="MAIL_SMTP_USER">
  1373. <!-- -->
  1374. </a>
  1375. <ul class="blockList">
  1376. <li class="blockList">
  1377. <h4>MAIL_SMTP_USER</h4>
  1378. <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>
  1379. public static final&nbsp;<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>
  1380. <div class="block"><span class="deprecatedLabel">Deprecated.</span>&nbsp;<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>
  1381. <dl>
  1382. <dt><span class="seeLabel">See Also:</span></dt>
  1383. <dd><a href="../../../../constant-values.html#org.apache.commons.mail.Email.MAIL_SMTP_USER">Constant Field Values</a></dd>
  1384. </dl>
  1385. </li>
  1386. </ul>
  1387. <a name="MAIL_SMTP_PASSWORD">
  1388. <!-- -->
  1389. </a>
  1390. <ul class="blockList">
  1391. <li class="blockList">
  1392. <h4>MAIL_SMTP_PASSWORD</h4>
  1393. <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>
  1394. public static final&nbsp;<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>
  1395. <div class="block"><span class="deprecatedLabel">Deprecated.</span>&nbsp;<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>
  1396. <dl>
  1397. <dt><span class="seeLabel">See Also:</span></dt>
  1398. <dd><a href="../../../../constant-values.html#org.apache.commons.mail.Email.MAIL_SMTP_PASSWORD">Constant Field Values</a></dd>
  1399. </dl>
  1400. </li>
  1401. </ul>
  1402. <a name="MAIL_TRANSPORT_PROTOCOL">
  1403. <!-- -->
  1404. </a>
  1405. <ul class="blockList">
  1406. <li class="blockList">
  1407. <h4>MAIL_TRANSPORT_PROTOCOL</h4>
  1408. <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>
  1409. public static final&nbsp;<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>
  1410. <div class="block"><span class="deprecatedLabel">Deprecated.</span>&nbsp;<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>
  1411. <dl>
  1412. <dt><span class="seeLabel">See Also:</span></dt>
  1413. <dd><a href="../../../../constant-values.html#org.apache.commons.mail.Email.MAIL_TRANSPORT_PROTOCOL">Constant Field Values</a></dd>
  1414. </dl>
  1415. </li>
  1416. </ul>
  1417. <a name="SMTP">
  1418. <!-- -->
  1419. </a>
  1420. <ul class="blockList">
  1421. <li class="blockList">
  1422. <h4>SMTP</h4>
  1423. <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>
  1424. public static final&nbsp;<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>
  1425. <div class="block"><span class="deprecatedLabel">Deprecated.</span>&nbsp;<span class="deprecationComment">since 1.3, use <a href="../../../../org/apache/commons/mail/EmailConstants.html#SMTP"><code>EmailConstants.SMTP</code></a> instead</span></div>
  1426. <dl>
  1427. <dt><span class="seeLabel">See Also:</span></dt>
  1428. <dd><a href="../../../../constant-values.html#org.apache.commons.mail.Email.SMTP">Constant Field Values</a></dd>
  1429. </dl>
  1430. </li>
  1431. </ul>
  1432. <a name="TEXT_HTML">
  1433. <!-- -->
  1434. </a>
  1435. <ul class="blockList">
  1436. <li class="blockList">
  1437. <h4>TEXT_HTML</h4>
  1438. <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>
  1439. public static final&nbsp;<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>
  1440. <div class="block"><span class="deprecatedLabel">Deprecated.</span>&nbsp;<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>
  1441. <dl>
  1442. <dt><span class="seeLabel">See Also:</span></dt>
  1443. <dd><a href="../../../../constant-values.html#org.apache.commons.mail.Email.TEXT_HTML">Constant Field Values</a></dd>
  1444. </dl>
  1445. </li>
  1446. </ul>
  1447. <a name="TEXT_PLAIN">
  1448. <!-- -->
  1449. </a>
  1450. <ul class="blockList">
  1451. <li class="blockList">
  1452. <h4>TEXT_PLAIN</h4>
  1453. <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>
  1454. public static final&nbsp;<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>
  1455. <div class="block"><span class="deprecatedLabel">Deprecated.</span>&nbsp;<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>
  1456. <dl>
  1457. <dt><span class="seeLabel">See Also:</span></dt>
  1458. <dd><a href="../../../../constant-values.html#org.apache.commons.mail.Email.TEXT_PLAIN">Constant Field Values</a></dd>
  1459. </dl>
  1460. </li>
  1461. </ul>
  1462. <a name="MAIL_TRANSPORT_TLS">
  1463. <!-- -->
  1464. </a>
  1465. <ul class="blockList">
  1466. <li class="blockList">
  1467. <h4>MAIL_TRANSPORT_TLS</h4>
  1468. <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>
  1469. public static final&nbsp;<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>
  1470. <div class="block"><span class="deprecatedLabel">Deprecated.</span>&nbsp;<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>
  1471. <dl>
  1472. <dt><span class="seeLabel">See Also:</span></dt>
  1473. <dd><a href="../../../../constant-values.html#org.apache.commons.mail.Email.MAIL_TRANSPORT_TLS">Constant Field Values</a></dd>
  1474. </dl>
  1475. </li>
  1476. </ul>
  1477. <a name="MAIL_SMTP_SOCKET_FACTORY_FALLBACK">
  1478. <!-- -->
  1479. </a>
  1480. <ul class="blockList">
  1481. <li class="blockList">
  1482. <h4>MAIL_SMTP_SOCKET_FACTORY_FALLBACK</h4>
  1483. <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>
  1484. public static final&nbsp;<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>
  1485. <div class="block"><span class="deprecatedLabel">Deprecated.</span>&nbsp;<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>
  1486. <dl>
  1487. <dt><span class="seeLabel">See Also:</span></dt>
  1488. <dd><a href="../../../../constant-values.html#org.apache.commons.mail.Email.MAIL_SMTP_SOCKET_FACTORY_FALLBACK">Constant Field Values</a></dd>
  1489. </dl>
  1490. </li>
  1491. </ul>
  1492. <a name="MAIL_SMTP_SOCKET_FACTORY_CLASS">
  1493. <!-- -->
  1494. </a>
  1495. <ul class="blockList">
  1496. <li class="blockList">
  1497. <h4>MAIL_SMTP_SOCKET_FACTORY_CLASS</h4>
  1498. <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>
  1499. public static final&nbsp;<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>
  1500. <div class="block"><span class="deprecatedLabel">Deprecated.</span>&nbsp;<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>
  1501. <dl>
  1502. <dt><span class="seeLabel">See Also:</span></dt>
  1503. <dd><a href="../../../../constant-values.html#org.apache.commons.mail.Email.MAIL_SMTP_SOCKET_FACTORY_CLASS">Constant Field Values</a></dd>
  1504. </dl>
  1505. </li>
  1506. </ul>
  1507. <a name="MAIL_SMTP_SOCKET_FACTORY_PORT">
  1508. <!-- -->
  1509. </a>
  1510. <ul class="blockList">
  1511. <li class="blockList">
  1512. <h4>MAIL_SMTP_SOCKET_FACTORY_PORT</h4>
  1513. <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>
  1514. public static final&nbsp;<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>
  1515. <div class="block"><span class="deprecatedLabel">Deprecated.</span>&nbsp;<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>
  1516. <dl>
  1517. <dt><span class="seeLabel">See Also:</span></dt>
  1518. <dd><a href="../../../../constant-values.html#org.apache.commons.mail.Email.MAIL_SMTP_SOCKET_FACTORY_PORT">Constant Field Values</a></dd>
  1519. </dl>
  1520. </li>
  1521. </ul>
  1522. <a name="MAIL_SMTP_CONNECTIONTIMEOUT">
  1523. <!-- -->
  1524. </a>
  1525. <ul class="blockList">
  1526. <li class="blockList">
  1527. <h4>MAIL_SMTP_CONNECTIONTIMEOUT</h4>
  1528. <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>
  1529. public static final&nbsp;<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>
  1530. <div class="block"><span class="deprecatedLabel">Deprecated.</span>&nbsp;<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>
  1531. <dl>
  1532. <dt><span class="seeLabel">See Also:</span></dt>
  1533. <dd><a href="../../../../constant-values.html#org.apache.commons.mail.Email.MAIL_SMTP_CONNECTIONTIMEOUT">Constant Field Values</a></dd>
  1534. </dl>
  1535. </li>
  1536. </ul>
  1537. <a name="MAIL_SMTP_TIMEOUT">
  1538. <!-- -->
  1539. </a>
  1540. <ul class="blockList">
  1541. <li class="blockList">
  1542. <h4>MAIL_SMTP_TIMEOUT</h4>
  1543. <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>
  1544. public static final&nbsp;<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>
  1545. <div class="block"><span class="deprecatedLabel">Deprecated.</span>&nbsp;<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>
  1546. <dl>
  1547. <dt><span class="seeLabel">See Also:</span></dt>
  1548. <dd><a href="../../../../constant-values.html#org.apache.commons.mail.Email.MAIL_SMTP_TIMEOUT">Constant Field Values</a></dd>
  1549. </dl>
  1550. </li>
  1551. </ul>
  1552. <a name="message">
  1553. <!-- -->
  1554. </a>
  1555. <ul class="blockList">
  1556. <li class="blockList">
  1557. <h4>message</h4>
  1558. <pre>protected&nbsp;<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>
  1559. <div class="block">The email message to send.</div>
  1560. </li>
  1561. </ul>
  1562. <a name="charset">
  1563. <!-- -->
  1564. </a>
  1565. <ul class="blockList">
  1566. <li class="blockList">
  1567. <h4>charset</h4>
  1568. <pre>protected&nbsp;<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>
  1569. <div class="block">The charset to use for this message.</div>
  1570. </li>
  1571. </ul>
  1572. <a name="fromAddress">
  1573. <!-- -->
  1574. </a>
  1575. <ul class="blockList">
  1576. <li class="blockList">
  1577. <h4>fromAddress</h4>
  1578. <pre>protected&nbsp;<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>
  1579. <div class="block">The Address of the sending party, mandatory.</div>
  1580. </li>
  1581. </ul>
  1582. <a name="subject">
  1583. <!-- -->
  1584. </a>
  1585. <ul class="blockList">
  1586. <li class="blockList">
  1587. <h4>subject</h4>
  1588. <pre>protected&nbsp;<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>
  1589. <div class="block">The Subject.</div>
  1590. </li>
  1591. </ul>
  1592. <a name="emailBody">
  1593. <!-- -->
  1594. </a>
  1595. <ul class="blockList">
  1596. <li class="blockList">
  1597. <h4>emailBody</h4>
  1598. <pre>protected&nbsp;<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>
  1599. <div class="block">An attachment.</div>
  1600. </li>
  1601. </ul>
  1602. <a name="content">
  1603. <!-- -->
  1604. </a>
  1605. <ul class="blockList">
  1606. <li class="blockList">
  1607. <h4>content</h4>
  1608. <pre>protected&nbsp;<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>
  1609. <div class="block">The content.</div>
  1610. </li>
  1611. </ul>
  1612. <a name="contentType">
  1613. <!-- -->
  1614. </a>
  1615. <ul class="blockList">
  1616. <li class="blockList">
  1617. <h4>contentType</h4>
  1618. <pre>protected&nbsp;<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>
  1619. <div class="block">The content type.</div>
  1620. </li>
  1621. </ul>
  1622. <a name="debug">
  1623. <!-- -->
  1624. </a>
  1625. <ul class="blockList">
  1626. <li class="blockList">
  1627. <h4>debug</h4>
  1628. <pre>protected&nbsp;boolean debug</pre>
  1629. <div class="block">Set session debugging on or off.</div>
  1630. </li>
  1631. </ul>
  1632. <a name="sentDate">
  1633. <!-- -->
  1634. </a>
  1635. <ul class="blockList">
  1636. <li class="blockList">
  1637. <h4>sentDate</h4>
  1638. <pre>protected&nbsp;<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>
  1639. <div class="block">Sent date.</div>
  1640. </li>
  1641. </ul>
  1642. <a name="authenticator">
  1643. <!-- -->
  1644. </a>
  1645. <ul class="blockList">
  1646. <li class="blockList">
  1647. <h4>authenticator</h4>
  1648. <pre>protected&nbsp;<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>
  1649. <div class="block">Instance of an <code>Authenticator</code> object that will be used
  1650. when authentication is requested from the mail server.</div>
  1651. </li>
  1652. </ul>
  1653. <a name="hostName">
  1654. <!-- -->
  1655. </a>
  1656. <ul class="blockList">
  1657. <li class="blockList">
  1658. <h4>hostName</h4>
  1659. <pre>protected&nbsp;<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>
  1660. <div class="block">The hostname of the mail server with which to connect. If null will try
  1661. to get property from system.properties. If still null, quit.</div>
  1662. </li>
  1663. </ul>
  1664. <a name="smtpPort">
  1665. <!-- -->
  1666. </a>
  1667. <ul class="blockList">
  1668. <li class="blockList">
  1669. <h4>smtpPort</h4>
  1670. <pre>protected&nbsp;<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>
  1671. <div class="block">The port number of the mail server to connect to.
  1672. Defaults to the standard port ( 25 ).</div>
  1673. </li>
  1674. </ul>
  1675. <a name="sslSmtpPort">
  1676. <!-- -->
  1677. </a>
  1678. <ul class="blockList">
  1679. <li class="blockList">
  1680. <h4>sslSmtpPort</h4>
  1681. <pre>protected&nbsp;<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>
  1682. <div class="block">The port number of the SSL enabled SMTP server;
  1683. defaults to the standard port, 465.</div>
  1684. </li>
  1685. </ul>
  1686. <a name="toList">
  1687. <!-- -->
  1688. </a>
  1689. <ul class="blockList">
  1690. <li class="blockList">
  1691. <h4>toList</h4>
  1692. <pre>protected&nbsp;<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>&lt;<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>&gt; toList</pre>
  1693. <div class="block">List of "to" email addresses.</div>
  1694. </li>
  1695. </ul>
  1696. <a name="ccList">
  1697. <!-- -->
  1698. </a>
  1699. <ul class="blockList">
  1700. <li class="blockList">
  1701. <h4>ccList</h4>
  1702. <pre>protected&nbsp;<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>&lt;<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>&gt; ccList</pre>
  1703. <div class="block">List of "cc" email addresses.</div>
  1704. </li>
  1705. </ul>
  1706. <a name="bccList">
  1707. <!-- -->
  1708. </a>
  1709. <ul class="blockList">
  1710. <li class="blockList">
  1711. <h4>bccList</h4>
  1712. <pre>protected&nbsp;<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>&lt;<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>&gt; bccList</pre>
  1713. <div class="block">List of "bcc" email addresses.</div>
  1714. </li>
  1715. </ul>
  1716. <a name="replyList">
  1717. <!-- -->
  1718. </a>
  1719. <ul class="blockList">
  1720. <li class="blockList">
  1721. <h4>replyList</h4>
  1722. <pre>protected&nbsp;<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>&lt;<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>&gt; replyList</pre>
  1723. <div class="block">List of "replyTo" email addresses.</div>
  1724. </li>
  1725. </ul>
  1726. <a name="bounceAddress">
  1727. <!-- -->
  1728. </a>
  1729. <ul class="blockList">
  1730. <li class="blockList">
  1731. <h4>bounceAddress</h4>
  1732. <pre>protected&nbsp;<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>
  1733. <div class="block">Address to which undeliverable mail should be sent.
  1734. Because this is handled by JavaMail as a String property
  1735. in the mail session, this property is of type <code>String</code>
  1736. rather than <code>InternetAddress</code>.</div>
  1737. </li>
  1738. </ul>
  1739. <a name="headers">
  1740. <!-- -->
  1741. </a>
  1742. <ul class="blockList">
  1743. <li class="blockList">
  1744. <h4>headers</h4>
  1745. <pre>protected&nbsp;<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>&lt;<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>&gt; headers</pre>
  1746. <div class="block">Used to specify the mail headers. Example:
  1747. X-Mailer: Sendmail, X-Priority: 1( highest )
  1748. or 2( high ) 3( normal ) 4( low ) and 5( lowest )
  1749. Disposition-Notification-To: user@domain.net</div>
  1750. </li>
  1751. </ul>
  1752. <a name="popBeforeSmtp">
  1753. <!-- -->
  1754. </a>
  1755. <ul class="blockList">
  1756. <li class="blockList">
  1757. <h4>popBeforeSmtp</h4>
  1758. <pre>protected&nbsp;boolean popBeforeSmtp</pre>
  1759. <div class="block">Used to determine whether to use pop3 before smtp, and if so the settings.</div>
  1760. </li>
  1761. </ul>
  1762. <a name="popHost">
  1763. <!-- -->
  1764. </a>
  1765. <ul class="blockList">
  1766. <li class="blockList">
  1767. <h4>popHost</h4>
  1768. <pre>protected&nbsp;<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>
  1769. <div class="block">the host name of the pop3 server.</div>
  1770. </li>
  1771. </ul>
  1772. <a name="popUsername">
  1773. <!-- -->
  1774. </a>
  1775. <ul class="blockList">
  1776. <li class="blockList">
  1777. <h4>popUsername</h4>
  1778. <pre>protected&nbsp;<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>
  1779. <div class="block">the user name to log into the pop3 server.</div>
  1780. </li>
  1781. </ul>
  1782. <a name="popPassword">
  1783. <!-- -->
  1784. </a>
  1785. <ul class="blockList">
  1786. <li class="blockList">
  1787. <h4>popPassword</h4>
  1788. <pre>protected&nbsp;<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>
  1789. <div class="block">the password to log into the pop3 server.</div>
  1790. </li>
  1791. </ul>
  1792. <a name="tls">
  1793. <!-- -->
  1794. </a>
  1795. <ul class="blockList">
  1796. <li class="blockList">
  1797. <h4>tls</h4>
  1798. <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>
  1799. protected&nbsp;boolean tls</pre>
  1800. <div class="block"><span class="deprecatedLabel">Deprecated.</span>&nbsp;<span class="deprecationComment">since 1.3, use setStartTLSEnabled() instead</span></div>
  1801. <div class="block">Does server require TLS encryption for authentication?</div>
  1802. </li>
  1803. </ul>
  1804. <a name="ssl">
  1805. <!-- -->
  1806. </a>
  1807. <ul class="blockList">
  1808. <li class="blockList">
  1809. <h4>ssl</h4>
  1810. <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>
  1811. protected&nbsp;boolean ssl</pre>
  1812. <div class="block"><span class="deprecatedLabel">Deprecated.</span>&nbsp;<span class="deprecationComment">since 1.3, use setSSLOnConnect() instead</span></div>
  1813. <div class="block">Does the current transport use SSL/TLS encryption upon connection?</div>
  1814. </li>
  1815. </ul>
  1816. <a name="socketTimeout">
  1817. <!-- -->
  1818. </a>
  1819. <ul class="blockList">
  1820. <li class="blockList">
  1821. <h4>socketTimeout</h4>
  1822. <pre>protected&nbsp;int socketTimeout</pre>
  1823. <div class="block">socket I/O timeout value in milliseconds.</div>
  1824. </li>
  1825. </ul>
  1826. <a name="socketConnectionTimeout">
  1827. <!-- -->
  1828. </a>
  1829. <ul class="blockListLast">
  1830. <li class="blockList">
  1831. <h4>socketConnectionTimeout</h4>
  1832. <pre>protected&nbsp;int socketConnectionTimeout</pre>
  1833. <div class="block">socket connection timeout value in milliseconds.</div>
  1834. </li>
  1835. </ul>
  1836. </li>
  1837. </ul>
  1838. <!-- ========= CONSTRUCTOR DETAIL ======== -->
  1839. <ul class="blockList">
  1840. <li class="blockList"><a name="constructor.detail">
  1841. <!-- -->
  1842. </a>
  1843. <h3>Constructor Detail</h3>
  1844. <a name="Email--">
  1845. <!-- -->
  1846. </a>
  1847. <ul class="blockListLast">
  1848. <li class="blockList">
  1849. <h4>Email</h4>
  1850. <pre>public&nbsp;Email()</pre>
  1851. </li>
  1852. </ul>
  1853. </li>
  1854. </ul>
  1855. <!-- ============ METHOD DETAIL ========== -->
  1856. <ul class="blockList">
  1857. <li class="blockList"><a name="method.detail">
  1858. <!-- -->
  1859. </a>
  1860. <h3>Method Detail</h3>
  1861. <a name="setDebug-boolean-">
  1862. <!-- -->
  1863. </a>
  1864. <ul class="blockList">
  1865. <li class="blockList">
  1866. <h4>setDebug</h4>
  1867. <pre>public&nbsp;void&nbsp;setDebug(boolean&nbsp;d)</pre>
  1868. <div class="block">Setting to true will enable the display of debug information.</div>
  1869. <dl>
  1870. <dt><span class="paramLabel">Parameters:</span></dt>
  1871. <dd><code>d</code> - A boolean.</dd>
  1872. <dt><span class="simpleTagLabel">Since:</span></dt>
  1873. <dd>1.0</dd>
  1874. </dl>
  1875. </li>
  1876. </ul>
  1877. <a name="setAuthentication-java.lang.String-java.lang.String-">
  1878. <!-- -->
  1879. </a>
  1880. <ul class="blockList">
  1881. <li class="blockList">
  1882. <h4>setAuthentication</h4>
  1883. <pre>public&nbsp;void&nbsp;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>&nbsp;userName,
  1884. <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>&nbsp;password)</pre>
  1885. <div class="block">Sets the userName and password if authentication is needed. If this
  1886. method is not used, no authentication will be performed.
  1887. <p>
  1888. This method will create a new instance of
  1889. <code>DefaultAuthenticator</code> using the supplied parameters.</div>
  1890. <dl>
  1891. <dt><span class="paramLabel">Parameters:</span></dt>
  1892. <dd><code>userName</code> - User name for the SMTP server</dd>
  1893. <dd><code>password</code> - password for the SMTP server</dd>
  1894. <dt><span class="simpleTagLabel">Since:</span></dt>
  1895. <dd>1.0</dd>
  1896. <dt><span class="seeLabel">See Also:</span></dt>
  1897. <dd><a href="../../../../org/apache/commons/mail/DefaultAuthenticator.html" title="class in org.apache.commons.mail"><code>DefaultAuthenticator</code></a>,
  1898. <a href="../../../../org/apache/commons/mail/Email.html#setAuthenticator-javax.mail.Authenticator-"><code>setAuthenticator(javax.mail.Authenticator)</code></a></dd>
  1899. </dl>
  1900. </li>
  1901. </ul>
  1902. <a name="setAuthenticator-javax.mail.Authenticator-">
  1903. <!-- -->
  1904. </a>
  1905. <ul class="blockList">
  1906. <li class="blockList">
  1907. <h4>setAuthenticator</h4>
  1908. <pre>public&nbsp;void&nbsp;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>&nbsp;newAuthenticator)</pre>
  1909. <div class="block">Sets the <code>Authenticator</code> to be used when authentication
  1910. is requested from the mail server.
  1911. <p>
  1912. This method should be used when your outgoing mail server requires
  1913. authentication. Your mail server must also support RFC2554.</div>
  1914. <dl>
  1915. <dt><span class="paramLabel">Parameters:</span></dt>
  1916. <dd><code>newAuthenticator</code> - the <code>Authenticator</code> object.</dd>
  1917. <dt><span class="simpleTagLabel">Since:</span></dt>
  1918. <dd>1.0</dd>
  1919. <dt><span class="seeLabel">See Also:</span></dt>
  1920. <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>
  1921. </dl>
  1922. </li>
  1923. </ul>
  1924. <a name="setCharset-java.lang.String-">
  1925. <!-- -->
  1926. </a>
  1927. <ul class="blockList">
  1928. <li class="blockList">
  1929. <h4>setCharset</h4>
  1930. <pre>public&nbsp;void&nbsp;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>&nbsp;newCharset)</pre>
  1931. <div class="block">Set the charset of the message. Please note that you should set the charset before
  1932. adding the message content.</div>
  1933. <dl>
  1934. <dt><span class="paramLabel">Parameters:</span></dt>
  1935. <dd><code>newCharset</code> - A String.</dd>
  1936. <dt><span class="throwsLabel">Throws:</span></dt>
  1937. <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>
  1938. <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
  1939. exists in the current JVM</dd>
  1940. <dt><span class="simpleTagLabel">Since:</span></dt>
  1941. <dd>1.0</dd>
  1942. </dl>
  1943. </li>
  1944. </ul>
  1945. <a name="setContent-javax.mail.internet.MimeMultipart-">
  1946. <!-- -->
  1947. </a>
  1948. <ul class="blockList">
  1949. <li class="blockList">
  1950. <h4>setContent</h4>
  1951. <pre>public&nbsp;void&nbsp;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>&nbsp;aMimeMultipart)</pre>
  1952. <div class="block">Set the emailBody to a MimeMultiPart</div>
  1953. <dl>
  1954. <dt><span class="paramLabel">Parameters:</span></dt>
  1955. <dd><code>aMimeMultipart</code> - aMimeMultipart</dd>
  1956. <dt><span class="simpleTagLabel">Since:</span></dt>
  1957. <dd>1.0</dd>
  1958. </dl>
  1959. </li>
  1960. </ul>
  1961. <a name="setContent-java.lang.Object-java.lang.String-">
  1962. <!-- -->
  1963. </a>
  1964. <ul class="blockList">
  1965. <li class="blockList">
  1966. <h4>setContent</h4>
  1967. <pre>public&nbsp;void&nbsp;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>&nbsp;aObject,
  1968. <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>&nbsp;aContentType)</pre>
  1969. <div class="block">Set the content and contentType.</div>
  1970. <dl>
  1971. <dt><span class="paramLabel">Parameters:</span></dt>
  1972. <dd><code>aObject</code> - aObject</dd>
  1973. <dd><code>aContentType</code> - aContentType</dd>
  1974. <dt><span class="simpleTagLabel">Since:</span></dt>
  1975. <dd>1.0</dd>
  1976. </dl>
  1977. </li>
  1978. </ul>
  1979. <a name="updateContentType-java.lang.String-">
  1980. <!-- -->
  1981. </a>
  1982. <ul class="blockList">
  1983. <li class="blockList">
  1984. <h4>updateContentType</h4>
  1985. <pre>public&nbsp;void&nbsp;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>&nbsp;aContentType)</pre>
  1986. <div class="block">Update the contentType.</div>
  1987. <dl>
  1988. <dt><span class="paramLabel">Parameters:</span></dt>
  1989. <dd><code>aContentType</code> - aContentType</dd>
  1990. <dt><span class="simpleTagLabel">Since:</span></dt>
  1991. <dd>1.2</dd>
  1992. </dl>
  1993. </li>
  1994. </ul>
  1995. <a name="setHostName-java.lang.String-">
  1996. <!-- -->
  1997. </a>
  1998. <ul class="blockList">
  1999. <li class="blockList">
  2000. <h4>setHostName</h4>
  2001. <pre>public&nbsp;void&nbsp;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>&nbsp;aHostName)</pre>
  2002. <div class="block">Set the hostname of the outgoing mail server.</div>
  2003. <dl>
  2004. <dt><span class="paramLabel">Parameters:</span></dt>
  2005. <dd><code>aHostName</code> - aHostName</dd>
  2006. <dt><span class="throwsLabel">Throws:</span></dt>
  2007. <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>
  2008. <dt><span class="simpleTagLabel">Since:</span></dt>
  2009. <dd>1.0</dd>
  2010. </dl>
  2011. </li>
  2012. </ul>
  2013. <a name="setTLS-boolean-">
  2014. <!-- -->
  2015. </a>
  2016. <ul class="blockList">
  2017. <li class="blockList">
  2018. <h4>setTLS</h4>
  2019. <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>
  2020. public&nbsp;void&nbsp;setTLS(boolean&nbsp;withTLS)</pre>
  2021. <div class="block"><span class="deprecatedLabel">Deprecated.</span>&nbsp;<span class="deprecationComment">since 1.3, use setStartTLSEnabled() instead</span></div>
  2022. <div class="block">Set or disable the STARTTLS encryption. Please see EMAIL-105
  2023. for the reasons of deprecation.</div>
  2024. <dl>
  2025. <dt><span class="paramLabel">Parameters:</span></dt>
  2026. <dd><code>withTLS</code> - true if STARTTLS requested, false otherwise</dd>
  2027. <dt><span class="simpleTagLabel">Since:</span></dt>
  2028. <dd>1.1</dd>
  2029. </dl>
  2030. </li>
  2031. </ul>
  2032. <a name="setStartTLSEnabled-boolean-">
  2033. <!-- -->
  2034. </a>
  2035. <ul class="blockList">
  2036. <li class="blockList">
  2037. <h4>setStartTLSEnabled</h4>
  2038. <pre>public&nbsp;<a href="../../../../org/apache/commons/mail/Email.html" title="class in org.apache.commons.mail">Email</a>&nbsp;setStartTLSEnabled(boolean&nbsp;startTlsEnabled)</pre>
  2039. <div class="block">Set or disable the STARTTLS encryption.</div>
  2040. <dl>
  2041. <dt><span class="paramLabel">Parameters:</span></dt>
  2042. <dd><code>startTlsEnabled</code> - true if STARTTLS requested, false otherwise</dd>
  2043. <dt><span class="returnLabel">Returns:</span></dt>
  2044. <dd>An Email.</dd>
  2045. <dt><span class="throwsLabel">Throws:</span></dt>
  2046. <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>
  2047. <dt><span class="simpleTagLabel">Since:</span></dt>
  2048. <dd>1.3</dd>
  2049. </dl>
  2050. </li>
  2051. </ul>
  2052. <a name="setStartTLSRequired-boolean-">
  2053. <!-- -->
  2054. </a>
  2055. <ul class="blockList">
  2056. <li class="blockList">
  2057. <h4>setStartTLSRequired</h4>
  2058. <pre>public&nbsp;<a href="../../../../org/apache/commons/mail/Email.html" title="class in org.apache.commons.mail">Email</a>&nbsp;setStartTLSRequired(boolean&nbsp;startTlsRequired)</pre>
  2059. <div class="block">Set or disable the required STARTTLS encryption.
  2060. <p>
  2061. 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>
  2062. <dl>
  2063. <dt><span class="paramLabel">Parameters:</span></dt>
  2064. <dd><code>startTlsRequired</code> - true if STARTTLS requested, false otherwise</dd>
  2065. <dt><span class="returnLabel">Returns:</span></dt>
  2066. <dd>An Email.</dd>
  2067. <dt><span class="throwsLabel">Throws:</span></dt>
  2068. <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>
  2069. <dt><span class="simpleTagLabel">Since:</span></dt>
  2070. <dd>1.3</dd>
  2071. </dl>
  2072. </li>
  2073. </ul>
  2074. <a name="setSmtpPort-int-">
  2075. <!-- -->
  2076. </a>
  2077. <ul class="blockList">
  2078. <li class="blockList">
  2079. <h4>setSmtpPort</h4>
  2080. <pre>public&nbsp;void&nbsp;setSmtpPort(int&nbsp;aPortNumber)</pre>
  2081. <div class="block">Set the non-SSL port number of the outgoing mail server.</div>
  2082. <dl>
  2083. <dt><span class="paramLabel">Parameters:</span></dt>
  2084. <dd><code>aPortNumber</code> - aPortNumber</dd>
  2085. <dt><span class="throwsLabel">Throws:</span></dt>
  2086. <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 &lt; 1</dd>
  2087. <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>
  2088. <dt><span class="simpleTagLabel">Since:</span></dt>
  2089. <dd>1.0</dd>
  2090. <dt><span class="seeLabel">See Also:</span></dt>
  2091. <dd><a href="../../../../org/apache/commons/mail/Email.html#setSslSmtpPort-java.lang.String-"><code>setSslSmtpPort(String)</code></a></dd>
  2092. </dl>
  2093. </li>
  2094. </ul>
  2095. <a name="setMailSession-javax.mail.Session-">
  2096. <!-- -->
  2097. </a>
  2098. <ul class="blockList">
  2099. <li class="blockList">
  2100. <h4>setMailSession</h4>
  2101. <pre>public&nbsp;void&nbsp;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>&nbsp;aSession)</pre>
  2102. <div class="block">Supply a mail Session object to use. Please note that passing
  2103. a user name and password (in the case of mail authentication) will
  2104. create a new mail session with a DefaultAuthenticator. This is a
  2105. convenience but might come unexpected.
  2106. If mail authentication is used but NO username and password
  2107. is supplied the implementation assumes that you have set a
  2108. authenticator and will use the existing mail session (as expected).</div>
  2109. <dl>
  2110. <dt><span class="paramLabel">Parameters:</span></dt>
  2111. <dd><code>aSession</code> - mail session to be used</dd>
  2112. <dt><span class="throwsLabel">Throws:</span></dt>
  2113. <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>
  2114. <dt><span class="simpleTagLabel">Since:</span></dt>
  2115. <dd>1.0</dd>
  2116. </dl>
  2117. </li>
  2118. </ul>
  2119. <a name="setMailSessionFromJNDI-java.lang.String-">
  2120. <!-- -->
  2121. </a>
  2122. <ul class="blockList">
  2123. <li class="blockList">
  2124. <h4>setMailSessionFromJNDI</h4>
  2125. <pre>public&nbsp;void&nbsp;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>&nbsp;jndiName)
  2126. 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>
  2127. <div class="block">Supply a mail Session object from a JNDI directory.</div>
  2128. <dl>
  2129. <dt><span class="paramLabel">Parameters:</span></dt>
  2130. <dd><code>jndiName</code> - name of JNDI resource (javax.mail.Session type), resource
  2131. if searched in java:comp/env if name does not start with "java:"</dd>
  2132. <dt><span class="throwsLabel">Throws:</span></dt>
  2133. <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>
  2134. <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>
  2135. <dt><span class="simpleTagLabel">Since:</span></dt>
  2136. <dd>1.1</dd>
  2137. </dl>
  2138. </li>
  2139. </ul>
  2140. <a name="getMailSession--">
  2141. <!-- -->
  2142. </a>
  2143. <ul class="blockList">
  2144. <li class="blockList">
  2145. <h4>getMailSession</h4>
  2146. <pre>public&nbsp;<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>&nbsp;getMailSession()
  2147. throws <a href="../../../../org/apache/commons/mail/EmailException.html" title="class in org.apache.commons.mail">EmailException</a></pre>
  2148. <div class="block">Determines the mail session used when sending this Email, creating
  2149. the Session if necessary. When a mail session is already
  2150. initialized setting the session related properties will cause
  2151. an IllegalStateException.</div>
  2152. <dl>
  2153. <dt><span class="returnLabel">Returns:</span></dt>
  2154. <dd>A Session.</dd>
  2155. <dt><span class="throwsLabel">Throws:</span></dt>
  2156. <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>
  2157. <dt><span class="simpleTagLabel">Since:</span></dt>
  2158. <dd>1.0</dd>
  2159. </dl>
  2160. </li>
  2161. </ul>
  2162. <a name="setFrom-java.lang.String-">
  2163. <!-- -->
  2164. </a>
  2165. <ul class="blockList">
  2166. <li class="blockList">
  2167. <h4>setFrom</h4>
  2168. <pre>public&nbsp;<a href="../../../../org/apache/commons/mail/Email.html" title="class in org.apache.commons.mail">Email</a>&nbsp;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>&nbsp;email)
  2169. throws <a href="../../../../org/apache/commons/mail/EmailException.html" title="class in org.apache.commons.mail">EmailException</a></pre>
  2170. <div class="block">Set the FROM field of the email to use the specified address. The email
  2171. address will also be used as the personal name.
  2172. 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>.
  2173. If it is not set, it will be encoded using
  2174. the Java platform's default charset (UTF-16) if it contains
  2175. non-ASCII characters; otherwise, it is used as is.</div>
  2176. <dl>
  2177. <dt><span class="paramLabel">Parameters:</span></dt>
  2178. <dd><code>email</code> - A String.</dd>
  2179. <dt><span class="returnLabel">Returns:</span></dt>
  2180. <dd>An Email.</dd>
  2181. <dt><span class="throwsLabel">Throws:</span></dt>
  2182. <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>
  2183. <dt><span class="simpleTagLabel">Since:</span></dt>
  2184. <dd>1.0</dd>
  2185. </dl>
  2186. </li>
  2187. </ul>
  2188. <a name="setFrom-java.lang.String-java.lang.String-">
  2189. <!-- -->
  2190. </a>
  2191. <ul class="blockList">
  2192. <li class="blockList">
  2193. <h4>setFrom</h4>
  2194. <pre>public&nbsp;<a href="../../../../org/apache/commons/mail/Email.html" title="class in org.apache.commons.mail">Email</a>&nbsp;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>&nbsp;email,
  2195. <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>&nbsp;name)
  2196. throws <a href="../../../../org/apache/commons/mail/EmailException.html" title="class in org.apache.commons.mail">EmailException</a></pre>
  2197. <div class="block">Set the FROM field of the email to use the specified address and the
  2198. specified personal name.
  2199. 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>.
  2200. If it is not set, it will be encoded using
  2201. the Java platform's default charset (UTF-16) if it contains
  2202. non-ASCII characters; otherwise, it is used as is.</div>
  2203. <dl>
  2204. <dt><span class="paramLabel">Parameters:</span></dt>
  2205. <dd><code>email</code> - A String.</dd>
  2206. <dd><code>name</code> - A String.</dd>
  2207. <dt><span class="returnLabel">Returns:</span></dt>
  2208. <dd>An Email.</dd>
  2209. <dt><span class="throwsLabel">Throws:</span></dt>
  2210. <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>
  2211. <dt><span class="simpleTagLabel">Since:</span></dt>
  2212. <dd>1.0</dd>
  2213. </dl>
  2214. </li>
  2215. </ul>
  2216. <a name="setFrom-java.lang.String-java.lang.String-java.lang.String-">
  2217. <!-- -->
  2218. </a>
  2219. <ul class="blockList">
  2220. <li class="blockList">
  2221. <h4>setFrom</h4>
  2222. <pre>public&nbsp;<a href="../../../../org/apache/commons/mail/Email.html" title="class in org.apache.commons.mail">Email</a>&nbsp;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>&nbsp;email,
  2223. <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>&nbsp;name,
  2224. <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>&nbsp;charset)
  2225. throws <a href="../../../../org/apache/commons/mail/EmailException.html" title="class in org.apache.commons.mail">EmailException</a></pre>
  2226. <div class="block">Set the FROM field of the email to use the specified address, personal
  2227. name, and charset encoding for the name.</div>
  2228. <dl>
  2229. <dt><span class="paramLabel">Parameters:</span></dt>
  2230. <dd><code>email</code> - A String.</dd>
  2231. <dd><code>name</code> - A String.</dd>
  2232. <dd><code>charset</code> - The charset to encode the name with.</dd>
  2233. <dt><span class="returnLabel">Returns:</span></dt>
  2234. <dd>An Email.</dd>
  2235. <dt><span class="throwsLabel">Throws:</span></dt>
  2236. <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>
  2237. <dt><span class="simpleTagLabel">Since:</span></dt>
  2238. <dd>1.1</dd>
  2239. </dl>
  2240. </li>
  2241. </ul>
  2242. <a name="addTo-java.lang.String-">
  2243. <!-- -->
  2244. </a>
  2245. <ul class="blockList">
  2246. <li class="blockList">
  2247. <h4>addTo</h4>
  2248. <pre>public&nbsp;<a href="../../../../org/apache/commons/mail/Email.html" title="class in org.apache.commons.mail">Email</a>&nbsp;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>&nbsp;email)
  2249. throws <a href="../../../../org/apache/commons/mail/EmailException.html" title="class in org.apache.commons.mail">EmailException</a></pre>
  2250. <div class="block">Add a recipient TO to the email. The email
  2251. address will also be used as the personal name.
  2252. The name will be encoded by the charset of
  2253. <a href="../../../../org/apache/commons/mail/Email.html#setCharset-java.lang.String-"><code>setCharset()</code></a>.
  2254. If it is not set, it will be encoded using
  2255. the Java platform's default charset (UTF-16) if it contains
  2256. non-ASCII characters; otherwise, it is used as is.</div>
  2257. <dl>
  2258. <dt><span class="paramLabel">Parameters:</span></dt>
  2259. <dd><code>email</code> - A String.</dd>
  2260. <dt><span class="returnLabel">Returns:</span></dt>
  2261. <dd>An Email.</dd>
  2262. <dt><span class="throwsLabel">Throws:</span></dt>
  2263. <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>
  2264. <dt><span class="simpleTagLabel">Since:</span></dt>
  2265. <dd>1.0</dd>
  2266. </dl>
  2267. </li>
  2268. </ul>
  2269. <a name="addTo-java.lang.String...-">
  2270. <!-- -->
  2271. </a>
  2272. <ul class="blockList">
  2273. <li class="blockList">
  2274. <h4>addTo</h4>
  2275. <pre>public&nbsp;<a href="../../../../org/apache/commons/mail/Email.html" title="class in org.apache.commons.mail">Email</a>&nbsp;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>...&nbsp;emails)
  2276. throws <a href="../../../../org/apache/commons/mail/EmailException.html" title="class in org.apache.commons.mail">EmailException</a></pre>
  2277. <div class="block">Add a list of TO recipients to the email. The email
  2278. addresses will also be used as the personal names.
  2279. The names will be encoded by the charset of
  2280. <a href="../../../../org/apache/commons/mail/Email.html#setCharset-java.lang.String-"><code>setCharset()</code></a>.
  2281. If it is not set, it will be encoded using
  2282. the Java platform's default charset (UTF-16) if it contains
  2283. non-ASCII characters; otherwise, it is used as is.</div>
  2284. <dl>
  2285. <dt><span class="paramLabel">Parameters:</span></dt>
  2286. <dd><code>emails</code> - A String array.</dd>
  2287. <dt><span class="returnLabel">Returns:</span></dt>
  2288. <dd>An Email.</dd>
  2289. <dt><span class="throwsLabel">Throws:</span></dt>
  2290. <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>
  2291. <dt><span class="simpleTagLabel">Since:</span></dt>
  2292. <dd>1.3</dd>
  2293. </dl>
  2294. </li>
  2295. </ul>
  2296. <a name="addTo-java.lang.String-java.lang.String-">
  2297. <!-- -->
  2298. </a>
  2299. <ul class="blockList">
  2300. <li class="blockList">
  2301. <h4>addTo</h4>
  2302. <pre>public&nbsp;<a href="../../../../org/apache/commons/mail/Email.html" title="class in org.apache.commons.mail">Email</a>&nbsp;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>&nbsp;email,
  2303. <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>&nbsp;name)
  2304. throws <a href="../../../../org/apache/commons/mail/EmailException.html" title="class in org.apache.commons.mail">EmailException</a></pre>
  2305. <div class="block">Add a recipient TO to the email using the specified address and the
  2306. specified personal name.
  2307. The name will be encoded by the charset of
  2308. <a href="../../../../org/apache/commons/mail/Email.html#setCharset-java.lang.String-"><code>setCharset()</code></a>.
  2309. If it is not set, it will be encoded using
  2310. the Java platform's default charset (UTF-16) if it contains
  2311. non-ASCII characters; otherwise, it is used as is.</div>
  2312. <dl>
  2313. <dt><span class="paramLabel">Parameters:</span></dt>
  2314. <dd><code>email</code> - A String.</dd>
  2315. <dd><code>name</code> - A String.</dd>
  2316. <dt><span class="returnLabel">Returns:</span></dt>
  2317. <dd>An Email.</dd>
  2318. <dt><span class="throwsLabel">Throws:</span></dt>
  2319. <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>
  2320. <dt><span class="simpleTagLabel">Since:</span></dt>
  2321. <dd>1.0</dd>
  2322. </dl>
  2323. </li>
  2324. </ul>
  2325. <a name="addTo-java.lang.String-java.lang.String-java.lang.String-">
  2326. <!-- -->
  2327. </a>
  2328. <ul class="blockList">
  2329. <li class="blockList">
  2330. <h4>addTo</h4>
  2331. <pre>public&nbsp;<a href="../../../../org/apache/commons/mail/Email.html" title="class in org.apache.commons.mail">Email</a>&nbsp;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>&nbsp;email,
  2332. <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>&nbsp;name,
  2333. <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>&nbsp;charset)
  2334. throws <a href="../../../../org/apache/commons/mail/EmailException.html" title="class in org.apache.commons.mail">EmailException</a></pre>
  2335. <div class="block">Add a recipient TO to the email using the specified address, personal
  2336. name, and charset encoding for the name.</div>
  2337. <dl>
  2338. <dt><span class="paramLabel">Parameters:</span></dt>
  2339. <dd><code>email</code> - A String.</dd>
  2340. <dd><code>name</code> - A String.</dd>
  2341. <dd><code>charset</code> - The charset to encode the name with.</dd>
  2342. <dt><span class="returnLabel">Returns:</span></dt>
  2343. <dd>An Email.</dd>
  2344. <dt><span class="throwsLabel">Throws:</span></dt>
  2345. <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>
  2346. <dt><span class="simpleTagLabel">Since:</span></dt>
  2347. <dd>1.1</dd>
  2348. </dl>
  2349. </li>
  2350. </ul>
  2351. <a name="setTo-java.util.Collection-">
  2352. <!-- -->
  2353. </a>
  2354. <ul class="blockList">
  2355. <li class="blockList">
  2356. <h4>setTo</h4>
  2357. <pre>public&nbsp;<a href="../../../../org/apache/commons/mail/Email.html" title="class in org.apache.commons.mail">Email</a>&nbsp;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>&lt;<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>&gt;&nbsp;aCollection)
  2358. throws <a href="../../../../org/apache/commons/mail/EmailException.html" title="class in org.apache.commons.mail">EmailException</a></pre>
  2359. <div class="block">Set a list of "TO" addresses. All elements in the specified
  2360. <code>Collection</code> are expected to be of type
  2361. <code>java.mail.internet.InternetAddress</code>.</div>
  2362. <dl>
  2363. <dt><span class="paramLabel">Parameters:</span></dt>
  2364. <dd><code>aCollection</code> - collection of <code>InternetAddress</code> objects.</dd>
  2365. <dt><span class="returnLabel">Returns:</span></dt>
  2366. <dd>An Email.</dd>
  2367. <dt><span class="throwsLabel">Throws:</span></dt>
  2368. <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>
  2369. <dt><span class="simpleTagLabel">Since:</span></dt>
  2370. <dd>1.0</dd>
  2371. <dt><span class="seeLabel">See Also:</span></dt>
  2372. <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>
  2373. </dl>
  2374. </li>
  2375. </ul>
  2376. <a name="addCc-java.lang.String-">
  2377. <!-- -->
  2378. </a>
  2379. <ul class="blockList">
  2380. <li class="blockList">
  2381. <h4>addCc</h4>
  2382. <pre>public&nbsp;<a href="../../../../org/apache/commons/mail/Email.html" title="class in org.apache.commons.mail">Email</a>&nbsp;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>&nbsp;email)
  2383. throws <a href="../../../../org/apache/commons/mail/EmailException.html" title="class in org.apache.commons.mail">EmailException</a></pre>
  2384. <div class="block">Add a recipient CC to the email. The email
  2385. address will also be used as the personal name.
  2386. 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>.
  2387. If it is not set, it will be encoded using
  2388. the Java platform's default charset (UTF-16) if it contains
  2389. non-ASCII characters; otherwise, it is used as is.</div>
  2390. <dl>
  2391. <dt><span class="paramLabel">Parameters:</span></dt>
  2392. <dd><code>email</code> - A String.</dd>
  2393. <dt><span class="returnLabel">Returns:</span></dt>
  2394. <dd>An Email.</dd>
  2395. <dt><span class="throwsLabel">Throws:</span></dt>
  2396. <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>
  2397. <dt><span class="simpleTagLabel">Since:</span></dt>
  2398. <dd>1.0</dd>
  2399. </dl>
  2400. </li>
  2401. </ul>
  2402. <a name="addCc-java.lang.String...-">
  2403. <!-- -->
  2404. </a>
  2405. <ul class="blockList">
  2406. <li class="blockList">
  2407. <h4>addCc</h4>
  2408. <pre>public&nbsp;<a href="../../../../org/apache/commons/mail/Email.html" title="class in org.apache.commons.mail">Email</a>&nbsp;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>...&nbsp;emails)
  2409. throws <a href="../../../../org/apache/commons/mail/EmailException.html" title="class in org.apache.commons.mail">EmailException</a></pre>
  2410. <div class="block">Add an array of CC recipients to the email. The email
  2411. addresses will also be used as the personal name.
  2412. The names will be encoded by the charset of
  2413. <a href="../../../../org/apache/commons/mail/Email.html#setCharset-java.lang.String-"><code>setCharset()</code></a>.
  2414. If it is not set, it will be encoded using
  2415. the Java platform's default charset (UTF-16) if it contains
  2416. non-ASCII characters; otherwise, it is used as is.</div>
  2417. <dl>
  2418. <dt><span class="paramLabel">Parameters:</span></dt>
  2419. <dd><code>emails</code> - A String array.</dd>
  2420. <dt><span class="returnLabel">Returns:</span></dt>
  2421. <dd>An Email.</dd>
  2422. <dt><span class="throwsLabel">Throws:</span></dt>
  2423. <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>
  2424. <dt><span class="simpleTagLabel">Since:</span></dt>
  2425. <dd>1.3</dd>
  2426. </dl>
  2427. </li>
  2428. </ul>
  2429. <a name="addCc-java.lang.String-java.lang.String-">
  2430. <!-- -->
  2431. </a>
  2432. <ul class="blockList">
  2433. <li class="blockList">
  2434. <h4>addCc</h4>
  2435. <pre>public&nbsp;<a href="../../../../org/apache/commons/mail/Email.html" title="class in org.apache.commons.mail">Email</a>&nbsp;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>&nbsp;email,
  2436. <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>&nbsp;name)
  2437. throws <a href="../../../../org/apache/commons/mail/EmailException.html" title="class in org.apache.commons.mail">EmailException</a></pre>
  2438. <div class="block">Add a recipient CC to the email using the specified address and the
  2439. specified personal name.
  2440. 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>.
  2441. If it is not set, it will be encoded using
  2442. the Java platform's default charset (UTF-16) if it contains
  2443. non-ASCII characters; otherwise, it is used as is.</div>
  2444. <dl>
  2445. <dt><span class="paramLabel">Parameters:</span></dt>
  2446. <dd><code>email</code> - A String.</dd>
  2447. <dd><code>name</code> - A String.</dd>
  2448. <dt><span class="returnLabel">Returns:</span></dt>
  2449. <dd>An Email.</dd>
  2450. <dt><span class="throwsLabel">Throws:</span></dt>
  2451. <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>
  2452. <dt><span class="simpleTagLabel">Since:</span></dt>
  2453. <dd>1.0</dd>
  2454. </dl>
  2455. </li>
  2456. </ul>
  2457. <a name="addCc-java.lang.String-java.lang.String-java.lang.String-">
  2458. <!-- -->
  2459. </a>
  2460. <ul class="blockList">
  2461. <li class="blockList">
  2462. <h4>addCc</h4>
  2463. <pre>public&nbsp;<a href="../../../../org/apache/commons/mail/Email.html" title="class in org.apache.commons.mail">Email</a>&nbsp;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>&nbsp;email,
  2464. <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>&nbsp;name,
  2465. <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>&nbsp;charset)
  2466. throws <a href="../../../../org/apache/commons/mail/EmailException.html" title="class in org.apache.commons.mail">EmailException</a></pre>
  2467. <div class="block">Add a recipient CC to the email using the specified address, personal
  2468. name, and charset encoding for the name.</div>
  2469. <dl>
  2470. <dt><span class="paramLabel">Parameters:</span></dt>
  2471. <dd><code>email</code> - A String.</dd>
  2472. <dd><code>name</code> - A String.</dd>
  2473. <dd><code>charset</code> - The charset to encode the name with.</dd>
  2474. <dt><span class="returnLabel">Returns:</span></dt>
  2475. <dd>An Email.</dd>
  2476. <dt><span class="throwsLabel">Throws:</span></dt>
  2477. <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>
  2478. <dt><span class="simpleTagLabel">Since:</span></dt>
  2479. <dd>1.1</dd>
  2480. </dl>
  2481. </li>
  2482. </ul>
  2483. <a name="setCc-java.util.Collection-">
  2484. <!-- -->
  2485. </a>
  2486. <ul class="blockList">
  2487. <li class="blockList">
  2488. <h4>setCc</h4>
  2489. <pre>public&nbsp;<a href="../../../../org/apache/commons/mail/Email.html" title="class in org.apache.commons.mail">Email</a>&nbsp;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>&lt;<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>&gt;&nbsp;aCollection)
  2490. throws <a href="../../../../org/apache/commons/mail/EmailException.html" title="class in org.apache.commons.mail">EmailException</a></pre>
  2491. <div class="block">Set a list of "CC" addresses. All elements in the specified
  2492. <code>Collection</code> are expected to be of type
  2493. <code>java.mail.internet.InternetAddress</code>.</div>
  2494. <dl>
  2495. <dt><span class="paramLabel">Parameters:</span></dt>
  2496. <dd><code>aCollection</code> - collection of <code>InternetAddress</code> objects.</dd>
  2497. <dt><span class="returnLabel">Returns:</span></dt>
  2498. <dd>An Email.</dd>
  2499. <dt><span class="throwsLabel">Throws:</span></dt>
  2500. <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>
  2501. <dt><span class="simpleTagLabel">Since:</span></dt>
  2502. <dd>1.0</dd>
  2503. <dt><span class="seeLabel">See Also:</span></dt>
  2504. <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>
  2505. </dl>
  2506. </li>
  2507. </ul>
  2508. <a name="addBcc-java.lang.String-">
  2509. <!-- -->
  2510. </a>
  2511. <ul class="blockList">
  2512. <li class="blockList">
  2513. <h4>addBcc</h4>
  2514. <pre>public&nbsp;<a href="../../../../org/apache/commons/mail/Email.html" title="class in org.apache.commons.mail">Email</a>&nbsp;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>&nbsp;email)
  2515. throws <a href="../../../../org/apache/commons/mail/EmailException.html" title="class in org.apache.commons.mail">EmailException</a></pre>
  2516. <div class="block">Add a blind BCC recipient to the email. The email
  2517. address will also be used as the personal name.
  2518. 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>.
  2519. If it is not set, it will be encoded using
  2520. the Java platform's default charset (UTF-16) if it contains
  2521. non-ASCII characters; otherwise, it is used as is.</div>
  2522. <dl>
  2523. <dt><span class="paramLabel">Parameters:</span></dt>
  2524. <dd><code>email</code> - A String.</dd>
  2525. <dt><span class="returnLabel">Returns:</span></dt>
  2526. <dd>An Email.</dd>
  2527. <dt><span class="throwsLabel">Throws:</span></dt>
  2528. <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>
  2529. <dt><span class="simpleTagLabel">Since:</span></dt>
  2530. <dd>1.0</dd>
  2531. </dl>
  2532. </li>
  2533. </ul>
  2534. <a name="addBcc-java.lang.String...-">
  2535. <!-- -->
  2536. </a>
  2537. <ul class="blockList">
  2538. <li class="blockList">
  2539. <h4>addBcc</h4>
  2540. <pre>public&nbsp;<a href="../../../../org/apache/commons/mail/Email.html" title="class in org.apache.commons.mail">Email</a>&nbsp;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>...&nbsp;emails)
  2541. throws <a href="../../../../org/apache/commons/mail/EmailException.html" title="class in org.apache.commons.mail">EmailException</a></pre>
  2542. <div class="block">Add an array of blind BCC recipients to the email. The email
  2543. addresses will also be used as the personal name.
  2544. The names will be encoded by the charset of
  2545. <a href="../../../../org/apache/commons/mail/Email.html#setCharset-java.lang.String-"><code>setCharset()</code></a>.
  2546. If it is not set, it will be encoded using
  2547. the Java platform's default charset (UTF-16) if it contains
  2548. non-ASCII characters; otherwise, it is used as is.</div>
  2549. <dl>
  2550. <dt><span class="paramLabel">Parameters:</span></dt>
  2551. <dd><code>emails</code> - A String array.</dd>
  2552. <dt><span class="returnLabel">Returns:</span></dt>
  2553. <dd>An Email.</dd>
  2554. <dt><span class="throwsLabel">Throws:</span></dt>
  2555. <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>
  2556. <dt><span class="simpleTagLabel">Since:</span></dt>
  2557. <dd>1.3</dd>
  2558. </dl>
  2559. </li>
  2560. </ul>
  2561. <a name="addBcc-java.lang.String-java.lang.String-">
  2562. <!-- -->
  2563. </a>
  2564. <ul class="blockList">
  2565. <li class="blockList">
  2566. <h4>addBcc</h4>
  2567. <pre>public&nbsp;<a href="../../../../org/apache/commons/mail/Email.html" title="class in org.apache.commons.mail">Email</a>&nbsp;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>&nbsp;email,
  2568. <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>&nbsp;name)
  2569. throws <a href="../../../../org/apache/commons/mail/EmailException.html" title="class in org.apache.commons.mail">EmailException</a></pre>
  2570. <div class="block">Add a blind BCC recipient to the email using the specified address and
  2571. the specified personal name.
  2572. 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>.
  2573. If it is not set, it will be encoded using
  2574. the Java platform's default charset (UTF-16) if it contains
  2575. non-ASCII characters; otherwise, it is used as is.</div>
  2576. <dl>
  2577. <dt><span class="paramLabel">Parameters:</span></dt>
  2578. <dd><code>email</code> - A String.</dd>
  2579. <dd><code>name</code> - A String.</dd>
  2580. <dt><span class="returnLabel">Returns:</span></dt>
  2581. <dd>An Email.</dd>
  2582. <dt><span class="throwsLabel">Throws:</span></dt>
  2583. <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>
  2584. <dt><span class="simpleTagLabel">Since:</span></dt>
  2585. <dd>1.0</dd>
  2586. </dl>
  2587. </li>
  2588. </ul>
  2589. <a name="addBcc-java.lang.String-java.lang.String-java.lang.String-">
  2590. <!-- -->
  2591. </a>
  2592. <ul class="blockList">
  2593. <li class="blockList">
  2594. <h4>addBcc</h4>
  2595. <pre>public&nbsp;<a href="../../../../org/apache/commons/mail/Email.html" title="class in org.apache.commons.mail">Email</a>&nbsp;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>&nbsp;email,
  2596. <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>&nbsp;name,
  2597. <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>&nbsp;charset)
  2598. throws <a href="../../../../org/apache/commons/mail/EmailException.html" title="class in org.apache.commons.mail">EmailException</a></pre>
  2599. <div class="block">Add a blind BCC recipient to the email using the specified address,
  2600. personal name, and charset encoding for the name.</div>
  2601. <dl>
  2602. <dt><span class="paramLabel">Parameters:</span></dt>
  2603. <dd><code>email</code> - A String.</dd>
  2604. <dd><code>name</code> - A String.</dd>
  2605. <dd><code>charset</code> - The charset to encode the name with.</dd>
  2606. <dt><span class="returnLabel">Returns:</span></dt>
  2607. <dd>An Email.</dd>
  2608. <dt><span class="throwsLabel">Throws:</span></dt>
  2609. <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>
  2610. <dt><span class="simpleTagLabel">Since:</span></dt>
  2611. <dd>1.1</dd>
  2612. </dl>
  2613. </li>
  2614. </ul>
  2615. <a name="setBcc-java.util.Collection-">
  2616. <!-- -->
  2617. </a>
  2618. <ul class="blockList">
  2619. <li class="blockList">
  2620. <h4>setBcc</h4>
  2621. <pre>public&nbsp;<a href="../../../../org/apache/commons/mail/Email.html" title="class in org.apache.commons.mail">Email</a>&nbsp;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>&lt;<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>&gt;&nbsp;aCollection)
  2622. throws <a href="../../../../org/apache/commons/mail/EmailException.html" title="class in org.apache.commons.mail">EmailException</a></pre>
  2623. <div class="block">Set a list of "BCC" addresses. All elements in the specified
  2624. <code>Collection</code> are expected to be of type
  2625. <code>java.mail.internet.InternetAddress</code>.</div>
  2626. <dl>
  2627. <dt><span class="paramLabel">Parameters:</span></dt>
  2628. <dd><code>aCollection</code> - collection of <code>InternetAddress</code> objects</dd>
  2629. <dt><span class="returnLabel">Returns:</span></dt>
  2630. <dd>An Email.</dd>
  2631. <dt><span class="throwsLabel">Throws:</span></dt>
  2632. <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>
  2633. <dt><span class="simpleTagLabel">Since:</span></dt>
  2634. <dd>1.0</dd>
  2635. <dt><span class="seeLabel">See Also:</span></dt>
  2636. <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>
  2637. </dl>
  2638. </li>
  2639. </ul>
  2640. <a name="addReplyTo-java.lang.String-">
  2641. <!-- -->
  2642. </a>
  2643. <ul class="blockList">
  2644. <li class="blockList">
  2645. <h4>addReplyTo</h4>
  2646. <pre>public&nbsp;<a href="../../../../org/apache/commons/mail/Email.html" title="class in org.apache.commons.mail">Email</a>&nbsp;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>&nbsp;email)
  2647. throws <a href="../../../../org/apache/commons/mail/EmailException.html" title="class in org.apache.commons.mail">EmailException</a></pre>
  2648. <div class="block">Add a reply to address to the email. The email
  2649. address will also be used as the personal name.
  2650. 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>.
  2651. If it is not set, it will be encoded using
  2652. the Java platform's default charset (UTF-16) if it contains
  2653. non-ASCII characters; otherwise, it is used as is.</div>
  2654. <dl>
  2655. <dt><span class="paramLabel">Parameters:</span></dt>
  2656. <dd><code>email</code> - A String.</dd>
  2657. <dt><span class="returnLabel">Returns:</span></dt>
  2658. <dd>An Email.</dd>
  2659. <dt><span class="throwsLabel">Throws:</span></dt>
  2660. <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>
  2661. <dt><span class="simpleTagLabel">Since:</span></dt>
  2662. <dd>1.0</dd>
  2663. </dl>
  2664. </li>
  2665. </ul>
  2666. <a name="addReplyTo-java.lang.String-java.lang.String-">
  2667. <!-- -->
  2668. </a>
  2669. <ul class="blockList">
  2670. <li class="blockList">
  2671. <h4>addReplyTo</h4>
  2672. <pre>public&nbsp;<a href="../../../../org/apache/commons/mail/Email.html" title="class in org.apache.commons.mail">Email</a>&nbsp;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>&nbsp;email,
  2673. <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>&nbsp;name)
  2674. throws <a href="../../../../org/apache/commons/mail/EmailException.html" title="class in org.apache.commons.mail">EmailException</a></pre>
  2675. <div class="block">Add a reply to address to the email using the specified address and
  2676. the specified personal name.
  2677. 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>.
  2678. If it is not set, it will be encoded using
  2679. the Java platform's default charset (UTF-16) if it contains
  2680. non-ASCII characters; otherwise, it is used as is.</div>
  2681. <dl>
  2682. <dt><span class="paramLabel">Parameters:</span></dt>
  2683. <dd><code>email</code> - A String.</dd>
  2684. <dd><code>name</code> - A String.</dd>
  2685. <dt><span class="returnLabel">Returns:</span></dt>
  2686. <dd>An Email.</dd>
  2687. <dt><span class="throwsLabel">Throws:</span></dt>
  2688. <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>
  2689. <dt><span class="simpleTagLabel">Since:</span></dt>
  2690. <dd>1.0</dd>
  2691. </dl>
  2692. </li>
  2693. </ul>
  2694. <a name="addReplyTo-java.lang.String-java.lang.String-java.lang.String-">
  2695. <!-- -->
  2696. </a>
  2697. <ul class="blockList">
  2698. <li class="blockList">
  2699. <h4>addReplyTo</h4>
  2700. <pre>public&nbsp;<a href="../../../../org/apache/commons/mail/Email.html" title="class in org.apache.commons.mail">Email</a>&nbsp;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>&nbsp;email,
  2701. <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>&nbsp;name,
  2702. <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>&nbsp;charset)
  2703. throws <a href="../../../../org/apache/commons/mail/EmailException.html" title="class in org.apache.commons.mail">EmailException</a></pre>
  2704. <div class="block">Add a reply to address to the email using the specified address,
  2705. personal name, and charset encoding for the name.</div>
  2706. <dl>
  2707. <dt><span class="paramLabel">Parameters:</span></dt>
  2708. <dd><code>email</code> - A String.</dd>
  2709. <dd><code>name</code> - A String.</dd>
  2710. <dd><code>charset</code> - The charset to encode the name with.</dd>
  2711. <dt><span class="returnLabel">Returns:</span></dt>
  2712. <dd>An Email.</dd>
  2713. <dt><span class="throwsLabel">Throws:</span></dt>
  2714. <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>
  2715. <dt><span class="simpleTagLabel">Since:</span></dt>
  2716. <dd>1.1</dd>
  2717. </dl>
  2718. </li>
  2719. </ul>
  2720. <a name="setReplyTo-java.util.Collection-">
  2721. <!-- -->
  2722. </a>
  2723. <ul class="blockList">
  2724. <li class="blockList">
  2725. <h4>setReplyTo</h4>
  2726. <pre>public&nbsp;<a href="../../../../org/apache/commons/mail/Email.html" title="class in org.apache.commons.mail">Email</a>&nbsp;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>&lt;<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>&gt;&nbsp;aCollection)
  2727. throws <a href="../../../../org/apache/commons/mail/EmailException.html" title="class in org.apache.commons.mail">EmailException</a></pre>
  2728. <div class="block">Set a list of reply to addresses. All elements in the specified
  2729. <code>Collection</code> are expected to be of type
  2730. <code>java.mail.internet.InternetAddress</code>.</div>
  2731. <dl>
  2732. <dt><span class="paramLabel">Parameters:</span></dt>
  2733. <dd><code>aCollection</code> - collection of <code>InternetAddress</code> objects</dd>
  2734. <dt><span class="returnLabel">Returns:</span></dt>
  2735. <dd>An Email.</dd>
  2736. <dt><span class="throwsLabel">Throws:</span></dt>
  2737. <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>
  2738. <dt><span class="simpleTagLabel">Since:</span></dt>
  2739. <dd>1.1</dd>
  2740. <dt><span class="seeLabel">See Also:</span></dt>
  2741. <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>
  2742. </dl>
  2743. </li>
  2744. </ul>
  2745. <a name="setHeaders-java.util.Map-">
  2746. <!-- -->
  2747. </a>
  2748. <ul class="blockList">
  2749. <li class="blockList">
  2750. <h4>setHeaders</h4>
  2751. <pre>public&nbsp;void&nbsp;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>&lt;<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>&gt;&nbsp;map)</pre>
  2752. <div class="block">Used to specify the mail headers. Example:
  2753. X-Mailer: Sendmail, X-Priority: 1( highest )
  2754. or 2( high ) 3( normal ) 4( low ) and 5( lowest )
  2755. Disposition-Notification-To: user@domain.net</div>
  2756. <dl>
  2757. <dt><span class="paramLabel">Parameters:</span></dt>
  2758. <dd><code>map</code> - A Map.</dd>
  2759. <dt><span class="throwsLabel">Throws:</span></dt>
  2760. <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>
  2761. <dt><span class="simpleTagLabel">Since:</span></dt>
  2762. <dd>1.0</dd>
  2763. </dl>
  2764. </li>
  2765. </ul>
  2766. <a name="addHeader-java.lang.String-java.lang.String-">
  2767. <!-- -->
  2768. </a>
  2769. <ul class="blockList">
  2770. <li class="blockList">
  2771. <h4>addHeader</h4>
  2772. <pre>public&nbsp;void&nbsp;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>&nbsp;name,
  2773. <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>&nbsp;value)</pre>
  2774. <div class="block">Adds a header ( name, value ) to the headers Map.</div>
  2775. <dl>
  2776. <dt><span class="paramLabel">Parameters:</span></dt>
  2777. <dd><code>name</code> - A String with the name.</dd>
  2778. <dd><code>value</code> - A String with the value.</dd>
  2779. <dt><span class="throwsLabel">Throws:</span></dt>
  2780. <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>
  2781. <dt><span class="simpleTagLabel">Since:</span></dt>
  2782. <dd>1.0</dd>
  2783. </dl>
  2784. </li>
  2785. </ul>
  2786. <a name="getHeader-java.lang.String-">
  2787. <!-- -->
  2788. </a>
  2789. <ul class="blockList">
  2790. <li class="blockList">
  2791. <h4>getHeader</h4>
  2792. <pre>public&nbsp;<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>&nbsp;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>&nbsp;header)</pre>
  2793. <div class="block">Gets the specified header.</div>
  2794. <dl>
  2795. <dt><span class="paramLabel">Parameters:</span></dt>
  2796. <dd><code>header</code> - A string with the header.</dd>
  2797. <dt><span class="returnLabel">Returns:</span></dt>
  2798. <dd>The value of the header, or null if no such header.</dd>
  2799. <dt><span class="simpleTagLabel">Since:</span></dt>
  2800. <dd>1.5</dd>
  2801. </dl>
  2802. </li>
  2803. </ul>
  2804. <a name="getHeaders--">
  2805. <!-- -->
  2806. </a>
  2807. <ul class="blockList">
  2808. <li class="blockList">
  2809. <h4>getHeaders</h4>
  2810. <pre>public&nbsp;<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>&lt;<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>&gt;&nbsp;getHeaders()</pre>
  2811. <div class="block">Gets all headers on an Email.</div>
  2812. <dl>
  2813. <dt><span class="returnLabel">Returns:</span></dt>
  2814. <dd>a Map of all headers.</dd>
  2815. <dt><span class="simpleTagLabel">Since:</span></dt>
  2816. <dd>1.5</dd>
  2817. </dl>
  2818. </li>
  2819. </ul>
  2820. <a name="setSubject-java.lang.String-">
  2821. <!-- -->
  2822. </a>
  2823. <ul class="blockList">
  2824. <li class="blockList">
  2825. <h4>setSubject</h4>
  2826. <pre>public&nbsp;<a href="../../../../org/apache/commons/mail/Email.html" title="class in org.apache.commons.mail">Email</a>&nbsp;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>&nbsp;aSubject)</pre>
  2827. <div class="block">Sets the email subject. Replaces end-of-line characters with spaces.</div>
  2828. <dl>
  2829. <dt><span class="paramLabel">Parameters:</span></dt>
  2830. <dd><code>aSubject</code> - A String.</dd>
  2831. <dt><span class="returnLabel">Returns:</span></dt>
  2832. <dd>An Email.</dd>
  2833. <dt><span class="simpleTagLabel">Since:</span></dt>
  2834. <dd>1.0</dd>
  2835. </dl>
  2836. </li>
  2837. </ul>
  2838. <a name="getBounceAddress--">
  2839. <!-- -->
  2840. </a>
  2841. <ul class="blockList">
  2842. <li class="blockList">
  2843. <h4>getBounceAddress</h4>
  2844. <pre>public&nbsp;<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>&nbsp;getBounceAddress()</pre>
  2845. <div class="block">Gets the "bounce address" of this email.</div>
  2846. <dl>
  2847. <dt><span class="returnLabel">Returns:</span></dt>
  2848. <dd>the bounce address as string</dd>
  2849. <dt><span class="simpleTagLabel">Since:</span></dt>
  2850. <dd>1.4</dd>
  2851. </dl>
  2852. </li>
  2853. </ul>
  2854. <a name="setBounceAddress-java.lang.String-">
  2855. <!-- -->
  2856. </a>
  2857. <ul class="blockList">
  2858. <li class="blockList">
  2859. <h4>setBounceAddress</h4>
  2860. <pre>public&nbsp;<a href="../../../../org/apache/commons/mail/Email.html" title="class in org.apache.commons.mail">Email</a>&nbsp;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>&nbsp;email)</pre>
  2861. <div class="block">Set the "bounce address" - the address to which undeliverable messages
  2862. will be returned. If this value is never set, then the message will be
  2863. sent to the address specified with the System property "mail.smtp.from",
  2864. or if that value is not set, then to the "from" address.</div>
  2865. <dl>
  2866. <dt><span class="paramLabel">Parameters:</span></dt>
  2867. <dd><code>email</code> - A String.</dd>
  2868. <dt><span class="returnLabel">Returns:</span></dt>
  2869. <dd>An Email.</dd>
  2870. <dt><span class="throwsLabel">Throws:</span></dt>
  2871. <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>
  2872. <dt><span class="simpleTagLabel">Since:</span></dt>
  2873. <dd>1.0</dd>
  2874. </dl>
  2875. </li>
  2876. </ul>
  2877. <a name="setMsg-java.lang.String-">
  2878. <!-- -->
  2879. </a>
  2880. <ul class="blockList">
  2881. <li class="blockList">
  2882. <h4>setMsg</h4>
  2883. <pre>public abstract&nbsp;<a href="../../../../org/apache/commons/mail/Email.html" title="class in org.apache.commons.mail">Email</a>&nbsp;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>&nbsp;msg)
  2884. throws <a href="../../../../org/apache/commons/mail/EmailException.html" title="class in org.apache.commons.mail">EmailException</a></pre>
  2885. <div class="block">Define the content of the mail. It should be overridden by the
  2886. subclasses.</div>
  2887. <dl>
  2888. <dt><span class="paramLabel">Parameters:</span></dt>
  2889. <dd><code>msg</code> - A String.</dd>
  2890. <dt><span class="returnLabel">Returns:</span></dt>
  2891. <dd>An Email.</dd>
  2892. <dt><span class="throwsLabel">Throws:</span></dt>
  2893. <dd><code><a href="../../../../org/apache/commons/mail/EmailException.html" title="class in org.apache.commons.mail">EmailException</a></code> - generic exception.</dd>
  2894. <dt><span class="simpleTagLabel">Since:</span></dt>
  2895. <dd>1.0</dd>
  2896. </dl>
  2897. </li>
  2898. </ul>
  2899. <a name="buildMimeMessage--">
  2900. <!-- -->
  2901. </a>
  2902. <ul class="blockList">
  2903. <li class="blockList">
  2904. <h4>buildMimeMessage</h4>
  2905. <pre>public&nbsp;void&nbsp;buildMimeMessage()
  2906. throws <a href="../../../../org/apache/commons/mail/EmailException.html" title="class in org.apache.commons.mail">EmailException</a></pre>
  2907. <div class="block">Does the work of actually building the MimeMessage. Please note that
  2908. a user rarely calls this method directly and only if he/she is
  2909. interested in the sending the underlying MimeMessage without
  2910. commons-email.</div>
  2911. <dl>
  2912. <dt><span class="throwsLabel">Throws:</span></dt>
  2913. <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>
  2914. <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>
  2915. <dt><span class="simpleTagLabel">Since:</span></dt>
  2916. <dd>1.0</dd>
  2917. </dl>
  2918. </li>
  2919. </ul>
  2920. <a name="sendMimeMessage--">
  2921. <!-- -->
  2922. </a>
  2923. <ul class="blockList">
  2924. <li class="blockList">
  2925. <h4>sendMimeMessage</h4>
  2926. <pre>public&nbsp;<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>&nbsp;sendMimeMessage()
  2927. throws <a href="../../../../org/apache/commons/mail/EmailException.html" title="class in org.apache.commons.mail">EmailException</a></pre>
  2928. <div class="block">Sends the previously created MimeMessage to the SMTP server.</div>
  2929. <dl>
  2930. <dt><span class="returnLabel">Returns:</span></dt>
  2931. <dd>the message id of the underlying MimeMessage</dd>
  2932. <dt><span class="throwsLabel">Throws:</span></dt>
  2933. <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>
  2934. <dd><code><a href="../../../../org/apache/commons/mail/EmailException.html" title="class in org.apache.commons.mail">EmailException</a></code> - the sending failed</dd>
  2935. </dl>
  2936. </li>
  2937. </ul>
  2938. <a name="getMimeMessage--">
  2939. <!-- -->
  2940. </a>
  2941. <ul class="blockList">
  2942. <li class="blockList">
  2943. <h4>getMimeMessage</h4>
  2944. <pre>public&nbsp;<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>&nbsp;getMimeMessage()</pre>
  2945. <div class="block">Returns the internal MimeMessage. Please note that the
  2946. MimeMessage is built by the buildMimeMessage() method.</div>
  2947. <dl>
  2948. <dt><span class="returnLabel">Returns:</span></dt>
  2949. <dd>the MimeMessage</dd>
  2950. </dl>
  2951. </li>
  2952. </ul>
  2953. <a name="send--">
  2954. <!-- -->
  2955. </a>
  2956. <ul class="blockList">
  2957. <li class="blockList">
  2958. <h4>send</h4>
  2959. <pre>public&nbsp;<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>&nbsp;send()
  2960. throws <a href="../../../../org/apache/commons/mail/EmailException.html" title="class in org.apache.commons.mail">EmailException</a></pre>
  2961. <div class="block">Sends the email. Internally we build a MimeMessage
  2962. which is afterwards sent to the SMTP server.</div>
  2963. <dl>
  2964. <dt><span class="returnLabel">Returns:</span></dt>
  2965. <dd>the message id of the underlying MimeMessage</dd>
  2966. <dt><span class="throwsLabel">Throws:</span></dt>
  2967. <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>
  2968. was already called</dd>
  2969. <dd><code><a href="../../../../org/apache/commons/mail/EmailException.html" title="class in org.apache.commons.mail">EmailException</a></code> - the sending failed</dd>
  2970. </dl>
  2971. </li>
  2972. </ul>
  2973. <a name="setSentDate-java.util.Date-">
  2974. <!-- -->
  2975. </a>
  2976. <ul class="blockList">
  2977. <li class="blockList">
  2978. <h4>setSentDate</h4>
  2979. <pre>public&nbsp;void&nbsp;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>&nbsp;date)</pre>
  2980. <div class="block">Sets the sent date for the email. The sent date will default to the
  2981. current date if not explicitly set.</div>
  2982. <dl>
  2983. <dt><span class="paramLabel">Parameters:</span></dt>
  2984. <dd><code>date</code> - Date to use as the sent date on the email</dd>
  2985. <dt><span class="simpleTagLabel">Since:</span></dt>
  2986. <dd>1.0</dd>
  2987. </dl>
  2988. </li>
  2989. </ul>
  2990. <a name="getSentDate--">
  2991. <!-- -->
  2992. </a>
  2993. <ul class="blockList">
  2994. <li class="blockList">
  2995. <h4>getSentDate</h4>
  2996. <pre>public&nbsp;<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>&nbsp;getSentDate()</pre>
  2997. <div class="block">Gets the sent date for the email.</div>
  2998. <dl>
  2999. <dt><span class="returnLabel">Returns:</span></dt>
  3000. <dd>date to be used as the sent date for the email</dd>
  3001. <dt><span class="simpleTagLabel">Since:</span></dt>
  3002. <dd>1.0</dd>
  3003. </dl>
  3004. </li>
  3005. </ul>
  3006. <a name="getSubject--">
  3007. <!-- -->
  3008. </a>
  3009. <ul class="blockList">
  3010. <li class="blockList">
  3011. <h4>getSubject</h4>
  3012. <pre>public&nbsp;<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>&nbsp;getSubject()</pre>
  3013. <div class="block">Gets the subject of the email.</div>
  3014. <dl>
  3015. <dt><span class="returnLabel">Returns:</span></dt>
  3016. <dd>email subject</dd>
  3017. </dl>
  3018. </li>
  3019. </ul>
  3020. <a name="getFromAddress--">
  3021. <!-- -->
  3022. </a>
  3023. <ul class="blockList">
  3024. <li class="blockList">
  3025. <h4>getFromAddress</h4>
  3026. <pre>public&nbsp;<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>&nbsp;getFromAddress()</pre>
  3027. <div class="block">Gets the sender of the email.</div>
  3028. <dl>
  3029. <dt><span class="returnLabel">Returns:</span></dt>
  3030. <dd>from address</dd>
  3031. </dl>
  3032. </li>
  3033. </ul>
  3034. <a name="getHostName--">
  3035. <!-- -->
  3036. </a>
  3037. <ul class="blockList">
  3038. <li class="blockList">
  3039. <h4>getHostName</h4>
  3040. <pre>public&nbsp;<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>&nbsp;getHostName()</pre>
  3041. <div class="block">Gets the host name of the SMTP server,</div>
  3042. <dl>
  3043. <dt><span class="returnLabel">Returns:</span></dt>
  3044. <dd>host name</dd>
  3045. </dl>
  3046. </li>
  3047. </ul>
  3048. <a name="getSmtpPort--">
  3049. <!-- -->
  3050. </a>
  3051. <ul class="blockList">
  3052. <li class="blockList">
  3053. <h4>getSmtpPort</h4>
  3054. <pre>public&nbsp;<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>&nbsp;getSmtpPort()</pre>
  3055. <div class="block">Gets the listening port of the SMTP server.</div>
  3056. <dl>
  3057. <dt><span class="returnLabel">Returns:</span></dt>
  3058. <dd>smtp port</dd>
  3059. </dl>
  3060. </li>
  3061. </ul>
  3062. <a name="isStartTLSRequired--">
  3063. <!-- -->
  3064. </a>
  3065. <ul class="blockList">
  3066. <li class="blockList">
  3067. <h4>isStartTLSRequired</h4>
  3068. <pre>public&nbsp;boolean&nbsp;isStartTLSRequired()</pre>
  3069. <div class="block">Gets whether the client is configured to require STARTTLS.</div>
  3070. <dl>
  3071. <dt><span class="returnLabel">Returns:</span></dt>
  3072. <dd>true if using STARTTLS for authentication, false otherwise</dd>
  3073. <dt><span class="simpleTagLabel">Since:</span></dt>
  3074. <dd>1.3</dd>
  3075. </dl>
  3076. </li>
  3077. </ul>
  3078. <a name="isStartTLSEnabled--">
  3079. <!-- -->
  3080. </a>
  3081. <ul class="blockList">
  3082. <li class="blockList">
  3083. <h4>isStartTLSEnabled</h4>
  3084. <pre>public&nbsp;boolean&nbsp;isStartTLSEnabled()</pre>
  3085. <div class="block">Gets whether the client is configured to try to enable STARTTLS.</div>
  3086. <dl>
  3087. <dt><span class="returnLabel">Returns:</span></dt>
  3088. <dd>true if using STARTTLS for authentication, false otherwise</dd>
  3089. <dt><span class="simpleTagLabel">Since:</span></dt>
  3090. <dd>1.3</dd>
  3091. </dl>
  3092. </li>
  3093. </ul>
  3094. <a name="isTLS--">
  3095. <!-- -->
  3096. </a>
  3097. <ul class="blockList">
  3098. <li class="blockList">
  3099. <h4>isTLS</h4>
  3100. <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>
  3101. public&nbsp;boolean&nbsp;isTLS()</pre>
  3102. <div class="block"><span class="deprecatedLabel">Deprecated.</span>&nbsp;<span class="deprecationComment">since 1.3, use isStartTLSEnabled() instead</span></div>
  3103. <div class="block">Gets whether the client is configured to try to enable STARTTLS.
  3104. See EMAIL-105 for reason of deprecation.</div>
  3105. <dl>
  3106. <dt><span class="returnLabel">Returns:</span></dt>
  3107. <dd>true if using STARTTLS for authentication, false otherwise</dd>
  3108. <dt><span class="simpleTagLabel">Since:</span></dt>
  3109. <dd>1.1</dd>
  3110. </dl>
  3111. </li>
  3112. </ul>
  3113. <a name="toInternetAddressArray-java.util.List-">
  3114. <!-- -->
  3115. </a>
  3116. <ul class="blockList">
  3117. <li class="blockList">
  3118. <h4>toInternetAddressArray</h4>
  3119. <pre>protected&nbsp;<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>[]&nbsp;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>&lt;<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>&gt;&nbsp;list)</pre>
  3120. <div class="block">Utility to copy List of known InternetAddress objects into an
  3121. array.</div>
  3122. <dl>
  3123. <dt><span class="paramLabel">Parameters:</span></dt>
  3124. <dd><code>list</code> - A List.</dd>
  3125. <dt><span class="returnLabel">Returns:</span></dt>
  3126. <dd>An InternetAddress[].</dd>
  3127. <dt><span class="simpleTagLabel">Since:</span></dt>
  3128. <dd>1.0</dd>
  3129. </dl>
  3130. </li>
  3131. </ul>
  3132. <a name="setPopBeforeSmtp-boolean-java.lang.String-java.lang.String-java.lang.String-">
  3133. <!-- -->
  3134. </a>
  3135. <ul class="blockList">
  3136. <li class="blockList">
  3137. <h4>setPopBeforeSmtp</h4>
  3138. <pre>public&nbsp;void&nbsp;setPopBeforeSmtp(boolean&nbsp;newPopBeforeSmtp,
  3139. <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>&nbsp;newPopHost,
  3140. <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>&nbsp;newPopUsername,
  3141. <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>&nbsp;newPopPassword)</pre>
  3142. <div class="block">Set details regarding "pop3 before smtp" authentication.</div>
  3143. <dl>
  3144. <dt><span class="paramLabel">Parameters:</span></dt>
  3145. <dd><code>newPopBeforeSmtp</code> - Whether or not to log into pop3 server before sending mail.</dd>
  3146. <dd><code>newPopHost</code> - The pop3 host to use.</dd>
  3147. <dd><code>newPopUsername</code> - The pop3 username.</dd>
  3148. <dd><code>newPopPassword</code> - The pop3 password.</dd>
  3149. <dt><span class="simpleTagLabel">Since:</span></dt>
  3150. <dd>1.0</dd>
  3151. </dl>
  3152. </li>
  3153. </ul>
  3154. <a name="isSSL--">
  3155. <!-- -->
  3156. </a>
  3157. <ul class="blockList">
  3158. <li class="blockList">
  3159. <h4>isSSL</h4>
  3160. <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>
  3161. public&nbsp;boolean&nbsp;isSSL()</pre>
  3162. <div class="block"><span class="deprecatedLabel">Deprecated.</span>&nbsp;<span class="deprecationComment">since 1.3, use isSSLOnConnect() instead</span></div>
  3163. <div class="block">Returns whether SSL/TLS encryption for the transport is currently enabled (SMTPS/POPS).
  3164. See EMAIL-105 for reason of deprecation.</div>
  3165. <dl>
  3166. <dt><span class="returnLabel">Returns:</span></dt>
  3167. <dd>true if SSL enabled for the transport</dd>
  3168. </dl>
  3169. </li>
  3170. </ul>
  3171. <a name="isSSLOnConnect--">
  3172. <!-- -->
  3173. </a>
  3174. <ul class="blockList">
  3175. <li class="blockList">
  3176. <h4>isSSLOnConnect</h4>
  3177. <pre>public&nbsp;boolean&nbsp;isSSLOnConnect()</pre>
  3178. <div class="block">Returns whether SSL/TLS encryption for the transport is currently enabled (SMTPS/POPS).</div>
  3179. <dl>
  3180. <dt><span class="returnLabel">Returns:</span></dt>
  3181. <dd>true if SSL enabled for the transport</dd>
  3182. <dt><span class="simpleTagLabel">Since:</span></dt>
  3183. <dd>1.3</dd>
  3184. </dl>
  3185. </li>
  3186. </ul>
  3187. <a name="setSSL-boolean-">
  3188. <!-- -->
  3189. </a>
  3190. <ul class="blockList">
  3191. <li class="blockList">
  3192. <h4>setSSL</h4>
  3193. <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>
  3194. public&nbsp;void&nbsp;setSSL(boolean&nbsp;ssl)</pre>
  3195. <div class="block"><span class="deprecatedLabel">Deprecated.</span>&nbsp;<span class="deprecationComment">since 1.3, use setSSLOnConnect() instead</span></div>
  3196. <div class="block">Sets whether SSL/TLS encryption should be enabled for the SMTP transport upon connection (SMTPS/POPS).
  3197. See EMAIL-105 for reason of deprecation.</div>
  3198. <dl>
  3199. <dt><span class="paramLabel">Parameters:</span></dt>
  3200. <dd><code>ssl</code> - whether to enable the SSL transport</dd>
  3201. </dl>
  3202. </li>
  3203. </ul>
  3204. <a name="setSSLOnConnect-boolean-">
  3205. <!-- -->
  3206. </a>
  3207. <ul class="blockList">
  3208. <li class="blockList">
  3209. <h4>setSSLOnConnect</h4>
  3210. <pre>public&nbsp;<a href="../../../../org/apache/commons/mail/Email.html" title="class in org.apache.commons.mail">Email</a>&nbsp;setSSLOnConnect(boolean&nbsp;ssl)</pre>
  3211. <div class="block">Sets whether SSL/TLS encryption should be enabled for the SMTP transport upon connection (SMTPS/POPS).
  3212. Takes precedence over <a href="../../../../org/apache/commons/mail/Email.html#setStartTLSRequired-boolean-"><code>setStartTLSRequired(boolean)</code></a>
  3213. <p>
  3214. 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>
  3215. <dl>
  3216. <dt><span class="paramLabel">Parameters:</span></dt>
  3217. <dd><code>ssl</code> - whether to enable the SSL transport</dd>
  3218. <dt><span class="returnLabel">Returns:</span></dt>
  3219. <dd>An Email.</dd>
  3220. <dt><span class="throwsLabel">Throws:</span></dt>
  3221. <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>
  3222. <dt><span class="simpleTagLabel">Since:</span></dt>
  3223. <dd>1.3</dd>
  3224. </dl>
  3225. </li>
  3226. </ul>
  3227. <a name="isSSLCheckServerIdentity--">
  3228. <!-- -->
  3229. </a>
  3230. <ul class="blockList">
  3231. <li class="blockList">
  3232. <h4>isSSLCheckServerIdentity</h4>
  3233. <pre>public&nbsp;boolean&nbsp;isSSLCheckServerIdentity()</pre>
  3234. <div class="block">Is the server identity checked as specified by RFC 2595</div>
  3235. <dl>
  3236. <dt><span class="returnLabel">Returns:</span></dt>
  3237. <dd>true if the server identity is checked</dd>
  3238. <dt><span class="simpleTagLabel">Since:</span></dt>
  3239. <dd>1.3</dd>
  3240. </dl>
  3241. </li>
  3242. </ul>
  3243. <a name="setSSLCheckServerIdentity-boolean-">
  3244. <!-- -->
  3245. </a>
  3246. <ul class="blockList">
  3247. <li class="blockList">
  3248. <h4>setSSLCheckServerIdentity</h4>
  3249. <pre>public&nbsp;<a href="../../../../org/apache/commons/mail/Email.html" title="class in org.apache.commons.mail">Email</a>&nbsp;setSSLCheckServerIdentity(boolean&nbsp;sslCheckServerIdentity)</pre>
  3250. <div class="block">Sets whether the server identity is checked as specified by RFC 2595</div>
  3251. <dl>
  3252. <dt><span class="paramLabel">Parameters:</span></dt>
  3253. <dd><code>sslCheckServerIdentity</code> - whether to enable server identity check</dd>
  3254. <dt><span class="returnLabel">Returns:</span></dt>
  3255. <dd>An Email.</dd>
  3256. <dt><span class="throwsLabel">Throws:</span></dt>
  3257. <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>
  3258. <dt><span class="simpleTagLabel">Since:</span></dt>
  3259. <dd>1.3</dd>
  3260. </dl>
  3261. </li>
  3262. </ul>
  3263. <a name="getSslSmtpPort--">
  3264. <!-- -->
  3265. </a>
  3266. <ul class="blockList">
  3267. <li class="blockList">
  3268. <h4>getSslSmtpPort</h4>
  3269. <pre>public&nbsp;<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>&nbsp;getSslSmtpPort()</pre>
  3270. <div class="block">Returns the current SSL port used by the SMTP transport.</div>
  3271. <dl>
  3272. <dt><span class="returnLabel">Returns:</span></dt>
  3273. <dd>the current SSL port used by the SMTP transport</dd>
  3274. </dl>
  3275. </li>
  3276. </ul>
  3277. <a name="setSslSmtpPort-java.lang.String-">
  3278. <!-- -->
  3279. </a>
  3280. <ul class="blockList">
  3281. <li class="blockList">
  3282. <h4>setSslSmtpPort</h4>
  3283. <pre>public&nbsp;void&nbsp;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>&nbsp;sslSmtpPort)</pre>
  3284. <div class="block">Sets the SSL port to use for the SMTP transport. Defaults to the standard
  3285. port, 465.</div>
  3286. <dl>
  3287. <dt><span class="paramLabel">Parameters:</span></dt>
  3288. <dd><code>sslSmtpPort</code> - the SSL port to use for the SMTP transport</dd>
  3289. <dt><span class="throwsLabel">Throws:</span></dt>
  3290. <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>
  3291. <dt><span class="seeLabel">See Also:</span></dt>
  3292. <dd><a href="../../../../org/apache/commons/mail/Email.html#setSmtpPort-int-"><code>setSmtpPort(int)</code></a></dd>
  3293. </dl>
  3294. </li>
  3295. </ul>
  3296. <a name="isSendPartial--">
  3297. <!-- -->
  3298. </a>
  3299. <ul class="blockList">
  3300. <li class="blockList">
  3301. <h4>isSendPartial</h4>
  3302. <pre>public&nbsp;boolean&nbsp;isSendPartial()</pre>
  3303. <div class="block">If partial sending of email enabled.</div>
  3304. <dl>
  3305. <dt><span class="returnLabel">Returns:</span></dt>
  3306. <dd>true if sending partial email is enabled</dd>
  3307. <dt><span class="simpleTagLabel">Since:</span></dt>
  3308. <dd>1.3.2</dd>
  3309. </dl>
  3310. </li>
  3311. </ul>
  3312. <a name="setSendPartial-boolean-">
  3313. <!-- -->
  3314. </a>
  3315. <ul class="blockList">
  3316. <li class="blockList">
  3317. <h4>setSendPartial</h4>
  3318. <pre>public&nbsp;<a href="../../../../org/apache/commons/mail/Email.html" title="class in org.apache.commons.mail">Email</a>&nbsp;setSendPartial(boolean&nbsp;sendPartial)</pre>
  3319. <div class="block">Sets whether the email is partially send in case of invalid addresses.
  3320. <p>
  3321. 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>
  3322. 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
  3323. to valid addresses will be transmitted). In case the email server does not reject
  3324. invalid addresses immediately, but return a bounce message, no exception will be thrown
  3325. by the <a href="../../../../org/apache/commons/mail/Email.html#send--"><code>send()</code></a> method.</div>
  3326. <dl>
  3327. <dt><span class="paramLabel">Parameters:</span></dt>
  3328. <dd><code>sendPartial</code> - whether to enable partial send mode</dd>
  3329. <dt><span class="returnLabel">Returns:</span></dt>
  3330. <dd>An Email.</dd>
  3331. <dt><span class="throwsLabel">Throws:</span></dt>
  3332. <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>
  3333. <dt><span class="simpleTagLabel">Since:</span></dt>
  3334. <dd>1.3.2</dd>
  3335. </dl>
  3336. </li>
  3337. </ul>
  3338. <a name="getToAddresses--">
  3339. <!-- -->
  3340. </a>
  3341. <ul class="blockList">
  3342. <li class="blockList">
  3343. <h4>getToAddresses</h4>
  3344. <pre>public&nbsp;<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>&lt;<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>&gt;&nbsp;getToAddresses()</pre>
  3345. <div class="block">Get the list of "To" addresses.</div>
  3346. <dl>
  3347. <dt><span class="returnLabel">Returns:</span></dt>
  3348. <dd>List addresses</dd>
  3349. </dl>
  3350. </li>
  3351. </ul>
  3352. <a name="getCcAddresses--">
  3353. <!-- -->
  3354. </a>
  3355. <ul class="blockList">
  3356. <li class="blockList">
  3357. <h4>getCcAddresses</h4>
  3358. <pre>public&nbsp;<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>&lt;<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>&gt;&nbsp;getCcAddresses()</pre>
  3359. <div class="block">Get the list of "CC" addresses.</div>
  3360. <dl>
  3361. <dt><span class="returnLabel">Returns:</span></dt>
  3362. <dd>List addresses</dd>
  3363. </dl>
  3364. </li>
  3365. </ul>
  3366. <a name="getBccAddresses--">
  3367. <!-- -->
  3368. </a>
  3369. <ul class="blockList">
  3370. <li class="blockList">
  3371. <h4>getBccAddresses</h4>
  3372. <pre>public&nbsp;<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>&lt;<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>&gt;&nbsp;getBccAddresses()</pre>
  3373. <div class="block">Get the list of "Bcc" addresses.</div>
  3374. <dl>
  3375. <dt><span class="returnLabel">Returns:</span></dt>
  3376. <dd>List addresses</dd>
  3377. </dl>
  3378. </li>
  3379. </ul>
  3380. <a name="getReplyToAddresses--">
  3381. <!-- -->
  3382. </a>
  3383. <ul class="blockList">
  3384. <li class="blockList">
  3385. <h4>getReplyToAddresses</h4>
  3386. <pre>public&nbsp;<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>&lt;<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>&gt;&nbsp;getReplyToAddresses()</pre>
  3387. <div class="block">Get the list of "Reply-To" addresses.</div>
  3388. <dl>
  3389. <dt><span class="returnLabel">Returns:</span></dt>
  3390. <dd>List addresses</dd>
  3391. </dl>
  3392. </li>
  3393. </ul>
  3394. <a name="getSocketConnectionTimeout--">
  3395. <!-- -->
  3396. </a>
  3397. <ul class="blockList">
  3398. <li class="blockList">
  3399. <h4>getSocketConnectionTimeout</h4>
  3400. <pre>public&nbsp;int&nbsp;getSocketConnectionTimeout()</pre>
  3401. <div class="block">Get the socket connection timeout value in milliseconds.</div>
  3402. <dl>
  3403. <dt><span class="returnLabel">Returns:</span></dt>
  3404. <dd>the timeout in milliseconds.</dd>
  3405. <dt><span class="simpleTagLabel">Since:</span></dt>
  3406. <dd>1.2</dd>
  3407. </dl>
  3408. </li>
  3409. </ul>
  3410. <a name="setSocketConnectionTimeout-int-">
  3411. <!-- -->
  3412. </a>
  3413. <ul class="blockList">
  3414. <li class="blockList">
  3415. <h4>setSocketConnectionTimeout</h4>
  3416. <pre>public&nbsp;void&nbsp;setSocketConnectionTimeout(int&nbsp;socketConnectionTimeout)</pre>
  3417. <div class="block">Set the socket connection timeout value in milliseconds.
  3418. Default is a 60 second timeout.</div>
  3419. <dl>
  3420. <dt><span class="paramLabel">Parameters:</span></dt>
  3421. <dd><code>socketConnectionTimeout</code> - the connection timeout</dd>
  3422. <dt><span class="throwsLabel">Throws:</span></dt>
  3423. <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>
  3424. <dt><span class="simpleTagLabel">Since:</span></dt>
  3425. <dd>1.2</dd>
  3426. </dl>
  3427. </li>
  3428. </ul>
  3429. <a name="getSocketTimeout--">
  3430. <!-- -->
  3431. </a>
  3432. <ul class="blockList">
  3433. <li class="blockList">
  3434. <h4>getSocketTimeout</h4>
  3435. <pre>public&nbsp;int&nbsp;getSocketTimeout()</pre>
  3436. <div class="block">Get the socket I/O timeout value in milliseconds.</div>
  3437. <dl>
  3438. <dt><span class="returnLabel">Returns:</span></dt>
  3439. <dd>the socket I/O timeout</dd>
  3440. <dt><span class="simpleTagLabel">Since:</span></dt>
  3441. <dd>1.2</dd>
  3442. </dl>
  3443. </li>
  3444. </ul>
  3445. <a name="setSocketTimeout-int-">
  3446. <!-- -->
  3447. </a>
  3448. <ul class="blockList">
  3449. <li class="blockList">
  3450. <h4>setSocketTimeout</h4>
  3451. <pre>public&nbsp;void&nbsp;setSocketTimeout(int&nbsp;socketTimeout)</pre>
  3452. <div class="block">Set the socket I/O timeout value in milliseconds.
  3453. Default is 60 second timeout.</div>
  3454. <dl>
  3455. <dt><span class="paramLabel">Parameters:</span></dt>
  3456. <dd><code>socketTimeout</code> - the socket I/O timeout</dd>
  3457. <dt><span class="throwsLabel">Throws:</span></dt>
  3458. <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>
  3459. <dt><span class="simpleTagLabel">Since:</span></dt>
  3460. <dd>1.2</dd>
  3461. </dl>
  3462. </li>
  3463. </ul>
  3464. <a name="createMimeMessage-javax.mail.Session-">
  3465. <!-- -->
  3466. </a>
  3467. <ul class="blockListLast">
  3468. <li class="blockList">
  3469. <h4>createMimeMessage</h4>
  3470. <pre>protected&nbsp;<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>&nbsp;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>&nbsp;aSession)</pre>
  3471. <div class="block">Factory method to create a customized MimeMessage which can be
  3472. implemented by a derived class, e.g. to set the message id.</div>
  3473. <dl>
  3474. <dt><span class="paramLabel">Parameters:</span></dt>
  3475. <dd><code>aSession</code> - mail session to be used</dd>
  3476. <dt><span class="returnLabel">Returns:</span></dt>
  3477. <dd>the newly created message</dd>
  3478. </dl>
  3479. </li>
  3480. </ul>
  3481. </li>
  3482. </ul>
  3483. </li>
  3484. </ul>
  3485. </div>
  3486. </div>
  3487. <!-- ========= END OF CLASS DATA ========= -->
  3488. <!-- ======= START OF BOTTOM NAVBAR ====== -->
  3489. <div class="bottomNav"><a name="navbar.bottom">
  3490. <!-- -->
  3491. </a>
  3492. <div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div>
  3493. <a name="navbar.bottom.firstrow">
  3494. <!-- -->
  3495. </a>
  3496. <ul class="navList" title="Navigation">
  3497. <li><a href="../../../../overview-summary.html">Overview</a></li>
  3498. <li><a href="package-summary.html">Package</a></li>
  3499. <li class="navBarCell1Rev">Class</li>
  3500. <li><a href="class-use/Email.html">Use</a></li>
  3501. <li><a href="package-tree.html">Tree</a></li>
  3502. <li><a href="../../../../deprecated-list.html">Deprecated</a></li>
  3503. <li><a href="../../../../index-all.html">Index</a></li>
  3504. <li><a href="../../../../help-doc.html">Help</a></li>
  3505. </ul>
  3506. </div>
  3507. <div class="subNav">
  3508. <ul class="navList">
  3509. <li><a href="../../../../org/apache/commons/mail/DefaultAuthenticator.html" title="class in org.apache.commons.mail"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
  3510. <li><a href="../../../../org/apache/commons/mail/EmailAttachment.html" title="class in org.apache.commons.mail"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
  3511. </ul>
  3512. <ul class="navList">
  3513. <li><a href="../../../../index.html?org/apache/commons/mail/Email.html" target="_top">Frames</a></li>
  3514. <li><a href="Email.html" target="_top">No&nbsp;Frames</a></li>
  3515. </ul>
  3516. <ul class="navList" id="allclasses_navbar_bottom">
  3517. <li><a href="../../../../allclasses-noframe.html">All&nbsp;Classes</a></li>
  3518. </ul>
  3519. <div>
  3520. <script type="text/javascript"><!--
  3521. allClassesLink = document.getElementById("allclasses_navbar_bottom");
  3522. if(window==top) {
  3523. allClassesLink.style.display = "block";
  3524. }
  3525. else {
  3526. allClassesLink.style.display = "none";
  3527. }
  3528. //-->
  3529. </script>
  3530. </div>
  3531. <div>
  3532. <ul class="subNavList">
  3533. <li>Summary:&nbsp;</li>
  3534. <li>Nested&nbsp;|&nbsp;</li>
  3535. <li><a href="#field.summary">Field</a>&nbsp;|&nbsp;</li>
  3536. <li><a href="#constructor.summary">Constr</a>&nbsp;|&nbsp;</li>
  3537. <li><a href="#method.summary">Method</a></li>
  3538. </ul>
  3539. <ul class="subNavList">
  3540. <li>Detail:&nbsp;</li>
  3541. <li><a href="#field.detail">Field</a>&nbsp;|&nbsp;</li>
  3542. <li><a href="#constructor.detail">Constr</a>&nbsp;|&nbsp;</li>
  3543. <li><a href="#method.detail">Method</a></li>
  3544. </ul>
  3545. </div>
  3546. <a name="skip.navbar.bottom">
  3547. <!-- -->
  3548. </a></div>
  3549. <!-- ======== END OF BOTTOM NAVBAR ======= -->
  3550. <p class="legalCopy"><small>Copyright &#169; 2001&#x2013;2017 <a href="http://www.apache.org/">The Apache Software Foundation</a>. All rights reserved.</small></p>
  3551. </body>
  3552. </html>