<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<!--NewPage-->
<!-- Generated by javadoc (build 1.6.0_10) on Tue Nov 17 12:13:43 PST 2009 -->
<
META http-equiv="Content-Type" content="text/html; charset=ISO-8859-1">
javax.mail.search (JavaMail API documentation)
<
META NAME="date" CONTENT="2009-11-17">
<
LINK REL ="stylesheet" TYPE="text/css" HREF="../../../stylesheet.css" TITLE="Style">
<
SCRIPT type="text/javascript">
function windowTitle()
{
if (location.href.indexOf('is-external=true') == -1) {
parent.document.title="javax.mail.search (JavaMail API documentation)";
}
}
<
BODY BGCOLOR="white" onload="windowTitle();">
<!-- ========= START OF TOP NAVBAR ======= -->
<
A NAME="navbar_top"><!-- --><
/A>
<
A HREF="#skip-navbar_top" title="Skip navigation links"><
/A>
<
TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">
<
TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
<
A NAME="navbar_top_firstrow"><!-- --><
/A>
<
TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">
<
TR ALIGN="center" VALIGN="top">
<
TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <
A HREF="../../../overview-summary.html"><
FONT CLASS="NavBarFont1"><
B>Overview<
/B><
/FONT><
/A> <
/TD>
<
TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> <
FONT CLASS="NavBarFont1Rev"><
B>Package<
/B><
/FONT> <
/TD>
<
TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <
FONT CLASS="NavBarFont1">Class<
/FONT> <
/TD>
<
TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <
A HREF="package-use.html"><
FONT CLASS="NavBarFont1"><
B>Use<
/B><
/FONT><
/A> <
/TD>
<
TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <
A HREF="package-tree.html"><
FONT CLASS="NavBarFont1"><
B>Tree<
/B><
/FONT><
/A> <
/TD>
<
TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <
A HREF="../../../deprecated-list.html"><
FONT CLASS="NavBarFont1"><
B>Deprecated<
/B><
/FONT><
/A> <
/TD>
<
TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <
A HREF="../../../index-files/index-1.html"><
FONT CLASS="NavBarFont1"><
B>Index<
/B><
/FONT><
/A> <
/TD>
<
TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <
A HREF="../../../help-doc.html"><
FONT CLASS="NavBarFont1"><
B>Help<
/B><
/FONT><
/A> <
/TD>
<
TD ALIGN="right" VALIGN="top" ROWSPAN=3><
EM>
<
TD BGCOLOR="white" CLASS="NavBarCell2"><
FONT SIZE="-2">
<
A HREF="../../../javax/mail/internet/package-summary.html"><
B>PREV PACKAGE<
/B><
/A>
<
A HREF="../../../javax/mail/util/package-summary.html"><
B>NEXT PACKAGE<
/B><
/A><
/FONT><
/TD>
<
TD BGCOLOR="white" CLASS="NavBarCell2"><
FONT SIZE="-2">
<
A HREF="../../../index.html?javax/mail/search/package-summary.html" target="_top"><
B>FRAMES<
/B><
/A>
<
A HREF="package-summary.html" target="_top"><
B>NO FRAMES<
/B><
/A>
<
SCRIPT type="text/javascript">
<!--
if(window==top) {
document.writeln('<A HREF="../../../allclasses-noframe.html"><B>All Classes</B></A>');
}
//-->
<
A HREF="../../../allclasses-noframe.html"><
B>All Classes<
/B><
/A>
<
A NAME="skip-navbar_top"><
/A>
<!-- ========= END OF TOP NAVBAR ========= -->
Package javax.mail.search
Message search terms for the JavaMail API.
<
A HREF="#package_description"><
B>Description<
/B><
/A>
<
TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
<
TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
<
TH ALIGN="left" COLSPAN="2"><
FONT SIZE="+2">
<
TR BGCOLOR="white" CLASS="TableRowColor">
<
TD WIDTH="15%"><
B><
A HREF="../../../javax/mail/search/AddressStringTerm.html" title="class in javax.mail.search">AddressStringTerm<
/A><
/B><
/TD>
<
TD>This abstract
class implements string comparisons
for Message
<
TR BGCOLOR="white" CLASS="TableRowColor">
<
TD WIDTH="15%"><
B><
A HREF="../../../javax/mail/search/AddressTerm.html" title="class in javax.mail.search">AddressTerm<
/A><
/B><
/TD>
<
TD>This
class implements Message Address comparisons.<
/TD>
<
TR BGCOLOR="white" CLASS="TableRowColor">
<
TD WIDTH="15%"><
B><
A HREF="../../../javax/mail/search/AndTerm.html" title="class in javax.mail.search">AndTerm<
/A><
/B><
/TD>
<
TD>This
class implements the logical AND operator on individual
<
TR BGCOLOR="white" CLASS="TableRowColor">
<
TD WIDTH="15%"><
B><
A HREF="../../../javax/mail/search/BodyTerm.html" title="class in javax.mail.search">BodyTerm<
/A><
/B><
/TD>
<
TD>This
class implements searches on a message body.<
/TD>
<
TR BGCOLOR="white" CLASS="TableRowColor">
<
TD WIDTH="15%"><
B><
A HREF="../../../javax/mail/search/ComparisonTerm.html" title="class in javax.mail.search">ComparisonTerm<
/A><
/B><
/TD>
<
TD>This
class models the comparison operator.<
/TD>
<
TR BGCOLOR="white" CLASS="TableRowColor">
<
TD WIDTH="15%"><
B><
A HREF="../../../javax/mail/search/DateTerm.html" title="class in javax.mail.search">DateTerm<
/A><
/B><
/TD>
<
TD>This
class implements comparisons
for Dates<
/TD>
<
TR BGCOLOR="white" CLASS="TableRowColor">
<
TD WIDTH="15%"><
B><
A HREF="../../../javax/mail/search/FlagTerm.html" title="class in javax.mail.search">FlagTerm<
/A><
/B><
/TD>
<
TD>This
class implements comparisons
for Message Flags.<
/TD>
<
TR BGCOLOR="white" CLASS="TableRowColor">
<
TD WIDTH="15%"><
B><
A HREF="../../../javax/mail/search/FromStringTerm.html" title="class in javax.mail.search">FromStringTerm<
/A><
/B><
/TD>
<
TD>This
class implements string comparisons
for the From Address
<
TR BGCOLOR="white" CLASS="TableRowColor">
<
TD WIDTH="15%"><
B><
A HREF="../../../javax/mail/search/FromTerm.html" title="class in javax.mail.search">FromTerm<
/A><
/B><
/TD>
<
TD>This
class implements comparisons
for the From Address header.<
/TD>
<
TR BGCOLOR="white" CLASS="TableRowColor">
<
TD WIDTH="15%"><
B><
A HREF="../../../javax/mail/search/HeaderTerm.html" title="class in javax.mail.search">HeaderTerm<
/A><
/B><
/TD>
<
TD>This
class implements comparisons
for Message
headers.<
/TD>
<
TR BGCOLOR="white" CLASS="TableRowColor">
<
TD WIDTH="15%"><
B><
A HREF="../../../javax/mail/search/IntegerComparisonTerm.html" title="class in javax.mail.search">IntegerComparisonTerm<
/A><
/B><
/TD>
<
TD>This
class implements comparisons
for integers.<
/TD>
<
TR BGCOLOR="white" CLASS="TableRowColor">
<
TD WIDTH="15%"><
B><
A HREF="../../../javax/mail/search/MessageIDTerm.html" title="class in javax.mail.search">MessageIDTerm<
/A><
/B><
/TD>
<
TD>This term models the RFC822
"MessageId" - a message-
id for
Internet messages that is supposed to be unique per message.<
/TD>
<
TR BGCOLOR="white" CLASS="TableRowColor">
<
TD WIDTH="15%"><
B><
A HREF="../../../javax/mail/search/MessageNumberTerm.html" title="class in javax.mail.search">MessageNumberTerm<
/A><
/B><
/TD>
<
TD>This
class implements comparisons
for Message numbers.<
/TD>
<
TR BGCOLOR="white" CLASS="TableRowColor">
<
TD WIDTH="15%"><
B><
A HREF="../../../javax/mail/search/NotTerm.html" title="class in javax.mail.search">NotTerm<
/A><
/B><
/TD>
<
TD>This
class implements the logical NEGATION operator.<
/TD>
<
TR BGCOLOR="white" CLASS="TableRowColor">
<
TD WIDTH="15%"><
B><
A HREF="../../../javax/mail/search/OrTerm.html" title="class in javax.mail.search">OrTerm<
/A><
/B><
/TD>
<
TD>This
class implements the logical OR operator on individual SearchTerms.<
/TD>
<
TR BGCOLOR="white" CLASS="TableRowColor">
<
TD WIDTH="15%"><
B><
A HREF="../../../javax/mail/search/ReceivedDateTerm.html" title="class in javax.mail.search">ReceivedDateTerm<
/A><
/B><
/TD>
<
TD>This
class implements comparisons
for the Message Received date<
/TD>
<
TR BGCOLOR="white" CLASS="TableRowColor">
<
TD WIDTH="15%"><
B><
A HREF="../../../javax/mail/search/RecipientStringTerm.html" title="class in javax.mail.search">RecipientStringTerm<
/A><
/B><
/TD>
<
TD>This
class implements string comparisons
for the Recipient Address
<
TR BGCOLOR="white" CLASS="TableRowColor">
<
TD WIDTH="15%"><
B><
A HREF="../../../javax/mail/search/RecipientTerm.html" title="class in javax.mail.search">RecipientTerm<
/A><
/B><
/TD>
<
TD>This
class implements comparisons
for the Recipient Address
headers.<
/TD>
<
TR BGCOLOR="white" CLASS="TableRowColor">
<
TD WIDTH="15%"><
B><
A HREF="../../../javax/mail/search/SearchTerm.html" title="class in javax.mail.search">SearchTerm<
/A><
/B><
/TD>
<
TD>Search criteria are expressed as a tree of search-terms, forming
a parse-tree
for the search expression.<
/TD>
<
TR BGCOLOR="white" CLASS="TableRowColor">
<
TD WIDTH="15%"><
B><
A HREF="../../../javax/mail/search/SentDateTerm.html" title="class in javax.mail.search">SentDateTerm<
/A><
/B><
/TD>
<
TD>This
class implements comparisons
for the Message SentDate.<
/TD>
<
TR BGCOLOR="white" CLASS="TableRowColor">
<
TD WIDTH="15%"><
B><
A HREF="../../../javax/mail/search/SizeTerm.html" title="class in javax.mail.search">SizeTerm<
/A><
/B><
/TD>
<
TD>This
class implements comparisons
for Message sizes.<
/TD>
<
TR BGCOLOR="white" CLASS="TableRowColor">
<
TD WIDTH="15%"><
B><
A HREF="../../../javax/mail/search/StringTerm.html" title="class in javax.mail.search">StringTerm<
/A><
/B><
/TD>
<
TD>This
class implements the match
method for Strings.<
/TD>
<
TR BGCOLOR="white" CLASS="TableRowColor">
<
TD WIDTH="15%"><
B><
A HREF="../../../javax/mail/search/SubjectTerm.html" title="class in javax.mail.search">SubjectTerm<
/A><
/B><
/TD>
<
TD>This
class implements comparisons
for the message Subject header.<
/TD>
<
TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
<
TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
<
TH ALIGN="left" COLSPAN="2"><
FONT SIZE="+2">
<
TR BGCOLOR="white" CLASS="TableRowColor">
<
TD WIDTH="15%"><
B><
A HREF="../../../javax/mail/search/SearchException.html" title="class in javax.mail.search">SearchException<
/A><
/B><
/TD>
<
TD>The exception thrown when a Search expression could not be handled.<
/TD>
<
A NAME="package_description"><!-- --><
/A><
H2>
Package javax.mail.search Description
Message search terms for the JavaMail API.
This package defines classes that can be used to construct a search
expression to search a folder for messages matching the expression;
see the <
A HREF="../../../javax/mail/Folder.html#search(javax.mail.search.SearchTerm)"><
CODE>search<
/CODE><
/A>
method on
<
A HREF="../../../javax/mail/Folder.html" title="class in javax.mail"><
CODE>javax.mail.Folder<
/CODE><
/A>.
See <
A HREF="../../../javax/mail/search/SearchTerm.html" title="class in javax.mail.search"><
CODE>SearchTerm<
/CODE><
/A>.
Note that the exact search capabilities depend on the protocol,
provider, and server in use. For the POP3 protocol, all searching is
done on the client side using the JavaMail classes. For IMAP, all
searching is done on the server side and is limited by the search
capabilities of the IMAP protocol and the IMAP server being used.
For example, IMAP date based searches have only day granularity.
In general, all of the string patterns supported by search terms are
just simple strings; no regular expressions are supported.
<!-- ======= START OF BOTTOM NAVBAR ====== -->
<
A NAME="navbar_bottom"><!-- --><
/A>
<
A HREF="#skip-navbar_bottom" title="Skip navigation links"><
/A>
<
TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">
<
TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
<
A NAME="navbar_bottom_firstrow"><!-- --><
/A>
<
TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">
<
TR ALIGN="center" VALIGN="top">
<
TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <
A HREF="../../../overview-summary.html"><
FONT CLASS="NavBarFont1"><
B>Overview<
/B><
/FONT><
/A> <
/TD>
<
TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> <
FONT CLASS="NavBarFont1Rev"><
B>Package<
/B><
/FONT> <
/TD>
<
TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <
FONT CLASS="NavBarFont1">Class<
/FONT> <
/TD>
<
TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <
A HREF="package-use.html"><
FONT CLASS="NavBarFont1"><
B>Use<
/B><
/FONT><
/A> <
/TD>
<
TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <
A HREF="package-tree.html"><
FONT CLASS="NavBarFont1"><
B>Tree<
/B><
/FONT><
/A> <
/TD>
<
TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <
A HREF="../../../deprecated-list.html"><
FONT CLASS="NavBarFont1"><
B>Deprecated<
/B><
/FONT><
/A> <
/TD>
<
TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <
A HREF="../../../index-files/index-1.html"><
FONT CLASS="NavBarFont1"><
B>Index<
/B><
/FONT><
/A> <
/TD>
<
TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <
A HREF="../../../help-doc.html"><
FONT CLASS="NavBarFont1"><
B>Help<
/B><
/FONT><
/A> <
/TD>
<
TD ALIGN="right" VALIGN="top" ROWSPAN=3><
EM>
<
TD BGCOLOR="white" CLASS="NavBarCell2"><
FONT SIZE="-2">
<
A HREF="../../../javax/mail/internet/package-summary.html"><
B>PREV PACKAGE<
/B><
/A>
<
A HREF="../../../javax/mail/util/package-summary.html"><
B>NEXT PACKAGE<
/B><
/A><
/FONT><
/TD>
<
TD BGCOLOR="white" CLASS="NavBarCell2"><
FONT SIZE="-2">
<
A HREF="../../../index.html?javax/mail/search/package-summary.html" target="_top"><
B>FRAMES<
/B><
/A>
<
A HREF="package-summary.html" target="_top"><
B>NO FRAMES<
/B><
/A>
<
SCRIPT type="text/javascript">
<!--
if(window==top) {
document.writeln('<A HREF="../../../allclasses-noframe.html"><B>All Classes</B></A>');
}
//-->
<
A HREF="../../../allclasses-noframe.html"><
B>All Classes<
/B><
/A>
<
A NAME="skip-navbar_bottom"><
/A>
<!-- ======== END OF BOTTOM NAVBAR ======= -->
Copyright &#
169;
2009 <
a href="http://www.sun.com">Sun Microsystems, Inc.<
/a>. All Rights Reserved.