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:38 PST 2009 -->
  6. <META http-equiv="Content-Type" content="text/html; charset=ISO-8859-1">
  7. <TITLE>
  8. QuotaAwareStore (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="QuotaAwareStore (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/QuotaAwareStore.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="../../javax/mail/Quota.Resource.html" title="class in javax.mail"><B>PREV CLASS</B></A>&nbsp;
  60. &nbsp;<A HREF="../../javax/mail/ReadOnlyFolderException.html" title="class in javax.mail"><B>NEXT CLASS</B></A></FONT></TD>
  61. <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
  62.   <A HREF="../../index.html?javax/mail/QuotaAwareStore.html" target="_top"><B>FRAMES</B></A>  &nbsp;
  63. &nbsp;<A HREF="QuotaAwareStore.html" target="_top"><B>NO FRAMES</B></A>  &nbsp;
  64. &nbsp;<SCRIPT type="text/javascript">
  65.   <!--
  66.   if(window==top) {
  67.     document.writeln('<A HREF="../../allclasses-noframe.html"><B>All Classes</B></A>');
  68.   }
  69.   //-->
  70. </SCRIPT>
  71. <NOSCRIPT>
  72.   <A HREF="../../allclasses-noframe.html"><B>All Classes</B></A>
  73. </NOSCRIPT>
  74.  
  75.  
  76. </FONT></TD>
  77. </TR>
  78. <TR>
  79. <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
  80.   SUMMARY:&nbsp;NESTED&nbsp;|&nbsp;FIELD&nbsp;|&nbsp;CONSTR&nbsp;|&nbsp;<A HREF="#method_summary">METHOD</A></FONT></TD>
  81. <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
  82. DETAIL:&nbsp;FIELD&nbsp;|&nbsp;CONSTR&nbsp;|&nbsp;<A HREF="#method_detail">METHOD</A></FONT></TD>
  83. </TR>
  84. </TABLE>
  85. <A NAME="skip-navbar_top"></A>
  86. <!-- ========= END OF TOP NAVBAR ========= -->
  87.  
  88. <HR>
  89. <!-- ======== START OF CLASS DATA ======== -->
  90. <H2>
  91. <FONT SIZE="-1">
  92. javax.mail</FONT>
  93. <BR>
  94. Interface QuotaAwareStore</H2>
  95. <DL>
  96. <DT><B>All Known Implementing Classes:</B> <DD><A HREF="../../com/sun/mail/imap/IMAPSSLStore.html" title="class in com.sun.mail.imap">IMAPSSLStore</A>, <A HREF="../../com/sun/mail/imap/IMAPStore.html" title="class in com.sun.mail.imap">IMAPStore</A></DD>
  97. </DL>
  98. <HR>
  99. <DL>
  100. <DT><PRE>public interface <B>QuotaAwareStore</B></DL>
  101. </PRE>
  102.  
  103. <P>
  104. An interface implemented by Stores that support quotas.
  105.  The <A HREF="../../javax/mail/QuotaAwareStore.html#getQuota(java.lang.String)"><CODE>getQuota</CODE></A> and <A HREF="../../javax/mail/QuotaAwareStore.html#setQuota(javax.mail.Quota)"><CODE>setQuota</CODE></A> methods
  106.  support the quota model defined by the IMAP QUOTA extension.
  107.  Refer to <A HREF="http://www.ietf.org/rfc/rfc2087.txt">RFC 2087</A>
  108.  for more information. <p>
  109. <P>
  110.  
  111. <P>
  112. <DL>
  113. <DT><B>Since:</B></DT>
  114.   <DD>JavaMail 1.4</DD>
  115. </DL>
  116. <HR>
  117.  
  118. <P>
  119.  
  120. <!-- ========== METHOD SUMMARY =========== -->
  121.  
  122. <A NAME="method_summary"><!-- --></A>
  123. <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
  124. <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
  125. <TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2">
  126. <B>Method Summary</B></FONT></TH>
  127. </TR>
  128. <TR BGCOLOR="white" CLASS="TableRowColor">
  129. <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
  130. <CODE>&nbsp;<A HREF="../../javax/mail/Quota.html" title="class in javax.mail">Quota</A>[]</CODE></FONT></TD>
  131. <TD><CODE><B><A HREF="../../javax/mail/QuotaAwareStore.html#getQuota(java.lang.String)">getQuota</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;folder)</CODE>
  132.  
  133. <BR>
  134. &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Get the quotas for the named folder.</TD>
  135. </TR>
  136. <TR BGCOLOR="white" CLASS="TableRowColor">
  137. <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
  138. <CODE>&nbsp;void</CODE></FONT></TD>
  139. <TD><CODE><B><A HREF="../../javax/mail/QuotaAwareStore.html#setQuota(javax.mail.Quota)">setQuota</A></B>(<A HREF="../../javax/mail/Quota.html" title="class in javax.mail">Quota</A>&nbsp;quota)</CODE>
  140.  
  141. <BR>
  142. &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Set the quotas for the quota root specified in the quota argument.</TD>
  143. </TR>
  144. </TABLE>
  145. &nbsp;
  146. <P>
  147.  
  148. <!-- ============ METHOD DETAIL ========== -->
  149.  
  150. <A NAME="method_detail"><!-- --></A>
  151. <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
  152. <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
  153. <TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2">
  154. <B>Method Detail</B></FONT></TH>
  155. </TR>
  156. </TABLE>
  157.  
  158. <A NAME="getQuota(java.lang.String)"><!-- --></A><H3>
  159. getQuota</H3>
  160. <PRE>
  161. <A HREF="../../javax/mail/Quota.html" title="class in javax.mail">Quota</A>[] <B>getQuota</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;folder)
  162.                  throws <A HREF="../../javax/mail/MessagingException.html" title="class in javax.mail">MessagingException</A></PRE>
  163. <DL>
  164. <DD>Get the quotas for the named folder.
  165.  Quotas are controlled on the basis of a quota root, not
  166.  (necessarily) a folder.  The relationship between folders
  167.  and quota roots depends on the server.  Some servers
  168.  might implement a single quota root for all folders owned by
  169.  a user.  Other servers might implement a separate quota root
  170.  for each folder.  A single folder can even have multiple
  171.  quota roots, perhaps controlling quotas for different
  172.  resources.
  173. <P>
  174. <DD><DL>
  175. <DT><B>Parameters:</B><DD><CODE>folder</CODE> - the name of the folder
  176. <DT><B>Returns:</B><DD>array of Quota objects
  177. <DT><B>Throws:</B>
  178. <DD><CODE><A HREF="../../javax/mail/MessagingException.html" title="class in javax.mail">MessagingException</A></CODE> - if the server doesn't support the
  179.                                        QUOTA extension</DL>
  180. </DD>
  181. </DL>
  182. <HR>
  183.  
  184. <A NAME="setQuota(javax.mail.Quota)"><!-- --></A><H3>
  185. setQuota</H3>
  186. <PRE>
  187. void <B>setQuota</B>(<A HREF="../../javax/mail/Quota.html" title="class in javax.mail">Quota</A>&nbsp;quota)
  188.              throws <A HREF="../../javax/mail/MessagingException.html" title="class in javax.mail">MessagingException</A></PRE>
  189. <DL>
  190. <DD>Set the quotas for the quota root specified in the quota argument.
  191. Typically this will be one of the quota roots obtained from the
  192. <code>getQuota</code> method, but it need not be.
  193. <P>
  194. <DD><DL>
  195. <DT><B>Parameters:</B><DD><CODE>quota</CODE> - the quota to set
  196. <DT><B>Throws:</B>
  197. <DD><CODE><A HREF="../../javax/mail/MessagingException.html" title="class in javax.mail">MessagingException</A></CODE> - if the server doesn't support the
  198.                                         QUOTA extension</DL>
  199. </DD>
  200. </DL>
  201. <!-- ========= END OF CLASS DATA ========= -->
  202. <HR>
  203.  
  204.  
  205. <!-- ======= START OF BOTTOM NAVBAR ====== -->
  206. <A NAME="navbar_bottom"><!-- --></A>
  207. <A HREF="#skip-navbar_bottom" title="Skip navigation links"></A>
  208. <TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">
  209. <TR>
  210. <TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
  211. <A NAME="navbar_bottom_firstrow"><!-- --></A>
  212. <TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">
  213.   <TR ALIGN="center" VALIGN="top">
  214.   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A>&nbsp;</TD>
  215.   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A>&nbsp;</TD>
  216.   <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> &nbsp;<FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT>&nbsp;</TD>
  217.   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="class-use/QuotaAwareStore.html"><FONT CLASS="NavBarFont1"><B>Use</B></FONT></A>&nbsp;</TD>
  218.   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A>&nbsp;</TD>
  219.   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A>&nbsp;</TD>
  220.   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../index-files/index-1.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A>&nbsp;</TD>
  221.   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A>&nbsp;</TD>
  222.   </TR>
  223. </TABLE>
  224. </TD>
  225. <TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
  226. </EM>
  227. </TD>
  228. </TR>
  229.  
  230. <TR>
  231. <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
  232. &nbsp;<A HREF="../../javax/mail/Quota.Resource.html" title="class in javax.mail"><B>PREV CLASS</B></A>&nbsp;
  233. &nbsp;<A HREF="../../javax/mail/ReadOnlyFolderException.html" title="class in javax.mail"><B>NEXT CLASS</B></A></FONT></TD>
  234. <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
  235.   <A HREF="../../index.html?javax/mail/QuotaAwareStore.html" target="_top"><B>FRAMES</B></A>  &nbsp;
  236. &nbsp;<A HREF="QuotaAwareStore.html" target="_top"><B>NO FRAMES</B></A>  &nbsp;
  237. &nbsp;<SCRIPT type="text/javascript">
  238.   <!--
  239.   if(window==top) {
  240.     document.writeln('<A HREF="../../allclasses-noframe.html"><B>All Classes</B></A>');
  241.   }
  242.   //-->
  243. </SCRIPT>
  244. <NOSCRIPT>
  245.   <A HREF="../../allclasses-noframe.html"><B>All Classes</B></A>
  246. </NOSCRIPT>
  247.  
  248.  
  249. </FONT></TD>
  250. </TR>
  251. <TR>
  252. <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
  253.   SUMMARY:&nbsp;NESTED&nbsp;|&nbsp;FIELD&nbsp;|&nbsp;CONSTR&nbsp;|&nbsp;<A HREF="#method_summary">METHOD</A></FONT></TD>
  254. <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
  255. DETAIL:&nbsp;FIELD&nbsp;|&nbsp;CONSTR&nbsp;|&nbsp;<A HREF="#method_detail">METHOD</A></FONT></TD>
  256. </TR>
  257. </TABLE>
  258. <A NAME="skip-navbar_bottom"></A>
  259. <!-- ======== END OF BOTTOM NAVBAR ======= -->
  260.  
  261. <HR>
  262. Copyright &#169; 2009 <a href="http://www.sun.com">Sun Microsystems, Inc.</a>. All Rights Reserved.
  263. </BODY>
  264. </HTML>
  265.