DefaultAuthenticator.html 15 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316
  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>DefaultAuthenticator (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="DefaultAuthenticator (Apache Commons Email 1.5 API)";
  16. }
  17. }
  18. catch(err) {
  19. }
  20. //-->
  21. var methods = {"i0":10};
  22. var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],8:["t4","Concrete 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/DefaultAuthenticator.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/DataSourceResolver.html" title="interface in org.apache.commons.mail"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
  53. <li><a href="../../../../org/apache/commons/mail/Email.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/DefaultAuthenticator.html" target="_top">Frames</a></li>
  57. <li><a href="DefaultAuthenticator.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>Field&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>Field&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 DefaultAuthenticator" class="title">Class DefaultAuthenticator</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><a href="http://docs.oracle.com/javaee/6/api/javax/mail/Authenticator.html?is-external=true" title="class or interface in javax.mail">javax.mail.Authenticator</a></li>
  104. <li>
  105. <ul class="inheritance">
  106. <li>org.apache.commons.mail.DefaultAuthenticator</li>
  107. </ul>
  108. </li>
  109. </ul>
  110. </li>
  111. </ul>
  112. <div class="description">
  113. <ul class="blockList">
  114. <li class="blockList">
  115. <hr>
  116. <br>
  117. <pre>public class <span class="typeNameLabel">DefaultAuthenticator</span>
  118. extends <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></pre>
  119. <div class="block">This is a very simple authentication object that can be used for any
  120. transport needing basic userName and password type authentication.</div>
  121. <dl>
  122. <dt><span class="simpleTagLabel">Since:</span></dt>
  123. <dd>1.0</dd>
  124. </dl>
  125. </li>
  126. </ul>
  127. </div>
  128. <div class="summary">
  129. <ul class="blockList">
  130. <li class="blockList">
  131. <!-- ======== CONSTRUCTOR SUMMARY ======== -->
  132. <ul class="blockList">
  133. <li class="blockList"><a name="constructor.summary">
  134. <!-- -->
  135. </a>
  136. <h3>Constructor Summary</h3>
  137. <table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Constructor Summary table, listing constructors, and an explanation">
  138. <caption><span>Constructors</span><span class="tabEnd">&nbsp;</span></caption>
  139. <tr>
  140. <th class="colOne" scope="col">Constructor and Description</th>
  141. </tr>
  142. <tr class="altColor">
  143. <td class="colOne"><code><span class="memberNameLink"><a href="../../../../org/apache/commons/mail/DefaultAuthenticator.html#DefaultAuthenticator-java.lang.String-java.lang.String-">DefaultAuthenticator</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,
  144. <a href="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>
  145. <div class="block">Default constructor.</div>
  146. </td>
  147. </tr>
  148. </table>
  149. </li>
  150. </ul>
  151. <!-- ========== METHOD SUMMARY =========== -->
  152. <ul class="blockList">
  153. <li class="blockList"><a name="method.summary">
  154. <!-- -->
  155. </a>
  156. <h3>Method Summary</h3>
  157. <table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation">
  158. <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="t4" class="tableTab"><span><a href="javascript:show(8);">Concrete Methods</a></span><span class="tabEnd">&nbsp;</span></span></caption>
  159. <tr>
  160. <th class="colFirst" scope="col">Modifier and Type</th>
  161. <th class="colLast" scope="col">Method and Description</th>
  162. </tr>
  163. <tr id="i0" class="altColor">
  164. <td class="colFirst"><code>protected <a href="http://docs.oracle.com/javaee/6/api/javax/mail/PasswordAuthentication.html?is-external=true" title="class or interface in javax.mail">PasswordAuthentication</a></code></td>
  165. <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/commons/mail/DefaultAuthenticator.html#getPasswordAuthentication--">getPasswordAuthentication</a></span>()</code>
  166. <div class="block">Gets the authentication object that will be used to login to the mail
  167. server.</div>
  168. </td>
  169. </tr>
  170. </table>
  171. <ul class="blockList">
  172. <li class="blockList"><a name="methods.inherited.from.class.javax.mail.Authenticator">
  173. <!-- -->
  174. </a>
  175. <h3>Methods inherited from class&nbsp;javax.mail.<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></h3>
  176. <code><a href="http://docs.oracle.com/javaee/6/api/javax/mail/Authenticator.html?is-external=true#getDefaultUserName--" title="class or interface in javax.mail">getDefaultUserName</a>, <a href="http://docs.oracle.com/javaee/6/api/javax/mail/Authenticator.html?is-external=true#getRequestingPort--" title="class or interface in javax.mail">getRequestingPort</a>, <a href="http://docs.oracle.com/javaee/6/api/javax/mail/Authenticator.html?is-external=true#getRequestingPrompt--" title="class or interface in javax.mail">getRequestingPrompt</a>, <a href="http://docs.oracle.com/javaee/6/api/javax/mail/Authenticator.html?is-external=true#getRequestingProtocol--" title="class or interface in javax.mail">getRequestingProtocol</a>, <a href="http://docs.oracle.com/javaee/6/api/javax/mail/Authenticator.html?is-external=true#getRequestingSite--" title="class or interface in javax.mail">getRequestingSite</a></code></li>
  177. </ul>
  178. <ul class="blockList">
  179. <li class="blockList"><a name="methods.inherited.from.class.java.lang.Object">
  180. <!-- -->
  181. </a>
  182. <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>
  183. <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>
  184. </ul>
  185. </li>
  186. </ul>
  187. </li>
  188. </ul>
  189. </div>
  190. <div class="details">
  191. <ul class="blockList">
  192. <li class="blockList">
  193. <!-- ========= CONSTRUCTOR DETAIL ======== -->
  194. <ul class="blockList">
  195. <li class="blockList"><a name="constructor.detail">
  196. <!-- -->
  197. </a>
  198. <h3>Constructor Detail</h3>
  199. <a name="DefaultAuthenticator-java.lang.String-java.lang.String-">
  200. <!-- -->
  201. </a>
  202. <ul class="blockListLast">
  203. <li class="blockList">
  204. <h4>DefaultAuthenticator</h4>
  205. <pre>public&nbsp;DefaultAuthenticator(<a href="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,
  206. <a href="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>
  207. <div class="block">Default constructor.</div>
  208. <dl>
  209. <dt><span class="paramLabel">Parameters:</span></dt>
  210. <dd><code>userName</code> - user name to use when authentication is requested</dd>
  211. <dd><code>password</code> - password to use when authentication is requested</dd>
  212. <dt><span class="simpleTagLabel">Since:</span></dt>
  213. <dd>1.0</dd>
  214. </dl>
  215. </li>
  216. </ul>
  217. </li>
  218. </ul>
  219. <!-- ============ METHOD DETAIL ========== -->
  220. <ul class="blockList">
  221. <li class="blockList"><a name="method.detail">
  222. <!-- -->
  223. </a>
  224. <h3>Method Detail</h3>
  225. <a name="getPasswordAuthentication--">
  226. <!-- -->
  227. </a>
  228. <ul class="blockListLast">
  229. <li class="blockList">
  230. <h4>getPasswordAuthentication</h4>
  231. <pre>protected&nbsp;<a href="http://docs.oracle.com/javaee/6/api/javax/mail/PasswordAuthentication.html?is-external=true" title="class or interface in javax.mail">PasswordAuthentication</a>&nbsp;getPasswordAuthentication()</pre>
  232. <div class="block">Gets the authentication object that will be used to login to the mail
  233. server.</div>
  234. <dl>
  235. <dt><span class="overrideSpecifyLabel">Overrides:</span></dt>
  236. <dd><code><a href="http://docs.oracle.com/javaee/6/api/javax/mail/Authenticator.html?is-external=true#getPasswordAuthentication--" title="class or interface in javax.mail">getPasswordAuthentication</a></code>&nbsp;in class&nbsp;<code><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></dd>
  237. <dt><span class="returnLabel">Returns:</span></dt>
  238. <dd>A <code>PasswordAuthentication</code> object containing the
  239. login information.</dd>
  240. <dt><span class="simpleTagLabel">Since:</span></dt>
  241. <dd>1.0</dd>
  242. </dl>
  243. </li>
  244. </ul>
  245. </li>
  246. </ul>
  247. </li>
  248. </ul>
  249. </div>
  250. </div>
  251. <!-- ========= END OF CLASS DATA ========= -->
  252. <!-- ======= START OF BOTTOM NAVBAR ====== -->
  253. <div class="bottomNav"><a name="navbar.bottom">
  254. <!-- -->
  255. </a>
  256. <div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div>
  257. <a name="navbar.bottom.firstrow">
  258. <!-- -->
  259. </a>
  260. <ul class="navList" title="Navigation">
  261. <li><a href="../../../../overview-summary.html">Overview</a></li>
  262. <li><a href="package-summary.html">Package</a></li>
  263. <li class="navBarCell1Rev">Class</li>
  264. <li><a href="class-use/DefaultAuthenticator.html">Use</a></li>
  265. <li><a href="package-tree.html">Tree</a></li>
  266. <li><a href="../../../../deprecated-list.html">Deprecated</a></li>
  267. <li><a href="../../../../index-all.html">Index</a></li>
  268. <li><a href="../../../../help-doc.html">Help</a></li>
  269. </ul>
  270. </div>
  271. <div class="subNav">
  272. <ul class="navList">
  273. <li><a href="../../../../org/apache/commons/mail/DataSourceResolver.html" title="interface in org.apache.commons.mail"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
  274. <li><a href="../../../../org/apache/commons/mail/Email.html" title="class in org.apache.commons.mail"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
  275. </ul>
  276. <ul class="navList">
  277. <li><a href="../../../../index.html?org/apache/commons/mail/DefaultAuthenticator.html" target="_top">Frames</a></li>
  278. <li><a href="DefaultAuthenticator.html" target="_top">No&nbsp;Frames</a></li>
  279. </ul>
  280. <ul class="navList" id="allclasses_navbar_bottom">
  281. <li><a href="../../../../allclasses-noframe.html">All&nbsp;Classes</a></li>
  282. </ul>
  283. <div>
  284. <script type="text/javascript"><!--
  285. allClassesLink = document.getElementById("allclasses_navbar_bottom");
  286. if(window==top) {
  287. allClassesLink.style.display = "block";
  288. }
  289. else {
  290. allClassesLink.style.display = "none";
  291. }
  292. //-->
  293. </script>
  294. </div>
  295. <div>
  296. <ul class="subNavList">
  297. <li>Summary:&nbsp;</li>
  298. <li>Nested&nbsp;|&nbsp;</li>
  299. <li>Field&nbsp;|&nbsp;</li>
  300. <li><a href="#constructor.summary">Constr</a>&nbsp;|&nbsp;</li>
  301. <li><a href="#method.summary">Method</a></li>
  302. </ul>
  303. <ul class="subNavList">
  304. <li>Detail:&nbsp;</li>
  305. <li>Field&nbsp;|&nbsp;</li>
  306. <li><a href="#constructor.detail">Constr</a>&nbsp;|&nbsp;</li>
  307. <li><a href="#method.detail">Method</a></li>
  308. </ul>
  309. </div>
  310. <a name="skip.navbar.bottom">
  311. <!-- -->
  312. </a></div>
  313. <!-- ======== END OF BOTTOM NAVBAR ======= -->
  314. <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>
  315. </body>
  316. </html>