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:41 PST 2009 -->
  6. <META http-equiv="Content-Type" content="text/html; charset=ISO-8859-1">
  7. <TITLE>
  8. IMAPFolder (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="IMAPFolder (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/IMAPFolder.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/imap/ACL.html" title="class in com.sun.mail.imap"><B>PREV CLASS</B></A>&nbsp;
  60. &nbsp;<A HREF="../../../../com/sun/mail/imap/IMAPFolder.FetchProfileItem.html" title="class in com.sun.mail.imap"><B>NEXT CLASS</B></A></FONT></TD>
  61. <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
  62.   <A HREF="../../../../index.html?com/sun/mail/imap/IMAPFolder.html" target="_top"><B>FRAMES</B></A>  &nbsp;
  63. &nbsp;<A HREF="IMAPFolder.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;<A HREF="#nested_class_summary">NESTED</A>&nbsp;|&nbsp;<A HREF="#field_summary">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;<A HREF="#field_detail">FIELD</A>&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.imap</FONT>
  93. <BR>
  94. Class IMAPFolder</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.imap.IMAPFolder</B>
  99. </PRE>
  100. <DL>
  101. <DT><B>All Implemented Interfaces:</B> <DD>com.sun.mail.iap.ResponseHandler, <A HREF="../../../../javax/mail/UIDFolder.html" title="interface in javax.mail">UIDFolder</A></DD>
  102. </DL>
  103. <HR>
  104. <DL>
  105. <DT><PRE>public class <B>IMAPFolder</B><DT>extends <A HREF="../../../../javax/mail/Folder.html" title="class in javax.mail">Folder</A><DT>implements <A HREF="../../../../javax/mail/UIDFolder.html" title="interface in javax.mail">UIDFolder</A>, com.sun.mail.iap.ResponseHandler</DL>
  106. </PRE>
  107.  
  108. <P>
  109. This class implements an IMAP folder. <p>
  110.  
  111.  A closed IMAPFolder object shares a protocol connection with its IMAPStore
  112.  object. When the folder is opened, it gets its own protocol connection. <p>
  113.  
  114.  Applications that need to make use of IMAP-specific features may cast
  115.  a <code>Folder</code> object to an <code>IMAPFolder</code> object and
  116.  use the methods on this class. The <A HREF="../../../../com/sun/mail/imap/IMAPFolder.html#getQuota()"><CODE>getQuota</CODE></A> and
  117.  <A HREF="../../../../com/sun/mail/imap/IMAPFolder.html#setQuota(javax.mail.Quota)"><CODE>setQuota</CODE></A> methods support the IMAP QUOTA extension.
  118.  Refer to <A HREF="http://www.ietf.org/rfc/rfc2087.txt">RFC 2087</A>
  119.  for more information. <p>
  120.  
  121.  The <A HREF="../../../../com/sun/mail/imap/IMAPFolder.html#getACL()"><CODE>getACL</CODE></A>, <A HREF="../../../../com/sun/mail/imap/IMAPFolder.html#addACL(com.sun.mail.imap.ACL)"><CODE>addACL</CODE></A>,
  122.  <A HREF="../../../../com/sun/mail/imap/IMAPFolder.html#removeACL(java.lang.String)"><CODE>removeACL</CODE></A>, <A HREF="../../../../com/sun/mail/imap/IMAPFolder.html#addRights(com.sun.mail.imap.ACL)"><CODE>addRights</CODE></A>,
  123.  <A HREF="../../../../com/sun/mail/imap/IMAPFolder.html#removeRights(com.sun.mail.imap.ACL)"><CODE>removeRights</CODE></A>, <A HREF="../../../../com/sun/mail/imap/IMAPFolder.html#listRights(java.lang.String)"><CODE>listRights</CODE></A>, and
  124.  <A HREF="../../../../com/sun/mail/imap/IMAPFolder.html#myRights()"><CODE>myRights</CODE></A> methods support the IMAP ACL extension.
  125.  Refer to <A HREF="http://www.ietf.org/rfc/rfc2086.txt">RFC 2086</A>
  126.  for more information. <p>
  127.  
  128.  The <A HREF="../../../../com/sun/mail/imap/IMAPFolder.html#doCommand(com.sun.mail.imap.IMAPFolder.ProtocolCommand)"><CODE>doCommand</CODE></A> method and
  129.  <A HREF="../../../../com/sun/mail/imap/IMAPFolder.ProtocolCommand.html" title="interface in com.sun.mail.imap"><CODE>IMAPFolder.ProtocolCommand</CODE></A>
  130.  interface support use of arbitrary IMAP protocol commands. <p>
  131.  
  132.  See the <a href="package-summary.html">com.sun.mail.imap</a> package
  133.  documentation for further information on the IMAP protocol provider. <p>
  134.  
  135.  <strong>WARNING:</strong> The APIs unique to this class should be
  136.  considered <strong>EXPERIMENTAL</strong>.  They may be changed in the
  137.  future in ways that are incompatible with applications using the
  138.  current APIs.
  139. <P>
  140.  
  141. <P>
  142. <HR>
  143.  
  144. <P>
  145. <!-- ======== NESTED CLASS SUMMARY ======== -->
  146.  
  147. <A NAME="nested_class_summary"><!-- --></A>
  148. <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
  149. <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
  150. <TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2">
  151. <B>Nested Class Summary</B></FONT></TH>
  152. </TR>
  153. <TR BGCOLOR="white" CLASS="TableRowColor">
  154. <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
  155. <CODE>static&nbsp;class</CODE></FONT></TD>
  156. <TD><CODE><B><A HREF="../../../../com/sun/mail/imap/IMAPFolder.FetchProfileItem.html" title="class in com.sun.mail.imap">IMAPFolder.FetchProfileItem</A></B></CODE>
  157.  
  158. <BR>
  159. &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;A fetch profile item for fetching headers.</TD>
  160. </TR>
  161. <TR BGCOLOR="white" CLASS="TableRowColor">
  162. <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
  163. <CODE>static&nbsp;interface</CODE></FONT></TD>
  164. <TD><CODE><B><A HREF="../../../../com/sun/mail/imap/IMAPFolder.ProtocolCommand.html" title="interface in com.sun.mail.imap">IMAPFolder.ProtocolCommand</A></B></CODE>
  165.  
  166. <BR>
  167. &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;A simple interface for user-defined IMAP protocol commands.</TD>
  168. </TR>
  169. </TABLE>
  170. &nbsp;<!-- =========== FIELD SUMMARY =========== -->
  171.  
  172. <A NAME="field_summary"><!-- --></A>
  173. <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
  174. <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
  175. <TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2">
  176. <B>Field Summary</B></FONT></TH>
  177. </TR>
  178. <TR BGCOLOR="white" CLASS="TableRowColor">
  179. <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
  180. <CODE>protected &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>
  181. <TD><CODE><B><A HREF="../../../../com/sun/mail/imap/IMAPFolder.html#attributes">attributes</A></B></CODE>
  182.  
  183. <BR>
  184. &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD>
  185. </TR>
  186. <TR BGCOLOR="white" CLASS="TableRowColor">
  187. <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
  188. <CODE>protected &nbsp;<A HREF="../../../../javax/mail/Flags.html" title="class in javax.mail">Flags</A></CODE></FONT></TD>
  189. <TD><CODE><B><A HREF="../../../../com/sun/mail/imap/IMAPFolder.html#availableFlags">availableFlags</A></B></CODE>
  190.  
  191. <BR>
  192. &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD>
  193. </TR>
  194. <TR BGCOLOR="white" CLASS="TableRowColor">
  195. <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
  196. <CODE>protected &nbsp;boolean</CODE></FONT></TD>
  197. <TD><CODE><B><A HREF="../../../../com/sun/mail/imap/IMAPFolder.html#exists">exists</A></B></CODE>
  198.  
  199. <BR>
  200. &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD>
  201. </TR>
  202. <TR BGCOLOR="white" CLASS="TableRowColor">
  203. <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
  204. <CODE>protected &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>
  205. <TD><CODE><B><A HREF="../../../../com/sun/mail/imap/IMAPFolder.html#fullName">fullName</A></B></CODE>
  206.  
  207. <BR>
  208. &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD>
  209. </TR>
  210. <TR BGCOLOR="white" CLASS="TableRowColor">
  211. <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
  212. <CODE>protected &nbsp;boolean</CODE></FONT></TD>
  213. <TD><CODE><B><A HREF="../../../../com/sun/mail/imap/IMAPFolder.html#isNamespace">isNamespace</A></B></CODE>
  214.  
  215. <BR>
  216. &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD>
  217. </TR>
  218. <TR BGCOLOR="white" CLASS="TableRowColor">
  219. <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
  220. <CODE>protected &nbsp;com.sun.mail.imap.MessageCache</CODE></FONT></TD>
  221. <TD><CODE><B><A HREF="../../../../com/sun/mail/imap/IMAPFolder.html#messageCache">messageCache</A></B></CODE>
  222.  
  223. <BR>
  224. &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD>
  225. </TR>
  226. <TR BGCOLOR="white" CLASS="TableRowColor">
  227. <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
  228. <CODE>protected &nbsp;<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></CODE></FONT></TD>
  229. <TD><CODE><B><A HREF="../../../../com/sun/mail/imap/IMAPFolder.html#messageCacheLock">messageCacheLock</A></B></CODE>
  230.  
  231. <BR>
  232. &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD>
  233. </TR>
  234. <TR BGCOLOR="white" CLASS="TableRowColor">
  235. <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
  236. <CODE>protected &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>
  237. <TD><CODE><B><A HREF="../../../../com/sun/mail/imap/IMAPFolder.html#name">name</A></B></CODE>
  238.  
  239. <BR>
  240. &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD>
  241. </TR>
  242. <TR BGCOLOR="white" CLASS="TableRowColor">
  243. <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
  244. <CODE>protected &nbsp;<A HREF="../../../../javax/mail/Flags.html" title="class in javax.mail">Flags</A></CODE></FONT></TD>
  245. <TD><CODE><B><A HREF="../../../../com/sun/mail/imap/IMAPFolder.html#permanentFlags">permanentFlags</A></B></CODE>
  246.  
  247. <BR>
  248. &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD>
  249. </TR>
  250. <TR BGCOLOR="white" CLASS="TableRowColor">
  251. <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
  252. <CODE>protected &nbsp;com.sun.mail.imap.protocol.IMAPProtocol</CODE></FONT></TD>
  253. <TD><CODE><B><A HREF="../../../../com/sun/mail/imap/IMAPFolder.html#protocol">protocol</A></B></CODE>
  254.  
  255. <BR>
  256. &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD>
  257. </TR>
  258. <TR BGCOLOR="white" CLASS="TableRowColor">
  259. <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
  260. <CODE>protected &nbsp;char</CODE></FONT></TD>
  261. <TD><CODE><B><A HREF="../../../../com/sun/mail/imap/IMAPFolder.html#separator">separator</A></B></CODE>
  262.  
  263. <BR>
  264. &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD>
  265. </TR>
  266. <TR BGCOLOR="white" CLASS="TableRowColor">
  267. <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
  268. <CODE>protected &nbsp;int</CODE></FONT></TD>
  269. <TD><CODE><B><A HREF="../../../../com/sun/mail/imap/IMAPFolder.html#type">type</A></B></CODE>
  270.  
  271. <BR>
  272. &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD>
  273. </TR>
  274. <TR BGCOLOR="white" CLASS="TableRowColor">
  275. <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
  276. <CODE>protected &nbsp;<A HREF="http://java.sun.com/j2se/1.4.2/docs/api/java/util/Hashtable.html?is-external=true" title="class or interface in java.util">Hashtable</A></CODE></FONT></TD>
  277. <TD><CODE><B><A HREF="../../../../com/sun/mail/imap/IMAPFolder.html#uidTable">uidTable</A></B></CODE>
  278.  
  279. <BR>
  280. &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD>
  281. </TR>
  282. <TR BGCOLOR="white" CLASS="TableRowColor">
  283. <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
  284. <CODE>protected static&nbsp;char</CODE></FONT></TD>
  285. <TD><CODE><B><A HREF="../../../../com/sun/mail/imap/IMAPFolder.html#UNKNOWN_SEPARATOR">UNKNOWN_SEPARATOR</A></B></CODE>
  286.  
  287. <BR>
  288. &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD>
  289. </TR>
  290. </TABLE>
  291. &nbsp;<A NAME="fields_inherited_from_class_javax.mail.Folder"><!-- --></A>
  292. <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
  293. <TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
  294. <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>
  295. </TR>
  296. <TR BGCOLOR="white" CLASS="TableRowColor">
  297. <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>
  298. </TR>
  299. </TABLE>
  300. &nbsp;<A NAME="fields_inherited_from_class_javax.mail.UIDFolder"><!-- --></A>
  301. <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
  302. <TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
  303. <TH ALIGN="left"><B>Fields inherited from interface javax.mail.<A HREF="../../../../javax/mail/UIDFolder.html" title="interface in javax.mail">UIDFolder</A></B></TH>
  304. </TR>
  305. <TR BGCOLOR="white" CLASS="TableRowColor">
  306. <TD><CODE><A HREF="../../../../javax/mail/UIDFolder.html#LASTUID">LASTUID</A></CODE></TD>
  307. </TR>
  308. </TABLE>
  309. &nbsp;
  310. <!-- ======== CONSTRUCTOR SUMMARY ======== -->
  311.  
  312. <A NAME="constructor_summary"><!-- --></A>
  313. <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
  314. <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
  315. <TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2">
  316. <B>Constructor Summary</B></FONT></TH>
  317. </TR>
  318. <TR BGCOLOR="white" CLASS="TableRowColor">
  319. <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
  320. <CODE>protected </CODE></FONT></TD>
  321. <TD><CODE><B><A HREF="../../../../com/sun/mail/imap/IMAPFolder.html#IMAPFolder(com.sun.mail.imap.protocol.ListInfo, com.sun.mail.imap.IMAPStore)">IMAPFolder</A></B>(com.sun.mail.imap.protocol.ListInfo&nbsp;li,
  322.            <A HREF="../../../../com/sun/mail/imap/IMAPStore.html" title="class in com.sun.mail.imap">IMAPStore</A>&nbsp;store)</CODE>
  323.  
  324. <BR>
  325. &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Constructor used to create an existing folder.</TD>
  326. </TR>
  327. <TR BGCOLOR="white" CLASS="TableRowColor">
  328. <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
  329. <CODE>protected </CODE></FONT></TD>
  330. <TD><CODE><B><A HREF="../../../../com/sun/mail/imap/IMAPFolder.html#IMAPFolder(java.lang.String, char, com.sun.mail.imap.IMAPStore)">IMAPFolder</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;fullName,
  331.            char&nbsp;separator,
  332.            <A HREF="../../../../com/sun/mail/imap/IMAPStore.html" title="class in com.sun.mail.imap">IMAPStore</A>&nbsp;store)</CODE>
  333.  
  334. <BR>
  335. &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Constructor used to create a possibly non-existent folder.</TD>
  336. </TR>
  337. <TR BGCOLOR="white" CLASS="TableRowColor">
  338. <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
  339. <CODE>protected </CODE></FONT></TD>
  340. <TD><CODE><B><A HREF="../../../../com/sun/mail/imap/IMAPFolder.html#IMAPFolder(java.lang.String, char, com.sun.mail.imap.IMAPStore, boolean)">IMAPFolder</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;fullName,
  341.            char&nbsp;separator,
  342.            <A HREF="../../../../com/sun/mail/imap/IMAPStore.html" title="class in com.sun.mail.imap">IMAPStore</A>&nbsp;store,
  343.            boolean&nbsp;isNamespace)</CODE>
  344.  
  345. <BR>
  346. &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Constructor used to create a possibly non-existent folder.</TD>
  347. </TR>
  348. </TABLE>
  349. &nbsp;
  350. <!-- ========== METHOD SUMMARY =========== -->
  351.  
  352. <A NAME="method_summary"><!-- --></A>
  353. <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
  354. <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
  355. <TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2">
  356. <B>Method Summary</B></FONT></TH>
  357. </TR>
  358. <TR BGCOLOR="white" CLASS="TableRowColor">
  359. <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
  360. <CODE>&nbsp;void</CODE></FONT></TD>
  361. <TD><CODE><B><A HREF="../../../../com/sun/mail/imap/IMAPFolder.html#addACL(com.sun.mail.imap.ACL)">addACL</A></B>(<A HREF="../../../../com/sun/mail/imap/ACL.html" title="class in com.sun.mail.imap">ACL</A>&nbsp;acl)</CODE>
  362.  
  363. <BR>
  364. &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Add an access control list entry to the access control list
  365.  for this folder.</TD>
  366. </TR>
  367. <TR BGCOLOR="white" CLASS="TableRowColor">
  368. <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
  369. <CODE>&nbsp;void</CODE></FONT></TD>
  370. <TD><CODE><B><A HREF="../../../../com/sun/mail/imap/IMAPFolder.html#addMessageCountListener(javax.mail.event.MessageCountListener)">addMessageCountListener</A></B>(<A HREF="../../../../javax/mail/event/MessageCountListener.html" title="interface in javax.mail.event">MessageCountListener</A>&nbsp;l)</CODE>
  371.  
  372. <BR>
  373. &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Add a listener for MessageCount events on this Folder.</TD>
  374. </TR>
  375. <TR BGCOLOR="white" CLASS="TableRowColor">
  376. <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
  377. <CODE>&nbsp;<A HREF="../../../../javax/mail/Message.html" title="class in javax.mail">Message</A>[]</CODE></FONT></TD>
  378. <TD><CODE><B><A HREF="../../../../com/sun/mail/imap/IMAPFolder.html#addMessages(javax.mail.Message[])">addMessages</A></B>(<A HREF="../../../../javax/mail/Message.html" title="class in javax.mail">Message</A>[]&nbsp;msgs)</CODE>
  379.  
  380. <BR>
  381. &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Append the given messages into this folder.</TD>
  382. </TR>
  383. <TR BGCOLOR="white" CLASS="TableRowColor">
  384. <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
  385. <CODE>&nbsp;void</CODE></FONT></TD>
  386. <TD><CODE><B><A HREF="../../../../com/sun/mail/imap/IMAPFolder.html#addRights(com.sun.mail.imap.ACL)">addRights</A></B>(<A HREF="../../../../com/sun/mail/imap/ACL.html" title="class in com.sun.mail.imap">ACL</A>&nbsp;acl)</CODE>
  387.  
  388. <BR>
  389. &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Add the rights specified in the ACL to the entry for the
  390.  identifier specified in the ACL.</TD>
  391. </TR>
  392. <TR BGCOLOR="white" CLASS="TableRowColor">
  393. <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
  394. <CODE>&nbsp;void</CODE></FONT></TD>
  395. <TD><CODE><B><A HREF="../../../../com/sun/mail/imap/IMAPFolder.html#appendMessages(javax.mail.Message[])">appendMessages</A></B>(<A HREF="../../../../javax/mail/Message.html" title="class in javax.mail">Message</A>[]&nbsp;msgs)</CODE>
  396.  
  397. <BR>
  398. &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Append the given messages into this folder.</TD>
  399. </TR>
  400. <TR BGCOLOR="white" CLASS="TableRowColor">
  401. <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
  402. <CODE>&nbsp;com.sun.mail.imap.AppendUID[]</CODE></FONT></TD>
  403. <TD><CODE><B><A HREF="../../../../com/sun/mail/imap/IMAPFolder.html#appendUIDMessages(javax.mail.Message[])">appendUIDMessages</A></B>(<A HREF="../../../../javax/mail/Message.html" title="class in javax.mail">Message</A>[]&nbsp;msgs)</CODE>
  404.  
  405. <BR>
  406. &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Append the given messages into this folder.</TD>
  407. </TR>
  408. <TR BGCOLOR="white" CLASS="TableRowColor">
  409. <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
  410. <CODE>&nbsp;void</CODE></FONT></TD>
  411. <TD><CODE><B><A HREF="../../../../com/sun/mail/imap/IMAPFolder.html#close(boolean)">close</A></B>(boolean&nbsp;expunge)</CODE>
  412.  
  413. <BR>
  414. &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Close this folder.</TD>
  415. </TR>
  416. <TR BGCOLOR="white" CLASS="TableRowColor">
  417. <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
  418. <CODE>&nbsp;void</CODE></FONT></TD>
  419. <TD><CODE><B><A HREF="../../../../com/sun/mail/imap/IMAPFolder.html#copyMessages(javax.mail.Message[], javax.mail.Folder)">copyMessages</A></B>(<A HREF="../../../../javax/mail/Message.html" title="class in javax.mail">Message</A>[]&nbsp;msgs,
  420.              <A HREF="../../../../javax/mail/Folder.html" title="class in javax.mail">Folder</A>&nbsp;folder)</CODE>
  421.  
  422. <BR>
  423. &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Copy the specified messages from this folder, to the
  424.  specified destination.</TD>
  425. </TR>
  426. <TR BGCOLOR="white" CLASS="TableRowColor">
  427. <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
  428. <CODE>&nbsp;boolean</CODE></FONT></TD>
  429. <TD><CODE><B><A HREF="../../../../com/sun/mail/imap/IMAPFolder.html#create(int)">create</A></B>(int&nbsp;type)</CODE>
  430.  
  431. <BR>
  432. &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Create this folder, with the specified type.</TD>
  433. </TR>
  434. <TR BGCOLOR="white" CLASS="TableRowColor">
  435. <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
  436. <CODE>&nbsp;boolean</CODE></FONT></TD>
  437. <TD><CODE><B><A HREF="../../../../com/sun/mail/imap/IMAPFolder.html#delete(boolean)">delete</A></B>(boolean&nbsp;recurse)</CODE>
  438.  
  439. <BR>
  440. &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Delete this folder.</TD>
  441. </TR>
  442. <TR BGCOLOR="white" CLASS="TableRowColor">
  443. <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
  444. <CODE>&nbsp;<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></CODE></FONT></TD>
  445. <TD><CODE><B><A HREF="../../../../com/sun/mail/imap/IMAPFolder.html#doCommand(com.sun.mail.imap.IMAPFolder.ProtocolCommand)">doCommand</A></B>(<A HREF="../../../../com/sun/mail/imap/IMAPFolder.ProtocolCommand.html" title="interface in com.sun.mail.imap">IMAPFolder.ProtocolCommand</A>&nbsp;cmd)</CODE>
  446.  
  447. <BR>
  448. &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Execute a user-supplied IMAP command.</TD>
  449. </TR>
  450. <TR BGCOLOR="white" CLASS="TableRowColor">
  451. <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
  452. <CODE>&nbsp;<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></CODE></FONT></TD>
  453. <TD><CODE><B><A HREF="../../../../com/sun/mail/imap/IMAPFolder.html#doCommandIgnoreFailure(com.sun.mail.imap.IMAPFolder.ProtocolCommand)">doCommandIgnoreFailure</A></B>(<A HREF="../../../../com/sun/mail/imap/IMAPFolder.ProtocolCommand.html" title="interface in com.sun.mail.imap">IMAPFolder.ProtocolCommand</A>&nbsp;cmd)</CODE>
  454.  
  455. <BR>
  456. &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD>
  457. </TR>
  458. <TR BGCOLOR="white" CLASS="TableRowColor">
  459. <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
  460. <CODE>&nbsp;<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></CODE></FONT></TD>
  461. <TD><CODE><B><A HREF="../../../../com/sun/mail/imap/IMAPFolder.html#doOptionalCommand(java.lang.String, com.sun.mail.imap.IMAPFolder.ProtocolCommand)">doOptionalCommand</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;err,
  462.                   <A HREF="../../../../com/sun/mail/imap/IMAPFolder.ProtocolCommand.html" title="interface in com.sun.mail.imap">IMAPFolder.ProtocolCommand</A>&nbsp;cmd)</CODE>
  463.  
  464. <BR>
  465. &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD>
  466. </TR>
  467. <TR BGCOLOR="white" CLASS="TableRowColor">
  468. <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
  469. <CODE>protected &nbsp;<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></CODE></FONT></TD>
  470. <TD><CODE><B><A HREF="../../../../com/sun/mail/imap/IMAPFolder.html#doProtocolCommand(com.sun.mail.imap.IMAPFolder.ProtocolCommand)">doProtocolCommand</A></B>(<A HREF="../../../../com/sun/mail/imap/IMAPFolder.ProtocolCommand.html" title="interface in com.sun.mail.imap">IMAPFolder.ProtocolCommand</A>&nbsp;cmd)</CODE>
  471.  
  472. <BR>
  473. &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD>
  474. </TR>
  475. <TR BGCOLOR="white" CLASS="TableRowColor">
  476. <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
  477. <CODE>&nbsp;boolean</CODE></FONT></TD>
  478. <TD><CODE><B><A HREF="../../../../com/sun/mail/imap/IMAPFolder.html#exists()">exists</A></B>()</CODE>
  479.  
  480. <BR>
  481. &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Check whether this folder really exists on the server.</TD>
  482. </TR>
  483. <TR BGCOLOR="white" CLASS="TableRowColor">
  484. <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
  485. <CODE>&nbsp;<A HREF="../../../../javax/mail/Message.html" title="class in javax.mail">Message</A>[]</CODE></FONT></TD>
  486. <TD><CODE><B><A HREF="../../../../com/sun/mail/imap/IMAPFolder.html#expunge()">expunge</A></B>()</CODE>
  487.  
  488. <BR>
  489. &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Expunge all messages marked as DELETED.</TD>
  490. </TR>
  491. <TR BGCOLOR="white" CLASS="TableRowColor">
  492. <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
  493. <CODE>&nbsp;<A HREF="../../../../javax/mail/Message.html" title="class in javax.mail">Message</A>[]</CODE></FONT></TD>
  494. <TD><CODE><B><A HREF="../../../../com/sun/mail/imap/IMAPFolder.html#expunge(javax.mail.Message[])">expunge</A></B>(<A HREF="../../../../javax/mail/Message.html" title="class in javax.mail">Message</A>[]&nbsp;msgs)</CODE>
  495.  
  496. <BR>
  497. &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Expunge the indicated messages, which must have been marked as DELETED.</TD>
  498. </TR>
  499. <TR BGCOLOR="white" CLASS="TableRowColor">
  500. <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
  501. <CODE>&nbsp;void</CODE></FONT></TD>
  502. <TD><CODE><B><A HREF="../../../../com/sun/mail/imap/IMAPFolder.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,
  503.       <A HREF="../../../../javax/mail/FetchProfile.html" title="class in javax.mail">FetchProfile</A>&nbsp;fp)</CODE>
  504.  
  505. <BR>
  506. &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Prefetch attributes, based on the given FetchProfile.</TD>
  507. </TR>
  508. <TR BGCOLOR="white" CLASS="TableRowColor">
  509. <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
  510. <CODE>&nbsp;void</CODE></FONT></TD>
  511. <TD><CODE><B><A HREF="../../../../com/sun/mail/imap/IMAPFolder.html#forceClose()">forceClose</A></B>()</CODE>
  512.  
  513. <BR>
  514. &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Close this folder without waiting for the server.</TD>
  515. </TR>
  516. <TR BGCOLOR="white" CLASS="TableRowColor">
  517. <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
  518. <CODE>&nbsp;<A HREF="../../../../com/sun/mail/imap/ACL.html" title="class in com.sun.mail.imap">ACL</A>[]</CODE></FONT></TD>
  519. <TD><CODE><B><A HREF="../../../../com/sun/mail/imap/IMAPFolder.html#getACL()">getACL</A></B>()</CODE>
  520.  
  521. <BR>
  522. &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Get the access control list entries for this folder.</TD>
  523. </TR>
  524. <TR BGCOLOR="white" CLASS="TableRowColor">
  525. <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
  526. <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>
  527. <TD><CODE><B><A HREF="../../../../com/sun/mail/imap/IMAPFolder.html#getAttributes()">getAttributes</A></B>()</CODE>
  528.  
  529. <BR>
  530. &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Get the attributes that the IMAP server returns with the
  531.  LIST response.</TD>
  532. </TR>
  533. <TR BGCOLOR="white" CLASS="TableRowColor">
  534. <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
  535. <CODE>&nbsp;int</CODE></FONT></TD>
  536. <TD><CODE><B><A HREF="../../../../com/sun/mail/imap/IMAPFolder.html#getDeletedMessageCount()">getDeletedMessageCount</A></B>()</CODE>
  537.  
  538. <BR>
  539. &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Get the deleted message count.</TD>
  540. </TR>
  541. <TR BGCOLOR="white" CLASS="TableRowColor">
  542. <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
  543. <CODE>&nbsp;<A HREF="../../../../javax/mail/Folder.html" title="class in javax.mail">Folder</A></CODE></FONT></TD>
  544. <TD><CODE><B><A HREF="../../../../com/sun/mail/imap/IMAPFolder.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>
  545.  
  546. <BR>
  547. &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Get the named subfolder.</TD>
  548. </TR>
  549. <TR BGCOLOR="white" CLASS="TableRowColor">
  550. <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
  551. <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>
  552. <TD><CODE><B><A HREF="../../../../com/sun/mail/imap/IMAPFolder.html#getFullName()">getFullName</A></B>()</CODE>
  553.  
  554. <BR>
  555. &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Get the fullname of this folder.</TD>
  556. </TR>
  557. <TR BGCOLOR="white" CLASS="TableRowColor">
  558. <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
  559. <CODE>&nbsp;<A HREF="../../../../javax/mail/Message.html" title="class in javax.mail">Message</A></CODE></FONT></TD>
  560. <TD><CODE><B><A HREF="../../../../com/sun/mail/imap/IMAPFolder.html#getMessage(int)">getMessage</A></B>(int&nbsp;msgnum)</CODE>
  561.  
  562. <BR>
  563. &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Get the specified message.</TD>
  564. </TR>
  565. <TR BGCOLOR="white" CLASS="TableRowColor">
  566. <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
  567. <CODE>&nbsp;<A HREF="../../../../javax/mail/Message.html" title="class in javax.mail">Message</A></CODE></FONT></TD>
  568. <TD><CODE><B><A HREF="../../../../com/sun/mail/imap/IMAPFolder.html#getMessageByUID(long)">getMessageByUID</A></B>(long&nbsp;uid)</CODE>
  569.  
  570. <BR>
  571. &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Get the Message corresponding to the given UID.</TD>
  572. </TR>
  573. <TR BGCOLOR="white" CLASS="TableRowColor">
  574. <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
  575. <CODE>&nbsp;int</CODE></FONT></TD>
  576. <TD><CODE><B><A HREF="../../../../com/sun/mail/imap/IMAPFolder.html#getMessageCount()">getMessageCount</A></B>()</CODE>
  577.  
  578. <BR>
  579. &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Get the total message count.</TD>
  580. </TR>
  581. <TR BGCOLOR="white" CLASS="TableRowColor">
  582. <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
  583. <CODE>&nbsp;<A HREF="../../../../javax/mail/Message.html" title="class in javax.mail">Message</A>[]</CODE></FONT></TD>
  584. <TD><CODE><B><A HREF="../../../../com/sun/mail/imap/IMAPFolder.html#getMessagesByUID(long[])">getMessagesByUID</A></B>(long[]&nbsp;uids)</CODE>
  585.  
  586. <BR>
  587. &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Get the Messages specified by the given array.</TD>
  588. </TR>
  589. <TR BGCOLOR="white" CLASS="TableRowColor">
  590. <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
  591. <CODE>&nbsp;<A HREF="../../../../javax/mail/Message.html" title="class in javax.mail">Message</A>[]</CODE></FONT></TD>
  592. <TD><CODE><B><A HREF="../../../../com/sun/mail/imap/IMAPFolder.html#getMessagesByUID(long, long)">getMessagesByUID</A></B>(long&nbsp;start,
  593.                  long&nbsp;end)</CODE>
  594.  
  595. <BR>
  596. &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Get the Messages specified by the given range.</TD>
  597. </TR>
  598. <TR BGCOLOR="white" CLASS="TableRowColor">
  599. <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
  600. <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>
  601. <TD><CODE><B><A HREF="../../../../com/sun/mail/imap/IMAPFolder.html#getName()">getName</A></B>()</CODE>
  602.  
  603. <BR>
  604. &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Get the name of this folder.</TD>
  605. </TR>
  606. <TR BGCOLOR="white" CLASS="TableRowColor">
  607. <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
  608. <CODE>&nbsp;int</CODE></FONT></TD>
  609. <TD><CODE><B><A HREF="../../../../com/sun/mail/imap/IMAPFolder.html#getNewMessageCount()">getNewMessageCount</A></B>()</CODE>
  610.  
  611. <BR>
  612. &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Get the new message count.</TD>
  613. </TR>
  614. <TR BGCOLOR="white" CLASS="TableRowColor">
  615. <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
  616. <CODE>&nbsp;<A HREF="../../../../javax/mail/Folder.html" title="class in javax.mail">Folder</A></CODE></FONT></TD>
  617. <TD><CODE><B><A HREF="../../../../com/sun/mail/imap/IMAPFolder.html#getParent()">getParent</A></B>()</CODE>
  618.  
  619. <BR>
  620. &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Get this folder's parent.</TD>
  621. </TR>
  622. <TR BGCOLOR="white" CLASS="TableRowColor">
  623. <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
  624. <CODE>&nbsp;<A HREF="../../../../javax/mail/Flags.html" title="class in javax.mail">Flags</A></CODE></FONT></TD>
  625. <TD><CODE><B><A HREF="../../../../com/sun/mail/imap/IMAPFolder.html#getPermanentFlags()">getPermanentFlags</A></B>()</CODE>
  626.  
  627. <BR>
  628. &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Return the permanent flags supported by the server.</TD>
  629. </TR>
  630. <TR BGCOLOR="white" CLASS="TableRowColor">
  631. <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
  632. <CODE>&nbsp;<A HREF="../../../../javax/mail/Quota.html" title="class in javax.mail">Quota</A>[]</CODE></FONT></TD>
  633. <TD><CODE><B><A HREF="../../../../com/sun/mail/imap/IMAPFolder.html#getQuota()">getQuota</A></B>()</CODE>
  634.  
  635. <BR>
  636. &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Get the quotas for the quotaroot associated with this
  637. folder.</TD>
  638. </TR>
  639. <TR BGCOLOR="white" CLASS="TableRowColor">
  640. <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
  641. <CODE>&nbsp;char</CODE></FONT></TD>
  642. <TD><CODE><B><A HREF="../../../../com/sun/mail/imap/IMAPFolder.html#getSeparator()">getSeparator</A></B>()</CODE>
  643.  
  644. <BR>
  645. &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Get the separator character.</TD>
  646. </TR>
  647. <TR BGCOLOR="white" CLASS="TableRowColor">
  648. <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
  649. <CODE>protected &nbsp;com.sun.mail.imap.protocol.IMAPProtocol</CODE></FONT></TD>
  650. <TD><CODE><B><A HREF="../../../../com/sun/mail/imap/IMAPFolder.html#getStoreProtocol()">getStoreProtocol</A></B>()</CODE>
  651.  
  652. <BR>
  653. &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Get this folder's Store's protocol connection.</TD>
  654. </TR>
  655. <TR BGCOLOR="white" CLASS="TableRowColor">
  656. <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
  657. <CODE>&nbsp;int</CODE></FONT></TD>
  658. <TD><CODE><B><A HREF="../../../../com/sun/mail/imap/IMAPFolder.html#getType()">getType</A></B>()</CODE>
  659.  
  660. <BR>
  661. &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Get the type of this folder.</TD>
  662. </TR>
  663. <TR BGCOLOR="white" CLASS="TableRowColor">
  664. <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
  665. <CODE>&nbsp;long</CODE></FONT></TD>
  666. <TD><CODE><B><A HREF="../../../../com/sun/mail/imap/IMAPFolder.html#getUID(javax.mail.Message)">getUID</A></B>(<A HREF="../../../../javax/mail/Message.html" title="class in javax.mail">Message</A>&nbsp;message)</CODE>
  667.  
  668. <BR>
  669. &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Get the UID for the specified message.</TD>
  670. </TR>
  671. <TR BGCOLOR="white" CLASS="TableRowColor">
  672. <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
  673. <CODE>&nbsp;long</CODE></FONT></TD>
  674. <TD><CODE><B><A HREF="../../../../com/sun/mail/imap/IMAPFolder.html#getUIDNext()">getUIDNext</A></B>()</CODE>
  675.  
  676. <BR>
  677. &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Returns the predicted UID that will be assigned to the
  678. next message that is appended to this folder.</TD>
  679. </TR>
  680. <TR BGCOLOR="white" CLASS="TableRowColor">
  681. <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
  682. <CODE>&nbsp;long</CODE></FONT></TD>
  683. <TD><CODE><B><A HREF="../../../../com/sun/mail/imap/IMAPFolder.html#getUIDValidity()">getUIDValidity</A></B>()</CODE>
  684.  
  685. <BR>
  686. &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Returns the UIDValidity for this folder.</TD>
  687. </TR>
  688. <TR BGCOLOR="white" CLASS="TableRowColor">
  689. <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
  690. <CODE>&nbsp;int</CODE></FONT></TD>
  691. <TD><CODE><B><A HREF="../../../../com/sun/mail/imap/IMAPFolder.html#getUnreadMessageCount()">getUnreadMessageCount</A></B>()</CODE>
  692.  
  693. <BR>
  694. &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Get the unread message count.</TD>
  695. </TR>
  696. <TR BGCOLOR="white" CLASS="TableRowColor">
  697. <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
  698. <CODE>&nbsp;void</CODE></FONT></TD>
  699. <TD><CODE><B><A HREF="../../../../com/sun/mail/imap/IMAPFolder.html#handleResponse(com.sun.mail.iap.Response)">handleResponse</A></B>(com.sun.mail.iap.Response&nbsp;r)</CODE>
  700.  
  701. <BR>
  702. &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;The response handler.</TD>
  703. </TR>
  704. <TR BGCOLOR="white" CLASS="TableRowColor">
  705. <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
  706. <CODE>&nbsp;boolean</CODE></FONT></TD>
  707. <TD><CODE><B><A HREF="../../../../com/sun/mail/imap/IMAPFolder.html#hasNewMessages()">hasNewMessages</A></B>()</CODE>
  708.  
  709. <BR>
  710. &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Check whether this folder has new messages.</TD>
  711. </TR>
  712. <TR BGCOLOR="white" CLASS="TableRowColor">
  713. <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
  714. <CODE>&nbsp;void</CODE></FONT></TD>
  715. <TD><CODE><B><A HREF="../../../../com/sun/mail/imap/IMAPFolder.html#idle()">idle</A></B>()</CODE>
  716.  
  717. <BR>
  718. &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Use the IMAP IDLE command (see
  719. <A HREF="http://www.ietf.org/rfc/rfc2177.txt">RFC 2177</A>),
  720. if supported by the server, to enter idle mode so that the server
  721. can send unsolicited notifications of new messages arriving, etc.</TD>
  722. </TR>
  723. <TR BGCOLOR="white" CLASS="TableRowColor">
  724. <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
  725. <CODE>&nbsp;void</CODE></FONT></TD>
  726. <TD><CODE><B><A HREF="../../../../com/sun/mail/imap/IMAPFolder.html#idle(boolean)">idle</A></B>(boolean&nbsp;once)</CODE>
  727.  
  728. <BR>
  729. &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Like <A HREF="../../../../com/sun/mail/imap/IMAPFolder.html#idle()"><CODE>idle()</CODE></A>, but if <code>once</code> is true, abort the
  730. IDLE command after the first notification, to allow the caller
  731. to process any notification synchronously.</TD>
  732. </TR>
  733. <TR BGCOLOR="white" CLASS="TableRowColor">
  734. <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
  735. <CODE>&nbsp;boolean</CODE></FONT></TD>
  736. <TD><CODE><B><A HREF="../../../../com/sun/mail/imap/IMAPFolder.html#isOpen()">isOpen</A></B>()</CODE>
  737.  
  738. <BR>
  739. &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Check whether this connection is really open.</TD>
  740. </TR>
  741. <TR BGCOLOR="white" CLASS="TableRowColor">
  742. <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
  743. <CODE>&nbsp;boolean</CODE></FONT></TD>
  744. <TD><CODE><B><A HREF="../../../../com/sun/mail/imap/IMAPFolder.html#isSubscribed()">isSubscribed</A></B>()</CODE>
  745.  
  746. <BR>
  747. &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Check whether this folder is subscribed.</TD>
  748. </TR>
  749. <TR BGCOLOR="white" CLASS="TableRowColor">
  750. <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
  751. <CODE>&nbsp;<A HREF="../../../../javax/mail/Folder.html" title="class in javax.mail">Folder</A>[]</CODE></FONT></TD>
  752. <TD><CODE><B><A HREF="../../../../com/sun/mail/imap/IMAPFolder.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>
  753.  
  754. <BR>
  755. &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;List all subfolders matching the specified pattern.</TD>
  756. </TR>
  757. <TR BGCOLOR="white" CLASS="TableRowColor">
  758. <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
  759. <CODE>&nbsp;<A HREF="../../../../com/sun/mail/imap/Rights.html" title="class in com.sun.mail.imap">Rights</A>[]</CODE></FONT></TD>
  760. <TD><CODE><B><A HREF="../../../../com/sun/mail/imap/IMAPFolder.html#listRights(java.lang.String)">listRights</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>
  761.  
  762. <BR>
  763. &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Get all the rights that may be allowed to the given identifier.</TD>
  764. </TR>
  765. <TR BGCOLOR="white" CLASS="TableRowColor">
  766. <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
  767. <CODE>&nbsp;<A HREF="../../../../javax/mail/Folder.html" title="class in javax.mail">Folder</A>[]</CODE></FONT></TD>
  768. <TD><CODE><B><A HREF="../../../../com/sun/mail/imap/IMAPFolder.html#listSubscribed(java.lang.String)">listSubscribed</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>
  769.  
  770. <BR>
  771. &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;List all subscribed subfolders matching the specified pattern.</TD>
  772. </TR>
  773. <TR BGCOLOR="white" CLASS="TableRowColor">
  774. <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
  775. <CODE>&nbsp;<A HREF="../../../../com/sun/mail/imap/Rights.html" title="class in com.sun.mail.imap">Rights</A></CODE></FONT></TD>
  776. <TD><CODE><B><A HREF="../../../../com/sun/mail/imap/IMAPFolder.html#myRights()">myRights</A></B>()</CODE>
  777.  
  778. <BR>
  779. &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Get the rights allowed to the currently authenticated user.</TD>
  780. </TR>
  781. <TR BGCOLOR="white" CLASS="TableRowColor">
  782. <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
  783. <CODE>&nbsp;void</CODE></FONT></TD>
  784. <TD><CODE><B><A HREF="../../../../com/sun/mail/imap/IMAPFolder.html#open(int)">open</A></B>(int&nbsp;mode)</CODE>
  785.  
  786. <BR>
  787. &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Open this folder in the given mode.</TD>
  788. </TR>
  789. <TR BGCOLOR="white" CLASS="TableRowColor">
  790. <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
  791. <CODE>protected &nbsp;void</CODE></FONT></TD>
  792. <TD><CODE><B><A HREF="../../../../com/sun/mail/imap/IMAPFolder.html#releaseStoreProtocol(com.sun.mail.imap.protocol.IMAPProtocol)">releaseStoreProtocol</A></B>(com.sun.mail.imap.protocol.IMAPProtocol&nbsp;p)</CODE>
  793.  
  794. <BR>
  795. &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Release the store protocol object.</TD>
  796. </TR>
  797. <TR BGCOLOR="white" CLASS="TableRowColor">
  798. <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
  799. <CODE>&nbsp;void</CODE></FONT></TD>
  800. <TD><CODE><B><A HREF="../../../../com/sun/mail/imap/IMAPFolder.html#removeACL(java.lang.String)">removeACL</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>
  801.  
  802. <BR>
  803. &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Remove any access control list entry for the given identifier
  804. from the access control list for this folder.</TD>
  805. </TR>
  806. <TR BGCOLOR="white" CLASS="TableRowColor">
  807. <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
  808. <CODE>&nbsp;void</CODE></FONT></TD>
  809. <TD><CODE><B><A HREF="../../../../com/sun/mail/imap/IMAPFolder.html#removeRights(com.sun.mail.imap.ACL)">removeRights</A></B>(<A HREF="../../../../com/sun/mail/imap/ACL.html" title="class in com.sun.mail.imap">ACL</A>&nbsp;acl)</CODE>
  810.  
  811. <BR>
  812. &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Remove the rights specified in the ACL from the entry for the
  813. identifier specified in the ACL.</TD>
  814. </TR>
  815. <TR BGCOLOR="white" CLASS="TableRowColor">
  816. <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
  817. <CODE>&nbsp;boolean</CODE></FONT></TD>
  818. <TD><CODE><B><A HREF="../../../../com/sun/mail/imap/IMAPFolder.html#renameTo(javax.mail.Folder)">renameTo</A></B>(<A HREF="../../../../javax/mail/Folder.html" title="class in javax.mail">Folder</A>&nbsp;f)</CODE>
  819.  
  820. <BR>
  821. &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Rename this folder.</TD>
  822. </TR>
  823. <TR BGCOLOR="white" CLASS="TableRowColor">
  824. <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
  825. <CODE>&nbsp;<A HREF="../../../../javax/mail/Message.html" title="class in javax.mail">Message</A>[]</CODE></FONT></TD>
  826. <TD><CODE><B><A HREF="../../../../com/sun/mail/imap/IMAPFolder.html#search(javax.mail.search.SearchTerm)">search</A></B>(<A HREF="../../../../javax/mail/search/SearchTerm.html" title="class in javax.mail.search">SearchTerm</A>&nbsp;term)</CODE>
  827.  
  828. <BR>
  829. &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Search whole folder for messages matching the given term.</TD>
  830. </TR>
  831. <TR BGCOLOR="white" CLASS="TableRowColor">
  832. <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
  833. <CODE>&nbsp;<A HREF="../../../../javax/mail/Message.html" title="class in javax.mail">Message</A>[]</CODE></FONT></TD>
  834. <TD><CODE><B><A HREF="../../../../com/sun/mail/imap/IMAPFolder.html#search(javax.mail.search.SearchTerm, javax.mail.Message[])">search</A></B>(<A HREF="../../../../javax/mail/search/SearchTerm.html" title="class in javax.mail.search">SearchTerm</A>&nbsp;term,
  835.       <A HREF="../../../../javax/mail/Message.html" title="class in javax.mail">Message</A>[]&nbsp;msgs)</CODE>
  836.  
  837. <BR>
  838. &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Search the folder for messages matching the given term.</TD>
  839. </TR>
  840. <TR BGCOLOR="white" CLASS="TableRowColor">
  841. <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
  842. <CODE>&nbsp;void</CODE></FONT></TD>
  843. <TD><CODE><B><A HREF="../../../../com/sun/mail/imap/IMAPFolder.html#setFlags(javax.mail.Message[], javax.mail.Flags, boolean)">setFlags</A></B>(<A HREF="../../../../javax/mail/Message.html" title="class in javax.mail">Message</A>[]&nbsp;msgs,
  844.         <A HREF="../../../../javax/mail/Flags.html" title="class in javax.mail">Flags</A>&nbsp;flag,
  845.         boolean&nbsp;value)</CODE>
  846.  
  847. <BR>
  848. &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Set the specified flags for the given array of messages.</TD>
  849. </TR>
  850. <TR BGCOLOR="white" CLASS="TableRowColor">
  851. <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
  852. <CODE>&nbsp;void</CODE></FONT></TD>
  853. <TD><CODE><B><A HREF="../../../../com/sun/mail/imap/IMAPFolder.html#setQuota(javax.mail.Quota)">setQuota</A></B>(<A HREF="../../../../javax/mail/Quota.html" title="class in javax.mail">Quota</A>&nbsp;quota)</CODE>
  854.  
  855. <BR>
  856. &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Set the quotas for the quotaroot specified in the quota argument.</TD>
  857. </TR>
  858. <TR BGCOLOR="white" CLASS="TableRowColor">
  859. <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
  860. <CODE>&nbsp;void</CODE></FONT></TD>
  861. <TD><CODE><B><A HREF="../../../../com/sun/mail/imap/IMAPFolder.html#setSubscribed(boolean)">setSubscribed</A></B>(boolean&nbsp;subscribe)</CODE>
  862.  
  863. <BR>
  864. &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Subscribe/Unsubscribe this folder.</TD>
  865. </TR>
  866. </TABLE>
  867. &nbsp;<A NAME="methods_inherited_from_class_javax.mail.Folder"><!-- --></A>
  868. <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
  869. <TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
  870. <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>
  871. </TR>
  872. <TR BGCOLOR="white" CLASS="TableRowColor">
  873. <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#finalize()">finalize</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#getStore()">getStore</A>, <A HREF="../../../../javax/mail/Folder.html#getURLName()">getURLName</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#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#notifyMessageChangedListeners(int, javax.mail.Message)">notifyMessageChangedListeners</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#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#toString()">toString</A></CODE></TD>
  874. </TR>
  875. </TABLE>
  876. &nbsp;<A NAME="methods_inherited_from_class_java.lang.Object"><!-- --></A>
  877. <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
  878. <TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
  879. <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>
  880. </TR>
  881. <TR BGCOLOR="white" CLASS="TableRowColor">
  882. <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>
  883. </TR>
  884. </TABLE>
  885. &nbsp;
  886. <P>
  887.  
  888. <!-- ============ FIELD DETAIL =========== -->
  889.  
  890. <A NAME="field_detail"><!-- --></A>
  891. <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
  892. <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
  893. <TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2">
  894. <B>Field Detail</B></FONT></TH>
  895. </TR>
  896. </TABLE>
  897.  
  898. <A NAME="fullName"><!-- --></A><H3>
  899. fullName</H3>
  900. <PRE>
  901. protected <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>fullName</B></PRE>
  902. <DL>
  903. <DL>
  904. </DL>
  905. </DL>
  906. <HR>
  907.  
  908. <A NAME="name"><!-- --></A><H3>
  909. name</H3>
  910. <PRE>
  911. protected <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>name</B></PRE>
  912. <DL>
  913. <DL>
  914. </DL>
  915. </DL>
  916. <HR>
  917.  
  918. <A NAME="type"><!-- --></A><H3>
  919. type</H3>
  920. <PRE>
  921. protected int <B>type</B></PRE>
  922. <DL>
  923. <DL>
  924. </DL>
  925. </DL>
  926. <HR>
  927.  
  928. <A NAME="separator"><!-- --></A><H3>
  929. separator</H3>
  930. <PRE>
  931. protected char <B>separator</B></PRE>
  932. <DL>
  933. <DL>
  934. </DL>
  935. </DL>
  936. <HR>
  937.  
  938. <A NAME="availableFlags"><!-- --></A><H3>
  939. availableFlags</H3>
  940. <PRE>
  941. protected <A HREF="../../../../javax/mail/Flags.html" title="class in javax.mail">Flags</A> <B>availableFlags</B></PRE>
  942. <DL>
  943. <DL>
  944. </DL>
  945. </DL>
  946. <HR>
  947.  
  948. <A NAME="permanentFlags"><!-- --></A><H3>
  949. permanentFlags</H3>
  950. <PRE>
  951. protected <A HREF="../../../../javax/mail/Flags.html" title="class in javax.mail">Flags</A> <B>permanentFlags</B></PRE>
  952. <DL>
  953. <DL>
  954. </DL>
  955. </DL>
  956. <HR>
  957.  
  958. <A NAME="exists"><!-- --></A><H3>
  959. exists</H3>
  960. <PRE>
  961. protected boolean <B>exists</B></PRE>
  962. <DL>
  963. <DL>
  964. </DL>
  965. </DL>
  966. <HR>
  967.  
  968. <A NAME="isNamespace"><!-- --></A><H3>
  969. isNamespace</H3>
  970. <PRE>
  971. protected boolean <B>isNamespace</B></PRE>
  972. <DL>
  973. <DL>
  974. </DL>
  975. </DL>
  976. <HR>
  977.  
  978. <A NAME="attributes"><!-- --></A><H3>
  979. attributes</H3>
  980. <PRE>
  981. protected <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>attributes</B></PRE>
  982. <DL>
  983. <DL>
  984. </DL>
  985. </DL>
  986. <HR>
  987.  
  988. <A NAME="protocol"><!-- --></A><H3>
  989. protocol</H3>
  990. <PRE>
  991. protected com.sun.mail.imap.protocol.IMAPProtocol <B>protocol</B></PRE>
  992. <DL>
  993. <DL>
  994. </DL>
  995. </DL>
  996. <HR>
  997.  
  998. <A NAME="messageCache"><!-- --></A><H3>
  999. messageCache</H3>
  1000. <PRE>
  1001. protected com.sun.mail.imap.MessageCache <B>messageCache</B></PRE>
  1002. <DL>
  1003. <DL>
  1004. </DL>
  1005. </DL>
  1006. <HR>
  1007.  
  1008. <A NAME="messageCacheLock"><!-- --></A><H3>
  1009. messageCacheLock</H3>
  1010. <PRE>
  1011. protected final <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>messageCacheLock</B></PRE>
  1012. <DL>
  1013. <DL>
  1014. </DL>
  1015. </DL>
  1016. <HR>
  1017.  
  1018. <A NAME="uidTable"><!-- --></A><H3>
  1019. uidTable</H3>
  1020. <PRE>
  1021. protected <A HREF="http://java.sun.com/j2se/1.4.2/docs/api/java/util/Hashtable.html?is-external=true" title="class or interface in java.util">Hashtable</A> <B>uidTable</B></PRE>
  1022. <DL>
  1023. <DL>
  1024. </DL>
  1025. </DL>
  1026. <HR>
  1027.  
  1028. <A NAME="UNKNOWN_SEPARATOR"><!-- --></A><H3>
  1029. UNKNOWN_SEPARATOR</H3>
  1030. <PRE>
  1031. protected static final char <B>UNKNOWN_SEPARATOR</B></PRE>
  1032. <DL>
  1033. <DL>
  1034. <DT><B>See Also:</B><DD><A HREF="../../../../constant-values.html#com.sun.mail.imap.IMAPFolder.UNKNOWN_SEPARATOR">Constant Field Values</A></DL>
  1035. </DL>
  1036.  
  1037. <!-- ========= CONSTRUCTOR DETAIL ======== -->
  1038.  
  1039. <A NAME="constructor_detail"><!-- --></A>
  1040. <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
  1041. <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
  1042. <TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2">
  1043. <B>Constructor Detail</B></FONT></TH>
  1044. </TR>
  1045. </TABLE>
  1046.  
  1047. <A NAME="IMAPFolder(java.lang.String, char, com.sun.mail.imap.IMAPStore)"><!-- --></A><H3>
  1048. IMAPFolder</H3>
  1049. <PRE>
  1050. protected <B>IMAPFolder</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;fullName,
  1051.                     char&nbsp;separator,
  1052.                     <A HREF="../../../../com/sun/mail/imap/IMAPStore.html" title="class in com.sun.mail.imap">IMAPStore</A>&nbsp;store)</PRE>
  1053. <DL>
  1054. <DD>Constructor used to create a possibly non-existent folder.
  1055. <P>
  1056. <DL>
  1057. <DT><B>Parameters:</B><DD><CODE>fullName</CODE> - fullname of this folder<DD><CODE>separator</CODE> - the default separator character for this
  1058.                        folder's namespace<DD><CODE>store</CODE> - the Store</DL>
  1059. </DL>
  1060. <HR>
  1061.  
  1062. <A NAME="IMAPFolder(java.lang.String, char, com.sun.mail.imap.IMAPStore, boolean)"><!-- --></A><H3>
  1063. IMAPFolder</H3>
  1064. <PRE>
  1065. protected <B>IMAPFolder</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;fullName,
  1066.                      char&nbsp;separator,
  1067.                      <A HREF="../../../../com/sun/mail/imap/IMAPStore.html" title="class in com.sun.mail.imap">IMAPStore</A>&nbsp;store,
  1068.                      boolean&nbsp;isNamespace)</PRE>
  1069. <DL>
  1070. <DD>Constructor used to create a possibly non-existent folder.
  1071. <P>
  1072. <DL>
  1073. <DT><B>Parameters:</B><DD><CODE>fullName</CODE> - fullname of this folder<DD><CODE>separator</CODE> - the default separator character for this
  1074.                         folder's namespace<DD><CODE>store</CODE> - the Store</DL>
  1075. </DL>
  1076. <HR>
  1077.  
  1078. <A NAME="IMAPFolder(com.sun.mail.imap.protocol.ListInfo, com.sun.mail.imap.IMAPStore)"><!-- --></A><H3>
  1079. IMAPFolder</H3>
  1080. <PRE>
  1081. protected <B>IMAPFolder</B>(com.sun.mail.imap.protocol.ListInfo&nbsp;li,
  1082.                     <A HREF="../../../../com/sun/mail/imap/IMAPStore.html" title="class in com.sun.mail.imap">IMAPStore</A>&nbsp;store)</PRE>
  1083. <DL>
  1084. <DD>Constructor used to create an existing folder.
  1085. <P>
  1086. </DL>
  1087.  
  1088. <!-- ============ METHOD DETAIL ========== -->
  1089.  
  1090. <A NAME="method_detail"><!-- --></A>
  1091. <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
  1092. <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
  1093. <TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2">
  1094. <B>Method Detail</B></FONT></TH>
  1095. </TR>
  1096. </TABLE>
  1097.  
  1098. <A NAME="getName()"><!-- --></A><H3>
  1099. getName</H3>
  1100. <PRE>
  1101. 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>
  1102. <DL>
  1103. <DD>Get the name of this folder.
  1104. <P>
  1105. <DD><DL>
  1106. <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>
  1107. </DD>
  1108. <DD><DL>
  1109.  
  1110. <DT><B>Returns:</B><DD>name of the Folder</DL>
  1111. </DD>
  1112. </DL>
  1113. <HR>
  1114.  
  1115. <A NAME="getFullName()"><!-- --></A><H3>
  1116. getFullName</H3>
  1117. <PRE>
  1118. 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>
  1119. <DL>
  1120. <DD>Get the fullname of this folder.
  1121. <P>
  1122. <DD><DL>
  1123. <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>
  1124. </DD>
  1125. <DD><DL>
  1126.  
  1127. <DT><B>Returns:</B><DD>full name of the Folder</DL>
  1128. </DD>
  1129. </DL>
  1130. <HR>
  1131.  
  1132. <A NAME="getParent()"><!-- --></A><H3>
  1133. getParent</H3>
  1134. <PRE>
  1135. public <A HREF="../../../../javax/mail/Folder.html" title="class in javax.mail">Folder</A> <B>getParent</B>()
  1136.                 throws <A HREF="../../../../javax/mail/MessagingException.html" title="class in javax.mail">MessagingException</A></PRE>
  1137. <DL>
  1138. <DD>Get this folder's parent.
  1139. <P>
  1140. <DD><DL>
  1141. <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>
  1142. </DD>
  1143. <DD><DL>
  1144.  
  1145. <DT><B>Returns:</B><DD>Parent folder
  1146. <DT><B>Throws:</B>
  1147. <DD><CODE><A HREF="../../../../javax/mail/MessagingException.html" title="class in javax.mail">MessagingException</A></CODE></DL>
  1148. </DD>
  1149. </DL>
  1150. <HR>
  1151.  
  1152. <A NAME="exists()"><!-- --></A><H3>
  1153. exists</H3>
  1154. <PRE>
  1155. public boolean <B>exists</B>()
  1156.                throws <A HREF="../../../../javax/mail/MessagingException.html" title="class in javax.mail">MessagingException</A></PRE>
  1157. <DL>
  1158. <DD>Check whether this folder really exists on the server.
  1159. <P>
  1160. <DD><DL>
  1161. <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>
  1162. </DD>
  1163. <DD><DL>
  1164.  
  1165. <DT><B>Returns:</B><DD>true if the folder exists, otherwise false
  1166. <DT><B>Throws:</B>
  1167. <DD><CODE><A HREF="../../../../javax/mail/MessagingException.html" title="class in javax.mail">MessagingException</A></CODE> - typically if the connection
  1168.                         to the server is lost.<DT><B>See Also:</B><DD><A HREF="../../../../javax/mail/Folder.html#create(int)"><CODE>Folder.create(int)</CODE></A></DL>
  1169. </DD>
  1170. </DL>
  1171. <HR>
  1172.  
  1173. <A NAME="list(java.lang.String)"><!-- --></A><H3>
  1174. list</H3>
  1175. <PRE>
  1176. 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)
  1177.               throws <A HREF="../../../../javax/mail/MessagingException.html" title="class in javax.mail">MessagingException</A></PRE>
  1178. <DL>
  1179. <DD>List all subfolders matching the specified pattern.
  1180. <P>
  1181. <DD><DL>
  1182. <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>
  1183. </DD>
  1184. <DD><DL>
  1185. <DT><B>Parameters:</B><DD><CODE>pattern</CODE> - the match pattern
  1186. <DT><B>Returns:</B><DD>array of matching Folder objects. An empty
  1187.                         array is returned if no matching Folders exist.
  1188. <DT><B>Throws:</B>
  1189. <DD><CODE><A HREF="../../../../javax/mail/FolderNotFoundException.html" title="class in javax.mail">FolderNotFoundException</A></CODE> - if this folder does
  1190.                         not exist.
  1191. <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#listSubscribed(java.lang.String)"><CODE>Folder.listSubscribed(java.lang.String)</CODE></A></DL>
  1192. </DD>
  1193. </DL>
  1194. <HR>
  1195.  
  1196. <A NAME="listSubscribed(java.lang.String)"><!-- --></A><H3>
  1197. listSubscribed</H3>
  1198. <PRE>
  1199. public <A HREF="../../../../javax/mail/Folder.html" title="class in javax.mail">Folder</A>[] <B>listSubscribed</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)
  1200.                         throws <A HREF="../../../../javax/mail/MessagingException.html" title="class in javax.mail">MessagingException</A></PRE>
  1201. <DL>
  1202. <DD>List all subscribed subfolders matching the specified pattern.
  1203. <P>
  1204. <DD><DL>
  1205. <DT><B>Overrides:</B><DD><CODE><A HREF="../../../../javax/mail/Folder.html#listSubscribed(java.lang.String)">listSubscribed</A></CODE> in class <CODE><A HREF="../../../../javax/mail/Folder.html" title="class in javax.mail">Folder</A></CODE></DL>
  1206. </DD>
  1207. <DD><DL>
  1208. <DT><B>Parameters:</B><DD><CODE>pattern</CODE> - the match pattern
  1209. <DT><B>Returns:</B><DD>array of matching subscribed Folder objects. An
  1210.                         empty array is returned if no matching
  1211.                         subscribed folders exist.
  1212. <DT><B>Throws:</B>
  1213. <DD><CODE><A HREF="../../../../javax/mail/FolderNotFoundException.html" title="class in javax.mail">FolderNotFoundException</A></CODE> - if this folder does
  1214.                         not exist.
  1215. <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#list(java.lang.String)"><CODE>Folder.list(java.lang.String)</CODE></A></DL>
  1216. </DD>
  1217. </DL>
  1218. <HR>
  1219.  
  1220. <A NAME="getSeparator()"><!-- --></A><H3>
  1221. getSeparator</H3>
  1222. <PRE>
  1223. public char <B>getSeparator</B>()
  1224.                   throws <A HREF="../../../../javax/mail/MessagingException.html" title="class in javax.mail">MessagingException</A></PRE>
  1225. <DL>
  1226. <DD>Get the separator character.
  1227. <P>
  1228. <DD><DL>
  1229. <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>
  1230. </DD>
  1231. <DD><DL>
  1232.  
  1233. <DT><B>Returns:</B><DD>Hierarchy separator character
  1234. <DT><B>Throws:</B>
  1235. <DD><CODE><A HREF="../../../../javax/mail/FolderNotFoundException.html" title="class in javax.mail">FolderNotFoundException</A></CODE> - if the implementation
  1236.                         requires the folder to exist, but it does not
  1237. <DD><CODE><A HREF="../../../../javax/mail/MessagingException.html" title="class in javax.mail">MessagingException</A></CODE></DL>
  1238. </DD>
  1239. </DL>
  1240. <HR>
  1241.  
  1242. <A NAME="getType()"><!-- --></A><H3>
  1243. getType</H3>
  1244. <PRE>
  1245. public int <B>getType</B>()
  1246.             throws <A HREF="../../../../javax/mail/MessagingException.html" title="class in javax.mail">MessagingException</A></PRE>
  1247. <DL>
  1248. <DD>Get the type of this folder.
  1249. <P>
  1250. <DD><DL>
  1251. <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>
  1252. </DD>
  1253. <DD><DL>
  1254.  
  1255. <DT><B>Returns:</B><DD>integer with appropriate bits set
  1256. <DT><B>Throws:</B>
  1257. <DD><CODE><A HREF="../../../../javax/mail/FolderNotFoundException.html" title="class in javax.mail">FolderNotFoundException</A></CODE> - if this folder does
  1258.                         not exist.
  1259. <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>,
  1260. <A HREF="../../../../javax/mail/Folder.html#HOLDS_MESSAGES"><CODE>Folder.HOLDS_MESSAGES</CODE></A></DL>
  1261. </DD>
  1262. </DL>
  1263. <HR>
  1264.  
  1265. <A NAME="isSubscribed()"><!-- --></A><H3>
  1266. isSubscribed</H3>
  1267. <PRE>
  1268. public boolean <B>isSubscribed</B>()</PRE>
  1269. <DL>
  1270. <DD>Check whether this folder is subscribed. <p>
  1271. <P>
  1272. <DD><DL>
  1273. <DT><B>Overrides:</B><DD><CODE><A HREF="../../../../javax/mail/Folder.html#isSubscribed()">isSubscribed</A></CODE> in class <CODE><A HREF="../../../../javax/mail/Folder.html" title="class in javax.mail">Folder</A></CODE></DL>
  1274. </DD>
  1275. <DD><DL>
  1276.  
  1277. <DT><B>Returns:</B><DD>true if this Folder is subscribed</DL>
  1278. </DD>
  1279. </DL>
  1280. <HR>
  1281.  
  1282. <A NAME="setSubscribed(boolean)"><!-- --></A><H3>
  1283. setSubscribed</H3>
  1284. <PRE>
  1285. public void <B>setSubscribed</B>(boolean&nbsp;subscribe)
  1286.                    throws <A HREF="../../../../javax/mail/MessagingException.html" title="class in javax.mail">MessagingException</A></PRE>
  1287. <DL>
  1288. <DD>Subscribe/Unsubscribe this folder.
  1289. <P>
  1290. <DD><DL>
  1291. <DT><B>Overrides:</B><DD><CODE><A HREF="../../../../javax/mail/Folder.html#setSubscribed(boolean)">setSubscribed</A></CODE> in class <CODE><A HREF="../../../../javax/mail/Folder.html" title="class in javax.mail">Folder</A></CODE></DL>
  1292. </DD>
  1293. <DD><DL>
  1294. <DT><B>Parameters:</B><DD><CODE>subscribe</CODE> - true to subscribe, false to unsubscribe
  1295. <DT><B>Throws:</B>
  1296. <DD><CODE><A HREF="../../../../javax/mail/FolderNotFoundException.html" title="class in javax.mail">FolderNotFoundException</A></CODE> - if this folder does
  1297.                         not exist.
  1298. <DD><CODE><A HREF="../../../../javax/mail/MethodNotSupportedException.html" title="class in javax.mail">MethodNotSupportedException</A></CODE> - if this store
  1299.                         does not support subscription
  1300. <DD><CODE><A HREF="../../../../javax/mail/MessagingException.html" title="class in javax.mail">MessagingException</A></CODE></DL>
  1301. </DD>
  1302. </DL>
  1303. <HR>
  1304.  
  1305. <A NAME="create(int)"><!-- --></A><H3>
  1306. create</H3>
  1307. <PRE>
  1308. public boolean <B>create</B>(int&nbsp;type)
  1309.                throws <A HREF="../../../../javax/mail/MessagingException.html" title="class in javax.mail">MessagingException</A></PRE>
  1310. <DL>
  1311. <DD>Create this folder, with the specified type.
  1312. <P>
  1313. <DD><DL>
  1314. <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>
  1315. </DD>
  1316. <DD><DL>
  1317. <DT><B>Parameters:</B><DD><CODE>type</CODE> - The type of this folder.
  1318. <DT><B>Returns:</B><DD>true if the creation succeeds, else false.
  1319. <DT><B>Throws:</B>
  1320. <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>,
  1321. <A HREF="../../../../javax/mail/Folder.html#HOLDS_MESSAGES"><CODE>Folder.HOLDS_MESSAGES</CODE></A>,
  1322. <A HREF="../../../../javax/mail/event/FolderEvent.html" title="class in javax.mail.event"><CODE>FolderEvent</CODE></A></DL>
  1323. </DD>
  1324. </DL>
  1325. <HR>
  1326.  
  1327. <A NAME="hasNewMessages()"><!-- --></A><H3>
  1328. hasNewMessages</H3>
  1329. <PRE>
  1330. public boolean <B>hasNewMessages</B>()
  1331.                        throws <A HREF="../../../../javax/mail/MessagingException.html" title="class in javax.mail">MessagingException</A></PRE>
  1332. <DL>
  1333. <DD>Check whether this folder has new messages.
  1334. <P>
  1335. <DD><DL>
  1336. <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>
  1337. </DD>
  1338. <DD><DL>
  1339.  
  1340. <DT><B>Returns:</B><DD>true if the Store has new Messages
  1341. <DT><B>Throws:</B>
  1342. <DD><CODE><A HREF="../../../../javax/mail/FolderNotFoundException.html" title="class in javax.mail">FolderNotFoundException</A></CODE> - if this folder does
  1343.                         not exist.
  1344. <DD><CODE><A HREF="../../../../javax/mail/MessagingException.html" title="class in javax.mail">MessagingException</A></CODE></DL>
  1345. </DD>
  1346. </DL>
  1347. <HR>
  1348.  
  1349. <A NAME="getFolder(java.lang.String)"><!-- --></A><H3>
  1350. getFolder</H3>
  1351. <PRE>
  1352. 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)
  1353.                  throws <A HREF="../../../../javax/mail/MessagingException.html" title="class in javax.mail">MessagingException</A></PRE>
  1354. <DL>
  1355. <DD>Get the named subfolder. <p>
  1356. <P>
  1357. <DD><DL>
  1358. <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>
  1359. </DD>
  1360. <DD><DL>
  1361. <DT><B>Parameters:</B><DD><CODE>name</CODE> - name of the Folder
  1362. <DT><B>Returns:</B><DD>Folder object
  1363. <DT><B>Throws:</B>
  1364. <DD><CODE><A HREF="../../../../javax/mail/MessagingException.html" title="class in javax.mail">MessagingException</A></CODE></DL>
  1365. </DD>
  1366. </DL>
  1367. <HR>
  1368.  
  1369. <A NAME="delete(boolean)"><!-- --></A><H3>
  1370. delete</H3>
  1371. <PRE>
  1372. public boolean <B>delete</B>(boolean&nbsp;recurse)
  1373.                throws <A HREF="../../../../javax/mail/MessagingException.html" title="class in javax.mail">MessagingException</A></PRE>
  1374. <DL>
  1375. <DD>Delete this folder.
  1376. <P>
  1377. <DD><DL>
  1378. <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>
  1379. </DD>
  1380. <DD><DL>
  1381.  
  1382. <DT><B>Returns:</B><DD>true if the Folder is deleted successfully
  1383. <DT><B>Throws:</B>
  1384. <DD><CODE><A HREF="../../../../javax/mail/FolderNotFoundException.html" title="class in javax.mail">FolderNotFoundException</A></CODE> - if this folder does
  1385.                         not exist
  1386. <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>
  1387. </DD>
  1388. </DL>
  1389. <HR>
  1390.  
  1391. <A NAME="renameTo(javax.mail.Folder)"><!-- --></A><H3>
  1392. renameTo</H3>
  1393. <PRE>
  1394. public boolean <B>renameTo</B>(<A HREF="../../../../javax/mail/Folder.html" title="class in javax.mail">Folder</A>&nbsp;f)
  1395.                  throws <A HREF="../../../../javax/mail/MessagingException.html" title="class in javax.mail">MessagingException</A></PRE>
  1396. <DL>
  1397. <DD>Rename this folder. <p>
  1398. <P>
  1399. <DD><DL>
  1400. <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>
  1401. </DD>
  1402. <DD><DL>
  1403. <DT><B>Parameters:</B><DD><CODE>f</CODE> - a folder representing the new name for this Folder
  1404. <DT><B>Returns:</B><DD>true if the Folder is renamed successfully
  1405. <DT><B>Throws:</B>
  1406. <DD><CODE><A HREF="../../../../javax/mail/FolderNotFoundException.html" title="class in javax.mail">FolderNotFoundException</A></CODE> - if this folder does
  1407.                         not exist
  1408. <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>
  1409. </DD>
  1410. </DL>
  1411. <HR>
  1412.  
  1413. <A NAME="open(int)"><!-- --></A><H3>
  1414. open</H3>
  1415. <PRE>
  1416. public void <B>open</B>(int&nbsp;mode)
  1417.           throws <A HREF="../../../../javax/mail/MessagingException.html" title="class in javax.mail">MessagingException</A></PRE>
  1418. <DL>
  1419. <DD>Open this folder in the given mode.
  1420. <P>
  1421. <DD><DL>
  1422. <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>
  1423. </DD>
  1424. <DD><DL>
  1425. <DT><B>Parameters:</B><DD><CODE>mode</CODE> - open the Folder READ_ONLY or READ_WRITE
  1426. <DT><B>Throws:</B>
  1427. <DD><CODE><A HREF="../../../../javax/mail/FolderNotFoundException.html" title="class in javax.mail">FolderNotFoundException</A></CODE> - if this folder does
  1428.                         not exist.
  1429. <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#READ_ONLY"><CODE>Folder.READ_ONLY</CODE></A>,
  1430. <A HREF="../../../../javax/mail/Folder.html#READ_WRITE"><CODE>Folder.READ_WRITE</CODE></A>,
  1431. <A HREF="../../../../javax/mail/Folder.html#getType()"><CODE>Folder.getType()</CODE></A>,
  1432. <A HREF="../../../../javax/mail/event/ConnectionEvent.html" title="class in javax.mail.event"><CODE>ConnectionEvent</CODE></A></DL>
  1433. </DD>
  1434. </DL>
  1435. <HR>
  1436.  
  1437. <A NAME="fetch(javax.mail.Message[], javax.mail.FetchProfile)"><!-- --></A><H3>
  1438. fetch</H3>
  1439. <PRE>
  1440. public void <B>fetch</B>(<A HREF="../../../../javax/mail/Message.html" title="class in javax.mail">Message</A>[]&nbsp;msgs,
  1441.                   <A HREF="../../../../javax/mail/FetchProfile.html" title="class in javax.mail">FetchProfile</A>&nbsp;fp)
  1442.            throws <A HREF="../../../../javax/mail/MessagingException.html" title="class in javax.mail">MessagingException</A></PRE>
  1443. <DL>
  1444. <DD>Prefetch attributes, based on the given FetchProfile.
  1445. <P>
  1446. <DD><DL>
  1447. <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>
  1448. </DD>
  1449. <DD><DL>
  1450. <DT><B>Parameters:</B><DD><CODE>msgs</CODE> - fetch items for these messages<DD><CODE>fp</CODE> - the FetchProfile
  1451. <DT><B>Throws:</B>
  1452. <DD><CODE><A HREF="../../../../javax/mail/MessagingException.html" title="class in javax.mail">MessagingException</A></CODE></DL>
  1453. </DD>
  1454. </DL>
  1455. <HR>
  1456.  
  1457. <A NAME="setFlags(javax.mail.Message[], javax.mail.Flags, boolean)"><!-- --></A><H3>
  1458. setFlags</H3>
  1459. <PRE>
  1460. public void <B>setFlags</B>(<A HREF="../../../../javax/mail/Message.html" title="class in javax.mail">Message</A>[]&nbsp;msgs,
  1461.                      <A HREF="../../../../javax/mail/Flags.html" title="class in javax.mail">Flags</A>&nbsp;flag,
  1462.                      boolean&nbsp;value)
  1463.               throws <A HREF="../../../../javax/mail/MessagingException.html" title="class in javax.mail">MessagingException</A></PRE>
  1464. <DL>
  1465. <DD>Set the specified flags for the given array of messages.
  1466. <P>
  1467. <DD><DL>
  1468. <DT><B>Overrides:</B><DD><CODE><A HREF="../../../../javax/mail/Folder.html#setFlags(javax.mail.Message[], javax.mail.Flags, boolean)">setFlags</A></CODE> in class <CODE><A HREF="../../../../javax/mail/Folder.html" title="class in javax.mail">Folder</A></CODE></DL>
  1469. </DD>
  1470. <DD><DL>
  1471. <DT><B>Parameters:</B><DD><CODE>msgs</CODE> - the array of message objects<DD><CODE>flag</CODE> - Flags object containing the flags to be set<DD><CODE>value</CODE> - set the flags to this boolean value
  1472. <DT><B>Throws:</B>
  1473. <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#setFlags(javax.mail.Flags, boolean)"><CODE>Message.setFlags(javax.mail.Flags, boolean)</CODE></A>,
  1474. <A HREF="../../../../javax/mail/event/MessageChangedEvent.html" title="class in javax.mail.event"><CODE>MessageChangedEvent</CODE></A></DL>
  1475. </DD>
  1476. </DL>
  1477. <HR>
  1478.  
  1479. <A NAME="close(boolean)"><!-- --></A><H3>
  1480. close</H3>
  1481. <PRE>
  1482. public void <B>close</B>(boolean&nbsp;expunge)
  1483.            throws <A HREF="../../../../javax/mail/MessagingException.html" title="class in javax.mail">MessagingException</A></PRE>
  1484. <DL>
  1485. <DD>Close this folder.
  1486. <P>
  1487. <DD><DL>
  1488. <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>
  1489. </DD>
  1490. <DD><DL>
  1491. <DT><B>Parameters:</B><DD><CODE>expunge</CODE> - expunges all deleted messages if this flag is true
  1492. <DT><B>Throws:</B>
  1493. <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>
  1494. </DD>
  1495. </DL>
  1496. <HR>
  1497.  
  1498. <A NAME="forceClose()"><!-- --></A><H3>
  1499. forceClose</H3>
  1500. <PRE>
  1501. public void <B>forceClose</B>()
  1502.                 throws <A HREF="../../../../javax/mail/MessagingException.html" title="class in javax.mail">MessagingException</A></PRE>
  1503. <DL>
  1504. <DD>Close this folder without waiting for the server.
  1505. <P>
  1506. <DD><DL>
  1507. </DL>
  1508. </DD>
  1509. <DD><DL>
  1510.  
  1511. <DT><B>Throws:</B>
  1512. <DD><CODE><A HREF="../../../../javax/mail/MessagingException.html" title="class in javax.mail">MessagingException</A></CODE></DL>
  1513. </DD>
  1514. </DL>
  1515. <HR>
  1516.  
  1517. <A NAME="isOpen()"><!-- --></A><H3>
  1518. isOpen</H3>
  1519. <PRE>
  1520. public boolean <B>isOpen</B>()</PRE>
  1521. <DL>
  1522. <DD>Check whether this connection is really open.
  1523. <P>
  1524. <DD><DL>
  1525. <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>
  1526. </DD>
  1527. <DD><DL>
  1528.  
  1529. <DT><B>Returns:</B><DD>true if this Folder is in the 'open' state.</DL>
  1530. </DD>
  1531. </DL>
  1532. <HR>
  1533.  
  1534. <A NAME="getPermanentFlags()"><!-- --></A><H3>
  1535. getPermanentFlags</H3>
  1536. <PRE>
  1537. public <A HREF="../../../../javax/mail/Flags.html" title="class in javax.mail">Flags</A> <B>getPermanentFlags</B>()</PRE>
  1538. <DL>
  1539. <DD>Return the permanent flags supported by the server.
  1540. <P>
  1541. <DD><DL>
  1542. <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>
  1543. </DD>
  1544. <DD><DL>
  1545.  
  1546. <DT><B>Returns:</B><DD>permanent flags, or null if not known</DL>
  1547. </DD>
  1548. </DL>
  1549. <HR>
  1550.  
  1551. <A NAME="getMessageCount()"><!-- --></A><H3>
  1552. getMessageCount</H3>
  1553. <PRE>
  1554. public int <B>getMessageCount</B>()
  1555.                     throws <A HREF="../../../../javax/mail/MessagingException.html" title="class in javax.mail">MessagingException</A></PRE>
  1556. <DL>
  1557. <DD>Get the total message count.
  1558. <P>
  1559. <DD><DL>
  1560. <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>
  1561. </DD>
  1562. <DD><DL>
  1563.  
  1564. <DT><B>Returns:</B><DD>total number of messages. -1 may be returned
  1565.                         by certain implementations if this method is
  1566.                         invoked on a closed folder.
  1567. <DT><B>Throws:</B>
  1568. <DD><CODE><A HREF="../../../../javax/mail/FolderNotFoundException.html" title="class in javax.mail">FolderNotFoundException</A></CODE> - if this folder does
  1569.                         not exist.
  1570. <DD><CODE><A HREF="../../../../javax/mail/MessagingException.html" title="class in javax.mail">MessagingException</A></CODE></DL>
  1571. </DD>
  1572. </DL>
  1573. <HR>
  1574.  
  1575. <A NAME="getNewMessageCount()"><!-- --></A><H3>
  1576. getNewMessageCount</H3>
  1577. <PRE>
  1578. public int <B>getNewMessageCount</B>()
  1579.                        throws <A HREF="../../../../javax/mail/MessagingException.html" title="class in javax.mail">MessagingException</A></PRE>
  1580. <DL>
  1581. <DD>Get the new message count.
  1582. <P>
  1583. <DD><DL>
  1584. <DT><B>Overrides:</B><DD><CODE><A HREF="../../../../javax/mail/Folder.html#getNewMessageCount()">getNewMessageCount</A></CODE> in class <CODE><A HREF="../../../../javax/mail/Folder.html" title="class in javax.mail">Folder</A></CODE></DL>
  1585. </DD>
  1586. <DD><DL>
  1587.  
  1588. <DT><B>Returns:</B><DD>number of new messages. -1 may be returned
  1589.                         by certain implementations if this method is
  1590.                         invoked on a closed folder.
  1591. <DT><B>Throws:</B>
  1592. <DD><CODE><A HREF="../../../../javax/mail/FolderNotFoundException.html" title="class in javax.mail">FolderNotFoundException</A></CODE> - if this folder does
  1593.                         not exist.
  1594. <DD><CODE><A HREF="../../../../javax/mail/MessagingException.html" title="class in javax.mail">MessagingException</A></CODE></DL>
  1595. </DD>
  1596. </DL>
  1597. <HR>
  1598.  
  1599. <A NAME="getUnreadMessageCount()"><!-- --></A><H3>
  1600. getUnreadMessageCount</H3>
  1601. <PRE>
  1602. public int <B>getUnreadMessageCount</B>()
  1603.                           throws <A HREF="../../../../javax/mail/MessagingException.html" title="class in javax.mail">MessagingException</A></PRE>
  1604. <DL>
  1605. <DD>Get the unread message count.
  1606. <P>
  1607. <DD><DL>
  1608. <DT><B>Overrides:</B><DD><CODE><A HREF="../../../../javax/mail/Folder.html#getUnreadMessageCount()">getUnreadMessageCount</A></CODE> in class <CODE><A HREF="../../../../javax/mail/Folder.html" title="class in javax.mail">Folder</A></CODE></DL>
  1609. </DD>
  1610. <DD><DL>
  1611.  
  1612. <DT><B>Returns:</B><DD>total number of unread messages. -1 may be returned
  1613.                         by certain implementations if this method is
  1614.                         invoked on a closed folder.
  1615. <DT><B>Throws:</B>
  1616. <DD><CODE><A HREF="../../../../javax/mail/FolderNotFoundException.html" title="class in javax.mail">FolderNotFoundException</A></CODE> - if this folder does
  1617.                         not exist.
  1618. <DD><CODE><A HREF="../../../../javax/mail/MessagingException.html" title="class in javax.mail">MessagingException</A></CODE></DL>
  1619. </DD>
  1620. </DL>
  1621. <HR>
  1622.  
  1623. <A NAME="getDeletedMessageCount()"><!-- --></A><H3>
  1624. getDeletedMessageCount</H3>
  1625. <PRE>
  1626. public int <B>getDeletedMessageCount</B>()
  1627.                            throws <A HREF="../../../../javax/mail/MessagingException.html" title="class in javax.mail">MessagingException</A></PRE>
  1628. <DL>
  1629. <DD>Get the deleted message count.
  1630. <P>
  1631. <DD><DL>
  1632. <DT><B>Overrides:</B><DD><CODE><A HREF="../../../../javax/mail/Folder.html#getDeletedMessageCount()">getDeletedMessageCount</A></CODE> in class <CODE><A HREF="../../../../javax/mail/Folder.html" title="class in javax.mail">Folder</A></CODE></DL>
  1633. </DD>
  1634. <DD><DL>
  1635.  
  1636. <DT><B>Returns:</B><DD>number of deleted messages. -1 may be returned
  1637.                         by certain implementations if this method is
  1638.                         invoked on a closed folder.
  1639. <DT><B>Throws:</B>
  1640. <DD><CODE><A HREF="../../../../javax/mail/FolderNotFoundException.html" title="class in javax.mail">FolderNotFoundException</A></CODE> - if this folder does
  1641.                         not exist.
  1642. <DD><CODE><A HREF="../../../../javax/mail/MessagingException.html" title="class in javax.mail">MessagingException</A></CODE></DL>
  1643. </DD>
  1644. </DL>
  1645. <HR>
  1646.  
  1647. <A NAME="getMessage(int)"><!-- --></A><H3>
  1648. getMessage</H3>
  1649. <PRE>
  1650. public <A HREF="../../../../javax/mail/Message.html" title="class in javax.mail">Message</A> <B>getMessage</B>(int&nbsp;msgnum)
  1651.                    throws <A HREF="../../../../javax/mail/MessagingException.html" title="class in javax.mail">MessagingException</A></PRE>
  1652. <DL>
  1653. <DD>Get the specified message.
  1654. <P>
  1655. <DD><DL>
  1656. <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>
  1657. </DD>
  1658. <DD><DL>
  1659. <DT><B>Parameters:</B><DD><CODE>msgnum</CODE> - the message number
  1660. <DT><B>Returns:</B><DD>the Message object
  1661. <DT><B>Throws:</B>
  1662. <DD><CODE><A HREF="../../../../javax/mail/FolderNotFoundException.html" title="class in javax.mail">FolderNotFoundException</A></CODE> - if this folder does
  1663.                         not exist.
  1664. <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>,
  1665. <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>
  1666. </DD>
  1667. </DL>
  1668. <HR>
  1669.  
  1670. <A NAME="appendMessages(javax.mail.Message[])"><!-- --></A><H3>
  1671. appendMessages</H3>
  1672. <PRE>
  1673. public void <B>appendMessages</B>(<A HREF="../../../../javax/mail/Message.html" title="class in javax.mail">Message</A>[]&nbsp;msgs)
  1674.                     throws <A HREF="../../../../javax/mail/MessagingException.html" title="class in javax.mail">MessagingException</A></PRE>
  1675. <DL>
  1676. <DD>Append the given messages into this folder.
  1677. <P>
  1678. <DD><DL>
  1679. <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>
  1680. </DD>
  1681. <DD><DL>
  1682. <DT><B>Parameters:</B><DD><CODE>msgs</CODE> - array of Messages to be appended
  1683. <DT><B>Throws:</B>
  1684. <DD><CODE><A HREF="../../../../javax/mail/FolderNotFoundException.html" title="class in javax.mail">FolderNotFoundException</A></CODE> - if this folder does
  1685.                         not exist.
  1686. <DD><CODE><A HREF="../../../../javax/mail/MessagingException.html" title="class in javax.mail">MessagingException</A></CODE> - if the append failed.</DL>
  1687. </DD>
  1688. </DL>
  1689. <HR>
  1690.  
  1691. <A NAME="appendUIDMessages(javax.mail.Message[])"><!-- --></A><H3>
  1692. appendUIDMessages</H3>
  1693. <PRE>
  1694. public com.sun.mail.imap.AppendUID[] <B>appendUIDMessages</B>(<A HREF="../../../../javax/mail/Message.html" title="class in javax.mail">Message</A>[]&nbsp;msgs)
  1695.                                                 throws <A HREF="../../../../javax/mail/MessagingException.html" title="class in javax.mail">MessagingException</A></PRE>
  1696. <DL>
  1697. <DD>Append the given messages into this folder.
  1698.  Return array of AppendUID objects containing
  1699.  UIDs of these messages in the destination folder.
  1700.  Each element of the returned array corresponds to
  1701.  an element of the <code>msgs</code> array.  A null
  1702.  element means the server didn't return UID information
  1703. for the appended message.  <p>
  1704.  
  1705. Depends on the APPENDUID response code defined by the
  1706. UIDPLUS extension -
  1707. <A HREF="http://www.ietf.org/rfc/rfc2359.txt">RFC 2359</A>.
  1708. <P>
  1709. <DD><DL>
  1710. </DL>
  1711. </DD>
  1712. <DD><DL>
  1713.  
  1714. <DT><B>Throws:</B>
  1715. <DD><CODE><A HREF="../../../../javax/mail/MessagingException.html" title="class in javax.mail">MessagingException</A></CODE><DT><B>Since:</B></DT>
  1716.  <DD>JavaMail 1.4</DD>
  1717. </DL>
  1718. </DD>
  1719. </DL>
  1720. <HR>
  1721.  
  1722. <A NAME="addMessages(javax.mail.Message[])"><!-- --></A><H3>
  1723. addMessages</H3>
  1724. <PRE>
  1725. public <A HREF="../../../../javax/mail/Message.html" title="class in javax.mail">Message</A>[] <B>addMessages</B>(<A HREF="../../../../javax/mail/Message.html" title="class in javax.mail">Message</A>[]&nbsp;msgs)
  1726.                      throws <A HREF="../../../../javax/mail/MessagingException.html" title="class in javax.mail">MessagingException</A></PRE>
  1727. <DL>
  1728. <DD>Append the given messages into this folder.
  1729. Return array of Message objects representing
  1730. the messages in the destination folder.  Note
  1731. that the folder must be open.
  1732. Each element of the returned array corresponds to
  1733. an element of the <code>msgs</code> array.  A null
  1734. element means the server didn't return UID information
  1735.  for the appended message. <p>
  1736.  
  1737.  Depends on the APPENDUID response code defined by the
  1738.  UIDPLUS extension -
  1739.  <A HREF="http://www.ietf.org/rfc/rfc2359.txt">RFC 2359</A>.
  1740. <P>
  1741. <DD><DL>
  1742. </DL>
  1743. </DD>
  1744. <DD><DL>
  1745.  
  1746. <DT><B>Throws:</B>
  1747. <DD><CODE><A HREF="../../../../javax/mail/MessagingException.html" title="class in javax.mail">MessagingException</A></CODE><DT><B>Since:</B></DT>
  1748.   <DD>JavaMail 1.4</DD>
  1749. </DL>
  1750. </DD>
  1751. </DL>
  1752. <HR>
  1753.  
  1754. <A NAME="copyMessages(javax.mail.Message[], javax.mail.Folder)"><!-- --></A><H3>
  1755. copyMessages</H3>
  1756. <PRE>
  1757. public void <B>copyMessages</B>(<A HREF="../../../../javax/mail/Message.html" title="class in javax.mail">Message</A>[]&nbsp;msgs,
  1758.                          <A HREF="../../../../javax/mail/Folder.html" title="class in javax.mail">Folder</A>&nbsp;folder)
  1759.                   throws <A HREF="../../../../javax/mail/MessagingException.html" title="class in javax.mail">MessagingException</A></PRE>
  1760. <DL>
  1761. <DD>Copy the specified messages from this folder, to the
  1762.  specified destination.
  1763. <P>
  1764. <DD><DL>
  1765. <DT><B>Overrides:</B><DD><CODE><A HREF="../../../../javax/mail/Folder.html#copyMessages(javax.mail.Message[], javax.mail.Folder)">copyMessages</A></CODE> in class <CODE><A HREF="../../../../javax/mail/Folder.html" title="class in javax.mail">Folder</A></CODE></DL>
  1766. </DD>
  1767. <DD><DL>
  1768. <DT><B>Parameters:</B><DD><CODE>msgs</CODE> - the array of message objects<DD><CODE>folder</CODE> - the folder to copy the messages to
  1769. <DT><B>Throws:</B>
  1770. <DD><CODE><A HREF="../../../../javax/mail/FolderNotFoundException.html" title="class in javax.mail">FolderNotFoundException</A></CODE> - if the destination
  1771.                         folder does not exist.
  1772. <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#appendMessages(javax.mail.Message[])"><CODE>Folder.appendMessages(javax.mail.Message[])</CODE></A></DL>
  1773. </DD>
  1774. </DL>
  1775. <HR>
  1776.  
  1777. <A NAME="expunge()"><!-- --></A><H3>
  1778. expunge</H3>
  1779. <PRE>
  1780. public <A HREF="../../../../javax/mail/Message.html" title="class in javax.mail">Message</A>[] <B>expunge</B>()
  1781.                   throws <A HREF="../../../../javax/mail/MessagingException.html" title="class in javax.mail">MessagingException</A></PRE>
  1782. <DL>
  1783. <DD>Expunge all messages marked as DELETED.
  1784. <P>
  1785. <DD><DL>
  1786. <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>
  1787. </DD>
  1788. <DD><DL>
  1789.  
  1790. <DT><B>Returns:</B><DD>array of expunged Message objects
  1791. <DT><B>Throws:</B>
  1792. <DD><CODE><A HREF="../../../../javax/mail/FolderNotFoundException.html" title="class in javax.mail">FolderNotFoundException</A></CODE> - if this folder does not
  1793.                         exist
  1794. <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>,
  1795. <A HREF="../../../../javax/mail/event/MessageCountEvent.html" title="class in javax.mail.event"><CODE>MessageCountEvent</CODE></A></DL>
  1796. </DD>
  1797. </DL>
  1798. <HR>
  1799.  
  1800. <A NAME="expunge(javax.mail.Message[])"><!-- --></A><H3>
  1801. expunge</H3>
  1802. <PRE>
  1803. public <A HREF="../../../../javax/mail/Message.html" title="class in javax.mail">Message</A>[] <B>expunge</B>(<A HREF="../../../../javax/mail/Message.html" title="class in javax.mail">Message</A>[]&nbsp;msgs)
  1804.                   throws <A HREF="../../../../javax/mail/MessagingException.html" title="class in javax.mail">MessagingException</A></PRE>
  1805. <DL>
  1806. <DD>Expunge the indicated messages, which must have been marked as DELETED.
  1807. <P>
  1808. <DD><DL>
  1809. </DL>
  1810. </DD>
  1811. <DD><DL>
  1812.  
  1813. <DT><B>Throws:</B>
  1814. <DD><CODE><A HREF="../../../../javax/mail/MessagingException.html" title="class in javax.mail">MessagingException</A></CODE></DL>
  1815. </DD>
  1816. </DL>
  1817. <HR>
  1818.  
  1819. <A NAME="search(javax.mail.search.SearchTerm)"><!-- --></A><H3>
  1820. search</H3>
  1821. <PRE>
  1822. public <A HREF="../../../../javax/mail/Message.html" title="class in javax.mail">Message</A>[] <B>search</B>(<A HREF="../../../../javax/mail/search/SearchTerm.html" title="class in javax.mail.search">SearchTerm</A>&nbsp;term)
  1823.                  throws <A HREF="../../../../javax/mail/MessagingException.html" title="class in javax.mail">MessagingException</A></PRE>
  1824. <DL>
  1825. <DD>Search whole folder for messages matching the given term.
  1826. <P>
  1827. <DD><DL>
  1828. <DT><B>Overrides:</B><DD><CODE><A HREF="../../../../javax/mail/Folder.html#search(javax.mail.search.SearchTerm)">search</A></CODE> in class <CODE><A HREF="../../../../javax/mail/Folder.html" title="class in javax.mail">Folder</A></CODE></DL>
  1829. </DD>
  1830. <DD><DL>
  1831. <DT><B>Parameters:</B><DD><CODE>term</CODE> - the search criterion
  1832. <DT><B>Returns:</B><DD>array of matching messages
  1833. <DT><B>Throws:</B>
  1834. <DD><CODE><A HREF="../../../../javax/mail/search/SearchException.html" title="class in javax.mail.search">SearchException</A></CODE> - if the search
  1835.                         term is too complex for the implementation to handle.
  1836. <DD><CODE><A HREF="../../../../javax/mail/FolderNotFoundException.html" title="class in javax.mail">FolderNotFoundException</A></CODE> - if this folder does
  1837.                         not exist.
  1838. <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/search/SearchTerm.html" title="class in javax.mail.search"><CODE>SearchTerm</CODE></A></DL>
  1839. </DD>
  1840. </DL>
  1841. <HR>
  1842.  
  1843. <A NAME="search(javax.mail.search.SearchTerm, javax.mail.Message[])"><!-- --></A><H3>
  1844. search</H3>
  1845. <PRE>
  1846. public <A HREF="../../../../javax/mail/Message.html" title="class in javax.mail">Message</A>[] <B>search</B>(<A HREF="../../../../javax/mail/search/SearchTerm.html" title="class in javax.mail.search">SearchTerm</A>&nbsp;term,
  1847.                         <A HREF="../../../../javax/mail/Message.html" title="class in javax.mail">Message</A>[]&nbsp;msgs)
  1848.                  throws <A HREF="../../../../javax/mail/MessagingException.html" title="class in javax.mail">MessagingException</A></PRE>
  1849. <DL>
  1850. <DD>Search the folder for messages matching the given term. Returns
  1851.  array of matching messages. Returns an empty array if no matching
  1852.  messages are found.
  1853. <P>
  1854. <DD><DL>
  1855. <DT><B>Overrides:</B><DD><CODE><A HREF="../../../../javax/mail/Folder.html#search(javax.mail.search.SearchTerm, javax.mail.Message[])">search</A></CODE> in class <CODE><A HREF="../../../../javax/mail/Folder.html" title="class in javax.mail">Folder</A></CODE></DL>
  1856. </DD>
  1857. <DD><DL>
  1858. <DT><B>Parameters:</B><DD><CODE>term</CODE> - the search criterion<DD><CODE>msgs</CODE> - the messages to be searched
  1859. <DT><B>Returns:</B><DD>array of matching messages
  1860. <DT><B>Throws:</B>
  1861. <DD><CODE><A HREF="../../../../javax/mail/search/SearchException.html" title="class in javax.mail.search">SearchException</A></CODE> - if the search
  1862.                         term is too complex for the implementation to handle.
  1863. <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/search/SearchTerm.html" title="class in javax.mail.search"><CODE>SearchTerm</CODE></A></DL>
  1864. </DD>
  1865. </DL>
  1866. <HR>
  1867.  
  1868. <A NAME="addMessageCountListener(javax.mail.event.MessageCountListener)"><!-- --></A><H3>
  1869. addMessageCountListener</H3>
  1870. <PRE>
  1871. public void <B>addMessageCountListener</B>(<A HREF="../../../../javax/mail/event/MessageCountListener.html" title="interface in javax.mail.event">MessageCountListener</A>&nbsp;l)</PRE>
  1872. <DL>
  1873. <DD><B>Description copied from class: <CODE><A HREF="../../../../javax/mail/Folder.html#addMessageCountListener(javax.mail.event.MessageCountListener)">Folder</A></CODE></B></DD>
  1874. <DD>Add a listener for MessageCount events on this Folder. <p>
  1875.  
  1876.  The implementation provided here adds this listener
  1877.  to an internal list of MessageCountListeners.
  1878. <P>
  1879. <DD><DL>
  1880. <DT><B>Overrides:</B><DD><CODE><A HREF="../../../../javax/mail/Folder.html#addMessageCountListener(javax.mail.event.MessageCountListener)">addMessageCountListener</A></CODE> in class <CODE><A HREF="../../../../javax/mail/Folder.html" title="class in javax.mail">Folder</A></CODE></DL>
  1881. </DD>
  1882. <DD><DL>
  1883. <DT><B>Parameters:</B><DD><CODE>l</CODE> - the Listener for MessageCount events<DT><B>See Also:</B><DD><A HREF="../../../../javax/mail/event/MessageCountEvent.html" title="class in javax.mail.event"><CODE>MessageCountEvent</CODE></A></DL>
  1884. </DD>
  1885. </DL>
  1886. <HR>
  1887.  
  1888. <A NAME="getUIDValidity()"><!-- --></A><H3>
  1889. getUIDValidity</H3>
  1890. <PRE>
  1891. public long <B>getUIDValidity</B>()
  1892.                     throws <A HREF="../../../../javax/mail/MessagingException.html" title="class in javax.mail">MessagingException</A></PRE>
  1893. <DL>
  1894. <DD>Returns the UIDValidity for this folder.
  1895. <P>
  1896. <DD><DL>
  1897. <DT><B>Specified by:</B><DD><CODE><A HREF="../../../../javax/mail/UIDFolder.html#getUIDValidity()">getUIDValidity</A></CODE> in interface <CODE><A HREF="../../../../javax/mail/UIDFolder.html" title="interface in javax.mail">UIDFolder</A></CODE></DL>
  1898. </DD>
  1899. <DD><DL>
  1900.  
  1901. <DT><B>Returns:</B><DD>UIDValidity
  1902. <DT><B>Throws:</B>
  1903. <DD><CODE><A HREF="../../../../javax/mail/MessagingException.html" title="class in javax.mail">MessagingException</A></CODE></DL>
  1904. </DD>
  1905. </DL>
  1906. <HR>
  1907.  
  1908. <A NAME="getUIDNext()"><!-- --></A><H3>
  1909. getUIDNext</H3>
  1910. <PRE>
  1911. public long <B>getUIDNext</B>()
  1912.                 throws <A HREF="../../../../javax/mail/MessagingException.html" title="class in javax.mail">MessagingException</A></PRE>
  1913. <DL>
  1914. <DD>Returns the predicted UID that will be assigned to the
  1915.  next message that is appended to this folder.
  1916.  If the folder is closed, the STATUS command is used to
  1917.  retrieve this value.  If the folder is open, the value
  1918.  returned from the SELECT or EXAMINE command is returned.
  1919.  Note that messages may have been appended to the folder
  1920.  while it was open and thus this value may be out of
  1921.  date. <p>
  1922.  
  1923.  Servers implementing RFC2060 likely won't return this value
  1924. when a folder is opened.  Servers implementing RFC3501
  1925. should return this value when a folder is opened. <p>
  1926. <P>
  1927. <DD><DL>
  1928. </DL>
  1929. </DD>
  1930. <DD><DL>
  1931.  
  1932. <DT><B>Returns:</B><DD>the UIDNEXT value, or -1 if unknown
  1933. <DT><B>Throws:</B>
  1934. <DD><CODE><A HREF="../../../../javax/mail/MessagingException.html" title="class in javax.mail">MessagingException</A></CODE><DT><B>Since:</B></DT>
  1935.  <DD>JavaMail 1.3.3</DD>
  1936. </DL>
  1937. </DD>
  1938. </DL>
  1939. <HR>
  1940.  
  1941. <A NAME="getMessageByUID(long)"><!-- --></A><H3>
  1942. getMessageByUID</H3>
  1943. <PRE>
  1944. public <A HREF="../../../../javax/mail/Message.html" title="class in javax.mail">Message</A> <B>getMessageByUID</B>(long&nbsp;uid)
  1945.                        throws <A HREF="../../../../javax/mail/MessagingException.html" title="class in javax.mail">MessagingException</A></PRE>
  1946. <DL>
  1947. <DD>Get the Message corresponding to the given UID.
  1948. If no such message exists, <code> null </code> is returned.
  1949. <P>
  1950. <DD><DL>
  1951. <DT><B>Specified by:</B><DD><CODE><A HREF="../../../../javax/mail/UIDFolder.html#getMessageByUID(long)">getMessageByUID</A></CODE> in interface <CODE><A HREF="../../../../javax/mail/UIDFolder.html" title="interface in javax.mail">UIDFolder</A></CODE></DL>
  1952. </DD>
  1953. <DD><DL>
  1954. <DT><B>Parameters:</B><DD><CODE>uid</CODE> - UID for the desired message
  1955. <DT><B>Returns:</B><DD>the Message object. <code>null</code> is returned
  1956.                        if no message corresponding to this UID is obtained.
  1957. <DT><B>Throws:</B>
  1958. <DD><CODE><A HREF="../../../../javax/mail/MessagingException.html" title="class in javax.mail">MessagingException</A></CODE></DL>
  1959. </DD>
  1960. </DL>
  1961. <HR>
  1962.  
  1963. <A NAME="getMessagesByUID(long, long)"><!-- --></A><H3>
  1964. getMessagesByUID</H3>
  1965. <PRE>
  1966. public <A HREF="../../../../javax/mail/Message.html" title="class in javax.mail">Message</A>[] <B>getMessagesByUID</B>(long&nbsp;start,
  1967.                                  long&nbsp;end)
  1968.                           throws <A HREF="../../../../javax/mail/MessagingException.html" title="class in javax.mail">MessagingException</A></PRE>
  1969. <DL>
  1970. <DD>Get the Messages specified by the given range. <p>
  1971. Returns Message objects for all valid messages in this range.
  1972. Returns an empty array if no messages are found.
  1973. <P>
  1974. <DD><DL>
  1975. <DT><B>Specified by:</B><DD><CODE><A HREF="../../../../javax/mail/UIDFolder.html#getMessagesByUID(long, long)">getMessagesByUID</A></CODE> in interface <CODE><A HREF="../../../../javax/mail/UIDFolder.html" title="interface in javax.mail">UIDFolder</A></CODE></DL>
  1976. </DD>
  1977. <DD><DL>
  1978. <DT><B>Parameters:</B><DD><CODE>start</CODE> - start UID<DD><CODE>end</CODE> - end UID
  1979. <DT><B>Returns:</B><DD>array of Message objects
  1980. <DT><B>Throws:</B>
  1981. <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/UIDFolder.html#LASTUID"><CODE>UIDFolder.LASTUID</CODE></A></DL>
  1982. </DD>
  1983. </DL>
  1984. <HR>
  1985.  
  1986. <A NAME="getMessagesByUID(long[])"><!-- --></A><H3>
  1987. getMessagesByUID</H3>
  1988. <PRE>
  1989. public <A HREF="../../../../javax/mail/Message.html" title="class in javax.mail">Message</A>[] <B>getMessagesByUID</B>(long[]&nbsp;uids)
  1990.                           throws <A HREF="../../../../javax/mail/MessagingException.html" title="class in javax.mail">MessagingException</A></PRE>
  1991. <DL>
  1992. <DD>Get the Messages specified by the given array. <p>
  1993.  
  1994. <code>uids.length()</code> elements are returned.
  1995. If any UID in the array is invalid, a <code>null</code> entry
  1996. is returned for that element.
  1997. <P>
  1998. <DD><DL>
  1999. <DT><B>Specified by:</B><DD><CODE><A HREF="../../../../javax/mail/UIDFolder.html#getMessagesByUID(long[])">getMessagesByUID</A></CODE> in interface <CODE><A HREF="../../../../javax/mail/UIDFolder.html" title="interface in javax.mail">UIDFolder</A></CODE></DL>
  2000. </DD>
  2001. <DD><DL>
  2002. <DT><B>Parameters:</B><DD><CODE>uids</CODE> - array of UIDs
  2003. <DT><B>Returns:</B><DD>array of Message objects
  2004. <DT><B>Throws:</B>
  2005. <DD><CODE><A HREF="../../../../javax/mail/MessagingException.html" title="class in javax.mail">MessagingException</A></CODE></DL>
  2006. </DD>
  2007. </DL>
  2008. <HR>
  2009.  
  2010. <A NAME="getUID(javax.mail.Message)"><!-- --></A><H3>
  2011. getUID</H3>
  2012. <PRE>
  2013. public long <B>getUID</B>(<A HREF="../../../../javax/mail/Message.html" title="class in javax.mail">Message</A>&nbsp;message)
  2014.            throws <A HREF="../../../../javax/mail/MessagingException.html" title="class in javax.mail">MessagingException</A></PRE>
  2015. <DL>
  2016. <DD>Get the UID for the specified message.
  2017. <P>
  2018. <DD><DL>
  2019. <DT><B>Specified by:</B><DD><CODE><A HREF="../../../../javax/mail/UIDFolder.html#getUID(javax.mail.Message)">getUID</A></CODE> in interface <CODE><A HREF="../../../../javax/mail/UIDFolder.html" title="interface in javax.mail">UIDFolder</A></CODE></DL>
  2020. </DD>
  2021. <DD><DL>
  2022. <DT><B>Parameters:</B><DD><CODE>message</CODE> - Message from this folder
  2023. <DT><B>Returns:</B><DD>UID for this message
  2024. <DT><B>Throws:</B>
  2025. <DD><CODE><A HREF="../../../../javax/mail/MessagingException.html" title="class in javax.mail">MessagingException</A></CODE></DL>
  2026. </DD>
  2027. </DL>
  2028. <HR>
  2029.  
  2030. <A NAME="getQuota()"><!-- --></A><H3>
  2031. getQuota</H3>
  2032. <PRE>
  2033. public <A HREF="../../../../javax/mail/Quota.html" title="class in javax.mail">Quota</A>[] <B>getQuota</B>()
  2034.                 throws <A HREF="../../../../javax/mail/MessagingException.html" title="class in javax.mail">MessagingException</A></PRE>
  2035. <DL>
  2036. <DD>Get the quotas for the quotaroot associated with this
  2037. folder.  Note that many folders may have the same quotaroot.
  2038. Quotas are controlled on the basis of a quotaroot, not
  2039. (necessarily) a folder.  The relationship between folders
  2040. and quotaroots depends on the IMAP server.  Some servers
  2041. might implement a single quotaroot for all folders owned by
  2042. a user.  Other servers might implement a separate quotaroot
  2043. for each folder.  A single folder can even have multiple
  2044. quotaroots, perhaps controlling quotas for different
  2045. resources.
  2046. <P>
  2047. <DD><DL>
  2048. </DL>
  2049. </DD>
  2050. <DD><DL>
  2051.  
  2052. <DT><B>Returns:</B><DD>array of Quota objects for the quotaroots associated with
  2053.                this folder
  2054. <DT><B>Throws:</B>
  2055. <DD><CODE><A HREF="../../../../javax/mail/MessagingException.html" title="class in javax.mail">MessagingException</A></CODE> - if the server doesn't support the
  2056.                                         QUOTA extension</DL>
  2057. </DD>
  2058. </DL>
  2059. <HR>
  2060.  
  2061. <A NAME="setQuota(javax.mail.Quota)"><!-- --></A><H3>
  2062. setQuota</H3>
  2063. <PRE>
  2064. public void <B>setQuota</B>(<A HREF="../../../../javax/mail/Quota.html" title="class in javax.mail">Quota</A>&nbsp;quota)
  2065.               throws <A HREF="../../../../javax/mail/MessagingException.html" title="class in javax.mail">MessagingException</A></PRE>
  2066. <DL>
  2067. <DD>Set the quotas for the quotaroot specified in the quota argument.
  2068.  Typically this will be one of the quotaroots associated with this
  2069.  folder, as obtained from the <code>getQuota</code> method, but it
  2070.  need not be.
  2071. <P>
  2072. <DD><DL>
  2073. </DL>
  2074. </DD>
  2075. <DD><DL>
  2076. <DT><B>Parameters:</B><DD><CODE>quota</CODE> - the quota to set
  2077. <DT><B>Throws:</B>
  2078. <DD><CODE><A HREF="../../../../javax/mail/MessagingException.html" title="class in javax.mail">MessagingException</A></CODE> - if the server doesn't support the
  2079.                                        QUOTA extension</DL>
  2080. </DD>
  2081. </DL>
  2082. <HR>
  2083.  
  2084. <A NAME="getACL()"><!-- --></A><H3>
  2085. getACL</H3>
  2086. <PRE>
  2087. public <A HREF="../../../../com/sun/mail/imap/ACL.html" title="class in com.sun.mail.imap">ACL</A>[] <B>getACL</B>()
  2088.             throws <A HREF="../../../../javax/mail/MessagingException.html" title="class in javax.mail">MessagingException</A></PRE>
  2089. <DL>
  2090. <DD>Get the access control list entries for this folder.
  2091. <P>
  2092. <DD><DL>
  2093. </DL>
  2094. </DD>
  2095. <DD><DL>
  2096.  
  2097. <DT><B>Returns:</B><DD>array of access control list entries
  2098. <DT><B>Throws:</B>
  2099. <DD><CODE><A HREF="../../../../javax/mail/MessagingException.html" title="class in javax.mail">MessagingException</A></CODE> - if the server doesn't support the
  2100.                                         ACL extension</DL>
  2101. </DD>
  2102. </DL>
  2103. <HR>
  2104.  
  2105. <A NAME="addACL(com.sun.mail.imap.ACL)"><!-- --></A><H3>
  2106. addACL</H3>
  2107. <PRE>
  2108. public void <B>addACL</B>(<A HREF="../../../../com/sun/mail/imap/ACL.html" title="class in com.sun.mail.imap">ACL</A>&nbsp;acl)
  2109.             throws <A HREF="../../../../javax/mail/MessagingException.html" title="class in javax.mail">MessagingException</A></PRE>
  2110. <DL>
  2111. <DD>Add an access control list entry to the access control list
  2112.  for this folder.
  2113. <P>
  2114. <DD><DL>
  2115. </DL>
  2116. </DD>
  2117. <DD><DL>
  2118. <DT><B>Parameters:</B><DD><CODE>acl</CODE> - the access control list entry to add
  2119. <DT><B>Throws:</B>
  2120. <DD><CODE><A HREF="../../../../javax/mail/MessagingException.html" title="class in javax.mail">MessagingException</A></CODE> - if the server doesn't support the
  2121.                                        ACL extension</DL>
  2122. </DD>
  2123. </DL>
  2124. <HR>
  2125.  
  2126. <A NAME="removeACL(java.lang.String)"><!-- --></A><H3>
  2127. removeACL</H3>
  2128. <PRE>
  2129. public void <B>removeACL</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)
  2130.               throws <A HREF="../../../../javax/mail/MessagingException.html" title="class in javax.mail">MessagingException</A></PRE>
  2131. <DL>
  2132. <DD>Remove any access control list entry for the given identifier
  2133. from the access control list for this folder.
  2134. <P>
  2135. <DD><DL>
  2136. </DL>
  2137. </DD>
  2138. <DD><DL>
  2139. <DT><B>Parameters:</B><DD><CODE>name</CODE> - the identifier for which to remove all ACL entries
  2140. <DT><B>Throws:</B>
  2141. <DD><CODE><A HREF="../../../../javax/mail/MessagingException.html" title="class in javax.mail">MessagingException</A></CODE> - if the server doesn't support the
  2142.                                         ACL extension</DL>
  2143. </DD>
  2144. </DL>
  2145. <HR>
  2146.  
  2147. <A NAME="addRights(com.sun.mail.imap.ACL)"><!-- --></A><H3>
  2148. addRights</H3>
  2149. <PRE>
  2150. public void <B>addRights</B>(<A HREF="../../../../com/sun/mail/imap/ACL.html" title="class in com.sun.mail.imap">ACL</A>&nbsp;acl)
  2151.                throws <A HREF="../../../../javax/mail/MessagingException.html" title="class in javax.mail">MessagingException</A></PRE>
  2152. <DL>
  2153. <DD>Add the rights specified in the ACL to the entry for the
  2154.  identifier specified in the ACL.  If an entry for the identifier
  2155.  doesn't already exist, add one.
  2156. <P>
  2157. <DD><DL>
  2158. </DL>
  2159. </DD>
  2160. <DD><DL>
  2161. <DT><B>Parameters:</B><DD><CODE>acl</CODE> - the identifer and rights to add
  2162. <DT><B>Throws:</B>
  2163. <DD><CODE><A HREF="../../../../javax/mail/MessagingException.html" title="class in javax.mail">MessagingException</A></CODE> - if the server doesn't support the
  2164.                                         ACL extension</DL>
  2165. </DD>
  2166. </DL>
  2167. <HR>
  2168.  
  2169. <A NAME="removeRights(com.sun.mail.imap.ACL)"><!-- --></A><H3>
  2170. removeRights</H3>
  2171. <PRE>
  2172. public void <B>removeRights</B>(<A HREF="../../../../com/sun/mail/imap/ACL.html" title="class in com.sun.mail.imap">ACL</A>&nbsp;acl)
  2173.                   throws <A HREF="../../../../javax/mail/MessagingException.html" title="class in javax.mail">MessagingException</A></PRE>
  2174. <DL>
  2175. <DD>Remove the rights specified in the ACL from the entry for the
  2176.  identifier specified in the ACL.
  2177. <P>
  2178. <DD><DL>
  2179. </DL>
  2180. </DD>
  2181. <DD><DL>
  2182. <DT><B>Parameters:</B><DD><CODE>acl</CODE> - the identifer and rights to remove
  2183. <DT><B>Throws:</B>
  2184. <DD><CODE><A HREF="../../../../javax/mail/MessagingException.html" title="class in javax.mail">MessagingException</A></CODE> - if the server doesn't support the
  2185.                                        ACL extension</DL>
  2186. </DD>
  2187. </DL>
  2188. <HR>
  2189.  
  2190. <A NAME="listRights(java.lang.String)"><!-- --></A><H3>
  2191. listRights</H3>
  2192. <PRE>
  2193. public <A HREF="../../../../com/sun/mail/imap/Rights.html" title="class in com.sun.mail.imap">Rights</A>[] <B>listRights</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)
  2194.                    throws <A HREF="../../../../javax/mail/MessagingException.html" title="class in javax.mail">MessagingException</A></PRE>
  2195. <DL>
  2196. <DD>Get all the rights that may be allowed to the given identifier.
  2197. Rights are grouped per RFC 2086 and each group is returned as an
  2198. element of the array.  The first element of the array is the set
  2199. of rights that are always granted to the identifier.  Later
  2200. elements are rights that may be optionally granted to the
  2201. identifier. <p>
  2202.  
  2203. Note that this method lists the rights that it is possible to
  2204. assign to the given identifier, <em>not</em> the rights that are
  2205. actually granted to the given identifier.  For the latter, see
  2206. the <code>getACL</code> method.
  2207. <P>
  2208. <DD><DL>
  2209. </DL>
  2210. </DD>
  2211. <DD><DL>
  2212. <DT><B>Parameters:</B><DD><CODE>name</CODE> - the identifier to list rights for
  2213. <DT><B>Returns:</B><DD>array of Rights objects representing possible
  2214.                        rights for the identifier
  2215. <DT><B>Throws:</B>
  2216. <DD><CODE><A HREF="../../../../javax/mail/MessagingException.html" title="class in javax.mail">MessagingException</A></CODE> - if the server doesn't support the
  2217.                                         ACL extension</DL>
  2218. </DD>
  2219. </DL>
  2220. <HR>
  2221.  
  2222. <A NAME="myRights()"><!-- --></A><H3>
  2223. myRights</H3>
  2224. <PRE>
  2225. public <A HREF="../../../../com/sun/mail/imap/Rights.html" title="class in com.sun.mail.imap">Rights</A> <B>myRights</B>()
  2226.                 throws <A HREF="../../../../javax/mail/MessagingException.html" title="class in javax.mail">MessagingException</A></PRE>
  2227. <DL>
  2228. <DD>Get the rights allowed to the currently authenticated user.
  2229. <P>
  2230. <DD><DL>
  2231. </DL>
  2232. </DD>
  2233. <DD><DL>
  2234.  
  2235. <DT><B>Returns:</B><DD>the rights granted to the current user
  2236. <DT><B>Throws:</B>
  2237. <DD><CODE><A HREF="../../../../javax/mail/MessagingException.html" title="class in javax.mail">MessagingException</A></CODE> - if the server doesn't support the
  2238.                                        ACL extension</DL>
  2239. </DD>
  2240. </DL>
  2241. <HR>
  2242.  
  2243. <A NAME="getAttributes()"><!-- --></A><H3>
  2244. getAttributes</H3>
  2245. <PRE>
  2246. 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>getAttributes</B>()
  2247.                       throws <A HREF="../../../../javax/mail/MessagingException.html" title="class in javax.mail">MessagingException</A></PRE>
  2248. <DL>
  2249. <DD>Get the attributes that the IMAP server returns with the
  2250. LIST response.
  2251. <P>
  2252. <DD><DL>
  2253. </DL>
  2254. </DD>
  2255. <DD><DL>
  2256.  
  2257. <DT><B>Throws:</B>
  2258. <DD><CODE><A HREF="../../../../javax/mail/MessagingException.html" title="class in javax.mail">MessagingException</A></CODE><DT><B>Since:</B></DT>
  2259.  <DD>JavaMail 1.3.3</DD>
  2260. </DL>
  2261. </DD>
  2262. </DL>
  2263. <HR>
  2264.  
  2265. <A NAME="idle()"><!-- --></A><H3>
  2266. idle</H3>
  2267. <PRE>
  2268. public void <B>idle</B>()
  2269.          throws <A HREF="../../../../javax/mail/MessagingException.html" title="class in javax.mail">MessagingException</A></PRE>
  2270. <DL>
  2271. <DD>Use the IMAP IDLE command (see
  2272. <A HREF="http://www.ietf.org/rfc/rfc2177.txt">RFC 2177</A>),
  2273. if supported by the server, to enter idle mode so that the server
  2274. can send unsolicited notifications of new messages arriving, etc.
  2275. without the need for the client to constantly poll the server.
  2276. Use an appropriate listener to be notified of new messages or
  2277. other events.  When another thread (e.g., the listener thread)
  2278. needs to issue an IMAP comand for this folder, the idle mode will
  2279. be terminated and this method will return.  Typically the caller
  2280. will invoke this method in a loop. <p>
  2281.  
  2282. The mail.imap.minidletime property enforces a minimum delay
  2283. before returning from this method, to ensure that other threads
  2284. have a chance to issue commands before the caller invokes this
  2285. method again.  The default delay is 10 milliseconds.
  2286. <P>
  2287. <DD><DL>
  2288. </DL>
  2289. </DD>
  2290. <DD><DL>
  2291.  
  2292. <DT><B>Throws:</B>
  2293. <DD><CODE><A HREF="../../../../javax/mail/MessagingException.html" title="class in javax.mail">MessagingException</A></CODE> - if the server doesn't support the
  2294.                                         IDLE extension
  2295. <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<DT><B>Since:</B></DT>
  2296.  <DD>JavaMail 1.4.1</DD>
  2297. </DL>
  2298. </DD>
  2299. </DL>
  2300. <HR>
  2301.  
  2302. <A NAME="idle(boolean)"><!-- --></A><H3>
  2303. idle</H3>
  2304. <PRE>
  2305. public void <B>idle</B>(boolean&nbsp;once)
  2306.          throws <A HREF="../../../../javax/mail/MessagingException.html" title="class in javax.mail">MessagingException</A></PRE>
  2307. <DL>
  2308. <DD>Like <A HREF="../../../../com/sun/mail/imap/IMAPFolder.html#idle()"><CODE>idle()</CODE></A>, but if <code>once</code> is true, abort the
  2309. IDLE command after the first notification, to allow the caller
  2310. to process any notification synchronously.
  2311. <P>
  2312. <DD><DL>
  2313. </DL>
  2314. </DD>
  2315. <DD><DL>
  2316.  
  2317. <DT><B>Throws:</B>
  2318. <DD><CODE><A HREF="../../../../javax/mail/MessagingException.html" title="class in javax.mail">MessagingException</A></CODE> - if the server doesn't support the
  2319.                                         IDLE extension
  2320. <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<DT><B>Since:</B></DT>
  2321.  <DD>JavaMail 1.4.3</DD>
  2322. </DL>
  2323. </DD>
  2324. </DL>
  2325. <HR>
  2326.  
  2327. <A NAME="handleResponse(com.sun.mail.iap.Response)"><!-- --></A><H3>
  2328. handleResponse</H3>
  2329. <PRE>
  2330. public void <B>handleResponse</B>(com.sun.mail.iap.Response&nbsp;r)</PRE>
  2331. <DL>
  2332. <DD>The response handler. This is the callback routine that is
  2333. invoked by the protocol layer.
  2334. <P>
  2335. <DD><DL>
  2336. <DT><B>Specified by:</B><DD><CODE>handleResponse</CODE> in interface <CODE>com.sun.mail.iap.ResponseHandler</CODE></DL>
  2337. </DD>
  2338. <DD><DL>
  2339. </DL>
  2340. </DD>
  2341. </DL>
  2342. <HR>
  2343.  
  2344. <A NAME="getStoreProtocol()"><!-- --></A><H3>
  2345. getStoreProtocol</H3>
  2346. <PRE>
  2347. protected com.sun.mail.imap.protocol.IMAPProtocol <B>getStoreProtocol</B>()
  2348.                                                            throws com.sun.mail.iap.ProtocolException</PRE>
  2349. <DL>
  2350. <DD>Get this folder's Store's protocol connection.
  2351.  
  2352. When acquiring a store protocol object, it is important to
  2353. use the following steps:
  2354.  
  2355.     IMAPProtocol p = null;
  2356.     try {
  2357.         p = getStoreProtocol();
  2358.         // perform the command
  2359.     } catch (WhateverException ex) {
  2360.         // handle it
  2361.     } finally {
  2362.         releaseStoreProtocol(p);
  2363.     }
  2364. <P>
  2365. <DD><DL>
  2366. </DL>
  2367. </DD>
  2368. <DD><DL>
  2369.  
  2370. <DT><B>Throws:</B>
  2371. <DD><CODE>com.sun.mail.iap.ProtocolException</CODE></DL>
  2372. </DD>
  2373. </DL>
  2374. <HR>
  2375.  
  2376. <A NAME="doCommand(com.sun.mail.imap.IMAPFolder.ProtocolCommand)"><!-- --></A><H3>
  2377. doCommand</H3>
  2378. <PRE>
  2379. public <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>doCommand</B>(<A HREF="../../../../com/sun/mail/imap/IMAPFolder.ProtocolCommand.html" title="interface in com.sun.mail.imap">IMAPFolder.ProtocolCommand</A>&nbsp;cmd)
  2380.                 throws <A HREF="../../../../javax/mail/MessagingException.html" title="class in javax.mail">MessagingException</A></PRE>
  2381. <DL>
  2382. <DD>Execute a user-supplied IMAP command.  The command is executed
  2383. in the appropriate context with the necessary locks held and
  2384. using the appropriate <code>IMAPProtocol</code> object. <p>
  2385.  
  2386. This method returns whatever the <code>ProtocolCommand</code>
  2387. object's <code>doCommand</code> method returns.  If the
  2388.  <code>doCommand</code> method throws a <code>ConnectionException</code>
  2389.  it is translated into a <code>StoreClosedException</code> or
  2390.  <code>FolderClosedException</code> as appropriate.  If the
  2391.  <code>doCommand</code> method throws a <code>ProtocolException</code>
  2392.  it is translated into a <code>MessagingException</code>. <p>
  2393.  
  2394.  The following example shows how to execute the IMAP NOOP command.
  2395.  Executing more complex IMAP commands requires intimate knowledge
  2396.  of the <code>com.sun.mail.iap</code> and
  2397.  <code>com.sun.mail.imap.protocol</code> packages, best acquired by
  2398.  reading the source code. <p>
  2399.  
  2400.  <blockquote><pre>
  2401.  import com.sun.mail.iap.*;
  2402.  import com.sun.mail.imap.*;
  2403.  import com.sun.mail.imap.protocol.*;
  2404.  
  2405.  ...
  2406.  
  2407.  IMAPFolder f = (IMAPFolder)folder;
  2408.  Object val = f.doCommand(new IMAPFolder.ProtocolCommand() {
  2409.         public Object doCommand(IMAPProtocol p)
  2410.                         throws ProtocolException {
  2411.             p.simpleCommand("NOOP", null);
  2412.             return null;
  2413.         }
  2414.  });
  2415.  </pre></blockquote>
  2416.  <p>
  2417.  
  2418.  Here's a more complex example showing how to use the proposed
  2419. IMAP SORT extension: <p>
  2420.  
  2421. <pre><blockquote>
  2422. import com.sun.mail.iap.*;
  2423. import com.sun.mail.imap.*;
  2424. import com.sun.mail.imap.protocol.*;
  2425.  
  2426. ...
  2427.  
  2428. IMAPFolder f = (IMAPFolder)folder;
  2429. Object val = f.doCommand(new IMAPFolder.ProtocolCommand() {
  2430.        public Object doCommand(IMAPProtocol p)
  2431.                        throws ProtocolException {
  2432.            // Issue command
  2433.            Argument args = new Argument();
  2434.            Argument list = new Argument();
  2435.            list.writeString("SUBJECT");
  2436.            args.writeArgument(list);
  2437.            args.writeString("UTF-8");
  2438.            args.writeString("ALL");
  2439.            Response[] r = p.command("SORT", args);
  2440.            Response response = r[r.length-1];
  2441.  
  2442.            // Grab response
  2443.            Vector v = new Vector();
  2444.            if (response.isOK()) { // command succesful
  2445.                for (int i = 0, len = r.length; i < len; i++) {
  2446.                    if (!(r[i] instanceof IMAPResponse))
  2447.                        continue;
  2448.  
  2449.                    IMAPResponse ir = (IMAPResponse)r[i];
  2450.                    if (ir.keyEquals("SORT")) {
  2451.                        String num;
  2452.                        while ((num = ir.readAtomString()) != null)
  2453.                            System.out.println(num);
  2454.                        r[i] = null;
  2455.                    }
  2456.                }
  2457.            }
  2458.  
  2459.            // dispatch remaining untagged responses
  2460.            p.notifyResponseHandlers(r);
  2461.            p.handleResult(response);
  2462.  
  2463.            return null;
  2464.        }
  2465. });
  2466. </pre></blockquote>
  2467. <P>
  2468. <DD><DL>
  2469. </DL>
  2470. </DD>
  2471. <DD><DL>
  2472.  
  2473. <DT><B>Throws:</B>
  2474. <DD><CODE><A HREF="../../../../javax/mail/MessagingException.html" title="class in javax.mail">MessagingException</A></CODE></DL>
  2475. </DD>
  2476. </DL>
  2477. <HR>
  2478.  
  2479. <A NAME="doOptionalCommand(java.lang.String, com.sun.mail.imap.IMAPFolder.ProtocolCommand)"><!-- --></A><H3>
  2480. doOptionalCommand</H3>
  2481. <PRE>
  2482. public <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>doOptionalCommand</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;err,
  2483.                                <A HREF="../../../../com/sun/mail/imap/IMAPFolder.ProtocolCommand.html" title="interface in com.sun.mail.imap">IMAPFolder.ProtocolCommand</A>&nbsp;cmd)
  2484.                         throws <A HREF="../../../../javax/mail/MessagingException.html" title="class in javax.mail">MessagingException</A></PRE>
  2485. <DL>
  2486. <DD><DL>
  2487. </DL>
  2488. </DD>
  2489. <DD><DL>
  2490.  
  2491. <DT><B>Throws:</B>
  2492. <DD><CODE><A HREF="../../../../javax/mail/MessagingException.html" title="class in javax.mail">MessagingException</A></CODE></DL>
  2493. </DD>
  2494. </DL>
  2495. <HR>
  2496.  
  2497. <A NAME="doCommandIgnoreFailure(com.sun.mail.imap.IMAPFolder.ProtocolCommand)"><!-- --></A><H3>
  2498. doCommandIgnoreFailure</H3>
  2499. <PRE>
  2500. public <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>doCommandIgnoreFailure</B>(<A HREF="../../../../com/sun/mail/imap/IMAPFolder.ProtocolCommand.html" title="interface in com.sun.mail.imap">IMAPFolder.ProtocolCommand</A>&nbsp;cmd)
  2501.                              throws <A HREF="../../../../javax/mail/MessagingException.html" title="class in javax.mail">MessagingException</A></PRE>
  2502. <DL>
  2503. <DD><DL>
  2504. </DL>
  2505. </DD>
  2506. <DD><DL>
  2507.  
  2508. <DT><B>Throws:</B>
  2509. <DD><CODE><A HREF="../../../../javax/mail/MessagingException.html" title="class in javax.mail">MessagingException</A></CODE></DL>
  2510. </DD>
  2511. </DL>
  2512. <HR>
  2513.  
  2514. <A NAME="doProtocolCommand(com.sun.mail.imap.IMAPFolder.ProtocolCommand)"><!-- --></A><H3>
  2515. doProtocolCommand</H3>
  2516. <PRE>
  2517. protected <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>doProtocolCommand</B>(<A HREF="../../../../com/sun/mail/imap/IMAPFolder.ProtocolCommand.html" title="interface in com.sun.mail.imap">IMAPFolder.ProtocolCommand</A>&nbsp;cmd)
  2518.                            throws com.sun.mail.iap.ProtocolException</PRE>
  2519. <DL>
  2520. <DD><DL>
  2521. </DL>
  2522. </DD>
  2523. <DD><DL>
  2524.  
  2525. <DT><B>Throws:</B>
  2526. <DD><CODE>com.sun.mail.iap.ProtocolException</CODE></DL>
  2527. </DD>
  2528. </DL>
  2529. <HR>
  2530.  
  2531. <A NAME="releaseStoreProtocol(com.sun.mail.imap.protocol.IMAPProtocol)"><!-- --></A><H3>
  2532. releaseStoreProtocol</H3>
  2533. <PRE>
  2534. protected void <B>releaseStoreProtocol</B>(com.sun.mail.imap.protocol.IMAPProtocol&nbsp;p)</PRE>
  2535. <DL>
  2536. <DD>Release the store protocol object.  If we borrowed a protocol
  2537. object from the connection pool, give it back.  If we used our
  2538. own protocol object, nothing to do.
  2539. <P>
  2540. <DD><DL>
  2541. </DL>
  2542. </DD>
  2543. <DD><DL>
  2544. </DL>
  2545. </DD>
  2546. </DL>
  2547. <!-- ========= END OF CLASS DATA ========= -->
  2548. <HR>
  2549.  
  2550.  
  2551. <!-- ======= START OF BOTTOM NAVBAR ====== -->
  2552. <A NAME="navbar_bottom"><!-- --></A>
  2553. <A HREF="#skip-navbar_bottom" title="Skip navigation links"></A>
  2554. <TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">
  2555. <TR>
  2556. <TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
  2557. <A NAME="navbar_bottom_firstrow"><!-- --></A>
  2558. <TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">
  2559.  <TR ALIGN="center" VALIGN="top">
  2560.  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A>&nbsp;</TD>
  2561.  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A>&nbsp;</TD>
  2562.  <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> &nbsp;<FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT>&nbsp;</TD>
  2563.  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="class-use/IMAPFolder.html"><FONT CLASS="NavBarFont1"><B>Use</B></FONT></A>&nbsp;</TD>
  2564.  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A>&nbsp;</TD>
  2565.  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A>&nbsp;</TD>
  2566.  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../index-files/index-1.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A>&nbsp;</TD>
  2567.  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A>&nbsp;</TD>
  2568.  </TR>
  2569. </TABLE>
  2570. </TD>
  2571. <TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
  2572. </EM>
  2573. </TD>
  2574. </TR>
  2575.  
  2576. <TR>
  2577. <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
  2578. &nbsp;<A HREF="../../../../com/sun/mail/imap/ACL.html" title="class in com.sun.mail.imap"><B>PREV CLASS</B></A>&nbsp;
  2579. &nbsp;<A HREF="../../../../com/sun/mail/imap/IMAPFolder.FetchProfileItem.html" title="class in com.sun.mail.imap"><B>NEXT CLASS</B></A></FONT></TD>
  2580. <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
  2581.  <A HREF="../../../../index.html?com/sun/mail/imap/IMAPFolder.html" target="_top"><B>FRAMES</B></A>  &nbsp;
  2582. &nbsp;<A HREF="IMAPFolder.html" target="_top"><B>NO FRAMES</B></A>  &nbsp;
  2583. &nbsp;<SCRIPT type="text/javascript">
  2584.  <!--
  2585.  if(window==top) {
  2586.    document.writeln('<A HREF="../../../../allclasses-noframe.html"><B>All Classes</B></A>');
  2587.  }
  2588.  //-->
  2589. </SCRIPT>
  2590. <NOSCRIPT>
  2591.  <A HREF="../../../../allclasses-noframe.html"><B>All Classes</B></A>
  2592. </NOSCRIPT>
  2593.  
  2594.  
  2595. </FONT></TD>
  2596. </TR>
  2597. <TR>
  2598. <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
  2599.  SUMMARY:&nbsp;<A HREF="#nested_class_summary">NESTED</A>&nbsp;|&nbsp;<A HREF="#field_summary">FIELD</A>&nbsp;|&nbsp;<A HREF="#constructor_summary">CONSTR</A>&nbsp;|&nbsp;<A HREF="#method_summary">METHOD</A></FONT></TD>
  2600. <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
  2601. DETAIL:&nbsp;<A HREF="#field_detail">FIELD</A>&nbsp;|&nbsp;<A HREF="#constructor_detail">CONSTR</A>&nbsp;|&nbsp;<A HREF="#method_detail">METHOD</A></FONT></TD>
  2602. </TR>
  2603. </TABLE>
  2604. <A NAME="skip-navbar_bottom"></A>
  2605. <!-- ======== END OF BOTTOM NAVBAR ======= -->
  2606.  
  2607. <HR>
  2608. Copyright &#169; 2009 <a href="http://www.sun.com">Sun Microsystems, Inc.</a>. All Rights Reserved.
  2609. </BODY>
  2610. </HTML>
  2611.