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. POP3Folder (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="POP3Folder (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/POP3Folder.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;PREV CLASS&nbsp;
  60. &nbsp;<A HREF="../../../../com/sun/mail/pop3/POP3Message.html" title="class in com.sun.mail.pop3"><B>NEXT CLASS</B></A></FONT></TD>
  61. <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
  62.   <A HREF="../../../../index.html?com/sun/mail/pop3/POP3Folder.html" target="_top"><B>FRAMES</B></A>  &nbsp;
  63. &nbsp;<A HREF="POP3Folder.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.Folder">FIELD</A>&nbsp;|&nbsp;CONSTR&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;CONSTR&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 POP3Folder</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/Folder.html" title="class in javax.mail">javax.mail.Folder</A>
  98.       <IMG SRC="../../../../resources/inherit.gif" ALT="extended by "><B>com.sun.mail.pop3.POP3Folder</B>
  99. </PRE>
  100. <HR>
  101. <DL>
  102. <DT><PRE>public class <B>POP3Folder</B><DT>extends <A HREF="../../../../javax/mail/Folder.html" title="class in javax.mail">Folder</A></DL>
  103. </PRE>
  104.  
  105. <P>
  106. A POP3 Folder (can only be "INBOX").
  107.  
  108.  See the <a href="package-summary.html">com.sun.mail.pop3</a> package
  109.  documentation for further information on the POP3 protocol provider. <p>
  110. <P>
  111.  
  112. <P>
  113. <HR>
  114.  
  115. <P>
  116. <!-- =========== FIELD SUMMARY =========== -->
  117.  
  118. <A NAME="field_summary"><!-- --></A>
  119. <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
  120. <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
  121. <TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2">
  122. <B>Field Summary</B></FONT></TH>
  123. </TR>
  124. </TABLE>
  125. &nbsp;<A NAME="fields_inherited_from_class_javax.mail.Folder"><!-- --></A>
  126. <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
  127. <TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
  128. <TH ALIGN="left"><B>Fields inherited from class javax.mail.<A HREF="../../../../javax/mail/Folder.html" title="class in javax.mail">Folder</A></B></TH>
  129. </TR>
  130. <TR BGCOLOR="white" CLASS="TableRowColor">
  131. <TD><CODE><A HREF="../../../../javax/mail/Folder.html#HOLDS_FOLDERS">HOLDS_FOLDERS</A>, <A HREF="../../../../javax/mail/Folder.html#HOLDS_MESSAGES">HOLDS_MESSAGES</A>, <A HREF="../../../../javax/mail/Folder.html#mode">mode</A>, <A HREF="../../../../javax/mail/Folder.html#READ_ONLY">READ_ONLY</A>, <A HREF="../../../../javax/mail/Folder.html#READ_WRITE">READ_WRITE</A>, <A HREF="../../../../javax/mail/Folder.html#store">store</A></CODE></TD>
  132. </TR>
  133. </TABLE>
  134. &nbsp;
  135. <!-- ========== METHOD SUMMARY =========== -->
  136.  
  137. <A NAME="method_summary"><!-- --></A>
  138. <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
  139. <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
  140. <TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2">
  141. <B>Method Summary</B></FONT></TH>
  142. </TR>
  143. <TR BGCOLOR="white" CLASS="TableRowColor">
  144. <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
  145. <CODE>&nbsp;void</CODE></FONT></TD>
  146. <TD><CODE><B><A HREF="../../../../com/sun/mail/pop3/POP3Folder.html#appendMessages(javax.mail.Message[])">appendMessages</A></B>(<A HREF="../../../../javax/mail/Message.html" title="class in javax.mail">Message</A>[]&nbsp;msgs)</CODE>
  147.  
  148. <BR>
  149. &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Always throws <code>MethodNotSupportedException</code>
  150.  because the POP3 protocol doesn't support appending messages.</TD>
  151. </TR>
  152. <TR BGCOLOR="white" CLASS="TableRowColor">
  153. <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
  154. <CODE>&nbsp;void</CODE></FONT></TD>
  155. <TD><CODE><B><A HREF="../../../../com/sun/mail/pop3/POP3Folder.html#close(boolean)">close</A></B>(boolean&nbsp;expunge)</CODE>
  156.  
  157. <BR>
  158. &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Close this Folder.</TD>
  159. </TR>
  160. <TR BGCOLOR="white" CLASS="TableRowColor">
  161. <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
  162. <CODE>&nbsp;boolean</CODE></FONT></TD>
  163. <TD><CODE><B><A HREF="../../../../com/sun/mail/pop3/POP3Folder.html#create(int)">create</A></B>(int&nbsp;type)</CODE>
  164.  
  165. <BR>
  166. &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Always returns <code>false</code>; the POP3 protocol doesn't
  167.  support creating folders.</TD>
  168. </TR>
  169. <TR BGCOLOR="white" CLASS="TableRowColor">
  170. <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
  171. <CODE>protected &nbsp;<A HREF="../../../../com/sun/mail/pop3/POP3Message.html" title="class in com.sun.mail.pop3">POP3Message</A></CODE></FONT></TD>
  172. <TD><CODE><B><A HREF="../../../../com/sun/mail/pop3/POP3Folder.html#createMessage(javax.mail.Folder, int)">createMessage</A></B>(<A HREF="../../../../javax/mail/Folder.html" title="class in javax.mail">Folder</A>&nbsp;f,
  173.               int&nbsp;msgno)</CODE>
  174.  
  175. <BR>
  176. &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD>
  177. </TR>
  178. <TR BGCOLOR="white" CLASS="TableRowColor">
  179. <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
  180. <CODE>&nbsp;boolean</CODE></FONT></TD>
  181. <TD><CODE><B><A HREF="../../../../com/sun/mail/pop3/POP3Folder.html#delete(boolean)">delete</A></B>(boolean&nbsp;recurse)</CODE>
  182.  
  183. <BR>
  184. &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Always throws <code>MethodNotSupportedException</code>
  185.  because the POP3 protocol doesn't allow the INBOX to
  186. be deleted.</TD>
  187. </TR>
  188. <TR BGCOLOR="white" CLASS="TableRowColor">
  189. <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
  190. <CODE>&nbsp;boolean</CODE></FONT></TD>
  191. <TD><CODE><B><A HREF="../../../../com/sun/mail/pop3/POP3Folder.html#exists()">exists</A></B>()</CODE>
  192.  
  193. <BR>
  194. &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Always true for the folder "INBOX", always false for
  195. any other name.</TD>
  196. </TR>
  197. <TR BGCOLOR="white" CLASS="TableRowColor">
  198. <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
  199. <CODE>&nbsp;<A HREF="../../../../javax/mail/Message.html" title="class in javax.mail">Message</A>[]</CODE></FONT></TD>
  200. <TD><CODE><B><A HREF="../../../../com/sun/mail/pop3/POP3Folder.html#expunge()">expunge</A></B>()</CODE>
  201.  
  202. <BR>
  203. &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Always throws <code>MethodNotSupportedException</code>
  204. because the POP3 protocol doesn't support expunging messages
  205.  without closing the folder; call the <A HREF="../../../../com/sun/mail/pop3/POP3Folder.html#close(boolean)"><CODE>close</CODE></A> method
  206.  with the <code>expunge</code> argument set to <code>true</code>
  207.  instead.</TD>
  208. </TR>
  209. <TR BGCOLOR="white" CLASS="TableRowColor">
  210. <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
  211. <CODE>&nbsp;void</CODE></FONT></TD>
  212. <TD><CODE><B><A HREF="../../../../com/sun/mail/pop3/POP3Folder.html#fetch(javax.mail.Message[], javax.mail.FetchProfile)">fetch</A></B>(<A HREF="../../../../javax/mail/Message.html" title="class in javax.mail">Message</A>[]&nbsp;msgs,
  213.       <A HREF="../../../../javax/mail/FetchProfile.html" title="class in javax.mail">FetchProfile</A>&nbsp;fp)</CODE>
  214.  
  215. <BR>
  216. &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Prefetch information about POP3 messages.</TD>
  217. </TR>
  218. <TR BGCOLOR="white" CLASS="TableRowColor">
  219. <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
  220. <CODE>protected &nbsp;void</CODE></FONT></TD>
  221. <TD><CODE><B><A HREF="../../../../com/sun/mail/pop3/POP3Folder.html#finalize()">finalize</A></B>()</CODE>
  222.  
  223. <BR>
  224. &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Close the folder when we're finalized.</TD>
  225. </TR>
  226. <TR BGCOLOR="white" CLASS="TableRowColor">
  227. <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
  228. <CODE>&nbsp;<A HREF="../../../../javax/mail/Folder.html" title="class in javax.mail">Folder</A></CODE></FONT></TD>
  229. <TD><CODE><B><A HREF="../../../../com/sun/mail/pop3/POP3Folder.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>
  230.  
  231. <BR>
  232. &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Always throws <code>MessagingException</code> because no POP3 folders
  233. can contain subfolders.</TD>
  234. </TR>
  235. <TR BGCOLOR="white" CLASS="TableRowColor">
  236. <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
  237. <CODE>&nbsp;<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></CODE></FONT></TD>
  238. <TD><CODE><B><A HREF="../../../../com/sun/mail/pop3/POP3Folder.html#getFullName()">getFullName</A></B>()</CODE>
  239.  
  240. <BR>
  241. &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Returns the full name of this Folder.</TD>
  242. </TR>
  243. <TR BGCOLOR="white" CLASS="TableRowColor">
  244. <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
  245. <CODE>&nbsp;<A HREF="../../../../javax/mail/Message.html" title="class in javax.mail">Message</A></CODE></FONT></TD>
  246. <TD><CODE><B><A HREF="../../../../com/sun/mail/pop3/POP3Folder.html#getMessage(int)">getMessage</A></B>(int&nbsp;msgno)</CODE>
  247.  
  248. <BR>
  249. &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Get the Message object corresponding to the given message
  250. number.</TD>
  251. </TR>
  252. <TR BGCOLOR="white" CLASS="TableRowColor">
  253. <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
  254. <CODE>&nbsp;int</CODE></FONT></TD>
  255. <TD><CODE><B><A HREF="../../../../com/sun/mail/pop3/POP3Folder.html#getMessageCount()">getMessageCount</A></B>()</CODE>
  256.  
  257. <BR>
  258. &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Will not change while the folder is open because the POP3
  259. protocol doesn't support notification of new messages
  260.  arriving in open folders.</TD>
  261. </TR>
  262. <TR BGCOLOR="white" CLASS="TableRowColor">
  263. <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
  264. <CODE>&nbsp;<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></CODE></FONT></TD>
  265. <TD><CODE><B><A HREF="../../../../com/sun/mail/pop3/POP3Folder.html#getName()">getName</A></B>()</CODE>
  266.  
  267. <BR>
  268. &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Returns the name of this Folder.</TD>
  269. </TR>
  270. <TR BGCOLOR="white" CLASS="TableRowColor">
  271. <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
  272. <CODE>&nbsp;<A HREF="../../../../javax/mail/Folder.html" title="class in javax.mail">Folder</A></CODE></FONT></TD>
  273. <TD><CODE><B><A HREF="../../../../com/sun/mail/pop3/POP3Folder.html#getParent()">getParent</A></B>()</CODE>
  274.  
  275. <BR>
  276. &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Returns the parent folder of this folder.</TD>
  277. </TR>
  278. <TR BGCOLOR="white" CLASS="TableRowColor">
  279. <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
  280. <CODE>&nbsp;<A HREF="../../../../javax/mail/Flags.html" title="class in javax.mail">Flags</A></CODE></FONT></TD>
  281. <TD><CODE><B><A HREF="../../../../com/sun/mail/pop3/POP3Folder.html#getPermanentFlags()">getPermanentFlags</A></B>()</CODE>
  282.  
  283. <BR>
  284. &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Always returns an empty <code>Flags</code> object because
  285.  the POP3 protocol doesn't support any permanent flags.</TD>
  286. </TR>
  287. <TR BGCOLOR="white" CLASS="TableRowColor">
  288. <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
  289. <CODE>&nbsp;char</CODE></FONT></TD>
  290. <TD><CODE><B><A HREF="../../../../com/sun/mail/pop3/POP3Folder.html#getSeparator()">getSeparator</A></B>()</CODE>
  291.  
  292. <BR>
  293. &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Always returns a NUL character because POP3 doesn't support a hierarchy.</TD>
  294. </TR>
  295. <TR BGCOLOR="white" CLASS="TableRowColor">
  296. <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
  297. <CODE>&nbsp;int</CODE></FONT></TD>
  298. <TD><CODE><B><A HREF="../../../../com/sun/mail/pop3/POP3Folder.html#getSize()">getSize</A></B>()</CODE>
  299.  
  300. <BR>
  301. &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Return the size of this folder, as was returned by the POP3 STAT
  302.  command when this folder was opened.</TD>
  303. </TR>
  304. <TR BGCOLOR="white" CLASS="TableRowColor">
  305. <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
  306. <CODE>&nbsp;int[]</CODE></FONT></TD>
  307. <TD><CODE><B><A HREF="../../../../com/sun/mail/pop3/POP3Folder.html#getSizes()">getSizes</A></B>()</CODE>
  308.  
  309. <BR>
  310. &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Return the sizes of all messages in this folder, as returned
  311.  by the POP3 LIST command.</TD>
  312. </TR>
  313. <TR BGCOLOR="white" CLASS="TableRowColor">
  314. <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
  315. <CODE>&nbsp;int</CODE></FONT></TD>
  316. <TD><CODE><B><A HREF="../../../../com/sun/mail/pop3/POP3Folder.html#getType()">getType</A></B>()</CODE>
  317.  
  318. <BR>
  319. &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Always returns Folder.HOLDS_MESSAGES.</TD>
  320. </TR>
  321. <TR BGCOLOR="white" CLASS="TableRowColor">
  322. <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
  323. <CODE>&nbsp;<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></CODE></FONT></TD>
  324. <TD><CODE><B><A HREF="../../../../com/sun/mail/pop3/POP3Folder.html#getUID(javax.mail.Message)">getUID</A></B>(<A HREF="../../../../javax/mail/Message.html" title="class in javax.mail">Message</A>&nbsp;msg)</CODE>
  325.  
  326. <BR>
  327. &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Return the unique ID string for this message, or null if
  328.  not available.</TD>
  329. </TR>
  330. <TR BGCOLOR="white" CLASS="TableRowColor">
  331. <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
  332. <CODE>&nbsp;boolean</CODE></FONT></TD>
  333. <TD><CODE><B><A HREF="../../../../com/sun/mail/pop3/POP3Folder.html#hasNewMessages()">hasNewMessages</A></B>()</CODE>
  334.  
  335. <BR>
  336. &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Always returns <code>false</code>; the POP3 protocol provides
  337.  no way to determine when a new message arrives.</TD>
  338. </TR>
  339. <TR BGCOLOR="white" CLASS="TableRowColor">
  340. <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
  341. <CODE>&nbsp;boolean</CODE></FONT></TD>
  342. <TD><CODE><B><A HREF="../../../../com/sun/mail/pop3/POP3Folder.html#isOpen()">isOpen</A></B>()</CODE>
  343.  
  344. <BR>
  345. &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Indicates whether this Folder is in the 'open' state.</TD>
  346. </TR>
  347. <TR BGCOLOR="white" CLASS="TableRowColor">
  348. <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
  349. <CODE>&nbsp;<A HREF="../../../../javax/mail/Folder.html" title="class in javax.mail">Folder</A>[]</CODE></FONT></TD>
  350. <TD><CODE><B><A HREF="../../../../com/sun/mail/pop3/POP3Folder.html#list(java.lang.String)">list</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;pattern)</CODE>
  351.  
  352. <BR>
  353. &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Always throws <code>MessagingException</code> because no POP3 folders
  354.  can contain subfolders.</TD>
  355. </TR>
  356. <TR BGCOLOR="white" CLASS="TableRowColor">
  357. <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
  358. <CODE>&nbsp;<A HREF="http://java.sun.com/j2se/1.4.2/docs/api/java/io/InputStream.html?is-external=true" title="class or interface in java.io">InputStream</A></CODE></FONT></TD>
  359. <TD><CODE><B><A HREF="../../../../com/sun/mail/pop3/POP3Folder.html#listCommand()">listCommand</A></B>()</CODE>
  360.  
  361. <BR>
  362. &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Return the raw results of the POP3 LIST command with no arguments.</TD>
  363. </TR>
  364. <TR BGCOLOR="white" CLASS="TableRowColor">
  365. <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
  366. <CODE>protected &nbsp;void</CODE></FONT></TD>
  367. <TD><CODE><B><A HREF="../../../../com/sun/mail/pop3/POP3Folder.html#notifyMessageChangedListeners(int, javax.mail.Message)">notifyMessageChangedListeners</A></B>(int&nbsp;type,
  368.                               <A HREF="../../../../javax/mail/Message.html" title="class in javax.mail">Message</A>&nbsp;m)</CODE>
  369.  
  370. <BR>
  371. &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Notify all MessageChangedListeners.</TD>
  372. </TR>
  373. <TR BGCOLOR="white" CLASS="TableRowColor">
  374. <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
  375. <CODE>&nbsp;void</CODE></FONT></TD>
  376. <TD><CODE><B><A HREF="../../../../com/sun/mail/pop3/POP3Folder.html#open(int)">open</A></B>(int&nbsp;mode)</CODE>
  377.  
  378. <BR>
  379. &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Throws <code>FolderNotFoundException</code> unless this
  380.  folder is named "INBOX".</TD>
  381. </TR>
  382. <TR BGCOLOR="white" CLASS="TableRowColor">
  383. <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
  384. <CODE>&nbsp;boolean</CODE></FONT></TD>
  385. <TD><CODE><B><A HREF="../../../../com/sun/mail/pop3/POP3Folder.html#renameTo(javax.mail.Folder)">renameTo</A></B>(<A HREF="../../../../javax/mail/Folder.html" title="class in javax.mail">Folder</A>&nbsp;f)</CODE>
  386.  
  387. <BR>
  388. &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Always throws <code>MethodNotSupportedException</code>
  389.  because the POP3 protocol doesn't support multiple folders.</TD>
  390. </TR>
  391. </TABLE>
  392. &nbsp;<A NAME="methods_inherited_from_class_javax.mail.Folder"><!-- --></A>
  393. <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
  394. <TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
  395. <TH ALIGN="left"><B>Methods inherited from class javax.mail.<A HREF="../../../../javax/mail/Folder.html" title="class in javax.mail">Folder</A></B></TH>
  396. </TR>
  397. <TR BGCOLOR="white" CLASS="TableRowColor">
  398. <TD><CODE><A HREF="../../../../javax/mail/Folder.html#addConnectionListener(javax.mail.event.ConnectionListener)">addConnectionListener</A>, <A HREF="../../../../javax/mail/Folder.html#addFolderListener(javax.mail.event.FolderListener)">addFolderListener</A>, <A HREF="../../../../javax/mail/Folder.html#addMessageChangedListener(javax.mail.event.MessageChangedListener)">addMessageChangedListener</A>, <A HREF="../../../../javax/mail/Folder.html#addMessageCountListener(javax.mail.event.MessageCountListener)">addMessageCountListener</A>, <A HREF="../../../../javax/mail/Folder.html#copyMessages(javax.mail.Message[], javax.mail.Folder)">copyMessages</A>, <A HREF="../../../../javax/mail/Folder.html#getDeletedMessageCount()">getDeletedMessageCount</A>, <A HREF="../../../../javax/mail/Folder.html#getMessages()">getMessages</A>, <A HREF="../../../../javax/mail/Folder.html#getMessages(int[])">getMessages</A>, <A HREF="../../../../javax/mail/Folder.html#getMessages(int, int)">getMessages</A>, <A HREF="../../../../javax/mail/Folder.html#getMode()">getMode</A>, <A HREF="../../../../javax/mail/Folder.html#getNewMessageCount()">getNewMessageCount</A>, <A HREF="../../../../javax/mail/Folder.html#getStore()">getStore</A>, <A HREF="../../../../javax/mail/Folder.html#getUnreadMessageCount()">getUnreadMessageCount</A>, <A HREF="../../../../javax/mail/Folder.html#getURLName()">getURLName</A>, <A HREF="../../../../javax/mail/Folder.html#isSubscribed()">isSubscribed</A>, <A HREF="../../../../javax/mail/Folder.html#list()">list</A>, <A HREF="../../../../javax/mail/Folder.html#listSubscribed()">listSubscribed</A>, <A HREF="../../../../javax/mail/Folder.html#listSubscribed(java.lang.String)">listSubscribed</A>, <A HREF="../../../../javax/mail/Folder.html#notifyConnectionListeners(int)">notifyConnectionListeners</A>, <A HREF="../../../../javax/mail/Folder.html#notifyFolderListeners(int)">notifyFolderListeners</A>, <A HREF="../../../../javax/mail/Folder.html#notifyFolderRenamedListeners(javax.mail.Folder)">notifyFolderRenamedListeners</A>, <A HREF="../../../../javax/mail/Folder.html#notifyMessageAddedListeners(javax.mail.Message[])">notifyMessageAddedListeners</A>, <A HREF="../../../../javax/mail/Folder.html#notifyMessageRemovedListeners(boolean, javax.mail.Message[])">notifyMessageRemovedListeners</A>, <A HREF="../../../../javax/mail/Folder.html#removeConnectionListener(javax.mail.event.ConnectionListener)">removeConnectionListener</A>, <A HREF="../../../../javax/mail/Folder.html#removeFolderListener(javax.mail.event.FolderListener)">removeFolderListener</A>, <A HREF="../../../../javax/mail/Folder.html#removeMessageChangedListener(javax.mail.event.MessageChangedListener)">removeMessageChangedListener</A>, <A HREF="../../../../javax/mail/Folder.html#removeMessageCountListener(javax.mail.event.MessageCountListener)">removeMessageCountListener</A>, <A HREF="../../../../javax/mail/Folder.html#search(javax.mail.search.SearchTerm)">search</A>, <A HREF="../../../../javax/mail/Folder.html#search(javax.mail.search.SearchTerm, javax.mail.Message[])">search</A>, <A HREF="../../../../javax/mail/Folder.html#setFlags(int[], javax.mail.Flags, boolean)">setFlags</A>, <A HREF="../../../../javax/mail/Folder.html#setFlags(int, int, javax.mail.Flags, boolean)">setFlags</A>, <A HREF="../../../../javax/mail/Folder.html#setFlags(javax.mail.Message[], javax.mail.Flags, boolean)">setFlags</A>, <A HREF="../../../../javax/mail/Folder.html#setSubscribed(boolean)">setSubscribed</A>, <A HREF="../../../../javax/mail/Folder.html#toString()">toString</A></CODE></TD>
  399. </TR>
  400. </TABLE>
  401. &nbsp;<A NAME="methods_inherited_from_class_java.lang.Object"><!-- --></A>
  402. <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
  403. <TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
  404. <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>
  405. </TR>
  406. <TR BGCOLOR="white" CLASS="TableRowColor">
  407. <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>
  408. </TR>
  409. </TABLE>
  410. &nbsp;
  411. <P>
  412.  
  413. <!-- ============ METHOD DETAIL ========== -->
  414.  
  415. <A NAME="method_detail"><!-- --></A>
  416. <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
  417. <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
  418. <TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2">
  419. <B>Method Detail</B></FONT></TH>
  420. </TR>
  421. </TABLE>
  422.  
  423. <A NAME="getName()"><!-- --></A><H3>
  424. getName</H3>
  425. <PRE>
  426. public <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> <B>getName</B>()</PRE>
  427. <DL>
  428. <DD><B>Description copied from class: <CODE><A HREF="../../../../javax/mail/Folder.html#getName()">Folder</A></CODE></B></DD>
  429. <DD>Returns the name of this Folder. <p>
  430.  
  431. This method can be invoked on a closed Folder.
  432. <P>
  433. <DD><DL>
  434. <DT><B>Specified by:</B><DD><CODE><A HREF="../../../../javax/mail/Folder.html#getName()">getName</A></CODE> in class <CODE><A HREF="../../../../javax/mail/Folder.html" title="class in javax.mail">Folder</A></CODE></DL>
  435. </DD>
  436. <DD><DL>
  437.  
  438. <DT><B>Returns:</B><DD>name of the Folder</DL>
  439. </DD>
  440. </DL>
  441. <HR>
  442.  
  443. <A NAME="getFullName()"><!-- --></A><H3>
  444. getFullName</H3>
  445. <PRE>
  446. public <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> <B>getFullName</B>()</PRE>
  447. <DL>
  448. <DD><B>Description copied from class: <CODE><A HREF="../../../../javax/mail/Folder.html#getFullName()">Folder</A></CODE></B></DD>
  449. <DD>Returns the full name of this Folder. If the folder resides under
  450. the root hierarchy of this Store, the returned name is relative
  451. to the root. Otherwise an absolute name, starting with the
  452. hierarchy delimiter, is returned. <p>
  453.  
  454. This method can be invoked on a closed Folder.
  455. <P>
  456. <DD><DL>
  457. <DT><B>Specified by:</B><DD><CODE><A HREF="../../../../javax/mail/Folder.html#getFullName()">getFullName</A></CODE> in class <CODE><A HREF="../../../../javax/mail/Folder.html" title="class in javax.mail">Folder</A></CODE></DL>
  458. </DD>
  459. <DD><DL>
  460.  
  461. <DT><B>Returns:</B><DD>full name of the Folder</DL>
  462. </DD>
  463. </DL>
  464. <HR>
  465.  
  466. <A NAME="getParent()"><!-- --></A><H3>
  467. getParent</H3>
  468. <PRE>
  469. public <A HREF="../../../../javax/mail/Folder.html" title="class in javax.mail">Folder</A> <B>getParent</B>()</PRE>
  470. <DL>
  471. <DD><B>Description copied from class: <CODE><A HREF="../../../../javax/mail/Folder.html#getParent()">Folder</A></CODE></B></DD>
  472. <DD>Returns the parent folder of this folder.
  473. This method can be invoked on a closed Folder. If this folder
  474. is the top of a folder hierarchy, this method returns null. <p>
  475.  
  476. Note that since Folder objects are not cached, invoking this method
  477. returns a new distinct Folder object.
  478. <P>
  479. <DD><DL>
  480. <DT><B>Specified by:</B><DD><CODE><A HREF="../../../../javax/mail/Folder.html#getParent()">getParent</A></CODE> in class <CODE><A HREF="../../../../javax/mail/Folder.html" title="class in javax.mail">Folder</A></CODE></DL>
  481. </DD>
  482. <DD><DL>
  483.  
  484. <DT><B>Returns:</B><DD>Parent folder</DL>
  485. </DD>
  486. </DL>
  487. <HR>
  488.  
  489. <A NAME="exists()"><!-- --></A><H3>
  490. exists</H3>
  491. <PRE>
  492. public boolean <B>exists</B>()</PRE>
  493. <DL>
  494. <DD>Always true for the folder "INBOX", always false for
  495. any other name.
  496. <P>
  497. <DD><DL>
  498. <DT><B>Specified by:</B><DD><CODE><A HREF="../../../../javax/mail/Folder.html#exists()">exists</A></CODE> in class <CODE><A HREF="../../../../javax/mail/Folder.html" title="class in javax.mail">Folder</A></CODE></DL>
  499. </DD>
  500. <DD><DL>
  501.  
  502. <DT><B>Returns:</B><DD>true for INBOX, false otherwise<DT><B>See Also:</B><DD><A HREF="../../../../javax/mail/Folder.html#create(int)"><CODE>Folder.create(int)</CODE></A></DL>
  503. </DD>
  504. </DL>
  505. <HR>
  506.  
  507. <A NAME="list(java.lang.String)"><!-- --></A><H3>
  508. list</H3>
  509. <PRE>
  510. public <A HREF="../../../../javax/mail/Folder.html" title="class in javax.mail">Folder</A>[] <B>list</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;pattern)
  511.              throws <A HREF="../../../../javax/mail/MessagingException.html" title="class in javax.mail">MessagingException</A></PRE>
  512. <DL>
  513. <DD>Always throws <code>MessagingException</code> because no POP3 folders
  514. can contain subfolders.
  515. <P>
  516. <DD><DL>
  517. <DT><B>Specified by:</B><DD><CODE><A HREF="../../../../javax/mail/Folder.html#list(java.lang.String)">list</A></CODE> in class <CODE><A HREF="../../../../javax/mail/Folder.html" title="class in javax.mail">Folder</A></CODE></DL>
  518. </DD>
  519. <DD><DL>
  520. <DT><B>Parameters:</B><DD><CODE>pattern</CODE> - the match pattern
  521. <DT><B>Returns:</B><DD>array of matching Folder objects. An empty
  522.                        array is returned if no matching Folders exist.
  523. <DT><B>Throws:</B>
  524. <DD><CODE><A HREF="../../../../javax/mail/MessagingException.html" title="class in javax.mail">MessagingException</A></CODE> - always<DT><B>See Also:</B><DD><A HREF="../../../../javax/mail/Folder.html#listSubscribed(java.lang.String)"><CODE>Folder.listSubscribed(java.lang.String)</CODE></A></DL>
  525. </DD>
  526. </DL>
  527. <HR>
  528.  
  529. <A NAME="getSeparator()"><!-- --></A><H3>
  530. getSeparator</H3>
  531. <PRE>
  532. public char <B>getSeparator</B>()</PRE>
  533. <DL>
  534. <DD>Always returns a NUL character because POP3 doesn't support a hierarchy.
  535. <P>
  536. <DD><DL>
  537. <DT><B>Specified by:</B><DD><CODE><A HREF="../../../../javax/mail/Folder.html#getSeparator()">getSeparator</A></CODE> in class <CODE><A HREF="../../../../javax/mail/Folder.html" title="class in javax.mail">Folder</A></CODE></DL>
  538. </DD>
  539. <DD><DL>
  540.  
  541. <DT><B>Returns:</B><DD>NUL</DL>
  542. </DD>
  543. </DL>
  544. <HR>
  545.  
  546. <A NAME="getType()"><!-- --></A><H3>
  547. getType</H3>
  548. <PRE>
  549. public int <B>getType</B>()</PRE>
  550. <DL>
  551. <DD>Always returns Folder.HOLDS_MESSAGES.
  552. <P>
  553. <DD><DL>
  554. <DT><B>Specified by:</B><DD><CODE><A HREF="../../../../javax/mail/Folder.html#getType()">getType</A></CODE> in class <CODE><A HREF="../../../../javax/mail/Folder.html" title="class in javax.mail">Folder</A></CODE></DL>
  555. </DD>
  556. <DD><DL>
  557.  
  558. <DT><B>Returns:</B><DD>Folder.HOLDS_MESSAGES<DT><B>See Also:</B><DD><A HREF="../../../../javax/mail/Folder.html#HOLDS_FOLDERS"><CODE>Folder.HOLDS_FOLDERS</CODE></A>,
  559. <A HREF="../../../../javax/mail/Folder.html#HOLDS_MESSAGES"><CODE>Folder.HOLDS_MESSAGES</CODE></A></DL>
  560. </DD>
  561. </DL>
  562. <HR>
  563.  
  564. <A NAME="create(int)"><!-- --></A><H3>
  565. create</H3>
  566. <PRE>
  567. public boolean <B>create</B>(int&nbsp;type)
  568.                throws <A HREF="../../../../javax/mail/MessagingException.html" title="class in javax.mail">MessagingException</A></PRE>
  569. <DL>
  570. <DD>Always returns <code>false</code>; the POP3 protocol doesn't
  571. support creating folders.
  572. <P>
  573. <DD><DL>
  574. <DT><B>Specified by:</B><DD><CODE><A HREF="../../../../javax/mail/Folder.html#create(int)">create</A></CODE> in class <CODE><A HREF="../../../../javax/mail/Folder.html" title="class in javax.mail">Folder</A></CODE></DL>
  575. </DD>
  576. <DD><DL>
  577. <DT><B>Parameters:</B><DD><CODE>type</CODE> - The type of this folder.
  578. <DT><B>Returns:</B><DD>false
  579. <DT><B>Throws:</B>
  580. <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#HOLDS_FOLDERS"><CODE>Folder.HOLDS_FOLDERS</CODE></A>,
  581. <A HREF="../../../../javax/mail/Folder.html#HOLDS_MESSAGES"><CODE>Folder.HOLDS_MESSAGES</CODE></A>,
  582. <A HREF="../../../../javax/mail/event/FolderEvent.html" title="class in javax.mail.event"><CODE>FolderEvent</CODE></A></DL>
  583. </DD>
  584. </DL>
  585. <HR>
  586.  
  587. <A NAME="hasNewMessages()"><!-- --></A><H3>
  588. hasNewMessages</H3>
  589. <PRE>
  590. public boolean <B>hasNewMessages</B>()
  591.                       throws <A HREF="../../../../javax/mail/MessagingException.html" title="class in javax.mail">MessagingException</A></PRE>
  592. <DL>
  593. <DD>Always returns <code>false</code>; the POP3 protocol provides
  594. no way to determine when a new message arrives.
  595. <P>
  596. <DD><DL>
  597. <DT><B>Specified by:</B><DD><CODE><A HREF="../../../../javax/mail/Folder.html#hasNewMessages()">hasNewMessages</A></CODE> in class <CODE><A HREF="../../../../javax/mail/Folder.html" title="class in javax.mail">Folder</A></CODE></DL>
  598. </DD>
  599. <DD><DL>
  600.  
  601. <DT><B>Returns:</B><DD>false
  602. <DT><B>Throws:</B>
  603. <DD><CODE><A HREF="../../../../javax/mail/FolderNotFoundException.html" title="class in javax.mail">FolderNotFoundException</A></CODE> - if this folder does
  604.                        not exist.
  605. <DD><CODE><A HREF="../../../../javax/mail/MessagingException.html" title="class in javax.mail">MessagingException</A></CODE></DL>
  606. </DD>
  607. </DL>
  608. <HR>
  609.  
  610. <A NAME="getFolder(java.lang.String)"><!-- --></A><H3>
  611. getFolder</H3>
  612. <PRE>
  613. 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)
  614.                 throws <A HREF="../../../../javax/mail/MessagingException.html" title="class in javax.mail">MessagingException</A></PRE>
  615. <DL>
  616. <DD>Always throws <code>MessagingException</code> because no POP3 folders
  617. can contain subfolders.
  618. <P>
  619. <DD><DL>
  620. <DT><B>Specified by:</B><DD><CODE><A HREF="../../../../javax/mail/Folder.html#getFolder(java.lang.String)">getFolder</A></CODE> in class <CODE><A HREF="../../../../javax/mail/Folder.html" title="class in javax.mail">Folder</A></CODE></DL>
  621. </DD>
  622. <DD><DL>
  623. <DT><B>Parameters:</B><DD><CODE>name</CODE> - name of the Folder
  624. <DT><B>Returns:</B><DD>Folder object
  625. <DT><B>Throws:</B>
  626. <DD><CODE><A HREF="../../../../javax/mail/MessagingException.html" title="class in javax.mail">MessagingException</A></CODE> - always</DL>
  627. </DD>
  628. </DL>
  629. <HR>
  630.  
  631. <A NAME="delete(boolean)"><!-- --></A><H3>
  632. delete</H3>
  633. <PRE>
  634. public boolean <B>delete</B>(boolean&nbsp;recurse)
  635.               throws <A HREF="../../../../javax/mail/MessagingException.html" title="class in javax.mail">MessagingException</A></PRE>
  636. <DL>
  637. <DD>Always throws <code>MethodNotSupportedException</code>
  638. because the POP3 protocol doesn't allow the INBOX to
  639.  be deleted.
  640. <P>
  641. <DD><DL>
  642. <DT><B>Specified by:</B><DD><CODE><A HREF="../../../../javax/mail/Folder.html#delete(boolean)">delete</A></CODE> in class <CODE><A HREF="../../../../javax/mail/Folder.html" title="class in javax.mail">Folder</A></CODE></DL>
  643. </DD>
  644. <DD><DL>
  645.  
  646. <DT><B>Returns:</B><DD>true if the Folder is deleted successfully
  647. <DT><B>Throws:</B>
  648. <DD><CODE><A HREF="../../../../javax/mail/MethodNotSupportedException.html" title="class in javax.mail">MethodNotSupportedException</A></CODE> - always
  649. <DD><CODE><A HREF="../../../../javax/mail/FolderNotFoundException.html" title="class in javax.mail">FolderNotFoundException</A></CODE> - if this folder does
  650.                         not exist
  651. <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/event/FolderEvent.html" title="class in javax.mail.event"><CODE>FolderEvent</CODE></A></DL>
  652. </DD>
  653. </DL>
  654. <HR>
  655.  
  656. <A NAME="renameTo(javax.mail.Folder)"><!-- --></A><H3>
  657. renameTo</H3>
  658. <PRE>
  659. public boolean <B>renameTo</B>(<A HREF="../../../../javax/mail/Folder.html" title="class in javax.mail">Folder</A>&nbsp;f)
  660.                  throws <A HREF="../../../../javax/mail/MessagingException.html" title="class in javax.mail">MessagingException</A></PRE>
  661. <DL>
  662. <DD>Always throws <code>MethodNotSupportedException</code>
  663.  because the POP3 protocol doesn't support multiple folders.
  664. <P>
  665. <DD><DL>
  666. <DT><B>Specified by:</B><DD><CODE><A HREF="../../../../javax/mail/Folder.html#renameTo(javax.mail.Folder)">renameTo</A></CODE> in class <CODE><A HREF="../../../../javax/mail/Folder.html" title="class in javax.mail">Folder</A></CODE></DL>
  667. </DD>
  668. <DD><DL>
  669. <DT><B>Parameters:</B><DD><CODE>f</CODE> - a folder representing the new name for this Folder
  670. <DT><B>Returns:</B><DD>true if the Folder is renamed successfully
  671. <DT><B>Throws:</B>
  672. <DD><CODE><A HREF="../../../../javax/mail/MethodNotSupportedException.html" title="class in javax.mail">MethodNotSupportedException</A></CODE> - always
  673. <DD><CODE><A HREF="../../../../javax/mail/FolderNotFoundException.html" title="class in javax.mail">FolderNotFoundException</A></CODE> - if this folder does
  674.                        not exist
  675. <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/event/FolderEvent.html" title="class in javax.mail.event"><CODE>FolderEvent</CODE></A></DL>
  676. </DD>
  677. </DL>
  678. <HR>
  679.  
  680. <A NAME="open(int)"><!-- --></A><H3>
  681. open</H3>
  682. <PRE>
  683. public void <B>open</B>(int&nbsp;mode)
  684.          throws <A HREF="../../../../javax/mail/MessagingException.html" title="class in javax.mail">MessagingException</A></PRE>
  685. <DL>
  686. <DD>Throws <code>FolderNotFoundException</code> unless this
  687. folder is named "INBOX".
  688. <P>
  689. <DD><DL>
  690. <DT><B>Specified by:</B><DD><CODE><A HREF="../../../../javax/mail/Folder.html#open(int)">open</A></CODE> in class <CODE><A HREF="../../../../javax/mail/Folder.html" title="class in javax.mail">Folder</A></CODE></DL>
  691. </DD>
  692. <DD><DL>
  693. <DT><B>Parameters:</B><DD><CODE>mode</CODE> - open the Folder READ_ONLY or READ_WRITE
  694. <DT><B>Throws:</B>
  695. <DD><CODE><A HREF="../../../../javax/mail/FolderNotFoundException.html" title="class in javax.mail">FolderNotFoundException</A></CODE> - if not INBOX
  696. <DD><CODE>AuthenticationException</CODE> - authentication failures
  697. <DD><CODE><A HREF="../../../../javax/mail/MessagingException.html" title="class in javax.mail">MessagingException</A></CODE> - other open failures<DT><B>See Also:</B><DD><A HREF="../../../../javax/mail/Folder.html#READ_ONLY"><CODE>Folder.READ_ONLY</CODE></A>,
  698. <A HREF="../../../../javax/mail/Folder.html#READ_WRITE"><CODE>Folder.READ_WRITE</CODE></A>,
  699. <A HREF="../../../../javax/mail/Folder.html#getType()"><CODE>Folder.getType()</CODE></A>,
  700. <A HREF="../../../../javax/mail/event/ConnectionEvent.html" title="class in javax.mail.event"><CODE>ConnectionEvent</CODE></A></DL>
  701. </DD>
  702. </DL>
  703. <HR>
  704.  
  705. <A NAME="close(boolean)"><!-- --></A><H3>
  706. close</H3>
  707. <PRE>
  708. public void <B>close</B>(boolean&nbsp;expunge)
  709.           throws <A HREF="../../../../javax/mail/MessagingException.html" title="class in javax.mail">MessagingException</A></PRE>
  710. <DL>
  711. <DD><B>Description copied from class: <CODE><A HREF="../../../../javax/mail/Folder.html#close(boolean)">Folder</A></CODE></B></DD>
  712. <DD>Close this Folder. This method is valid only on open Folders. <p>
  713.  
  714. A CLOSED ConnectionEvent is delivered to any ConnectionListeners
  715. registered on this Folder. Note that the folder is closed even
  716. if this method terminates abnormally by throwing a
  717. MessagingException.
  718. <P>
  719. <DD><DL>
  720. <DT><B>Specified by:</B><DD><CODE><A HREF="../../../../javax/mail/Folder.html#close(boolean)">close</A></CODE> in class <CODE><A HREF="../../../../javax/mail/Folder.html" title="class in javax.mail">Folder</A></CODE></DL>
  721. </DD>
  722. <DD><DL>
  723. <DT><B>Parameters:</B><DD><CODE>expunge</CODE> - expunges all deleted messages if this flag is true
  724. <DT><B>Throws:</B>
  725. <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/event/ConnectionEvent.html" title="class in javax.mail.event"><CODE>ConnectionEvent</CODE></A></DL>
  726. </DD>
  727. </DL>
  728. <HR>
  729.  
  730. <A NAME="isOpen()"><!-- --></A><H3>
  731. isOpen</H3>
  732. <PRE>
  733. public boolean <B>isOpen</B>()</PRE>
  734. <DL>
  735. <DD><B>Description copied from class: <CODE><A HREF="../../../../javax/mail/Folder.html#isOpen()">Folder</A></CODE></B></DD>
  736. <DD>Indicates whether this Folder is in the 'open' state.
  737. <P>
  738. <DD><DL>
  739. <DT><B>Specified by:</B><DD><CODE><A HREF="../../../../javax/mail/Folder.html#isOpen()">isOpen</A></CODE> in class <CODE><A HREF="../../../../javax/mail/Folder.html" title="class in javax.mail">Folder</A></CODE></DL>
  740. </DD>
  741. <DD><DL>
  742.  
  743. <DT><B>Returns:</B><DD>true if this Folder is in the 'open' state.</DL>
  744. </DD>
  745. </DL>
  746. <HR>
  747.  
  748. <A NAME="getPermanentFlags()"><!-- --></A><H3>
  749. getPermanentFlags</H3>
  750. <PRE>
  751. public <A HREF="../../../../javax/mail/Flags.html" title="class in javax.mail">Flags</A> <B>getPermanentFlags</B>()</PRE>
  752. <DL>
  753. <DD>Always returns an empty <code>Flags</code> object because
  754. the POP3 protocol doesn't support any permanent flags.
  755. <P>
  756. <DD><DL>
  757. <DT><B>Specified by:</B><DD><CODE><A HREF="../../../../javax/mail/Folder.html#getPermanentFlags()">getPermanentFlags</A></CODE> in class <CODE><A HREF="../../../../javax/mail/Folder.html" title="class in javax.mail">Folder</A></CODE></DL>
  758. </DD>
  759. <DD><DL>
  760.  
  761. <DT><B>Returns:</B><DD>empty Flags object</DL>
  762. </DD>
  763. </DL>
  764. <HR>
  765.  
  766. <A NAME="getMessageCount()"><!-- --></A><H3>
  767. getMessageCount</H3>
  768. <PRE>
  769. public int <B>getMessageCount</B>()
  770.                     throws <A HREF="../../../../javax/mail/MessagingException.html" title="class in javax.mail">MessagingException</A></PRE>
  771. <DL>
  772. <DD>Will not change while the folder is open because the POP3
  773.  protocol doesn't support notification of new messages
  774. arriving in open folders.
  775. <P>
  776. <DD><DL>
  777. <DT><B>Specified by:</B><DD><CODE><A HREF="../../../../javax/mail/Folder.html#getMessageCount()">getMessageCount</A></CODE> in class <CODE><A HREF="../../../../javax/mail/Folder.html" title="class in javax.mail">Folder</A></CODE></DL>
  778. </DD>
  779. <DD><DL>
  780.  
  781. <DT><B>Returns:</B><DD>total number of messages. -1 may be returned
  782.                        by certain implementations if this method is
  783.                        invoked on a closed folder.
  784. <DT><B>Throws:</B>
  785. <DD><CODE><A HREF="../../../../javax/mail/FolderNotFoundException.html" title="class in javax.mail">FolderNotFoundException</A></CODE> - if this folder does
  786.                        not exist.
  787. <DD><CODE><A HREF="../../../../javax/mail/MessagingException.html" title="class in javax.mail">MessagingException</A></CODE></DL>
  788. </DD>
  789. </DL>
  790. <HR>
  791.  
  792. <A NAME="getMessage(int)"><!-- --></A><H3>
  793. getMessage</H3>
  794. <PRE>
  795. public <A HREF="../../../../javax/mail/Message.html" title="class in javax.mail">Message</A> <B>getMessage</B>(int&nbsp;msgno)
  796.                   throws <A HREF="../../../../javax/mail/MessagingException.html" title="class in javax.mail">MessagingException</A></PRE>
  797. <DL>
  798. <DD><B>Description copied from class: <CODE><A HREF="../../../../javax/mail/Folder.html#getMessage(int)">Folder</A></CODE></B></DD>
  799. <DD>Get the Message object corresponding to the given message
  800. number.  A Message object's message number is the relative
  801.  position of this Message in its Folder. Messages are numbered
  802.  starting at 1 through the total number of message in the folder.
  803.  Note that the message number for a particular Message can change
  804.  during a session if other messages in the Folder are deleted and
  805.  the Folder is expunged. <p>
  806.  
  807.  Message objects are light-weight references to the actual message
  808.  that get filled up on demand. Hence Folder implementations are
  809.  expected to provide light-weight Message objects. <p>
  810.  
  811.  Unlike Folder objects, repeated calls to getMessage with the
  812.  same message number will return the same Message object, as
  813.  long as no messages in this folder have been expunged. <p>
  814.  
  815.  Since message numbers can change within a session if the folder
  816.  is expunged , clients are advised not to use message numbers as
  817.  references to messages. Use Message objects instead.
  818. <P>
  819. <DD><DL>
  820. <DT><B>Specified by:</B><DD><CODE><A HREF="../../../../javax/mail/Folder.html#getMessage(int)">getMessage</A></CODE> in class <CODE><A HREF="../../../../javax/mail/Folder.html" title="class in javax.mail">Folder</A></CODE></DL>
  821. </DD>
  822. <DD><DL>
  823. <DT><B>Parameters:</B><DD><CODE>msgno</CODE> - the message number
  824. <DT><B>Returns:</B><DD>the Message object
  825. <DT><B>Throws:</B>
  826. <DD><CODE><A HREF="../../../../javax/mail/FolderNotFoundException.html" title="class in javax.mail">FolderNotFoundException</A></CODE> - if this folder does
  827.                         not exist.
  828. <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#getMessageCount()"><CODE>Folder.getMessageCount()</CODE></A>,
  829. <A HREF="../../../../javax/mail/Folder.html#fetch(javax.mail.Message[], javax.mail.FetchProfile)"><CODE>Folder.fetch(javax.mail.Message[], javax.mail.FetchProfile)</CODE></A></DL>
  830. </DD>
  831. </DL>
  832. <HR>
  833.  
  834. <A NAME="createMessage(javax.mail.Folder, int)"><!-- --></A><H3>
  835. createMessage</H3>
  836. <PRE>
  837. protected <A HREF="../../../../com/sun/mail/pop3/POP3Message.html" title="class in com.sun.mail.pop3">POP3Message</A> <B>createMessage</B>(<A HREF="../../../../javax/mail/Folder.html" title="class in javax.mail">Folder</A>&nbsp;f,
  838.                                     int&nbsp;msgno)
  839.                              throws <A HREF="../../../../javax/mail/MessagingException.html" title="class in javax.mail">MessagingException</A></PRE>
  840. <DL>
  841. <DD><DL>
  842.  
  843. <DT><B>Throws:</B>
  844. <DD><CODE><A HREF="../../../../javax/mail/MessagingException.html" title="class in javax.mail">MessagingException</A></CODE></DL>
  845. </DD>
  846. </DL>
  847. <HR>
  848.  
  849. <A NAME="appendMessages(javax.mail.Message[])"><!-- --></A><H3>
  850. appendMessages</H3>
  851. <PRE>
  852. public void <B>appendMessages</B>(<A HREF="../../../../javax/mail/Message.html" title="class in javax.mail">Message</A>[]&nbsp;msgs)
  853.                     throws <A HREF="../../../../javax/mail/MessagingException.html" title="class in javax.mail">MessagingException</A></PRE>
  854. <DL>
  855. <DD>Always throws <code>MethodNotSupportedException</code>
  856.  because the POP3 protocol doesn't support appending messages.
  857. <P>
  858. <DD><DL>
  859. <DT><B>Specified by:</B><DD><CODE><A HREF="../../../../javax/mail/Folder.html#appendMessages(javax.mail.Message[])">appendMessages</A></CODE> in class <CODE><A HREF="../../../../javax/mail/Folder.html" title="class in javax.mail">Folder</A></CODE></DL>
  860. </DD>
  861. <DD><DL>
  862. <DT><B>Parameters:</B><DD><CODE>msgs</CODE> - array of Messages to be appended
  863. <DT><B>Throws:</B>
  864. <DD><CODE><A HREF="../../../../javax/mail/MethodNotSupportedException.html" title="class in javax.mail">MethodNotSupportedException</A></CODE> - always
  865. <DD><CODE><A HREF="../../../../javax/mail/FolderNotFoundException.html" title="class in javax.mail">FolderNotFoundException</A></CODE> - if this folder does
  866.                        not exist.
  867. <DD><CODE><A HREF="../../../../javax/mail/MessagingException.html" title="class in javax.mail">MessagingException</A></CODE> - if the append failed.</DL>
  868. </DD>
  869. </DL>
  870. <HR>
  871.  
  872. <A NAME="expunge()"><!-- --></A><H3>
  873. expunge</H3>
  874. <PRE>
  875. public <A HREF="../../../../javax/mail/Message.html" title="class in javax.mail">Message</A>[] <B>expunge</B>()
  876.                  throws <A HREF="../../../../javax/mail/MessagingException.html" title="class in javax.mail">MessagingException</A></PRE>
  877. <DL>
  878. <DD>Always throws <code>MethodNotSupportedException</code>
  879. because the POP3 protocol doesn't support expunging messages
  880.  without closing the folder; call the <A HREF="../../../../com/sun/mail/pop3/POP3Folder.html#close(boolean)"><CODE>close</CODE></A> method
  881.  with the <code>expunge</code> argument set to <code>true</code>
  882.  instead.
  883. <P>
  884. <DD><DL>
  885. <DT><B>Specified by:</B><DD><CODE><A HREF="../../../../javax/mail/Folder.html#expunge()">expunge</A></CODE> in class <CODE><A HREF="../../../../javax/mail/Folder.html" title="class in javax.mail">Folder</A></CODE></DL>
  886. </DD>
  887. <DD><DL>
  888.  
  889. <DT><B>Returns:</B><DD>array of expunged Message objects
  890. <DT><B>Throws:</B>
  891. <DD><CODE><A HREF="../../../../javax/mail/MethodNotSupportedException.html" title="class in javax.mail">MethodNotSupportedException</A></CODE> - always
  892. <DD><CODE><A HREF="../../../../javax/mail/FolderNotFoundException.html" title="class in javax.mail">FolderNotFoundException</A></CODE> - if this folder does not
  893.                         exist
  894. <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/Message.html#isExpunged()"><CODE>Message.isExpunged()</CODE></A>,
  895. <A HREF="../../../../javax/mail/event/MessageCountEvent.html" title="class in javax.mail.event"><CODE>MessageCountEvent</CODE></A></DL>
  896. </DD>
  897. </DL>
  898. <HR>
  899.  
  900. <A NAME="fetch(javax.mail.Message[], javax.mail.FetchProfile)"><!-- --></A><H3>
  901. fetch</H3>
  902. <PRE>
  903. public void <B>fetch</B>(<A HREF="../../../../javax/mail/Message.html" title="class in javax.mail">Message</A>[]&nbsp;msgs,
  904.                   <A HREF="../../../../javax/mail/FetchProfile.html" title="class in javax.mail">FetchProfile</A>&nbsp;fp)
  905.            throws <A HREF="../../../../javax/mail/MessagingException.html" title="class in javax.mail">MessagingException</A></PRE>
  906. <DL>
  907. <DD>Prefetch information about POP3 messages.
  908.  If the FetchProfile contains <code>UIDFolder.FetchProfileItem.UID</code>,
  909.  POP3 UIDs for all messages in the folder are fetched using the POP3
  910.  UIDL command.
  911.  If the FetchProfile contains <code>FetchProfile.Item.ENVELOPE</code>,
  912.  the headers and size of all messages are fetched using the POP3 TOP
  913.  and LIST commands.
  914. <P>
  915. <DD><DL>
  916. <DT><B>Overrides:</B><DD><CODE><A HREF="../../../../javax/mail/Folder.html#fetch(javax.mail.Message[], javax.mail.FetchProfile)">fetch</A></CODE> in class <CODE><A HREF="../../../../javax/mail/Folder.html" title="class in javax.mail">Folder</A></CODE></DL>
  917. </DD>
  918. <DD><DL>
  919. <DT><B>Parameters:</B><DD><CODE>msgs</CODE> - fetch items for these messages<DD><CODE>fp</CODE> - the FetchProfile
  920. <DT><B>Throws:</B>
  921. <DD><CODE><A HREF="../../../../javax/mail/MessagingException.html" title="class in javax.mail">MessagingException</A></CODE></DL>
  922. </DD>
  923. </DL>
  924. <HR>
  925.  
  926. <A NAME="getUID(javax.mail.Message)"><!-- --></A><H3>
  927. getUID</H3>
  928. <PRE>
  929. public <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> <B>getUID</B>(<A HREF="../../../../javax/mail/Message.html" title="class in javax.mail">Message</A>&nbsp;msg)
  930.               throws <A HREF="../../../../javax/mail/MessagingException.html" title="class in javax.mail">MessagingException</A></PRE>
  931. <DL>
  932. <DD>Return the unique ID string for this message, or null if
  933.  not available.  Uses the POP3 UIDL command.
  934. <P>
  935. <DD><DL>
  936.  
  937. <DT><B>Returns:</B><DD>unique ID string
  938. <DT><B>Throws:</B>
  939. <DD><CODE><A HREF="../../../../javax/mail/MessagingException.html" title="class in javax.mail">MessagingException</A></CODE></DL>
  940. </DD>
  941. </DL>
  942. <HR>
  943.  
  944. <A NAME="getSize()"><!-- --></A><H3>
  945. getSize</H3>
  946. <PRE>
  947. public int <B>getSize</B>()
  948.             throws <A HREF="../../../../javax/mail/MessagingException.html" title="class in javax.mail">MessagingException</A></PRE>
  949. <DL>
  950. <DD>Return the size of this folder, as was returned by the POP3 STAT
  951.  command when this folder was opened.
  952. <P>
  953. <DD><DL>
  954.  
  955. <DT><B>Returns:</B><DD>folder size
  956. <DT><B>Throws:</B>
  957. <DD><CODE><A HREF="http://java.sun.com/j2se/1.4.2/docs/api/java/lang/IllegalStateException.html?is-external=true" title="class or interface in java.lang">IllegalStateException</A></CODE> - if the folder isn't open
  958. <DD><CODE><A HREF="../../../../javax/mail/MessagingException.html" title="class in javax.mail">MessagingException</A></CODE></DL>
  959. </DD>
  960. </DL>
  961. <HR>
  962.  
  963. <A NAME="getSizes()"><!-- --></A><H3>
  964. getSizes</H3>
  965. <PRE>
  966. public int[] <B>getSizes</B>()
  967.               throws <A HREF="../../../../javax/mail/MessagingException.html" title="class in javax.mail">MessagingException</A></PRE>
  968. <DL>
  969. <DD>Return the sizes of all messages in this folder, as returned
  970. by the POP3 LIST command.  Each entry in the array corresponds
  971. to a message; entry <i>i</i> corresponds to message number <i>i+1</i>.
  972. <P>
  973. <DD><DL>
  974.  
  975. <DT><B>Returns:</B><DD>array of message sizes
  976. <DT><B>Throws:</B>
  977. <DD><CODE><A HREF="http://java.sun.com/j2se/1.4.2/docs/api/java/lang/IllegalStateException.html?is-external=true" title="class or interface in java.lang">IllegalStateException</A></CODE> - if the folder isn't open
  978. <DD><CODE><A HREF="../../../../javax/mail/MessagingException.html" title="class in javax.mail">MessagingException</A></CODE><DT><B>Since:</B></DT>
  979.   <DD>JavaMail 1.3.3</DD>
  980. </DL>
  981. </DD>
  982. </DL>
  983. <HR>
  984.  
  985. <A NAME="listCommand()"><!-- --></A><H3>
  986. listCommand</H3>
  987. <PRE>
  988. public <A HREF="http://java.sun.com/j2se/1.4.2/docs/api/java/io/InputStream.html?is-external=true" title="class or interface in java.io">InputStream</A> <B>listCommand</B>()
  989.                         throws <A HREF="../../../../javax/mail/MessagingException.html" title="class in javax.mail">MessagingException</A>,
  990.                                <A HREF="http://java.sun.com/j2se/1.4.2/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</A></PRE>
  991. <DL>
  992. <DD>Return the raw results of the POP3 LIST command with no arguments.
  993. <P>
  994. <DD><DL>
  995.  
  996. <DT><B>Returns:</B><DD>InputStream containing results
  997. <DT><B>Throws:</B>
  998. <DD><CODE><A HREF="http://java.sun.com/j2se/1.4.2/docs/api/java/lang/IllegalStateException.html?is-external=true" title="class or interface in java.lang">IllegalStateException</A></CODE> - if the folder isn't open
  999. <DD><CODE><A HREF="../../../../javax/mail/MessagingException.html" title="class in javax.mail">MessagingException</A></CODE>
  1000. <DD><CODE><A HREF="http://java.sun.com/j2se/1.4.2/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</A></CODE><DT><B>Since:</B></DT>
  1001.  <DD>JavaMail 1.3.3</DD>
  1002. </DL>
  1003. </DD>
  1004. </DL>
  1005. <HR>
  1006.  
  1007. <A NAME="finalize()"><!-- --></A><H3>
  1008. finalize</H3>
  1009. <PRE>
  1010. protected void <B>finalize</B>()
  1011.                 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>
  1012. <DL>
  1013. <DD>Close the folder when we're finalized.
  1014. <P>
  1015. <DD><DL>
  1016. <DT><B>Overrides:</B><DD><CODE><A HREF="../../../../javax/mail/Folder.html#finalize()">finalize</A></CODE> in class <CODE><A HREF="../../../../javax/mail/Folder.html" title="class in javax.mail">Folder</A></CODE></DL>
  1017. </DD>
  1018. <DD><DL>
  1019.  
  1020. <DT><B>Throws:</B>
  1021. <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>
  1022. </DD>
  1023. </DL>
  1024. <HR>
  1025.  
  1026. <A NAME="notifyMessageChangedListeners(int, javax.mail.Message)"><!-- --></A><H3>
  1027. notifyMessageChangedListeners</H3>
  1028. <PRE>
  1029. protected void <B>notifyMessageChangedListeners</B>(int&nbsp;type,
  1030.                                              <A HREF="../../../../javax/mail/Message.html" title="class in javax.mail">Message</A>&nbsp;m)</PRE>
  1031. <DL>
  1032. <DD><B>Description copied from class: <CODE><A HREF="../../../../javax/mail/Folder.html#notifyMessageChangedListeners(int, javax.mail.Message)">Folder</A></CODE></B></DD>
  1033. <DD>Notify all MessageChangedListeners. Folder implementations are
  1034.  expected to use this method to broadcast MessageChanged events. <p>
  1035.  
  1036.  The provided implementation queues the event into
  1037.  an internal event queue. An event dispatcher thread dequeues
  1038.  events from the queue and dispatches them to registered
  1039.  MessageChangedListeners. Note that the event dispatching occurs
  1040.  in a separate thread, thus avoiding potential deadlock problems.
  1041. <P>
  1042. <DD><DL>
  1043. <DT><B>Overrides:</B><DD><CODE><A HREF="../../../../javax/mail/Folder.html#notifyMessageChangedListeners(int, javax.mail.Message)">notifyMessageChangedListeners</A></CODE> in class <CODE><A HREF="../../../../javax/mail/Folder.html" title="class in javax.mail">Folder</A></CODE></DL>
  1044. </DD>
  1045. <DD><DL>
  1046. </DL>
  1047. </DD>
  1048. </DL>
  1049. <!-- ========= END OF CLASS DATA ========= -->
  1050. <HR>
  1051.  
  1052.  
  1053. <!-- ======= START OF BOTTOM NAVBAR ====== -->
  1054. <A NAME="navbar_bottom"><!-- --></A>
  1055. <A HREF="#skip-navbar_bottom" title="Skip navigation links"></A>
  1056. <TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">
  1057. <TR>
  1058. <TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
  1059. <A NAME="navbar_bottom_firstrow"><!-- --></A>
  1060. <TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">
  1061.   <TR ALIGN="center" VALIGN="top">
  1062.   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A>&nbsp;</TD>
  1063.   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A>&nbsp;</TD>
  1064.   <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> &nbsp;<FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT>&nbsp;</TD>
  1065.   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="class-use/POP3Folder.html"><FONT CLASS="NavBarFont1"><B>Use</B></FONT></A>&nbsp;</TD>
  1066.   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A>&nbsp;</TD>
  1067.   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A>&nbsp;</TD>
  1068.   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../index-files/index-1.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A>&nbsp;</TD>
  1069.   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A>&nbsp;</TD>
  1070.   </TR>
  1071. </TABLE>
  1072. </TD>
  1073. <TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
  1074. </EM>
  1075. </TD>
  1076. </TR>
  1077.  
  1078. <TR>
  1079. <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
  1080. &nbsp;PREV CLASS&nbsp;
  1081. &nbsp;<A HREF="../../../../com/sun/mail/pop3/POP3Message.html" title="class in com.sun.mail.pop3"><B>NEXT CLASS</B></A></FONT></TD>
  1082. <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
  1083.   <A HREF="../../../../index.html?com/sun/mail/pop3/POP3Folder.html" target="_top"><B>FRAMES</B></A>  &nbsp;
  1084. &nbsp;<A HREF="POP3Folder.html" target="_top"><B>NO FRAMES</B></A>  &nbsp;
  1085. &nbsp;<SCRIPT type="text/javascript">
  1086.   <!--
  1087.   if(window==top) {
  1088.     document.writeln('<A HREF="../../../../allclasses-noframe.html"><B>All Classes</B></A>');
  1089.   }
  1090.   //-->
  1091. </SCRIPT>
  1092. <NOSCRIPT>
  1093.   <A HREF="../../../../allclasses-noframe.html"><B>All Classes</B></A>
  1094. </NOSCRIPT>
  1095.  
  1096.  
  1097. </FONT></TD>
  1098. </TR>
  1099. <TR>
  1100. <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
  1101.   SUMMARY:&nbsp;NESTED&nbsp;|&nbsp;<A HREF="#fields_inherited_from_class_javax.mail.Folder">FIELD</A>&nbsp;|&nbsp;CONSTR&nbsp;|&nbsp;<A HREF="#method_summary">METHOD</A></FONT></TD>
  1102. <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
  1103. DETAIL:&nbsp;FIELD&nbsp;|&nbsp;CONSTR&nbsp;|&nbsp;<A HREF="#method_detail">METHOD</A></FONT></TD>
  1104. </TR>
  1105. </TABLE>
  1106. <A NAME="skip-navbar_bottom"></A>
  1107. <!-- ======== END OF BOTTOM NAVBAR ======= -->
  1108.  
  1109. <HR>
  1110. Copyright &#169; 2009 <a href="http://www.sun.com">Sun Microsystems, Inc.</a>. All Rights Reserved.
  1111. </BODY>
  1112. </HTML>
  1113.