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:43 PST 2009 -->
  6. <META http-equiv="Content-Type" content="text/html; charset=ISO-8859-1">
  7. <TITLE>
  8. javax.mail.search (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="javax.mail.search (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="#FFFFFF" CLASS="NavBarCell1Rev"> &nbsp;<FONT CLASS="NavBarFont1Rev"><B>Package</B></FONT>&nbsp;</TD>
  43.   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <FONT CLASS="NavBarFont1">Class</FONT>&nbsp;</TD>
  44.   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="package-use.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/internet/package-summary.html"><B>PREV PACKAGE</B></A>&nbsp;
  60. &nbsp;<A HREF="../../../javax/mail/util/package-summary.html"><B>NEXT PACKAGE</B></A></FONT></TD>
  61. <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
  62.   <A HREF="../../../index.html?javax/mail/search/package-summary.html" target="_top"><B>FRAMES</B></A>  &nbsp;
  63. &nbsp;<A HREF="package-summary.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. </TABLE>
  79. <A NAME="skip-navbar_top"></A>
  80. <!-- ========= END OF TOP NAVBAR ========= -->
  81.  
  82. <HR>
  83. <H2>
  84. Package javax.mail.search
  85. </H2>
  86. Message search terms for the JavaMail API.
  87. <P>
  88. <B>See:</B>
  89. <BR>
  90. &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<A HREF="#package_description"><B>Description</B></A>
  91. <P>
  92.  
  93. <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
  94. <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
  95. <TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2">
  96. <B>Class Summary</B></FONT></TH>
  97. </TR>
  98. <TR BGCOLOR="white" CLASS="TableRowColor">
  99. <TD WIDTH="15%"><B><A HREF="../../../javax/mail/search/AddressStringTerm.html" title="class in javax.mail.search">AddressStringTerm</A></B></TD>
  100. <TD>This abstract class implements string comparisons for Message
  101.  addresses.</TD>
  102. </TR>
  103. <TR BGCOLOR="white" CLASS="TableRowColor">
  104. <TD WIDTH="15%"><B><A HREF="../../../javax/mail/search/AddressTerm.html" title="class in javax.mail.search">AddressTerm</A></B></TD>
  105. <TD>This class implements Message Address comparisons.</TD>
  106. </TR>
  107. <TR BGCOLOR="white" CLASS="TableRowColor">
  108. <TD WIDTH="15%"><B><A HREF="../../../javax/mail/search/AndTerm.html" title="class in javax.mail.search">AndTerm</A></B></TD>
  109. <TD>This class implements the logical AND operator on individual
  110.  SearchTerms.</TD>
  111. </TR>
  112. <TR BGCOLOR="white" CLASS="TableRowColor">
  113. <TD WIDTH="15%"><B><A HREF="../../../javax/mail/search/BodyTerm.html" title="class in javax.mail.search">BodyTerm</A></B></TD>
  114. <TD>This class implements searches on a message body.</TD>
  115. </TR>
  116. <TR BGCOLOR="white" CLASS="TableRowColor">
  117. <TD WIDTH="15%"><B><A HREF="../../../javax/mail/search/ComparisonTerm.html" title="class in javax.mail.search">ComparisonTerm</A></B></TD>
  118. <TD>This class models the comparison operator.</TD>
  119. </TR>
  120. <TR BGCOLOR="white" CLASS="TableRowColor">
  121. <TD WIDTH="15%"><B><A HREF="../../../javax/mail/search/DateTerm.html" title="class in javax.mail.search">DateTerm</A></B></TD>
  122. <TD>This class implements comparisons for Dates</TD>
  123. </TR>
  124. <TR BGCOLOR="white" CLASS="TableRowColor">
  125. <TD WIDTH="15%"><B><A HREF="../../../javax/mail/search/FlagTerm.html" title="class in javax.mail.search">FlagTerm</A></B></TD>
  126. <TD>This class implements comparisons for Message Flags.</TD>
  127. </TR>
  128. <TR BGCOLOR="white" CLASS="TableRowColor">
  129. <TD WIDTH="15%"><B><A HREF="../../../javax/mail/search/FromStringTerm.html" title="class in javax.mail.search">FromStringTerm</A></B></TD>
  130. <TD>This class implements string comparisons for the From Address
  131.  header.</TD>
  132. </TR>
  133. <TR BGCOLOR="white" CLASS="TableRowColor">
  134. <TD WIDTH="15%"><B><A HREF="../../../javax/mail/search/FromTerm.html" title="class in javax.mail.search">FromTerm</A></B></TD>
  135. <TD>This class implements comparisons for the From Address header.</TD>
  136. </TR>
  137. <TR BGCOLOR="white" CLASS="TableRowColor">
  138. <TD WIDTH="15%"><B><A HREF="../../../javax/mail/search/HeaderTerm.html" title="class in javax.mail.search">HeaderTerm</A></B></TD>
  139. <TD>This class implements comparisons for Message headers.</TD>
  140. </TR>
  141. <TR BGCOLOR="white" CLASS="TableRowColor">
  142. <TD WIDTH="15%"><B><A HREF="../../../javax/mail/search/IntegerComparisonTerm.html" title="class in javax.mail.search">IntegerComparisonTerm</A></B></TD>
  143. <TD>This class implements comparisons for integers.</TD>
  144. </TR>
  145. <TR BGCOLOR="white" CLASS="TableRowColor">
  146. <TD WIDTH="15%"><B><A HREF="../../../javax/mail/search/MessageIDTerm.html" title="class in javax.mail.search">MessageIDTerm</A></B></TD>
  147. <TD>This term models the RFC822 "MessageId" - a message-id for
  148.  Internet messages that is supposed to be unique per message.</TD>
  149. </TR>
  150. <TR BGCOLOR="white" CLASS="TableRowColor">
  151. <TD WIDTH="15%"><B><A HREF="../../../javax/mail/search/MessageNumberTerm.html" title="class in javax.mail.search">MessageNumberTerm</A></B></TD>
  152. <TD>This class implements comparisons for Message numbers.</TD>
  153. </TR>
  154. <TR BGCOLOR="white" CLASS="TableRowColor">
  155. <TD WIDTH="15%"><B><A HREF="../../../javax/mail/search/NotTerm.html" title="class in javax.mail.search">NotTerm</A></B></TD>
  156. <TD>This class implements the logical NEGATION operator.</TD>
  157. </TR>
  158. <TR BGCOLOR="white" CLASS="TableRowColor">
  159. <TD WIDTH="15%"><B><A HREF="../../../javax/mail/search/OrTerm.html" title="class in javax.mail.search">OrTerm</A></B></TD>
  160. <TD>This class implements the logical OR operator on individual SearchTerms.</TD>
  161. </TR>
  162. <TR BGCOLOR="white" CLASS="TableRowColor">
  163. <TD WIDTH="15%"><B><A HREF="../../../javax/mail/search/ReceivedDateTerm.html" title="class in javax.mail.search">ReceivedDateTerm</A></B></TD>
  164. <TD>This class implements comparisons for the Message Received date</TD>
  165. </TR>
  166. <TR BGCOLOR="white" CLASS="TableRowColor">
  167. <TD WIDTH="15%"><B><A HREF="../../../javax/mail/search/RecipientStringTerm.html" title="class in javax.mail.search">RecipientStringTerm</A></B></TD>
  168. <TD>This class implements string comparisons for the Recipient Address
  169.  headers.</TD>
  170. </TR>
  171. <TR BGCOLOR="white" CLASS="TableRowColor">
  172. <TD WIDTH="15%"><B><A HREF="../../../javax/mail/search/RecipientTerm.html" title="class in javax.mail.search">RecipientTerm</A></B></TD>
  173. <TD>This class implements comparisons for the Recipient Address headers.</TD>
  174. </TR>
  175. <TR BGCOLOR="white" CLASS="TableRowColor">
  176. <TD WIDTH="15%"><B><A HREF="../../../javax/mail/search/SearchTerm.html" title="class in javax.mail.search">SearchTerm</A></B></TD>
  177. <TD>Search criteria are expressed as a tree of search-terms, forming
  178.  a parse-tree for the search expression.</TD>
  179. </TR>
  180. <TR BGCOLOR="white" CLASS="TableRowColor">
  181. <TD WIDTH="15%"><B><A HREF="../../../javax/mail/search/SentDateTerm.html" title="class in javax.mail.search">SentDateTerm</A></B></TD>
  182. <TD>This class implements comparisons for the Message SentDate.</TD>
  183. </TR>
  184. <TR BGCOLOR="white" CLASS="TableRowColor">
  185. <TD WIDTH="15%"><B><A HREF="../../../javax/mail/search/SizeTerm.html" title="class in javax.mail.search">SizeTerm</A></B></TD>
  186. <TD>This class implements comparisons for Message sizes.</TD>
  187. </TR>
  188. <TR BGCOLOR="white" CLASS="TableRowColor">
  189. <TD WIDTH="15%"><B><A HREF="../../../javax/mail/search/StringTerm.html" title="class in javax.mail.search">StringTerm</A></B></TD>
  190. <TD>This class implements the match method for Strings.</TD>
  191. </TR>
  192. <TR BGCOLOR="white" CLASS="TableRowColor">
  193. <TD WIDTH="15%"><B><A HREF="../../../javax/mail/search/SubjectTerm.html" title="class in javax.mail.search">SubjectTerm</A></B></TD>
  194. <TD>This class implements comparisons for the message Subject header.</TD>
  195. </TR>
  196. </TABLE>
  197. &nbsp;
  198.  
  199. <P>
  200.  
  201. <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
  202. <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
  203. <TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2">
  204. <B>Exception Summary</B></FONT></TH>
  205. </TR>
  206. <TR BGCOLOR="white" CLASS="TableRowColor">
  207. <TD WIDTH="15%"><B><A HREF="../../../javax/mail/search/SearchException.html" title="class in javax.mail.search">SearchException</A></B></TD>
  208. <TD>The exception thrown when a Search expression could not be handled.</TD>
  209. </TR>
  210. </TABLE>
  211. &nbsp;
  212.  
  213. <P>
  214. <A NAME="package_description"><!-- --></A><H2>
  215. Package javax.mail.search Description
  216. </H2>
  217.  
  218. <P>
  219. Message search terms for the JavaMail API.
  220. This package defines classes that can be used to construct a search
  221. expression to search a folder for messages matching the expression;
  222. see the <A HREF="../../../javax/mail/Folder.html#search(javax.mail.search.SearchTerm)"><CODE>search</CODE></A> method on
  223. <A HREF="../../../javax/mail/Folder.html" title="class in javax.mail"><CODE>javax.mail.Folder</CODE></A>.
  224. See <A HREF="../../../javax/mail/search/SearchTerm.html" title="class in javax.mail.search"><CODE>SearchTerm</CODE></A>.
  225. <P>
  226. Note that the exact search capabilities depend on the protocol,
  227. provider, and server in use.  For the POP3 protocol, all searching is
  228. done on the client side using the JavaMail classes.  For IMAP, all
  229. searching is done on the server side and is limited by the search
  230. capabilities of the IMAP protocol and the IMAP server being used.
  231. For example, IMAP date based searches have only day granularity.
  232. <P>
  233. In general, all of the string patterns supported by search terms are
  234. just simple strings; no regular expressions are supported.
  235. <P>
  236.  
  237. <P>
  238. <DL>
  239. </DL>
  240. <HR>
  241.  
  242.  
  243. <!-- ======= START OF BOTTOM NAVBAR ====== -->
  244. <A NAME="navbar_bottom"><!-- --></A>
  245. <A HREF="#skip-navbar_bottom" title="Skip navigation links"></A>
  246. <TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">
  247. <TR>
  248. <TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
  249. <A NAME="navbar_bottom_firstrow"><!-- --></A>
  250. <TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">
  251.   <TR ALIGN="center" VALIGN="top">
  252.   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A>&nbsp;</TD>
  253.   <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> &nbsp;<FONT CLASS="NavBarFont1Rev"><B>Package</B></FONT>&nbsp;</TD>
  254.   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <FONT CLASS="NavBarFont1">Class</FONT>&nbsp;</TD>
  255.   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="package-use.html"><FONT CLASS="NavBarFont1"><B>Use</B></FONT></A>&nbsp;</TD>
  256.   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A>&nbsp;</TD>
  257.   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A>&nbsp;</TD>
  258.   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../index-files/index-1.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A>&nbsp;</TD>
  259.   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A>&nbsp;</TD>
  260.   </TR>
  261. </TABLE>
  262. </TD>
  263. <TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
  264. </EM>
  265. </TD>
  266. </TR>
  267.  
  268. <TR>
  269. <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
  270. &nbsp;<A HREF="../../../javax/mail/internet/package-summary.html"><B>PREV PACKAGE</B></A>&nbsp;
  271. &nbsp;<A HREF="../../../javax/mail/util/package-summary.html"><B>NEXT PACKAGE</B></A></FONT></TD>
  272. <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
  273.   <A HREF="../../../index.html?javax/mail/search/package-summary.html" target="_top"><B>FRAMES</B></A>  &nbsp;
  274. &nbsp;<A HREF="package-summary.html" target="_top"><B>NO FRAMES</B></A>  &nbsp;
  275. &nbsp;<SCRIPT type="text/javascript">
  276.   <!--
  277.   if(window==top) {
  278.     document.writeln('<A HREF="../../../allclasses-noframe.html"><B>All Classes</B></A>');
  279.   }
  280.   //-->
  281. </SCRIPT>
  282. <NOSCRIPT>
  283.   <A HREF="../../../allclasses-noframe.html"><B>All Classes</B></A>
  284. </NOSCRIPT>
  285.  
  286.  
  287. </FONT></TD>
  288. </TR>
  289. </TABLE>
  290. <A NAME="skip-navbar_bottom"></A>
  291. <!-- ======== END OF BOTTOM NAVBAR ======= -->
  292.  
  293. <HR>
  294. Copyright &#169; 2009 <a href="http://www.sun.com">Sun Microsystems, Inc.</a>. All Rights Reserved.
  295. </BODY>
  296. </HTML>
  297.