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. UIDFolder.FetchProfileItem (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="UIDFolder.FetchProfileItem (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/UIDFolder.FetchProfileItem.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/UIDFolder.html" title="interface in javax.mail"><B>PREV CLASS</B></A>&nbsp;
  60. &nbsp;<A HREF="../../javax/mail/URLName.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/UIDFolder.FetchProfileItem.html" target="_top"><B>FRAMES</B></A>  &nbsp;
  63. &nbsp;<A HREF="UIDFolder.FetchProfileItem.html" target="_top"><B>NO FRAMES</B></A>  &nbsp;
  64. &nbsp;<SCRIPT type="text/javascript">
  65.   <!--
  66.   if(window==top) {
  67.     document.writeln('<A HREF="../../allclasses-noframe.html"><B>All Classes</B></A>');
  68.   }
  69.   //-->
  70. </SCRIPT>
  71. <NOSCRIPT>
  72.   <A HREF="../../allclasses-noframe.html"><B>All Classes</B></A>
  73. </NOSCRIPT>
  74.  
  75.  
  76. </FONT></TD>
  77. </TR>
  78. <TR>
  79. <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
  80.   SUMMARY:&nbsp;NESTED&nbsp;|&nbsp;<A HREF="#field_summary">FIELD</A>&nbsp;|&nbsp;<A HREF="#constructor_summary">CONSTR</A>&nbsp;|&nbsp;<A HREF="#methods_inherited_from_class_javax.mail.FetchProfile.Item">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;METHOD</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. Class UIDFolder.FetchProfileItem</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/FetchProfile.Item.html" title="class in javax.mail">javax.mail.FetchProfile.Item</A>
  98.       <IMG SRC="../../resources/inherit.gif" ALT="extended by "><B>javax.mail.UIDFolder.FetchProfileItem</B>
  99. </PRE>
  100. <DL>
  101. <DT><B>Enclosing interface:</B><DD><A HREF="../../javax/mail/UIDFolder.html" title="interface in javax.mail">UIDFolder</A></DD>
  102. </DL>
  103. <HR>
  104. <DL>
  105. <DT><PRE>public static class <B>UIDFolder.FetchProfileItem</B><DT>extends <A HREF="../../javax/mail/FetchProfile.Item.html" title="class in javax.mail">FetchProfile.Item</A></DL>
  106. </PRE>
  107.  
  108. <P>
  109. A fetch profile item for fetching UIDs.
  110.  This inner class extends the <code>FetchProfile.Item</code>
  111.  class to add new FetchProfile item types, specific to UIDFolders.
  112.  The only item currently defined here is the <code>UID</code> item.
  113. <P>
  114.  
  115. <P>
  116. <DL>
  117. <DT><B>See Also:</B><DD><A HREF="../../javax/mail/FetchProfile.html" title="class in javax.mail"><CODE>FetchProfile</CODE></A></DL>
  118. <HR>
  119.  
  120. <P>
  121. <!-- =========== FIELD SUMMARY =========== -->
  122.  
  123. <A NAME="field_summary"><!-- --></A>
  124. <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
  125. <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
  126. <TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2">
  127. <B>Field Summary</B></FONT></TH>
  128. </TR>
  129. <TR BGCOLOR="white" CLASS="TableRowColor">
  130. <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
  131. <CODE>static&nbsp;<A HREF="../../javax/mail/UIDFolder.FetchProfileItem.html" title="class in javax.mail">UIDFolder.FetchProfileItem</A></CODE></FONT></TD>
  132. <TD><CODE><B><A HREF="../../javax/mail/UIDFolder.FetchProfileItem.html#UID">UID</A></B></CODE>
  133.  
  134. <BR>
  135. &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;UID is a fetch profile item that can be included in a
  136.  <code>FetchProfile</code> during a fetch request to a Folder.</TD>
  137. </TR>
  138. </TABLE>
  139. &nbsp;<A NAME="fields_inherited_from_class_javax.mail.FetchProfile.Item"><!-- --></A>
  140. <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
  141. <TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
  142. <TH ALIGN="left"><B>Fields inherited from class javax.mail.<A HREF="../../javax/mail/FetchProfile.Item.html" title="class in javax.mail">FetchProfile.Item</A></B></TH>
  143. </TR>
  144. <TR BGCOLOR="white" CLASS="TableRowColor">
  145. <TD><CODE><A HREF="../../javax/mail/FetchProfile.Item.html#CONTENT_INFO">CONTENT_INFO</A>, <A HREF="../../javax/mail/FetchProfile.Item.html#ENVELOPE">ENVELOPE</A>, <A HREF="../../javax/mail/FetchProfile.Item.html#FLAGS">FLAGS</A></CODE></TD>
  146. </TR>
  147. </TABLE>
  148. &nbsp;
  149. <!-- ======== CONSTRUCTOR SUMMARY ======== -->
  150.  
  151. <A NAME="constructor_summary"><!-- --></A>
  152. <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
  153. <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
  154. <TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2">
  155. <B>Constructor Summary</B></FONT></TH>
  156. </TR>
  157. <TR BGCOLOR="white" CLASS="TableRowColor">
  158. <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
  159. <CODE>protected </CODE></FONT></TD>
  160. <TD><CODE><B><A HREF="../../javax/mail/UIDFolder.FetchProfileItem.html#UIDFolder.FetchProfileItem(java.lang.String)">UIDFolder.FetchProfileItem</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>
  161.  
  162. <BR>
  163. &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD>
  164. </TR>
  165. </TABLE>
  166. &nbsp;
  167. <!-- ========== METHOD SUMMARY =========== -->
  168.  
  169. <A NAME="method_summary"><!-- --></A>
  170. <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
  171. <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
  172. <TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2">
  173. <B>Method Summary</B></FONT></TH>
  174. </TR>
  175. </TABLE>
  176. &nbsp;<A NAME="methods_inherited_from_class_javax.mail.FetchProfile.Item"><!-- --></A>
  177. <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
  178. <TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
  179. <TH ALIGN="left"><B>Methods inherited from class javax.mail.<A HREF="../../javax/mail/FetchProfile.Item.html" title="class in javax.mail">FetchProfile.Item</A></B></TH>
  180. </TR>
  181. <TR BGCOLOR="white" CLASS="TableRowColor">
  182. <TD><CODE><A HREF="../../javax/mail/FetchProfile.Item.html#toString()">toString</A></CODE></TD>
  183. </TR>
  184. </TABLE>
  185. &nbsp;<A NAME="methods_inherited_from_class_java.lang.Object"><!-- --></A>
  186. <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
  187. <TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
  188. <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>
  189. </TR>
  190. <TR BGCOLOR="white" CLASS="TableRowColor">
  191. <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#finalize()" title="class or interface in java.lang">finalize</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>
  192. </TR>
  193. </TABLE>
  194. &nbsp;
  195. <P>
  196.  
  197. <!-- ============ FIELD DETAIL =========== -->
  198.  
  199. <A NAME="field_detail"><!-- --></A>
  200. <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
  201. <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
  202. <TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2">
  203. <B>Field Detail</B></FONT></TH>
  204. </TR>
  205. </TABLE>
  206.  
  207. <A NAME="UID"><!-- --></A><H3>
  208. UID</H3>
  209. <PRE>
  210. public static final <A HREF="../../javax/mail/UIDFolder.FetchProfileItem.html" title="class in javax.mail">UIDFolder.FetchProfileItem</A> <B>UID</B></PRE>
  211. <DL>
  212. <DD>UID is a fetch profile item that can be included in a
  213.  <code>FetchProfile</code> during a fetch request to a Folder.
  214.  This item indicates that the UIDs for messages in the specified
  215.  range are desired to be prefetched. <p>
  216.  
  217.  An example of how a client uses this is below: <p>
  218.  <blockquote><pre>
  219.  
  220.         FetchProfile fp = new FetchProfile();
  221.         fp.add(UIDFolder.FetchProfileItem.UID);
  222.         folder.fetch(msgs, fp);
  223.  
  224.  </pre></blockquote><p>
  225. <P>
  226. <DL>
  227. </DL>
  228. </DL>
  229.  
  230. <!-- ========= CONSTRUCTOR DETAIL ======== -->
  231.  
  232. <A NAME="constructor_detail"><!-- --></A>
  233. <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
  234. <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
  235. <TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2">
  236. <B>Constructor Detail</B></FONT></TH>
  237. </TR>
  238. </TABLE>
  239.  
  240. <A NAME="UIDFolder.FetchProfileItem(java.lang.String)"><!-- --></A><H3>
  241. UIDFolder.FetchProfileItem</H3>
  242. <PRE>
  243. protected <B>UIDFolder.FetchProfileItem</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)</PRE>
  244. <DL>
  245. </DL>
  246. <!-- ========= END OF CLASS DATA ========= -->
  247. <HR>
  248.  
  249.  
  250. <!-- ======= START OF BOTTOM NAVBAR ====== -->
  251. <A NAME="navbar_bottom"><!-- --></A>
  252. <A HREF="#skip-navbar_bottom" title="Skip navigation links"></A>
  253. <TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">
  254. <TR>
  255. <TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
  256. <A NAME="navbar_bottom_firstrow"><!-- --></A>
  257. <TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">
  258.   <TR ALIGN="center" VALIGN="top">
  259.   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A>&nbsp;</TD>
  260.   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A>&nbsp;</TD>
  261.   <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> &nbsp;<FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT>&nbsp;</TD>
  262.   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="class-use/UIDFolder.FetchProfileItem.html"><FONT CLASS="NavBarFont1"><B>Use</B></FONT></A>&nbsp;</TD>
  263.   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A>&nbsp;</TD>
  264.   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A>&nbsp;</TD>
  265.   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../index-files/index-1.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A>&nbsp;</TD>
  266.   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A>&nbsp;</TD>
  267.   </TR>
  268. </TABLE>
  269. </TD>
  270. <TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
  271. </EM>
  272. </TD>
  273. </TR>
  274.  
  275. <TR>
  276. <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
  277. &nbsp;<A HREF="../../javax/mail/UIDFolder.html" title="interface in javax.mail"><B>PREV CLASS</B></A>&nbsp;
  278. &nbsp;<A HREF="../../javax/mail/URLName.html" title="class in javax.mail"><B>NEXT CLASS</B></A></FONT></TD>
  279. <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
  280.   <A HREF="../../index.html?javax/mail/UIDFolder.FetchProfileItem.html" target="_top"><B>FRAMES</B></A>  &nbsp;
  281. &nbsp;<A HREF="UIDFolder.FetchProfileItem.html" target="_top"><B>NO FRAMES</B></A>  &nbsp;
  282. &nbsp;<SCRIPT type="text/javascript">
  283.   <!--
  284.   if(window==top) {
  285.     document.writeln('<A HREF="../../allclasses-noframe.html"><B>All Classes</B></A>');
  286.   }
  287.   //-->
  288. </SCRIPT>
  289. <NOSCRIPT>
  290.   <A HREF="../../allclasses-noframe.html"><B>All Classes</B></A>
  291. </NOSCRIPT>
  292.  
  293.  
  294. </FONT></TD>
  295. </TR>
  296. <TR>
  297. <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
  298.   SUMMARY:&nbsp;NESTED&nbsp;|&nbsp;<A HREF="#field_summary">FIELD</A>&nbsp;|&nbsp;<A HREF="#constructor_summary">CONSTR</A>&nbsp;|&nbsp;<A HREF="#methods_inherited_from_class_javax.mail.FetchProfile.Item">METHOD</A></FONT></TD>
  299. <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
  300. DETAIL:&nbsp;<A HREF="#field_detail">FIELD</A>&nbsp;|&nbsp;<A HREF="#constructor_detail">CONSTR</A>&nbsp;|&nbsp;METHOD</FONT></TD>
  301. </TR>
  302. </TABLE>
  303. <A NAME="skip-navbar_bottom"></A>
  304. <!-- ======== END OF BOTTOM NAVBAR ======= -->
  305.  
  306. <HR>
  307. Copyright &#169; 2009 <a href="http://www.sun.com">Sun Microsystems, Inc.</a>. All Rights Reserved.
  308. </BODY>
  309. </HTML>
  310.