Subversion Repositories javautils

Rev

Blame | Last modification | View Log | RSS feed

  1. <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
  2. <!--NewPage-->
  3. <HTML>
  4. <HEAD>
  5. <!-- Generated by javadoc (build 1.6.0_10) on Tue Nov 17 12:13:42 PST 2009 -->
  6. <META http-equiv="Content-Type" content="text/html; charset=ISO-8859-1">
  7. <TITLE>
  8. POP3Store (JavaMail API documentation)
  9. </TITLE>
  10.  
  11. <META NAME="date" CONTENT="2009-11-17">
  12.  
  13. <LINK REL ="stylesheet" TYPE="text/css" HREF="../../../../stylesheet.css" TITLE="Style">
  14.  
  15. <SCRIPT type="text/javascript">
  16. function windowTitle()
  17. {
  18.     if (location.href.indexOf('is-external=true') == -1) {
  19.         parent.document.title="POP3Store (JavaMail API documentation)";
  20.     }
  21. }
  22. </SCRIPT>
  23. <NOSCRIPT>
  24. </NOSCRIPT>
  25.  
  26. </HEAD>
  27.  
  28. <BODY BGCOLOR="white" onload="windowTitle();">
  29. <HR>
  30.  
  31.  
  32. <!-- ========= START OF TOP NAVBAR ======= -->
  33. <A NAME="navbar_top"><!-- --></A>
  34. <A HREF="#skip-navbar_top" title="Skip navigation links"></A>
  35. <TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">
  36. <TR>
  37. <TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
  38. <A NAME="navbar_top_firstrow"><!-- --></A>
  39. <TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">
  40.   <TR ALIGN="center" VALIGN="top">
  41.   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A>&nbsp;</TD>
  42.   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A>&nbsp;</TD>
  43.   <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> &nbsp;<FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT>&nbsp;</TD>
  44.   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="class-use/POP3Store.html"><FONT CLASS="NavBarFont1"><B>Use</B></FONT></A>&nbsp;</TD>
  45.   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A>&nbsp;</TD>
  46.   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A>&nbsp;</TD>
  47.   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../index-files/index-1.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A>&nbsp;</TD>
  48.   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A>&nbsp;</TD>
  49.   </TR>
  50. </TABLE>
  51. </TD>
  52. <TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
  53. </EM>
  54. </TD>
  55. </TR>
  56.  
  57. <TR>
  58. <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
  59. &nbsp;<A HREF="../../../../com/sun/mail/pop3/POP3SSLStore.html" title="class in com.sun.mail.pop3"><B>PREV CLASS</B></A>&nbsp;
  60. &nbsp;NEXT CLASS</FONT></TD>
  61. <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
  62.   <A HREF="../../../../index.html?com/sun/mail/pop3/POP3Store.html" target="_top"><B>FRAMES</B></A>  &nbsp;
  63. &nbsp;<A HREF="POP3Store.html" target="_top"><B>NO FRAMES</B></A>  &nbsp;
  64. &nbsp;<SCRIPT type="text/javascript">
  65.   <!--
  66.   if(window==top) {
  67.     document.writeln('<A HREF="../../../../allclasses-noframe.html"><B>All Classes</B></A>');
  68.   }
  69.   //-->
  70. </SCRIPT>
  71. <NOSCRIPT>
  72.   <A HREF="../../../../allclasses-noframe.html"><B>All Classes</B></A>
  73. </NOSCRIPT>
  74.  
  75.  
  76. </FONT></TD>
  77. </TR>
  78. <TR>
  79. <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
  80.   SUMMARY:&nbsp;NESTED&nbsp;|&nbsp;<A HREF="#fields_inherited_from_class_javax.mail.Service">FIELD</A>&nbsp;|&nbsp;<A HREF="#constructor_summary">CONSTR</A>&nbsp;|&nbsp;<A HREF="#method_summary">METHOD</A></FONT></TD>
  81. <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
  82. DETAIL:&nbsp;FIELD&nbsp;|&nbsp;<A HREF="#constructor_detail">CONSTR</A>&nbsp;|&nbsp;<A HREF="#method_detail">METHOD</A></FONT></TD>
  83. </TR>
  84. </TABLE>
  85. <A NAME="skip-navbar_top"></A>
  86. <!-- ========= END OF TOP NAVBAR ========= -->
  87.  
  88. <HR>
  89. <!-- ======== START OF CLASS DATA ======== -->
  90. <H2>
  91. <FONT SIZE="-1">
  92. com.sun.mail.pop3</FONT>
  93. <BR>
  94. Class POP3Store</H2>
  95. <PRE>
  96. <A HREF="http://java.sun.com/j2se/1.4.2/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">java.lang.Object</A>
  97.   <IMG SRC="../../../../resources/inherit.gif" ALT="extended by "><A HREF="../../../../javax/mail/Service.html" title="class in javax.mail">javax.mail.Service</A>
  98.       <IMG SRC="../../../../resources/inherit.gif" ALT="extended by "><A HREF="../../../../javax/mail/Store.html" title="class in javax.mail">javax.mail.Store</A>
  99.           <IMG SRC="../../../../resources/inherit.gif" ALT="extended by "><B>com.sun.mail.pop3.POP3Store</B>
  100. </PRE>
  101. <DL>
  102. <DT><B>Direct Known Subclasses:</B> <DD><A HREF="../../../../com/sun/mail/pop3/POP3SSLStore.html" title="class in com.sun.mail.pop3">POP3SSLStore</A></DD>
  103. </DL>
  104. <HR>
  105. <DL>
  106. <DT><PRE>public class <B>POP3Store</B><DT>extends <A HREF="../../../../javax/mail/Store.html" title="class in javax.mail">Store</A></DL>
  107. </PRE>
  108.  
  109. <P>
  110. A POP3 Message Store.  Contains only one folder, "INBOX".
  111.  
  112.  See the <a href="package-summary.html">com.sun.mail.pop3</a> package
  113.  documentation for further information on the POP3 protocol provider. <p>
  114. <P>
  115.  
  116. <P>
  117. <HR>
  118.  
  119. <P>
  120. <!-- =========== FIELD SUMMARY =========== -->
  121.  
  122. <A NAME="field_summary"><!-- --></A>
  123. <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
  124. <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
  125. <TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2">
  126. <B>Field Summary</B></FONT></TH>
  127. </TR>
  128. </TABLE>
  129. &nbsp;<A NAME="fields_inherited_from_class_javax.mail.Service"><!-- --></A>
  130. <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
  131. <TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
  132. <TH ALIGN="left"><B>Fields inherited from class javax.mail.<A HREF="../../../../javax/mail/Service.html" title="class in javax.mail">Service</A></B></TH>
  133. </TR>
  134. <TR BGCOLOR="white" CLASS="TableRowColor">
  135. <TD><CODE><A HREF="../../../../javax/mail/Service.html#debug">debug</A>, <A HREF="../../../../javax/mail/Service.html#session">session</A>, <A HREF="../../../../javax/mail/Service.html#url">url</A></CODE></TD>
  136. </TR>
  137. </TABLE>
  138. &nbsp;
  139. <!-- ======== CONSTRUCTOR SUMMARY ======== -->
  140.  
  141. <A NAME="constructor_summary"><!-- --></A>
  142. <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
  143. <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
  144. <TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2">
  145. <B>Constructor Summary</B></FONT></TH>
  146. </TR>
  147. <TR BGCOLOR="white" CLASS="TableRowColor">
  148. <TD><CODE><B><A HREF="../../../../com/sun/mail/pop3/POP3Store.html#POP3Store(javax.mail.Session, javax.mail.URLName)">POP3Store</A></B>(<A HREF="../../../../javax/mail/Session.html" title="class in javax.mail">Session</A>&nbsp;session,
  149.           <A HREF="../../../../javax/mail/URLName.html" title="class in javax.mail">URLName</A>&nbsp;url)</CODE>
  150.  
  151. <BR>
  152. &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD>
  153. </TR>
  154. <TR BGCOLOR="white" CLASS="TableRowColor">
  155. <TD><CODE><B><A HREF="../../../../com/sun/mail/pop3/POP3Store.html#POP3Store(javax.mail.Session, javax.mail.URLName, java.lang.String, boolean)">POP3Store</A></B>(<A HREF="../../../../javax/mail/Session.html" title="class in javax.mail">Session</A>&nbsp;session,
  156.           <A HREF="../../../../javax/mail/URLName.html" title="class in javax.mail">URLName</A>&nbsp;url,
  157.           <A HREF="http://java.sun.com/j2se/1.4.2/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A>&nbsp;name,
  158.           boolean&nbsp;isSSL)</CODE>
  159.  
  160. <BR>
  161. &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD>
  162. </TR>
  163. </TABLE>
  164. &nbsp;
  165. <!-- ========== METHOD SUMMARY =========== -->
  166.  
  167. <A NAME="method_summary"><!-- --></A>
  168. <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
  169. <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
  170. <TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2">
  171. <B>Method Summary</B></FONT></TH>
  172. </TR>
  173. <TR BGCOLOR="white" CLASS="TableRowColor">
  174. <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
  175. <CODE>&nbsp;<A HREF="http://java.sun.com/j2se/1.4.2/docs/api/java/util/Map.html?is-external=true" title="class or interface in java.util">Map</A></CODE></FONT></TD>
  176. <TD><CODE><B><A HREF="../../../../com/sun/mail/pop3/POP3Store.html#capabilities()">capabilities</A></B>()</CODE>
  177.  
  178. <BR>
  179. &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Return a Map of the capabilities the server provided,
  180.  as per RFC 2449.</TD>
  181. </TR>
  182. <TR BGCOLOR="white" CLASS="TableRowColor">
  183. <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
  184. <CODE>&nbsp;void</CODE></FONT></TD>
  185. <TD><CODE><B><A HREF="../../../../com/sun/mail/pop3/POP3Store.html#close()">close</A></B>()</CODE>
  186.  
  187. <BR>
  188. &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Close this service and terminate its connection.</TD>
  189. </TR>
  190. <TR BGCOLOR="white" CLASS="TableRowColor">
  191. <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
  192. <CODE>protected &nbsp;void</CODE></FONT></TD>
  193. <TD><CODE><B><A HREF="../../../../com/sun/mail/pop3/POP3Store.html#finalize()">finalize</A></B>()</CODE>
  194.  
  195. <BR>
  196. &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Stop the event dispatcher thread so the queue can be garbage collected.</TD>
  197. </TR>
  198. <TR BGCOLOR="white" CLASS="TableRowColor">
  199. <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
  200. <CODE>&nbsp;<A HREF="../../../../javax/mail/Folder.html" title="class in javax.mail">Folder</A></CODE></FONT></TD>
  201. <TD><CODE><B><A HREF="../../../../com/sun/mail/pop3/POP3Store.html#getDefaultFolder()">getDefaultFolder</A></B>()</CODE>
  202.  
  203. <BR>
  204. &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Returns a Folder object that represents the 'root' of
  205.  the default namespace presented to the user by the Store.</TD>
  206. </TR>
  207. <TR BGCOLOR="white" CLASS="TableRowColor">
  208. <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
  209. <CODE>&nbsp;<A HREF="../../../../javax/mail/Folder.html" title="class in javax.mail">Folder</A></CODE></FONT></TD>
  210. <TD><CODE><B><A HREF="../../../../com/sun/mail/pop3/POP3Store.html#getFolder(java.lang.String)">getFolder</A></B>(<A HREF="http://java.sun.com/j2se/1.4.2/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A>&nbsp;name)</CODE>
  211.  
  212. <BR>
  213. &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Only the name "INBOX" is supported.</TD>
  214. </TR>
  215. <TR BGCOLOR="white" CLASS="TableRowColor">
  216. <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
  217. <CODE>&nbsp;<A HREF="../../../../javax/mail/Folder.html" title="class in javax.mail">Folder</A></CODE></FONT></TD>
  218. <TD><CODE><B><A HREF="../../../../com/sun/mail/pop3/POP3Store.html#getFolder(javax.mail.URLName)">getFolder</A></B>(<A HREF="../../../../javax/mail/URLName.html" title="class in javax.mail">URLName</A>&nbsp;url)</CODE>
  219.  
  220. <BR>
  221. &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Return a closed Folder object, corresponding to the given
  222.  URLName.</TD>
  223. </TR>
  224. <TR BGCOLOR="white" CLASS="TableRowColor">
  225. <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
  226. <CODE>&nbsp;boolean</CODE></FONT></TD>
  227. <TD><CODE><B><A HREF="../../../../com/sun/mail/pop3/POP3Store.html#isConnected()">isConnected</A></B>()</CODE>
  228.  
  229. <BR>
  230. &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Check whether this store is connected.</TD>
  231. </TR>
  232. <TR BGCOLOR="white" CLASS="TableRowColor">
  233. <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
  234. <CODE>protected &nbsp;boolean</CODE></FONT></TD>
  235. <TD><CODE><B><A HREF="../../../../com/sun/mail/pop3/POP3Store.html#protocolConnect(java.lang.String, int, java.lang.String, java.lang.String)">protocolConnect</A></B>(<A HREF="http://java.sun.com/j2se/1.4.2/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A>&nbsp;host,
  236.                 int&nbsp;portNum,
  237.                 <A HREF="http://java.sun.com/j2se/1.4.2/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A>&nbsp;user,
  238.                 <A HREF="http://java.sun.com/j2se/1.4.2/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A>&nbsp;passwd)</CODE>
  239.  
  240. <BR>
  241. &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;The service implementation should override this method to
  242.  perform the actual protocol-specific connection attempt.</TD>
  243. </TR>
  244. </TABLE>
  245. &nbsp;<A NAME="methods_inherited_from_class_javax.mail.Store"><!-- --></A>
  246. <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
  247. <TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
  248. <TH ALIGN="left"><B>Methods inherited from class javax.mail.<A HREF="../../../../javax/mail/Store.html" title="class in javax.mail">Store</A></B></TH>
  249. </TR>
  250. <TR BGCOLOR="white" CLASS="TableRowColor">
  251. <TD><CODE><A HREF="../../../../javax/mail/Store.html#addFolderListener(javax.mail.event.FolderListener)">addFolderListener</A>, <A HREF="../../../../javax/mail/Store.html#addStoreListener(javax.mail.event.StoreListener)">addStoreListener</A>, <A HREF="../../../../javax/mail/Store.html#getPersonalNamespaces()">getPersonalNamespaces</A>, <A HREF="../../../../javax/mail/Store.html#getSharedNamespaces()">getSharedNamespaces</A>, <A HREF="../../../../javax/mail/Store.html#getUserNamespaces(java.lang.String)">getUserNamespaces</A>, <A HREF="../../../../javax/mail/Store.html#notifyFolderListeners(int, javax.mail.Folder)">notifyFolderListeners</A>, <A HREF="../../../../javax/mail/Store.html#notifyFolderRenamedListeners(javax.mail.Folder, javax.mail.Folder)">notifyFolderRenamedListeners</A>, <A HREF="../../../../javax/mail/Store.html#notifyStoreListeners(int, java.lang.String)">notifyStoreListeners</A>, <A HREF="../../../../javax/mail/Store.html#removeFolderListener(javax.mail.event.FolderListener)">removeFolderListener</A>, <A HREF="../../../../javax/mail/Store.html#removeStoreListener(javax.mail.event.StoreListener)">removeStoreListener</A></CODE></TD>
  252. </TR>
  253. </TABLE>
  254. &nbsp;<A NAME="methods_inherited_from_class_javax.mail.Service"><!-- --></A>
  255. <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
  256. <TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
  257. <TH ALIGN="left"><B>Methods inherited from class javax.mail.<A HREF="../../../../javax/mail/Service.html" title="class in javax.mail">Service</A></B></TH>
  258. </TR>
  259. <TR BGCOLOR="white" CLASS="TableRowColor">
  260. <TD><CODE><A HREF="../../../../javax/mail/Service.html#addConnectionListener(javax.mail.event.ConnectionListener)">addConnectionListener</A>, <A HREF="../../../../javax/mail/Service.html#connect()">connect</A>, <A HREF="../../../../javax/mail/Service.html#connect(java.lang.String, int, java.lang.String, java.lang.String)">connect</A>, <A HREF="../../../../javax/mail/Service.html#connect(java.lang.String, java.lang.String)">connect</A>, <A HREF="../../../../javax/mail/Service.html#connect(java.lang.String, java.lang.String, java.lang.String)">connect</A>, <A HREF="../../../../javax/mail/Service.html#getURLName()">getURLName</A>, <A HREF="../../../../javax/mail/Service.html#notifyConnectionListeners(int)">notifyConnectionListeners</A>, <A HREF="../../../../javax/mail/Service.html#queueEvent(javax.mail.event.MailEvent, java.util.Vector)">queueEvent</A>, <A HREF="../../../../javax/mail/Service.html#removeConnectionListener(javax.mail.event.ConnectionListener)">removeConnectionListener</A>, <A HREF="../../../../javax/mail/Service.html#setConnected(boolean)">setConnected</A>, <A HREF="../../../../javax/mail/Service.html#setURLName(javax.mail.URLName)">setURLName</A>, <A HREF="../../../../javax/mail/Service.html#toString()">toString</A></CODE></TD>
  261. </TR>
  262. </TABLE>
  263. &nbsp;<A NAME="methods_inherited_from_class_java.lang.Object"><!-- --></A>
  264. <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
  265. <TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
  266. <TH ALIGN="left"><B>Methods inherited from class java.lang.<A HREF="http://java.sun.com/j2se/1.4.2/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</A></B></TH>
  267. </TR>
  268. <TR BGCOLOR="white" CLASS="TableRowColor">
  269. <TD><CODE><A HREF="http://java.sun.com/j2se/1.4.2/docs/api/java/lang/Object.html?is-external=true#clone()" title="class or interface in java.lang">clone</A>, <A HREF="http://java.sun.com/j2se/1.4.2/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://java.sun.com/j2se/1.4.2/docs/api/java/lang/Object.html?is-external=true#getClass()" title="class or interface in java.lang">getClass</A>, <A HREF="http://java.sun.com/j2se/1.4.2/docs/api/java/lang/Object.html?is-external=true#hashCode()" title="class or interface in java.lang">hashCode</A>, <A HREF="http://java.sun.com/j2se/1.4.2/docs/api/java/lang/Object.html?is-external=true#notify()" title="class or interface in java.lang">notify</A>, <A HREF="http://java.sun.com/j2se/1.4.2/docs/api/java/lang/Object.html?is-external=true#notifyAll()" title="class or interface in java.lang">notifyAll</A>, <A HREF="http://java.sun.com/j2se/1.4.2/docs/api/java/lang/Object.html?is-external=true#wait()" title="class or interface in java.lang">wait</A>, <A HREF="http://java.sun.com/j2se/1.4.2/docs/api/java/lang/Object.html?is-external=true#wait(long)" title="class or interface in java.lang">wait</A>, <A HREF="http://java.sun.com/j2se/1.4.2/docs/api/java/lang/Object.html?is-external=true#wait(long, int)" title="class or interface in java.lang">wait</A></CODE></TD>
  270. </TR>
  271. </TABLE>
  272. &nbsp;
  273. <P>
  274.  
  275. <!-- ========= CONSTRUCTOR DETAIL ======== -->
  276.  
  277. <A NAME="constructor_detail"><!-- --></A>
  278. <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
  279. <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
  280. <TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2">
  281. <B>Constructor Detail</B></FONT></TH>
  282. </TR>
  283. </TABLE>
  284.  
  285. <A NAME="POP3Store(javax.mail.Session, javax.mail.URLName)"><!-- --></A><H3>
  286. POP3Store</H3>
  287. <PRE>
  288. public <B>POP3Store</B>(<A HREF="../../../../javax/mail/Session.html" title="class in javax.mail">Session</A>&nbsp;session,
  289.                  <A HREF="../../../../javax/mail/URLName.html" title="class in javax.mail">URLName</A>&nbsp;url)</PRE>
  290. <DL>
  291. </DL>
  292. <HR>
  293.  
  294. <A NAME="POP3Store(javax.mail.Session, javax.mail.URLName, java.lang.String, boolean)"><!-- --></A><H3>
  295. POP3Store</H3>
  296. <PRE>
  297. public <B>POP3Store</B>(<A HREF="../../../../javax/mail/Session.html" title="class in javax.mail">Session</A>&nbsp;session,
  298.                  <A HREF="../../../../javax/mail/URLName.html" title="class in javax.mail">URLName</A>&nbsp;url,
  299.                  <A HREF="http://java.sun.com/j2se/1.4.2/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A>&nbsp;name,
  300.                  boolean&nbsp;isSSL)</PRE>
  301. <DL>
  302. </DL>
  303.  
  304. <!-- ============ METHOD DETAIL ========== -->
  305.  
  306. <A NAME="method_detail"><!-- --></A>
  307. <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
  308. <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
  309. <TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2">
  310. <B>Method Detail</B></FONT></TH>
  311. </TR>
  312. </TABLE>
  313.  
  314. <A NAME="protocolConnect(java.lang.String, int, java.lang.String, java.lang.String)"><!-- --></A><H3>
  315. protocolConnect</H3>
  316. <PRE>
  317. protected boolean <B>protocolConnect</B>(<A HREF="http://java.sun.com/j2se/1.4.2/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A>&nbsp;host,
  318.                                   int&nbsp;portNum,
  319.                                   <A HREF="http://java.sun.com/j2se/1.4.2/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A>&nbsp;user,
  320.                                   <A HREF="http://java.sun.com/j2se/1.4.2/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A>&nbsp;passwd)
  321.                            throws <A HREF="../../../../javax/mail/MessagingException.html" title="class in javax.mail">MessagingException</A></PRE>
  322. <DL>
  323. <DD><B>Description copied from class: <CODE><A HREF="../../../../javax/mail/Service.html#protocolConnect(java.lang.String, int, java.lang.String, java.lang.String)">Service</A></CODE></B></DD>
  324. <DD>The service implementation should override this method to
  325.  perform the actual protocol-specific connection attempt.
  326.  The default implementation of the <code>connect</code> method
  327.  calls this method as needed. <p>
  328.  
  329.  The <code>protocolConnect</code> method should return
  330.  <code>false</code> if a user name or password is required
  331.  for authentication but the corresponding parameter is null;
  332.  the <code>connect</code> method will prompt the user when
  333.  needed to supply missing information.  This method may
  334.  also return <code>false</code> if authentication fails for
  335.  the supplied user name or password.  Alternatively, this method
  336.  may throw an AuthenticationFailedException when authentication
  337.  fails.  This exception may include a String message with more
  338.  detail about the failure. <p>
  339.  
  340.  The <code>protocolConnect</code> method should throw an
  341.  exception to report failures not related to authentication,
  342.  such as an invalid host name or port number, loss of a
  343.  connection during the authentication process, unavailability
  344.  of the server, etc.
  345. <P>
  346. <DD><DL>
  347. <DT><B>Overrides:</B><DD><CODE><A HREF="../../../../javax/mail/Service.html#protocolConnect(java.lang.String, int, java.lang.String, java.lang.String)">protocolConnect</A></CODE> in class <CODE><A HREF="../../../../javax/mail/Service.html" title="class in javax.mail">Service</A></CODE></DL>
  348. </DD>
  349. <DD><DL>
  350. <DT><B>Parameters:</B><DD><CODE>host</CODE> - the name of the host to connect to<DD><CODE>portNum</CODE> - the port to use (-1 means use default port)<DD><CODE>user</CODE> - the name of the user to login as<DD><CODE>passwd</CODE> - the user's password
  351. <DT><B>Returns:</B><DD>true if connection successful, false if authentication failed
  352. <DT><B>Throws:</B>
  353. <DD><CODE><A HREF="../../../../javax/mail/AuthenticationFailedException.html" title="class in javax.mail">AuthenticationFailedException</A></CODE> - for authentication failures
  354. <DD><CODE><A HREF="../../../../javax/mail/MessagingException.html" title="class in javax.mail">MessagingException</A></CODE> - for non-authentication failures</DL>
  355. </DD>
  356. </DL>
  357. <HR>
  358.  
  359. <A NAME="isConnected()"><!-- --></A><H3>
  360. isConnected</H3>
  361. <PRE>
  362. public boolean <B>isConnected</B>()</PRE>
  363. <DL>
  364. <DD>Check whether this store is connected. Override superclass
  365. method, to actually ping our server connection. <p>
  366. <P>
  367. <DD><DL>
  368. <DT><B>Overrides:</B><DD><CODE><A HREF="../../../../javax/mail/Service.html#isConnected()">isConnected</A></CODE> in class <CODE><A HREF="../../../../javax/mail/Service.html" title="class in javax.mail">Service</A></CODE></DL>
  369. </DD>
  370. <DD><DL>
  371.  
  372. <DT><B>Returns:</B><DD>true if the service is connected, false if it is not connected</DL>
  373. </DD>
  374. </DL>
  375. <HR>
  376.  
  377. <A NAME="close()"><!-- --></A><H3>
  378. close</H3>
  379. <PRE>
  380. public void <B>close</B>()
  381.           throws <A HREF="../../../../javax/mail/MessagingException.html" title="class in javax.mail">MessagingException</A></PRE>
  382. <DL>
  383. <DD><B>Description copied from class: <CODE><A HREF="../../../../javax/mail/Service.html#close()">Service</A></CODE></B></DD>
  384. <DD>Close this service and terminate its connection. A close
  385. ConnectionEvent is delivered to any ConnectionListeners. Any
  386. Messaging components (Folders, Messages, etc.) belonging to this
  387. service are invalid after this service is closed. Note that the service
  388. is closed even if this method terminates abnormally by throwing
  389. a MessagingException. <p>
  390.  
  391. This implementation uses <code>setConnected(false)</code> to set
  392. this service's connected state to <code>false</code>. It will then
  393.  send a close ConnectionEvent to any registered ConnectionListeners.
  394.  Subclasses overriding this method to do implementation specific
  395.  cleanup should call this method as a last step to insure event
  396.  notification, probably by including a call to <code>super.close()</code>
  397.  in a <code>finally</code> clause.
  398. <P>
  399. <DD><DL>
  400. <DT><B>Overrides:</B><DD><CODE><A HREF="../../../../javax/mail/Service.html#close()">close</A></CODE> in class <CODE><A HREF="../../../../javax/mail/Service.html" title="class in javax.mail">Service</A></CODE></DL>
  401. </DD>
  402. <DD><DL>
  403.  
  404. <DT><B>Throws:</B>
  405. <DD><CODE><A HREF="../../../../javax/mail/MessagingException.html" title="class in javax.mail">MessagingException</A></CODE> - for errors while closing<DT><B>See Also:</B><DD><A HREF="../../../../javax/mail/event/ConnectionEvent.html" title="class in javax.mail.event"><CODE>ConnectionEvent</CODE></A></DL>
  406. </DD>
  407. </DL>
  408. <HR>
  409.  
  410. <A NAME="getDefaultFolder()"><!-- --></A><H3>
  411. getDefaultFolder</H3>
  412. <PRE>
  413. public <A HREF="../../../../javax/mail/Folder.html" title="class in javax.mail">Folder</A> <B>getDefaultFolder</B>()
  414.                         throws <A HREF="../../../../javax/mail/MessagingException.html" title="class in javax.mail">MessagingException</A></PRE>
  415. <DL>
  416. <DD><B>Description copied from class: <CODE><A HREF="../../../../javax/mail/Store.html#getDefaultFolder()">Store</A></CODE></B></DD>
  417. <DD>Returns a Folder object that represents the 'root' of
  418.  the default namespace presented to the user by the Store.
  419. <P>
  420. <DD><DL>
  421. <DT><B>Specified by:</B><DD><CODE><A HREF="../../../../javax/mail/Store.html#getDefaultFolder()">getDefaultFolder</A></CODE> in class <CODE><A HREF="../../../../javax/mail/Store.html" title="class in javax.mail">Store</A></CODE></DL>
  422. </DD>
  423. <DD><DL>
  424.  
  425. <DT><B>Returns:</B><DD>the root Folder
  426. <DT><B>Throws:</B>
  427. <DD><CODE><A HREF="../../../../javax/mail/MessagingException.html" title="class in javax.mail">MessagingException</A></CODE></DL>
  428. </DD>
  429. </DL>
  430. <HR>
  431.  
  432. <A NAME="getFolder(java.lang.String)"><!-- --></A><H3>
  433. getFolder</H3>
  434. <PRE>
  435. public <A HREF="../../../../javax/mail/Folder.html" title="class in javax.mail">Folder</A> <B>getFolder</B>(<A HREF="http://java.sun.com/j2se/1.4.2/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A>&nbsp;name)
  436.                  throws <A HREF="../../../../javax/mail/MessagingException.html" title="class in javax.mail">MessagingException</A></PRE>
  437. <DL>
  438. <DD>Only the name "INBOX" is supported.
  439. <P>
  440. <DD><DL>
  441. <DT><B>Specified by:</B><DD><CODE><A HREF="../../../../javax/mail/Store.html#getFolder(java.lang.String)">getFolder</A></CODE> in class <CODE><A HREF="../../../../javax/mail/Store.html" title="class in javax.mail">Store</A></CODE></DL>
  442. </DD>
  443. <DD><DL>
  444. <DT><B>Parameters:</B><DD><CODE>name</CODE> - The name of the Folder. In some Stores, name can
  445.                         be an absolute path if it starts with the
  446.                         hierarchy delimiter. Else it is interpreted
  447.                         relative to the 'root' of this namespace.
  448. <DT><B>Returns:</B><DD>Folder object
  449. <DT><B>Throws:</B>
  450. <DD><CODE><A HREF="../../../../javax/mail/MessagingException.html" title="class in javax.mail">MessagingException</A></CODE><DT><B>See Also:</B><DD><A HREF="../../../../javax/mail/Folder.html#exists()"><CODE>Folder.exists()</CODE></A>,
  451. <A HREF="../../../../javax/mail/Folder.html#create(int)"><CODE>Folder.create(int)</CODE></A></DL>
  452. </DD>
  453. </DL>
  454. <HR>
  455.  
  456. <A NAME="getFolder(javax.mail.URLName)"><!-- --></A><H3>
  457. getFolder</H3>
  458. <PRE>
  459. public <A HREF="../../../../javax/mail/Folder.html" title="class in javax.mail">Folder</A> <B>getFolder</B>(<A HREF="../../../../javax/mail/URLName.html" title="class in javax.mail">URLName</A>&nbsp;url)
  460.                  throws <A HREF="../../../../javax/mail/MessagingException.html" title="class in javax.mail">MessagingException</A></PRE>
  461. <DL>
  462. <DD><B>Description copied from class: <CODE><A HREF="../../../../javax/mail/Store.html#getFolder(javax.mail.URLName)">Store</A></CODE></B></DD>
  463. <DD>Return a closed Folder object, corresponding to the given
  464.  URLName. The store specified in the given URLName should
  465.  refer to this Store object. <p>
  466.  
  467.  Implementations of this method may obtain the name of the
  468.  actual folder using the <code>getFile()</code> method on
  469.  URLName, and use that name to create the folder.
  470. <P>
  471. <DD><DL>
  472. <DT><B>Specified by:</B><DD><CODE><A HREF="../../../../javax/mail/Store.html#getFolder(javax.mail.URLName)">getFolder</A></CODE> in class <CODE><A HREF="../../../../javax/mail/Store.html" title="class in javax.mail">Store</A></CODE></DL>
  473. </DD>
  474. <DD><DL>
  475. <DT><B>Parameters:</B><DD><CODE>url</CODE> - URLName that denotes a folder
  476. <DT><B>Returns:</B><DD>Folder object
  477. <DT><B>Throws:</B>
  478. <DD><CODE><A HREF="../../../../javax/mail/MessagingException.html" title="class in javax.mail">MessagingException</A></CODE><DT><B>See Also:</B><DD><A HREF="../../../../javax/mail/URLName.html" title="class in javax.mail"><CODE>URLName</CODE></A></DL>
  479. </DD>
  480. </DL>
  481. <HR>
  482.  
  483. <A NAME="capabilities()"><!-- --></A><H3>
  484. capabilities</H3>
  485. <PRE>
  486. public <A HREF="http://java.sun.com/j2se/1.4.2/docs/api/java/util/Map.html?is-external=true" title="class or interface in java.util">Map</A> <B>capabilities</B>()
  487.                  throws <A HREF="../../../../javax/mail/MessagingException.html" title="class in javax.mail">MessagingException</A></PRE>
  488. <DL>
  489. <DD>Return a Map of the capabilities the server provided,
  490.  as per RFC 2449.  If the server doesn't support RFC 2449,
  491. an emtpy Map is returned.  The returned Map can not be modified.
  492. The key to the Map is the upper case capability name as
  493. a String.  The value of the entry is the entire String
  494. capability line returned by the server. <p>
  495.  
  496. For example, to check if the server supports the STLS capability, use:
  497. <code>if (store.capabilities().containsKey("STLS")) ...</code>
  498. <P>
  499. <DD><DL>
  500.  
  501. <DT><B>Returns:</B><DD>Map of capabilities
  502. <DT><B>Throws:</B>
  503. <DD><CODE><A HREF="../../../../javax/mail/MessagingException.html" title="class in javax.mail">MessagingException</A></CODE><DT><B>Since:</B></DT>
  504.  <DD>JavaMail 1.4.3</DD>
  505. </DL>
  506. </DD>
  507. </DL>
  508. <HR>
  509.  
  510. <A NAME="finalize()"><!-- --></A><H3>
  511. finalize</H3>
  512. <PRE>
  513. protected void <B>finalize</B>()
  514.                 throws <A HREF="http://java.sun.com/j2se/1.4.2/docs/api/java/lang/Throwable.html?is-external=true" title="class or interface in java.lang">Throwable</A></PRE>
  515. <DL>
  516. <DD><B>Description copied from class: <CODE><A HREF="../../../../javax/mail/Service.html#finalize()">Service</A></CODE></B></DD>
  517. <DD>Stop the event dispatcher thread so the queue can be garbage collected.
  518. <P>
  519. <DD><DL>
  520. <DT><B>Overrides:</B><DD><CODE><A HREF="../../../../javax/mail/Service.html#finalize()">finalize</A></CODE> in class <CODE><A HREF="../../../../javax/mail/Service.html" title="class in javax.mail">Service</A></CODE></DL>
  521. </DD>
  522. <DD><DL>
  523.  
  524. <DT><B>Throws:</B>
  525. <DD><CODE><A HREF="http://java.sun.com/j2se/1.4.2/docs/api/java/lang/Throwable.html?is-external=true" title="class or interface in java.lang">Throwable</A></CODE></DL>
  526. </DD>
  527. </DL>
  528. <!-- ========= END OF CLASS DATA ========= -->
  529. <HR>
  530.  
  531.  
  532. <!-- ======= START OF BOTTOM NAVBAR ====== -->
  533. <A NAME="navbar_bottom"><!-- --></A>
  534. <A HREF="#skip-navbar_bottom" title="Skip navigation links"></A>
  535. <TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">
  536. <TR>
  537. <TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
  538. <A NAME="navbar_bottom_firstrow"><!-- --></A>
  539. <TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">
  540.  <TR ALIGN="center" VALIGN="top">
  541.  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A>&nbsp;</TD>
  542.  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A>&nbsp;</TD>
  543.  <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> &nbsp;<FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT>&nbsp;</TD>
  544.  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="class-use/POP3Store.html"><FONT CLASS="NavBarFont1"><B>Use</B></FONT></A>&nbsp;</TD>
  545.  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A>&nbsp;</TD>
  546.  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A>&nbsp;</TD>
  547.  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../index-files/index-1.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A>&nbsp;</TD>
  548.  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A>&nbsp;</TD>
  549.  </TR>
  550. </TABLE>
  551. </TD>
  552. <TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
  553. </EM>
  554. </TD>
  555. </TR>
  556.  
  557. <TR>
  558. <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
  559. &nbsp;<A HREF="../../../../com/sun/mail/pop3/POP3SSLStore.html" title="class in com.sun.mail.pop3"><B>PREV CLASS</B></A>&nbsp;
  560. &nbsp;NEXT CLASS</FONT></TD>
  561. <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
  562.  <A HREF="../../../../index.html?com/sun/mail/pop3/POP3Store.html" target="_top"><B>FRAMES</B></A>  &nbsp;
  563. &nbsp;<A HREF="POP3Store.html" target="_top"><B>NO FRAMES</B></A>  &nbsp;
  564. &nbsp;<SCRIPT type="text/javascript">
  565.  <!--
  566.  if(window==top) {
  567.    document.writeln('<A HREF="../../../../allclasses-noframe.html"><B>All Classes</B></A>');
  568.  }
  569.  //-->
  570. </SCRIPT>
  571. <NOSCRIPT>
  572.  <A HREF="../../../../allclasses-noframe.html"><B>All Classes</B></A>
  573. </NOSCRIPT>
  574.  
  575.  
  576. </FONT></TD>
  577. </TR>
  578. <TR>
  579. <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
  580.  SUMMARY:&nbsp;NESTED&nbsp;|&nbsp;<A HREF="#fields_inherited_from_class_javax.mail.Service">FIELD</A>&nbsp;|&nbsp;<A HREF="#constructor_summary">CONSTR</A>&nbsp;|&nbsp;<A HREF="#method_summary">METHOD</A></FONT></TD>
  581. <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
  582. DETAIL:&nbsp;FIELD&nbsp;|&nbsp;<A HREF="#constructor_detail">CONSTR</A>&nbsp;|&nbsp;<A HREF="#method_detail">METHOD</A></FONT></TD>
  583. </TR>
  584. </TABLE>
  585. <A NAME="skip-navbar_bottom"></A>
  586. <!-- ======== END OF BOTTOM NAVBAR ======= -->
  587.  
  588. <HR>
  589. Copyright &#169; 2009 <a href="http://www.sun.com">Sun Microsystems, Inc.</a>. All Rights Reserved.
  590. </BODY>
  591. </HTML>
  592.