<!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:41 PST 2009 -->
<
META http-equiv="Content-Type" content="text/html; charset=ISO-8859-1">
IMAPFolder (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="IMAPFolder (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="#EEEEFF" CLASS="NavBarCell1"> <
A HREF="package-summary.html"><
FONT CLASS="NavBarFont1"><
B>Package<
/B><
/FONT><
/A> <
/TD>
<
TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> <
FONT CLASS="NavBarFont1Rev"><
B>Class<
/B><
/FONT> <
/TD>
<
TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <
A HREF="class-use/IMAPFolder.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="../../../../com/sun/mail/imap/ACL.html" title="class in com.sun.mail.imap"><
B>PREV CLASS<
/B><
/A>
<
A HREF="../../../../com/sun/mail/imap/IMAPFolder.FetchProfileItem.html" title="class in com.sun.mail.imap"><
B>NEXT CLASS<
/B><
/A><
/FONT><
/TD>
<
TD BGCOLOR="white" CLASS="NavBarCell2"><
FONT SIZE="-2">
<
A HREF="../../../../index.html?com/sun/mail/imap/IMAPFolder.html" target="_top"><
B>FRAMES<
/B><
/A>
<
A HREF="IMAPFolder.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>
<
TD VALIGN="top" CLASS="NavBarCell3"><
FONT SIZE="-2">
SUMMARY: <
A HREF="#nested_class_summary">NESTED<
/A> | <
A HREF="#field_summary">FIELD<
/A> | <
A HREF="#constructor_summary">CONSTR<
/A> | <
A HREF="#method_summary">METHOD<
/A><
/FONT><
/TD>
<
TD VALIGN="top" CLASS="NavBarCell3"><
FONT SIZE="-2">
DETAIL: <
A HREF="#field_detail">FIELD<
/A> | <
A HREF="#constructor_detail">CONSTR<
/A> | <
A HREF="#method_detail">METHOD<
/A><
/FONT><
/TD>
<
A NAME="skip-navbar_top"><
/A>
<!-- ========= END OF TOP NAVBAR ========= -->
<!-- ======== START OF CLASS DATA ======== -->
<
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>
<
IMG SRC="../../../../resources/inherit.gif" ALT="extended by "><
A HREF="../../../../javax/mail/Folder.html" title="class in javax.mail">javax.mail.Folder<
/A>
<
IMG SRC="../../../../resources/inherit.gif" ALT="extended by "><
B>com.sun.mail.imap.IMAPFolder<
/B>
<
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>
<
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>
This
class implements an IMAP folder. <
p>
A closed IMAPFolder object shares a protocol connection with its IMAPStore
object. When the folder is opened, it gets its own protocol connection. <
p>
Applications that need to make use of IMAP-specific features may cast
use the methods on this
class. The <
A HREF="../../../../com/sun/mail/imap/IMAPFolder.html#getQuota()"><
CODE>getQuota<
/CODE><
/A> and
<
A HREF="../../../../com/sun/mail/imap/IMAPFolder.html#setQuota(javax.mail.Quota)"><
CODE>setQuota<
/CODE><
/A> methods support the IMAP QUOTA extension.
Refer to <
A HREF="http://www.ietf.org/rfc/rfc2087.txt">RFC
2087<
/A>
for more information. <
p>
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>,
<
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>,
<
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
<
A HREF="../../../../com/sun/mail/imap/IMAPFolder.html#myRights()"><
CODE>myRights<
/CODE><
/A> methods support the IMAP ACL extension.
Refer to <
A HREF="http://www.ietf.org/rfc/rfc2086.txt">RFC
2086<
/A>
for more information. <
p>
The <
A HREF="../../../../com/sun/mail/imap/IMAPFolder.html#doCommand(com.sun.mail.imap.IMAPFolder.ProtocolCommand)"><
CODE>doCommand<
/CODE><
/A>
method and
<
A HREF="../../../../com/sun/mail/imap/IMAPFolder.ProtocolCommand.html" title="interface in com.sun.mail.imap"><
CODE>IMAPFolder.ProtocolCommand<
/CODE><
/A>
interface support use of arbitrary IMAP protocol commands. <
p>
See the <
a href="package-summary.html">com.sun.mail.imap<
/a> package
documentation
for further information on the IMAP protocol provider. <
p>
<
strong>WARNING:<
/strong> The APIs unique to this
class should be
considered <
strong>EXPERIMENTAL<
/strong>. They may be changed in the
future in ways that are incompatible with applications using the
current APIs.
<!-- ======== NESTED CLASS SUMMARY ======== -->
<
A NAME="nested_class_summary"><!-- --><
/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 ALIGN="right" VALIGN="top" WIDTH="1%"><
FONT SIZE="-1">
<
TD><
CODE><
B><
A HREF="../../../../com/sun/mail/imap/IMAPFolder.FetchProfileItem.html" title="class in com.sun.mail.imap">IMAPFolder.FetchProfileItem<
/A><
/B><
/CODE>
A fetch
profile item
for fetching
headers.<
/TD>
<
TR BGCOLOR="white" CLASS="TableRowColor">
<
TD ALIGN="right" VALIGN="top" WIDTH="1%"><
FONT SIZE="-1">
<
TD><
CODE><
B><
A HREF="../../../../com/sun/mail/imap/IMAPFolder.ProtocolCommand.html" title="interface in com.sun.mail.imap">IMAPFolder.ProtocolCommand<
/A><
/B><
/CODE>
A simple interface
for user-defined IMAP protocol commands.<
/TD>
<!-- =========== FIELD SUMMARY =========== -->
<
A NAME="field_summary"><!-- --><
/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 ALIGN="right" VALIGN="top" WIDTH="1%"><
FONT SIZE="-1">
<
CODE>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>
[]<
/CODE><
/FONT><
/TD>
<
TD><
CODE><
B><
A HREF="../../../../com/sun/mail/imap/IMAPFolder.html#attributes">attributes<
/A><
/B><
/CODE>
<
/TD>
<
TR BGCOLOR="white" CLASS="TableRowColor">
<
TD ALIGN="right" VALIGN="top" WIDTH="1%"><
FONT SIZE="-1">
<
CODE>protected <
A HREF="../../../../javax/mail/Flags.html" title="class in javax.mail">Flags<
/A><
/CODE><
/FONT><
/TD>
<
TD><
CODE><
B><
A HREF="../../../../com/sun/mail/imap/IMAPFolder.html#availableFlags">availableFlags<
/A><
/B><
/CODE>
<
/TD>
<
TR BGCOLOR="white" CLASS="TableRowColor">
<
TD ALIGN="right" VALIGN="top" WIDTH="1%"><
FONT SIZE="-1">
<
TD><
CODE><
B><
A HREF="../../../../com/sun/mail/imap/IMAPFolder.html#exists">exists<
/A><
/B><
/CODE>
<
/TD>
<
TR BGCOLOR="white" CLASS="TableRowColor">
<
TD ALIGN="right" VALIGN="top" WIDTH="1%"><
FONT SIZE="-1">
<
CODE>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><
/CODE><
/FONT><
/TD>
<
TD><
CODE><
B><
A HREF="../../../../com/sun/mail/imap/IMAPFolder.html#fullName">fullName<
/A><
/B><
/CODE>
<
/TD>
<
TR BGCOLOR="white" CLASS="TableRowColor">
<
TD ALIGN="right" VALIGN="top" WIDTH="1%"><
FONT SIZE="-1">
<
TD><
CODE><
B><
A HREF="../../../../com/sun/mail/imap/IMAPFolder.html#isNamespace">isNamespace<
/A><
/B><
/CODE>
<
/TD>
<
TR BGCOLOR="white" CLASS="TableRowColor">
<
TD ALIGN="right" VALIGN="top" WIDTH="1%"><
FONT SIZE="-1">
<
CODE>protected com.sun.mail.imap.MessageCache<
/CODE><
/FONT><
/TD>
<
TD><
CODE><
B><
A HREF="../../../../com/sun/mail/imap/IMAPFolder.html#messageCache">messageCache<
/A><
/B><
/CODE>
<
/TD>
<
TR BGCOLOR="white" CLASS="TableRowColor">
<
TD ALIGN="right" VALIGN="top" WIDTH="1%"><
FONT SIZE="-1">
<
CODE>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><
/CODE><
/FONT><
/TD>
<
TD><
CODE><
B><
A HREF="../../../../com/sun/mail/imap/IMAPFolder.html#messageCacheLock">messageCacheLock<
/A><
/B><
/CODE>
<
/TD>
<
TR BGCOLOR="white" CLASS="TableRowColor">
<
TD ALIGN="right" VALIGN="top" WIDTH="1%"><
FONT SIZE="-1">
<
CODE>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><
/CODE><
/FONT><
/TD>
<
TD><
CODE><
B><
A HREF="../../../../com/sun/mail/imap/IMAPFolder.html#name">name<
/A><
/B><
/CODE>
<
/TD>
<
TR BGCOLOR="white" CLASS="TableRowColor">
<
TD ALIGN="right" VALIGN="top" WIDTH="1%"><
FONT SIZE="-1">
<
CODE>protected <
A HREF="../../../../javax/mail/Flags.html" title="class in javax.mail">Flags<
/A><
/CODE><
/FONT><
/TD>
<
TD><
CODE><
B><
A HREF="../../../../com/sun/mail/imap/IMAPFolder.html#permanentFlags">permanentFlags<
/A><
/B><
/CODE>
<
/TD>
<
TR BGCOLOR="white" CLASS="TableRowColor">
<
TD ALIGN="right" VALIGN="top" WIDTH="1%"><
FONT SIZE="-1">
<
CODE>protected com.sun.mail.imap.protocol.IMAPProtocol<
/CODE><
/FONT><
/TD>
<
TD><
CODE><
B><
A HREF="../../../../com/sun/mail/imap/IMAPFolder.html#protocol">protocol<
/A><
/B><
/CODE>
<
/TD>
<
TR BGCOLOR="white" CLASS="TableRowColor">
<
TD ALIGN="right" VALIGN="top" WIDTH="1%"><
FONT SIZE="-1">
<
TD><
CODE><
B><
A HREF="../../../../com/sun/mail/imap/IMAPFolder.html#separator">separator<
/A><
/B><
/CODE>
<
/TD>
<
TR BGCOLOR="white" CLASS="TableRowColor">
<
TD ALIGN="right" VALIGN="top" WIDTH="1%"><
FONT SIZE="-1">
<
TD><
CODE><
B><
A HREF="../../../../com/sun/mail/imap/IMAPFolder.html#type">type<
/A><
/B><
/CODE>
<
/TD>
<
TR BGCOLOR="white" CLASS="TableRowColor">
<
TD ALIGN="right" VALIGN="top" WIDTH="1%"><
FONT SIZE="-1">
<
CODE>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><
/CODE><
/FONT><
/TD>
<
TD><
CODE><
B><
A HREF="../../../../com/sun/mail/imap/IMAPFolder.html#uidTable">uidTable<
/A><
/B><
/CODE>
<
/TD>
<
TR BGCOLOR="white" CLASS="TableRowColor">
<
TD ALIGN="right" VALIGN="top" WIDTH="1%"><
FONT SIZE="-1">
<
TD><
CODE><
B><
A HREF="../../../../com/sun/mail/imap/IMAPFolder.html#UNKNOWN_SEPARATOR">UNKNOWN_SEPARATOR<
/A><
/B><
/CODE>
<
/TD>
<
A NAME="fields_inherited_from_class_javax.mail.Folder"><!-- --><
/A>
<
TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
<
TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
<
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>
<
TR BGCOLOR="white" CLASS="TableRowColor">
<
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>
<
A NAME="fields_inherited_from_class_javax.mail.UIDFolder"><!-- --><
/A>
<
TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
<
TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
<
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>
<
TR BGCOLOR="white" CLASS="TableRowColor">
<
TD><
CODE><
A HREF="../../../../javax/mail/UIDFolder.html#LASTUID">LASTUID<
/A><
/CODE><
/TD>
<!-- ======== CONSTRUCTOR SUMMARY ======== -->
<
A NAME="constructor_summary"><!-- --><
/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 ALIGN="right" VALIGN="top" WIDTH="1%"><
FONT SIZE="-1">
<
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 li,
<
A HREF="../../../../com/sun/mail/imap/IMAPStore.html" title="class in com.sun.mail.imap">IMAPStore<
/A> store
)<
/CODE>
Constructor used to create an existing folder.<
/TD>
<
TR BGCOLOR="white" CLASS="TableRowColor">
<
TD ALIGN="right" VALIGN="top" WIDTH="1%"><
FONT SIZE="-1">
<
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> fullName,
char separator,
<
A HREF="../../../../com/sun/mail/imap/IMAPStore.html" title="class in com.sun.mail.imap">IMAPStore<
/A> store
)<
/CODE>
Constructor used to create a possibly non-existent folder.<
/TD>
<
TR BGCOLOR="white" CLASS="TableRowColor">
<
TD ALIGN="right" VALIGN="top" WIDTH="1%"><
FONT SIZE="-1">
<
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> fullName,
char separator,
<
A HREF="../../../../com/sun/mail/imap/IMAPStore.html" title="class in com.sun.mail.imap">IMAPStore<
/A> store,
boolean isNamespace
)<
/CODE>
Constructor used to create a possibly non-existent folder.<
/TD>
<!-- ========== METHOD SUMMARY =========== -->
<
A NAME="method_summary"><!-- --><
/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 ALIGN="right" VALIGN="top" WIDTH="1%"><
FONT SIZE="-1">
<
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> acl
)<
/CODE>
Add an access control list entry to the access control list
<
TR BGCOLOR="white" CLASS="TableRowColor">
<
TD ALIGN="right" VALIGN="top" WIDTH="1%"><
FONT SIZE="-1">
<
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> l
)<
/CODE>
Add a listener
for MessageCount events on this Folder.<
/TD>
<
TR BGCOLOR="white" CLASS="TableRowColor">
<
TD ALIGN="right" VALIGN="top" WIDTH="1%"><
FONT SIZE="-1">
<
CODE> <
A HREF="../../../../javax/mail/Message.html" title="class in javax.mail">Message<
/A>
[]<
/CODE><
/FONT><
/TD>
<
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>
[] msgs
)<
/CODE>
Append the given messages into this folder.<
/TD>
<
TR BGCOLOR="white" CLASS="TableRowColor">
<
TD ALIGN="right" VALIGN="top" WIDTH="1%"><
FONT SIZE="-1">
<
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> acl
)<
/CODE>
Add the rights specified in the ACL to the entry for the
identifier specified in the ACL.<
/TD>
<
TR BGCOLOR="white" CLASS="TableRowColor">
<
TD ALIGN="right" VALIGN="top" WIDTH="1%"><
FONT SIZE="-1">
<
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>
[] msgs
)<
/CODE>
Append the given messages into this folder.<
/TD>
<
TR BGCOLOR="white" CLASS="TableRowColor">
<
TD ALIGN="right" VALIGN="top" WIDTH="1%"><
FONT SIZE="-1">
<
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>
[] msgs
)<
/CODE>
Append the given messages into this folder.<
/TD>
<
TR BGCOLOR="white" CLASS="TableRowColor">
<
TD ALIGN="right" VALIGN="top" WIDTH="1%"><
FONT SIZE="-1">
<
TD><
CODE><
B><
A HREF="../../../../com/sun/mail/imap/IMAPFolder.html#close(boolean)">close<
/A><
/B>
(boolean expunge
)<
/CODE>
Close this folder.<
/TD>
<
TR BGCOLOR="white" CLASS="TableRowColor">
<
TD ALIGN="right" VALIGN="top" WIDTH="1%"><
FONT SIZE="-1">
<
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>
[] msgs,
<
A HREF="../../../../javax/mail/Folder.html" title="class in javax.mail">Folder<
/A> folder
)<
/CODE>
Copy the specified messages from this folder, to the
specified destination.<
/TD>
<
TR BGCOLOR="white" CLASS="TableRowColor">
<
TD ALIGN="right" VALIGN="top" WIDTH="1%"><
FONT SIZE="-1">
<
TD><
CODE><
B><
A HREF="../../../../com/sun/mail/imap/IMAPFolder.html#create(int)">create<
/A><
/B>
(int
type)<
/CODE>
Create this folder, with the specified
type.<
/TD>
<
TR BGCOLOR="white" CLASS="TableRowColor">
<
TD ALIGN="right" VALIGN="top" WIDTH="1%"><
FONT SIZE="-1">
<
TD><
CODE><
B><
A HREF="../../../../com/sun/mail/imap/IMAPFolder.html#delete(boolean)">delete<
/A><
/B>
(boolean recurse
)<
/CODE>
Delete this folder.<
/TD>
<
TR BGCOLOR="white" CLASS="TableRowColor">
<
TD ALIGN="right" VALIGN="top" WIDTH="1%"><
FONT SIZE="-1">
<
CODE> <
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>
<
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> cmd
)<
/CODE>
Execute a user-supplied IMAP command.<
/TD>
<
TR BGCOLOR="white" CLASS="TableRowColor">
<
TD ALIGN="right" VALIGN="top" WIDTH="1%"><
FONT SIZE="-1">
<
CODE> <
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>
<
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> cmd
)<
/CODE>
<
/TD>
<
TR BGCOLOR="white" CLASS="TableRowColor">
<
TD ALIGN="right" VALIGN="top" WIDTH="1%"><
FONT SIZE="-1">
<
CODE> <
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>
<
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> err,
<
A HREF="../../../../com/sun/mail/imap/IMAPFolder.ProtocolCommand.html" title="interface in com.sun.mail.imap">IMAPFolder.ProtocolCommand<
/A> cmd
)<
/CODE>
<
/TD>
<
TR BGCOLOR="white" CLASS="TableRowColor">
<
TD ALIGN="right" VALIGN="top" WIDTH="1%"><
FONT SIZE="-1">
<
CODE>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><
/CODE><
/FONT><
/TD>
<
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> cmd
)<
/CODE>
<
/TD>
<
TR BGCOLOR="white" CLASS="TableRowColor">
<
TD ALIGN="right" VALIGN="top" WIDTH="1%"><
FONT SIZE="-1">
<
TD><
CODE><
B><
A HREF="../../../../com/sun/mail/imap/IMAPFolder.html#exists()">exists<
/A><
/B>
()<
/CODE>
Check whether this folder really exists on the server.<
/TD>
<
TR BGCOLOR="white" CLASS="TableRowColor">
<
TD ALIGN="right" VALIGN="top" WIDTH="1%"><
FONT SIZE="-1">
<
CODE> <
A HREF="../../../../javax/mail/Message.html" title="class in javax.mail">Message<
/A>
[]<
/CODE><
/FONT><
/TD>
<
TD><
CODE><
B><
A HREF="../../../../com/sun/mail/imap/IMAPFolder.html#expunge()">expunge<
/A><
/B>
()<
/CODE>
Expunge all messages marked as DELETED.<
/TD>
<
TR BGCOLOR="white" CLASS="TableRowColor">
<
TD ALIGN="right" VALIGN="top" WIDTH="1%"><
FONT SIZE="-1">
<
CODE> <
A HREF="../../../../javax/mail/Message.html" title="class in javax.mail">Message<
/A>
[]<
/CODE><
/FONT><
/TD>
<
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>
[] msgs
)<
/CODE>
Expunge the indicated messages, which must have been marked as DELETED.<
/TD>
<
TR BGCOLOR="white" CLASS="TableRowColor">
<
TD ALIGN="right" VALIGN="top" WIDTH="1%"><
FONT SIZE="-1">
<
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>
[] msgs,
<
A HREF="../../../../javax/mail/FetchProfile.html" title="class in javax.mail">FetchProfile<
/A> fp
)<
/CODE>
Prefetch attributes, based on the given FetchProfile.<
/TD>
<
TR BGCOLOR="white" CLASS="TableRowColor">
<
TD ALIGN="right" VALIGN="top" WIDTH="1%"><
FONT SIZE="-1">
<
TD><
CODE><
B><
A HREF="../../../../com/sun/mail/imap/IMAPFolder.html#forceClose()">forceClose<
/A><
/B>
()<
/CODE>
Close this folder without waiting
for the server.<
/TD>
<
TR BGCOLOR="white" CLASS="TableRowColor">
<
TD ALIGN="right" VALIGN="top" WIDTH="1%"><
FONT SIZE="-1">
<
CODE> <
A HREF="../../../../com/sun/mail/imap/ACL.html" title="class in com.sun.mail.imap">ACL<
/A>
[]<
/CODE><
/FONT><
/TD>
<
TD><
CODE><
B><
A HREF="../../../../com/sun/mail/imap/IMAPFolder.html#getACL()">getACL<
/A><
/B>
()<
/CODE>
Get the access control list entries
for this folder.<
/TD>
<
TR BGCOLOR="white" CLASS="TableRowColor">
<
TD ALIGN="right" VALIGN="top" WIDTH="1%"><
FONT SIZE="-1">
<
CODE> <
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>
<
TD><
CODE><
B><
A HREF="../../../../com/sun/mail/imap/IMAPFolder.html#getAttributes()">getAttributes<
/A><
/B>
()<
/CODE>
Get the attributes that the IMAP server returns with the
<
TR BGCOLOR="white" CLASS="TableRowColor">
<
TD ALIGN="right" VALIGN="top" WIDTH="1%"><
FONT SIZE="-1">
<
TD><
CODE><
B><
A HREF="../../../../com/sun/mail/imap/IMAPFolder.html#getDeletedMessageCount()">getDeletedMessageCount<
/A><
/B>
()<
/CODE>
Get the deleted message count.<
/TD>
<
TR BGCOLOR="white" CLASS="TableRowColor">
<
TD ALIGN="right" VALIGN="top" WIDTH="1%"><
FONT SIZE="-1">
<
CODE> <
A HREF="../../../../javax/mail/Folder.html" title="class in javax.mail">Folder<
/A><
/CODE><
/FONT><
/TD>
<
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>
name)<
/CODE>
Get the named subfolder.<
/TD>
<
TR BGCOLOR="white" CLASS="TableRowColor">
<
TD ALIGN="right" VALIGN="top" WIDTH="1%"><
FONT SIZE="-1">
<
CODE> <
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>
<
TD><
CODE><
B><
A HREF="../../../../com/sun/mail/imap/IMAPFolder.html#getFullName()">getFullName<
/A><
/B>
()<
/CODE>
Get the fullname of this folder.<
/TD>
<
TR BGCOLOR="white" CLASS="TableRowColor">
<
TD ALIGN="right" VALIGN="top" WIDTH="1%"><
FONT SIZE="-1">
<
CODE> <
A HREF="../../../../javax/mail/Message.html" title="class in javax.mail">Message<
/A><
/CODE><
/FONT><
/TD>
<
TD><
CODE><
B><
A HREF="../../../../com/sun/mail/imap/IMAPFolder.html#getMessage(int)">getMessage<
/A><
/B>
(int msgnum
)<
/CODE>
Get the specified message.<
/TD>
<
TR BGCOLOR="white" CLASS="TableRowColor">
<
TD ALIGN="right" VALIGN="top" WIDTH="1%"><
FONT SIZE="-1">
<
CODE> <
A HREF="../../../../javax/mail/Message.html" title="class in javax.mail">Message<
/A><
/CODE><
/FONT><
/TD>
<
TD><
CODE><
B><
A HREF="../../../../com/sun/mail/imap/IMAPFolder.html#getMessageByUID(long)">getMessageByUID<
/A><
/B>
(long uid
)<
/CODE>
Get the Message corresponding to the given UID.<
/TD>
<
TR BGCOLOR="white" CLASS="TableRowColor">
<
TD ALIGN="right" VALIGN="top" WIDTH="1%"><
FONT SIZE="-1">
<
TD><
CODE><
B><
A HREF="../../../../com/sun/mail/imap/IMAPFolder.html#getMessageCount()">getMessageCount<
/A><
/B>
()<
/CODE>
Get the total message count.<
/TD>
<
TR BGCOLOR="white" CLASS="TableRowColor">
<
TD ALIGN="right" VALIGN="top" WIDTH="1%"><
FONT SIZE="-1">
<
CODE> <
A HREF="../../../../javax/mail/Message.html" title="class in javax.mail">Message<
/A>
[]<
/CODE><
/FONT><
/TD>
<
TD><
CODE><
B><
A HREF="../../../../com/sun/mail/imap/IMAPFolder.html#getMessagesByUID(long[])">getMessagesByUID<
/A><
/B>
(long
[] uids
)<
/CODE>
Get the Messages specified by the given array.<
/TD>
<
TR BGCOLOR="white" CLASS="TableRowColor">
<
TD ALIGN="right" VALIGN="top" WIDTH="1%"><
FONT SIZE="-1">
<
CODE> <
A HREF="../../../../javax/mail/Message.html" title="class in javax.mail">Message<
/A>
[]<
/CODE><
/FONT><
/TD>
<
TD><
CODE><
B><
A HREF="../../../../com/sun/mail/imap/IMAPFolder.html#getMessagesByUID(long, long)">getMessagesByUID<
/A><
/B>
(long
start,
Get the Messages specified by the given range.<
/TD>
<
TR BGCOLOR="white" CLASS="TableRowColor">
<
TD ALIGN="right" VALIGN="top" WIDTH="1%"><
FONT SIZE="-1">
<
CODE> <
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>
<
TD><
CODE><
B><
A HREF="../../../../com/sun/mail/imap/IMAPFolder.html#getName()">getName<
/A><
/B>
()<
/CODE>
Get the
name of this folder.<
/TD>
<
TR BGCOLOR="white" CLASS="TableRowColor">
<
TD ALIGN="right" VALIGN="top" WIDTH="1%"><
FONT SIZE="-1">
<
TD><
CODE><
B><
A HREF="../../../../com/sun/mail/imap/IMAPFolder.html#getNewMessageCount()">getNewMessageCount<
/A><
/B>
()<
/CODE>
Get the new message count.<
/TD>
<
TR BGCOLOR="white" CLASS="TableRowColor">
<
TD ALIGN="right" VALIGN="top" WIDTH="1%"><
FONT SIZE="-1">
<
CODE> <
A HREF="../../../../javax/mail/Folder.html" title="class in javax.mail">Folder<
/A><
/CODE><
/FONT><
/TD>
<
TD><
CODE><
B><
A HREF="../../../../com/sun/mail/imap/IMAPFolder.html#getParent()">getParent<
/A><
/B>
()<
/CODE>
Get this folder's parent.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE> <A HREF="../../../../javax/mail/Flags.html" title="class in javax.mail">Flags</A></CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../com/sun/mail/imap/IMAPFolder.html#getPermanentFlags()">getPermanentFlags</A></B>()</CODE>
<BR>
Return the permanent flags supported by the server.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE> <A HREF="../../../../javax/mail/Quota.html" title="class in javax.mail">Quota</A>[]</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../com/sun/mail/imap/IMAPFolder.html#getQuota()">getQuota</A></B>()</CODE>
<BR>
Get the quotas for the quotaroot associated with this
folder.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE> char</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../com/sun/mail/imap/IMAPFolder.html#getSeparator()">getSeparator</A></B>()</CODE>
<BR>
Get the separator character.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>protected com.sun.mail.imap.protocol.IMAPProtocol</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../com/sun/mail/imap/IMAPFolder.html#getStoreProtocol()">getStoreProtocol</A></B>()</CODE>
<BR>
Get this folder's Store's protocol connection.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE> int</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../com/sun/mail/imap/IMAPFolder.html#getType()">getType</A></B>()</CODE>
<BR>
Get the type of this folder.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE> long</CODE></FONT></TD>
<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> message)</CODE>
<BR>
Get the UID for the specified message.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE> long</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../com/sun/mail/imap/IMAPFolder.html#getUIDNext()">getUIDNext</A></B>()</CODE>
<BR>
Returns the predicted UID that will be assigned to the
next message that is appended to this folder.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE> long</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../com/sun/mail/imap/IMAPFolder.html#getUIDValidity()">getUIDValidity</A></B>()</CODE>
<BR>
Returns the UIDValidity for this folder.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE> int</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../com/sun/mail/imap/IMAPFolder.html#getUnreadMessageCount()">getUnreadMessageCount</A></B>()</CODE>
<BR>
Get the unread message count.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE> void</CODE></FONT></TD>
<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 r)</CODE>
<BR>
The response handler.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE> boolean</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../com/sun/mail/imap/IMAPFolder.html#hasNewMessages()">hasNewMessages</A></B>()</CODE>
<BR>
Check whether this folder has new messages.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE> void</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../com/sun/mail/imap/IMAPFolder.html#idle()">idle</A></B>()</CODE>
<BR>
Use the IMAP IDLE command (see
<A HREF="http://www.ietf.org/rfc/rfc2177.txt">RFC 2177</A>),
if supported by the server, to enter idle mode so that the server
can send unsolicited notifications of new messages arriving, etc.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE> void</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../com/sun/mail/imap/IMAPFolder.html#idle(boolean)">idle</A></B>(boolean once)</CODE>
<BR>
Like <A HREF="../../../../com/sun/mail/imap/IMAPFolder.html#idle()"><CODE>idle()</CODE></A>, but if <code>once</code> is true, abort the
IDLE command after the first notification, to allow the caller
to process any notification synchronously.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE> boolean</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../com/sun/mail/imap/IMAPFolder.html#isOpen()">isOpen</A></B>()</CODE>
<BR>
Check whether this connection is really open.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE> boolean</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../com/sun/mail/imap/IMAPFolder.html#isSubscribed()">isSubscribed</A></B>()</CODE>
<BR>
Check whether this folder is subscribed.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE> <A HREF="../../../../javax/mail/Folder.html" title="class in javax.mail">Folder</A>[]</CODE></FONT></TD>
<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> pattern)</CODE>
<BR>
List all subfolders matching the specified pattern.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE> <A HREF="../../../../com/sun/mail/imap/Rights.html" title="class in com.sun.mail.imap">Rights</A>[]</CODE></FONT></TD>
<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> name)</CODE>
<BR>
Get all the rights that may be allowed to the given identifier.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE> <A HREF="../../../../javax/mail/Folder.html" title="class in javax.mail">Folder</A>[]</CODE></FONT></TD>
<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> pattern)</CODE>
<BR>
List all subscribed subfolders matching the specified pattern.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE> <A HREF="../../../../com/sun/mail/imap/Rights.html" title="class in com.sun.mail.imap">Rights</A></CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../com/sun/mail/imap/IMAPFolder.html#myRights()">myRights</A></B>()</CODE>
<BR>
Get the rights allowed to the currently authenticated user.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE> void</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../com/sun/mail/imap/IMAPFolder.html#open(int)">open</A></B>(int mode)</CODE>
<BR>
Open this folder in the given mode.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>protected void</CODE></FONT></TD>
<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 p)</CODE>
<BR>
Release the store protocol object.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE> void</CODE></FONT></TD>
<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> name)</CODE>
<BR>
Remove any access control list entry for the given identifier
from the access control list for this folder.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE> void</CODE></FONT></TD>
<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> acl)</CODE>
<BR>
Remove the rights specified in the ACL from the entry for the
identifier specified in the ACL.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE> boolean</CODE></FONT></TD>
<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> f)</CODE>
<BR>
Rename this folder.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE> <A HREF="../../../../javax/mail/Message.html" title="class in javax.mail">Message</A>[]</CODE></FONT></TD>
<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> term)</CODE>
<BR>
Search whole folder for messages matching the given term.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE> <A HREF="../../../../javax/mail/Message.html" title="class in javax.mail">Message</A>[]</CODE></FONT></TD>
<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> term,
<A HREF="../../../../javax/mail/Message.html" title="class in javax.mail">Message</A>[] msgs)</CODE>
<BR>
Search the folder for messages matching the given term.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE> void</CODE></FONT></TD>
<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>[] msgs,
<A HREF="../../../../javax/mail/Flags.html" title="class in javax.mail">Flags</A> flag,
boolean value)</CODE>
<BR>
Set the specified flags for the given array of messages.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE> void</CODE></FONT></TD>
<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> quota)</CODE>
<BR>
Set the quotas for the quotaroot specified in the quota argument.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE> void</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../com/sun/mail/imap/IMAPFolder.html#setSubscribed(boolean)">setSubscribed</A></B>(boolean subscribe)</CODE>
<BR>
Subscribe/Unsubscribe this folder.</TD>
</TR>
</TABLE>
<A NAME="methods_inherited_from_class_javax.mail.Folder"><!-- --></A>
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
<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>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<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>
</TR>
</TABLE>
<A NAME="methods_inherited_from_class_java.lang.Object"><!-- --></A>
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
<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>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<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>
</TR>
</TABLE>
<P>
<!-- ============ FIELD DETAIL =========== -->
<A NAME="field_detail"><!-- --></A>
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
<TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2">
<B>Field Detail</B></FONT></TH>
</TR>
</TABLE>
<A NAME="fullName"><!-- --></A><H3>
fullName</H3>
<PRE>
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>
<DL>
<DL>
</DL>
</DL>
<HR>
<A NAME="name"><!-- --></A><H3>
name</H3>
<PRE>
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>
<DL>
<DL>
</DL>
</DL>
<HR>
<A NAME="type"><!-- --></A><H3>
type</H3>
<PRE>
protected int <B>type</B></PRE>
<DL>
<DL>
</DL>
</DL>
<HR>
<A NAME="separator"><!-- --></A><H3>
separator</H3>
<PRE>
protected char <B>separator</B></PRE>
<DL>
<DL>
</DL>
</DL>
<HR>
<A NAME="availableFlags"><!-- --></A><H3>
availableFlags</H3>
<PRE>
protected <A HREF="../../../../javax/mail/Flags.html" title="class in javax.mail">Flags</A> <B>availableFlags</B></PRE>
<DL>
<DL>
</DL>
</DL>
<HR>
<A NAME="permanentFlags"><!-- --></A><H3>
permanentFlags</H3>
<PRE>
protected <A HREF="../../../../javax/mail/Flags.html" title="class in javax.mail">Flags</A> <B>permanentFlags</B></PRE>
<DL>
<DL>
</DL>
</DL>
<HR>
<A NAME="exists"><!-- --></A><H3>
exists</H3>
<PRE>
protected boolean <B>exists</B></PRE>
<DL>
<DL>
</DL>
</DL>
<HR>
<A NAME="isNamespace"><!-- --></A><H3>
isNamespace</H3>
<PRE>
protected boolean <B>isNamespace</B></PRE>
<DL>
<DL>
</DL>
</DL>
<HR>
<A NAME="attributes"><!-- --></A><H3>
attributes</H3>
<PRE>
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>
<DL>
<DL>
</DL>
</DL>
<HR>
<A NAME="protocol"><!-- --></A><H3>
protocol</H3>
<PRE>
protected com.sun.mail.imap.protocol.IMAPProtocol <B>protocol</B></PRE>
<DL>
<DL>
</DL>
</DL>
<HR>
<A NAME="messageCache"><!-- --></A><H3>
messageCache</H3>
<PRE>
protected com.sun.mail.imap.MessageCache <B>messageCache</B></PRE>
<DL>
<DL>
</DL>
</DL>
<HR>
<A NAME="messageCacheLock"><!-- --></A><H3>
messageCacheLock</H3>
<PRE>
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>
<DL>
<DL>
</DL>
</DL>
<HR>
<A NAME="uidTable"><!-- --></A><H3>
uidTable</H3>
<PRE>
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>
<DL>
<DL>
</DL>
</DL>
<HR>
<A NAME="UNKNOWN_SEPARATOR"><!-- --></A><H3>
UNKNOWN_SEPARATOR</H3>
<PRE>
protected static final char <B>UNKNOWN_SEPARATOR</B></PRE>
<DL>
<DL>
<DT><B>See Also:</B><DD><A HREF="../../../../constant-values.html#com.sun.mail.imap.IMAPFolder.UNKNOWN_SEPARATOR">Constant Field Values</A></DL>
</DL>
<!-- ========= CONSTRUCTOR DETAIL ======== -->
<A NAME="constructor_detail"><!-- --></A>
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
<TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2">
<B>Constructor Detail</B></FONT></TH>
</TR>
</TABLE>
<A NAME="IMAPFolder(java.lang.String, char, com.sun.mail.imap.IMAPStore)"><!-- --></A><H3>
IMAPFolder</H3>
<PRE>
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> fullName,
char separator,
<A HREF="../../../../com/sun/mail/imap/IMAPStore.html" title="class in com.sun.mail.imap">IMAPStore</A> store)</PRE>
<DL>
<DD>Constructor used to create a possibly non-existent folder.
<P>
<DL>
<DT><B>Parameters:</B><DD><CODE>fullName</CODE> - fullname of this folder<DD><CODE>separator</CODE> - the default separator character for this
<
A NAME="IMAPFolder(java.lang.String, char, com.sun.mail.imap.IMAPStore, boolean)"><!-- --><
/A><
H3>
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> fullName,
char separator,
<
A HREF="../../../../com/sun/mail/imap/IMAPStore.html" title="class in com.sun.mail.imap">IMAPStore<
/A> store,
boolean isNamespace
)<
/PRE>
<
DD>Constructor used to create a possibly non-existent folder.
<
DT><
B>Parameters:<
/B><
DD><
CODE>fullName<
/CODE> - fullname of this folder<
DD><
CODE>separator<
/CODE> - the default separator character
for this
folder's namespace<DD><CODE>store</CODE> - the Store</DL>
</DL>
<HR>
<A NAME="IMAPFolder(com.sun.mail.imap.protocol.ListInfo, com.sun.mail.imap.IMAPStore)"><!-- --></A><H3>
IMAPFolder</H3>
<PRE>
protected <B>IMAPFolder</B>(com.sun.mail.imap.protocol.ListInfo li,
<A HREF="../../../../com/sun/mail/imap/IMAPStore.html" title="class in com.sun.mail.imap">IMAPStore</A> store)</PRE>
<DL>
<DD>Constructor used to create an existing folder.
<P>
</DL>
<!-- ============ METHOD DETAIL ========== -->
<A NAME="method_detail"><!-- --></A>
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
<TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2">
<B>Method Detail</B></FONT></TH>
</TR>
</TABLE>
<A NAME="getName()"><!-- --></A><H3>
getName</H3>
<PRE>
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>
<DL>
<DD>Get the name of this folder.
<P>
<DD><DL>
<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>
</DD>
<DD><DL>
<DT><B>Returns:</B><DD>name of the Folder</DL>
</DD>
</DL>
<HR>
<A NAME="getFullName()"><!-- --></A><H3>
getFullName</H3>
<PRE>
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>
<DL>
<DD>Get the fullname of this folder.
<P>
<DD><DL>
<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>
</DD>
<DD><DL>
<DT><B>Returns:</B><DD>full name of the Folder</DL>
</DD>
</DL>
<HR>
<A NAME="getParent()"><!-- --></A><H3>
getParent</H3>
<PRE>
public <A HREF="../../../../javax/mail/Folder.html" title="class in javax.mail">Folder</A> <B>getParent</B>()
throws <A HREF="../../../../javax/mail/MessagingException.html" title="class in javax.mail">MessagingException</A></PRE>
<DL>
<DD>Get this folder's parent.
<
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>
<
DT><
B>Returns:<
/B><
DD>Parent folder
<
DD><
CODE><
A HREF="../../../../javax/mail/MessagingException.html" title="class in javax.mail">MessagingException<
/A><
/CODE><
/DL>
<
A NAME="exists()"><!-- --><
/A><
H3>
public boolean <
B>exists<
/B>
()
throws <
A HREF="../../../../javax/mail/MessagingException.html" title="class in javax.mail">MessagingException<
/A><
/PRE>
<
DD>Check whether this folder really exists on the server.
<
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>
<
DT><
B>Returns:<
/B><
DD>true if the folder exists, otherwise false
<
DD><
CODE><
A HREF="../../../../javax/mail/MessagingException.html" title="class in javax.mail">MessagingException<
/A><
/CODE> - typically if the connection
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>
<
A NAME="list(java.lang.String)"><!-- --><
/A><
H3>
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> pattern
)
throws <
A HREF="../../../../javax/mail/MessagingException.html" title="class in javax.mail">MessagingException<
/A><
/PRE>
<
DD>List all subfolders matching the specified pattern.
<
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>
<
DT><
B>Returns:<
/B><
DD>array of matching Folder objects. An empty
array is returned if no matching Folders exist.
<
DD><
CODE><
A HREF="../../../../javax/mail/FolderNotFoundException.html" title="class in javax.mail">FolderNotFoundException<
/A><
/CODE> - if this folder does
not exist.
<
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>
<
A NAME="listSubscribed(java.lang.String)"><!-- --><
/A><
H3>
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> pattern
)
throws <
A HREF="../../../../javax/mail/MessagingException.html" title="class in javax.mail">MessagingException<
/A><
/PRE>
<
DD>List all subscribed subfolders matching the specified pattern.
<
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>
<
DT><
B>Returns:<
/B><
DD>array of matching subscribed Folder objects. An
empty array is returned if no matching
subscribed folders exist.
<
DD><
CODE><
A HREF="../../../../javax/mail/FolderNotFoundException.html" title="class in javax.mail">FolderNotFoundException<
/A><
/CODE> - if this folder does
not exist.
<
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>
<
A NAME="getSeparator()"><!-- --><
/A><
H3>
public
char <
B>getSeparator<
/B>
()
throws <
A HREF="../../../../javax/mail/MessagingException.html" title="class in javax.mail">MessagingException<
/A><
/PRE>
<
DD>Get the separator character.
<
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>
<
DT><
B>Returns:<
/B><
DD>Hierarchy separator character
<
DD><
CODE><
A HREF="../../../../javax/mail/FolderNotFoundException.html" title="class in javax.mail">FolderNotFoundException<
/A><
/CODE> - if the implementation
requires the folder to exist, but it does not
<
DD><
CODE><
A HREF="../../../../javax/mail/MessagingException.html" title="class in javax.mail">MessagingException<
/A><
/CODE><
/DL>
<
A NAME="getType()"><!-- --><
/A><
H3>
public int <
B>getType<
/B>
()
throws <
A HREF="../../../../javax/mail/MessagingException.html" title="class in javax.mail">MessagingException<
/A><
/PRE>
<
DD>Get the
type of this folder.
<
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>
<
DT><
B>Returns:<
/B><
DD>integer with appropriate bits set
<
DD><
CODE><
A HREF="../../../../javax/mail/FolderNotFoundException.html" title="class in javax.mail">FolderNotFoundException<
/A><
/CODE> - if this folder does
not exist.
<
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>,
<
A HREF="../../../../javax/mail/Folder.html#HOLDS_MESSAGES"><
CODE>Folder.HOLDS_MESSAGES<
/CODE><
/A><
/DL>
<
A NAME="isSubscribed()"><!-- --><
/A><
H3>
public boolean <
B>isSubscribed<
/B>
()<
/PRE>
<
DD>Check whether this folder is subscribed. <
p>
<
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>
<
DT><
B>Returns:<
/B><
DD>true if this Folder is subscribed<
/DL>
<
A NAME="setSubscribed(boolean)"><!-- --><
/A><
H3>
public void <
B>setSubscribed<
/B>
(boolean subscribe
)
throws <
A HREF="../../../../javax/mail/MessagingException.html" title="class in javax.mail">MessagingException<
/A><
/PRE>
<
DD>Subscribe
/Unsubscribe this folder.
<
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>
<
DT><
B>Parameters:<
/B><
DD><
CODE>subscribe<
/CODE> - true to subscribe, false to unsubscribe
<
DD><
CODE><
A HREF="../../../../javax/mail/FolderNotFoundException.html" title="class in javax.mail">FolderNotFoundException<
/A><
/CODE> - if this folder does
not exist.
<
DD><
CODE><
A HREF="../../../../javax/mail/MethodNotSupportedException.html" title="class in javax.mail">MethodNotSupportedException<
/A><
/CODE> - if this store
does not support subscription
<
DD><
CODE><
A HREF="../../../../javax/mail/MessagingException.html" title="class in javax.mail">MessagingException<
/A><
/CODE><
/DL>
<
A NAME="create(int)"><!-- --><
/A><
H3>
public boolean <
B>create<
/B>
(int
type)
throws <
A HREF="../../../../javax/mail/MessagingException.html" title="class in javax.mail">MessagingException<
/A><
/PRE>
<
DD>Create this folder, with the specified
type.
<
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>
<
DT><
B>Parameters:<
/B><
DD><
CODE>type<
/CODE> - The
type of this folder.
<
DT><
B>Returns:<
/B><
DD>true if the creation succeeds, else false.
<
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>,
<
A HREF="../../../../javax/mail/Folder.html#HOLDS_MESSAGES"><
CODE>Folder.HOLDS_MESSAGES<
/CODE><
/A>,
<
A HREF="../../../../javax/mail/event/FolderEvent.html" title="class in javax.mail.event"><
CODE>FolderEvent<
/CODE><
/A><
/DL>
<
A NAME="hasNewMessages()"><!-- --><
/A><
H3>
public boolean <
B>hasNewMessages<
/B>
()
throws <
A HREF="../../../../javax/mail/MessagingException.html" title="class in javax.mail">MessagingException<
/A><
/PRE>
<
DD>Check whether this folder has new messages.
<
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>
<
DT><
B>Returns:<
/B><
DD>true if the Store has new Messages
<
DD><
CODE><
A HREF="../../../../javax/mail/FolderNotFoundException.html" title="class in javax.mail">FolderNotFoundException<
/A><
/CODE> - if this folder does
not exist.
<
DD><
CODE><
A HREF="../../../../javax/mail/MessagingException.html" title="class in javax.mail">MessagingException<
/A><
/CODE><
/DL>
<
A NAME="getFolder(java.lang.String)"><!-- --><
/A><
H3>
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>
name)
throws <
A HREF="../../../../javax/mail/MessagingException.html" title="class in javax.mail">MessagingException<
/A><
/PRE>
<
DD>Get the named subfolder. <
p>
<
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>
<
DT><
B>Returns:<
/B><
DD>Folder
object
<
DD><
CODE><
A HREF="../../../../javax/mail/MessagingException.html" title="class in javax.mail">MessagingException<
/A><
/CODE><
/DL>
<
A NAME="delete(boolean)"><!-- --><
/A><
H3>
public boolean <
B>delete<
/B>
(boolean recurse
)
throws <
A HREF="../../../../javax/mail/MessagingException.html" title="class in javax.mail">MessagingException<
/A><
/PRE>
<
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>
<
DT><
B>Returns:<
/B><
DD>true if the Folder is deleted successfully
<
DD><
CODE><
A HREF="../../../../javax/mail/FolderNotFoundException.html" title="class in javax.mail">FolderNotFoundException<
/A><
/CODE> - if this folder does
not exist
<
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>
<
A NAME="renameTo(javax.mail.Folder)"><!-- --><
/A><
H3>
public boolean <
B>renameTo<
/B>
(<
A HREF="../../../../javax/mail/Folder.html" title="class in javax.mail">Folder<
/A> f
)
throws <
A HREF="../../../../javax/mail/MessagingException.html" title="class in javax.mail">MessagingException<
/A><
/PRE>
<
DD>Rename this folder. <
p>
<
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>
<
DT><
B>Parameters:<
/B><
DD><
CODE>f<
/CODE> - a folder representing the new
name for this Folder
<
DT><
B>Returns:<
/B><
DD>true if the Folder is renamed successfully
<
DD><
CODE><
A HREF="../../../../javax/mail/FolderNotFoundException.html" title="class in javax.mail">FolderNotFoundException<
/A><
/CODE> - if this folder does
not exist
<
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>
<
A NAME="open(int)"><!-- --><
/A><
H3>
public void <
B>open<
/B>
(int mode
)
throws <
A HREF="../../../../javax/mail/MessagingException.html" title="class in javax.mail">MessagingException<
/A><
/PRE>
<
DD>Open this folder in the given mode.
<
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>
<
DT><
B>Parameters:<
/B><
DD><
CODE>mode<
/CODE> - open the Folder READ_ONLY or READ_WRITE
<
DD><
CODE><
A HREF="../../../../javax/mail/FolderNotFoundException.html" title="class in javax.mail">FolderNotFoundException<
/A><
/CODE> - if this folder does
not exist.
<
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>,
<
A HREF="../../../../javax/mail/Folder.html#READ_WRITE"><
CODE>Folder.READ_WRITE<
/CODE><
/A>,
<
A HREF="../../../../javax/mail/Folder.html#getType()"><
CODE>Folder.getType
()<
/CODE><
/A>,
<
A HREF="../../../../javax/mail/event/ConnectionEvent.html" title="class in javax.mail.event"><
CODE>ConnectionEvent<
/CODE><
/A><
/DL>
<
A NAME="fetch(javax.mail.Message[], javax.mail.FetchProfile)"><!-- --><
/A><
H3>
public void <
B>fetch<
/B>
(<
A HREF="../../../../javax/mail/Message.html" title="class in javax.mail">Message<
/A>
[] msgs,
<
A HREF="../../../../javax/mail/FetchProfile.html" title="class in javax.mail">FetchProfile<
/A> fp
)
throws <
A HREF="../../../../javax/mail/MessagingException.html" title="class in javax.mail">MessagingException<
/A><
/PRE>
<
DD>Prefetch attributes, based on the given FetchProfile.
<
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>
<
DD><
CODE><
A HREF="../../../../javax/mail/MessagingException.html" title="class in javax.mail">MessagingException<
/A><
/CODE><
/DL>
<
A NAME="setFlags(javax.mail.Message[], javax.mail.Flags, boolean)"><!-- --><
/A><
H3>
public void <
B>setFlags<
/B>
(<
A HREF="../../../../javax/mail/Message.html" title="class in javax.mail">Message<
/A>
[] msgs,
<
A HREF="../../../../javax/mail/Flags.html" title="class in javax.mail">Flags<
/A> flag,
boolean value)
throws <
A HREF="../../../../javax/mail/MessagingException.html" title="class in javax.mail">MessagingException<
/A><
/PRE>
<
DD>Set the specified flags
for the given array of messages.
<
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>
<
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
<
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>,
<
A HREF="../../../../javax/mail/event/MessageChangedEvent.html" title="class in javax.mail.event"><
CODE>MessageChangedEvent<
/CODE><
/A><
/DL>
<
A NAME="close(boolean)"><!-- --><
/A><
H3>
public void <
B>close<
/B>
(boolean expunge
)
throws <
A HREF="../../../../javax/mail/MessagingException.html" title="class in javax.mail">MessagingException<
/A><
/PRE>
<
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>
<
DT><
B>Parameters:<
/B><
DD><
CODE>expunge<
/CODE> - expunges all deleted messages if this flag is true
<
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>
<
A NAME="forceClose()"><!-- --><
/A><
H3>
public void <
B>forceClose<
/B>
()
throws <
A HREF="../../../../javax/mail/MessagingException.html" title="class in javax.mail">MessagingException<
/A><
/PRE>
<
DD>Close this folder without waiting
for the server.
<
DD><
CODE><
A HREF="../../../../javax/mail/MessagingException.html" title="class in javax.mail">MessagingException<
/A><
/CODE><
/DL>
<
A NAME="isOpen()"><!-- --><
/A><
H3>
public boolean <
B>isOpen<
/B>
()<
/PRE>
<
DD>Check whether this connection is really open.
<
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>
<
DT><
B>Returns:<
/B><
DD>true if this Folder is in the
'open' state.<
/DL>
<
A NAME="getPermanentFlags()"><!-- --><
/A><
H3>
public <
A HREF="../../../../javax/mail/Flags.html" title="class in javax.mail">Flags<
/A> <
B>getPermanentFlags<
/B>
()<
/PRE>
<
DD>Return the permanent flags supported by the server.
<
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>
<
DT><
B>Returns:<
/B><
DD>permanent flags, or null if not known<
/DL>
<
A NAME="getMessageCount()"><!-- --><
/A><
H3>
public int <
B>getMessageCount<
/B>
()
throws <
A HREF="../../../../javax/mail/MessagingException.html" title="class in javax.mail">MessagingException<
/A><
/PRE>
<
DD>Get the total message count.
<
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>
<
DT><
B>Returns:<
/B><
DD>total number of messages. -
1 may be returned
by certain implementations if this method is
invoked on a closed folder.
<
DD><
CODE><
A HREF="../../../../javax/mail/FolderNotFoundException.html" title="class in javax.mail">FolderNotFoundException<
/A><
/CODE> - if this folder does
not exist.
<
DD><
CODE><
A HREF="../../../../javax/mail/MessagingException.html" title="class in javax.mail">MessagingException<
/A><
/CODE><
/DL>
<
A NAME="getNewMessageCount()"><!-- --><
/A><
H3>
public int <
B>getNewMessageCount<
/B>
()
throws <
A HREF="../../../../javax/mail/MessagingException.html" title="class in javax.mail">MessagingException<
/A><
/PRE>
<
DD>Get the new message count.
<
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>
<
DT><
B>Returns:<
/B><
DD>number of new messages. -
1 may be returned
by certain implementations if this method is
invoked on a closed folder.
<
DD><
CODE><
A HREF="../../../../javax/mail/FolderNotFoundException.html" title="class in javax.mail">FolderNotFoundException<
/A><
/CODE> - if this folder does
not exist.
<
DD><
CODE><
A HREF="../../../../javax/mail/MessagingException.html" title="class in javax.mail">MessagingException<
/A><
/CODE><
/DL>
<
A NAME="getUnreadMessageCount()"><!-- --><
/A><
H3>
getUnreadMessageCount<
/H3>
public int <
B>getUnreadMessageCount<
/B>
()
throws <
A HREF="../../../../javax/mail/MessagingException.html" title="class in javax.mail">MessagingException<
/A><
/PRE>
<
DD>Get the unread message count.
<
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>
<
DT><
B>Returns:<
/B><
DD>total number of unread messages. -
1 may be returned
by certain implementations if this method is
invoked on a closed folder.
<
DD><
CODE><
A HREF="../../../../javax/mail/FolderNotFoundException.html" title="class in javax.mail">FolderNotFoundException<
/A><
/CODE> - if this folder does
not exist.
<
DD><
CODE><
A HREF="../../../../javax/mail/MessagingException.html" title="class in javax.mail">MessagingException<
/A><
/CODE><
/DL>
<
A NAME="getDeletedMessageCount()"><!-- --><
/A><
H3>
getDeletedMessageCount<
/H3>
public int <
B>getDeletedMessageCount<
/B>
()
throws <
A HREF="../../../../javax/mail/MessagingException.html" title="class in javax.mail">MessagingException<
/A><
/PRE>
<
DD>Get the deleted message count.
<
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>
<
DT><
B>Returns:<
/B><
DD>number of deleted messages. -
1 may be returned
by certain implementations if this method is
invoked on a closed folder.
<
DD><
CODE><
A HREF="../../../../javax/mail/FolderNotFoundException.html" title="class in javax.mail">FolderNotFoundException<
/A><
/CODE> - if this folder does
not exist.
<
DD><
CODE><
A HREF="../../../../javax/mail/MessagingException.html" title="class in javax.mail">MessagingException<
/A><
/CODE><
/DL>
<
A NAME="getMessage(int)"><!-- --><
/A><
H3>
public <
A HREF="../../../../javax/mail/Message.html" title="class in javax.mail">Message<
/A> <
B>getMessage<
/B>
(int msgnum
)
throws <
A HREF="../../../../javax/mail/MessagingException.html" title="class in javax.mail">MessagingException<
/A><
/PRE>
<
DD>Get the specified message.
<
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>
<
DT><
B>Returns:<
/B><
DD>the Message
object
<
DD><
CODE><
A HREF="../../../../javax/mail/FolderNotFoundException.html" title="class in javax.mail">FolderNotFoundException<
/A><
/CODE> - if this folder does
not exist.
<
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>,
<
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>
<
A NAME="appendMessages(javax.mail.Message[])"><!-- --><
/A><
H3>
public void <
B>appendMessages<
/B>
(<
A HREF="../../../../javax/mail/Message.html" title="class in javax.mail">Message<
/A>
[] msgs
)
throws <
A HREF="../../../../javax/mail/MessagingException.html" title="class in javax.mail">MessagingException<
/A><
/PRE>
<
DD>Append the given messages into this folder.
<
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>
<
DT><
B>Parameters:<
/B><
DD><
CODE>msgs<
/CODE> - array of Messages to be appended
<
DD><
CODE><
A HREF="../../../../javax/mail/FolderNotFoundException.html" title="class in javax.mail">FolderNotFoundException<
/A><
/CODE> - if this folder does
not exist.
<
DD><
CODE><
A HREF="../../../../javax/mail/MessagingException.html" title="class in javax.mail">MessagingException<
/A><
/CODE> - if the append failed.<
/DL>
<
A NAME="appendUIDMessages(javax.mail.Message[])"><!-- --><
/A><
H3>
public com.sun.mail.imap.AppendUID
[] <
B>appendUIDMessages<
/B>
(<
A HREF="../../../../javax/mail/Message.html" title="class in javax.mail">Message<
/A>
[] msgs
)
throws <
A HREF="../../../../javax/mail/MessagingException.html" title="class in javax.mail">MessagingException<
/A><
/PRE>
<
DD>Append the given messages into this folder.
Return array of AppendUID objects containing
UIDs of these messages in the destination folder.
Each element of the returned array corresponds to
an element of the <
code>msgs<
/code> array. A null
element means the server didn't return UID information
for the appended message. <p>
Depends on the APPENDUID response code defined by the
UIDPLUS extension -
<A HREF="http://www.ietf.org/rfc/rfc2359.txt">RFC 2359</A>.
<P>
<DD><DL>
</DL>
</DD>
<DD><DL>
<DT><B>Throws:</B>
<DD><CODE><A HREF="../../../../javax/mail/MessagingException.html" title="class in javax.mail">MessagingException</A></CODE><DT><B>Since:</B></DT>
<DD>JavaMail 1.4</DD>
</DL>
</DD>
</DL>
<HR>
<A NAME="addMessages(javax.mail.Message[])"><!-- --></A><H3>
addMessages</H3>
<PRE>
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>[] msgs)
throws <A HREF="../../../../javax/mail/MessagingException.html" title="class in javax.mail">MessagingException</A></PRE>
<DL>
<DD>Append the given messages into this folder.
Return array of Message objects representing
the messages in the destination folder. Note
that the folder must be open.
Each element of the returned array corresponds to
an element of the <code>msgs</code> array. A null
element means the server didn't return UID information
for the appended message. <
p>
Depends on the APPENDUID response code defined by the
UIDPLUS extension -
<
A HREF="http://www.ietf.org/rfc/rfc2359.txt">RFC
2359<
/A>.
<
DD><
CODE><
A HREF="../../../../javax/mail/MessagingException.html" title="class in javax.mail">MessagingException<
/A><
/CODE><
DT><
B>Since:<
/B><
/DT>
<
A NAME="copyMessages(javax.mail.Message[], javax.mail.Folder)"><!-- --><
/A><
H3>
public void <
B>copyMessages<
/B>
(<
A HREF="../../../../javax/mail/Message.html" title="class in javax.mail">Message<
/A>
[] msgs,
<
A HREF="../../../../javax/mail/Folder.html" title="class in javax.mail">Folder<
/A> folder
)
throws <
A HREF="../../../../javax/mail/MessagingException.html" title="class in javax.mail">MessagingException<
/A><
/PRE>
<
DD>Copy the specified messages from this folder, to the
specified destination.
<
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>
<
DT><
B>Parameters:<
/B><
DD><
CODE>msgs<
/CODE> - the array of message objects<
DD><
CODE>folder<
/CODE> - the folder to copy the messages to
<
DD><
CODE><
A HREF="../../../../javax/mail/FolderNotFoundException.html" title="class in javax.mail">FolderNotFoundException<
/A><
/CODE> - if the destination
folder does not exist.
<
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>
<
A NAME="expunge()"><!-- --><
/A><
H3>
public <
A HREF="../../../../javax/mail/Message.html" title="class in javax.mail">Message<
/A>
[] <
B>expunge<
/B>
()
throws <
A HREF="../../../../javax/mail/MessagingException.html" title="class in javax.mail">MessagingException<
/A><
/PRE>
<
DD>Expunge all messages marked as DELETED.
<
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>
<
DT><
B>Returns:<
/B><
DD>array of expunged Message objects
<
DD><
CODE><
A HREF="../../../../javax/mail/FolderNotFoundException.html" title="class in javax.mail">FolderNotFoundException<
/A><
/CODE> - if this folder does not
exist
<
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>,
<
A HREF="../../../../javax/mail/event/MessageCountEvent.html" title="class in javax.mail.event"><
CODE>MessageCountEvent<
/CODE><
/A><
/DL>
<
A NAME="expunge(javax.mail.Message[])"><!-- --><
/A><
H3>
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>
[] msgs
)
throws <
A HREF="../../../../javax/mail/MessagingException.html" title="class in javax.mail">MessagingException<
/A><
/PRE>
<
DD>Expunge the indicated messages, which must have been marked as DELETED.
<
DD><
CODE><
A HREF="../../../../javax/mail/MessagingException.html" title="class in javax.mail">MessagingException<
/A><
/CODE><
/DL>
<
A NAME="search(javax.mail.search.SearchTerm)"><!-- --><
/A><
H3>
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> term
)
throws <
A HREF="../../../../javax/mail/MessagingException.html" title="class in javax.mail">MessagingException<
/A><
/PRE>
<
DD>Search whole folder
for messages matching the given term.
<
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>
<
DT><
B>Returns:<
/B><
DD>array of matching messages
<
DD><
CODE><
A HREF="../../../../javax/mail/search/SearchException.html" title="class in javax.mail.search">SearchException<
/A><
/CODE> - if the search
term is too complex for the implementation to handle.
<
DD><
CODE><
A HREF="../../../../javax/mail/FolderNotFoundException.html" title="class in javax.mail">FolderNotFoundException<
/A><
/CODE> - if this folder does
not exist.
<
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>
<
A NAME="search(javax.mail.search.SearchTerm, javax.mail.Message[])"><!-- --><
/A><
H3>
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> term,
<
A HREF="../../../../javax/mail/Message.html" title="class in javax.mail">Message<
/A>
[] msgs
)
throws <
A HREF="../../../../javax/mail/MessagingException.html" title="class in javax.mail">MessagingException<
/A><
/PRE>
<
DD>Search the folder
for messages matching the given term. Returns
array of matching messages. Returns an empty array if no matching
messages are found.
<
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>
<
DT><
B>Returns:<
/B><
DD>array of matching messages
<
DD><
CODE><
A HREF="../../../../javax/mail/search/SearchException.html" title="class in javax.mail.search">SearchException<
/A><
/CODE> - if the search
term is too complex for the implementation to handle.
<
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>
<
A NAME="addMessageCountListener(javax.mail.event.MessageCountListener)"><!-- --><
/A><
H3>
addMessageCountListener<
/H3>
public void <
B>addMessageCountListener<
/B>
(<
A HREF="../../../../javax/mail/event/MessageCountListener.html" title="interface in javax.mail.event">MessageCountListener<
/A> l
)<
/PRE>
<
DD><
B>Description copied from
class: <
CODE><
A HREF="../../../../javax/mail/Folder.html#addMessageCountListener(javax.mail.event.MessageCountListener)">Folder<
/A><
/CODE><
/B><
/DD>
<
DD>Add a listener
for MessageCount events on this Folder. <
p>
The implementation provided here adds this listener
to an internal list of MessageCountListeners.
<
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>
<
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>
<
A NAME="getUIDValidity()"><!-- --><
/A><
H3>
public long <
B>getUIDValidity<
/B>
()
throws <
A HREF="../../../../javax/mail/MessagingException.html" title="class in javax.mail">MessagingException<
/A><
/PRE>
<
DD>Returns the UIDValidity
for this folder.
<
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>
<
DT><
B>Returns:<
/B><
DD>UIDValidity
<
DD><
CODE><
A HREF="../../../../javax/mail/MessagingException.html" title="class in javax.mail">MessagingException<
/A><
/CODE><
/DL>
<
A NAME="getUIDNext()"><!-- --><
/A><
H3>
public long <
B>getUIDNext<
/B>
()
throws <
A HREF="../../../../javax/mail/MessagingException.html" title="class in javax.mail">MessagingException<
/A><
/PRE>
<
DD>Returns the predicted UID that will be assigned to the
next message that is appended to this folder.
If the folder is closed, the STATUS command is used to
retrieve this value. If the folder is open, the value
returned from the SELECT or EXAMINE command is returned.
Note that messages may have been appended to the folder
while it was open and thus this value may be out of
Servers implementing RFC2060 likely won't return this value
when a folder is opened. Servers implementing RFC3501
should return this value when a folder is opened. <p>
<P>
<DD><DL>
</DL>
</DD>
<DD><DL>
<DT><B>Returns:</B><DD>the UIDNEXT value, or -1 if unknown
<DT><B>Throws:</B>
<DD><CODE><A HREF="../../../../javax/mail/MessagingException.html" title="class in javax.mail">MessagingException</A></CODE><DT><B>Since:</B></DT>
<DD>JavaMail 1.3.3</DD>
</DL>
</DD>
</DL>
<HR>
<A NAME="getMessageByUID(long)"><!-- --></A><H3>
getMessageByUID</H3>
<PRE>
public <A HREF="../../../../javax/mail/Message.html" title="class in javax.mail">Message</A> <B>getMessageByUID</B>(long uid)
throws <A HREF="../../../../javax/mail/MessagingException.html" title="class in javax.mail">MessagingException</A></PRE>
<DL>
<DD>Get the Message corresponding to the given UID.
If no such message exists, <code> null </code> is returned.
<P>
<DD><DL>
<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>
</DD>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>uid</CODE> - UID for the desired message
<DT><B>Returns:</B><DD>the Message object. <code>null</code> is returned
if no message corresponding to this UID is obtained.
<DT><B>Throws:</B>
<DD><CODE><A HREF="../../../../javax/mail/MessagingException.html" title="class in javax.mail">MessagingException</A></CODE></DL>
</DD>
</DL>
<HR>
<A NAME="getMessagesByUID(long, long)"><!-- --></A><H3>
getMessagesByUID</H3>
<PRE>
public <A HREF="../../../../javax/mail/Message.html" title="class in javax.mail">Message</A>[] <B>getMessagesByUID</B>(long start,
long end)
throws <A HREF="../../../../javax/mail/MessagingException.html" title="class in javax.mail">MessagingException</A></PRE>
<DL>
<DD>Get the Messages specified by the given range. <p>
Returns Message objects for all valid messages in this range.
Returns an empty array if no messages are found.
<P>
<DD><DL>
<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>
</DD>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>start</CODE> - start UID<DD><CODE>end</CODE> - end UID
<DT><B>Returns:</B><DD>array of Message objects
<DT><B>Throws:</B>
<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>
</DD>
</DL>
<HR>
<A NAME="getMessagesByUID(long[])"><!-- --></A><H3>
getMessagesByUID</H3>
<PRE>
public <A HREF="../../../../javax/mail/Message.html" title="class in javax.mail">Message</A>[] <B>getMessagesByUID</B>(long[] uids)
throws <A HREF="../../../../javax/mail/MessagingException.html" title="class in javax.mail">MessagingException</A></PRE>
<DL>
<DD>Get the Messages specified by the given array. <p>
<code>uids.length()</code> elements are returned.
If any UID in the array is invalid, a <code>null</code> entry
is returned for that element.
<P>
<DD><DL>
<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>
</DD>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>uids</CODE> - array of UIDs
<DT><B>Returns:</B><DD>array of Message objects
<DT><B>Throws:</B>
<DD><CODE><A HREF="../../../../javax/mail/MessagingException.html" title="class in javax.mail">MessagingException</A></CODE></DL>
</DD>
</DL>
<HR>
<A NAME="getUID(javax.mail.Message)"><!-- --></A><H3>
getUID</H3>
<PRE>
public long <B>getUID</B>(<A HREF="../../../../javax/mail/Message.html" title="class in javax.mail">Message</A> message)
throws <A HREF="../../../../javax/mail/MessagingException.html" title="class in javax.mail">MessagingException</A></PRE>
<DL>
<DD>Get the UID for the specified message.
<P>
<DD><DL>
<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>
</DD>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>message</CODE> - Message from this folder
<DT><B>Returns:</B><DD>UID for this message
<DT><B>Throws:</B>
<DD><CODE><A HREF="../../../../javax/mail/MessagingException.html" title="class in javax.mail">MessagingException</A></CODE></DL>
</DD>
</DL>
<HR>
<A NAME="getQuota()"><!-- --></A><H3>
getQuota</H3>
<PRE>
public <A HREF="../../../../javax/mail/Quota.html" title="class in javax.mail">Quota</A>[] <B>getQuota</B>()
throws <A HREF="../../../../javax/mail/MessagingException.html" title="class in javax.mail">MessagingException</A></PRE>
<DL>
<DD>Get the quotas for the quotaroot associated with this
folder. Note that many folders may have the same quotaroot.
Quotas are controlled on the basis of a quotaroot, not
(necessarily) a folder. The relationship between folders
and quotaroots depends on the IMAP server. Some servers
might implement a single quotaroot for all folders owned by
a user. Other servers might implement a separate quotaroot
for each folder. A single folder can even have multiple
quotaroots, perhaps controlling quotas for different
resources.
<P>
<DD><DL>
</DL>
</DD>
<DD><DL>
<DT><B>Returns:</B><DD>array of Quota objects for the quotaroots associated with
this folder
<DT><B>Throws:</B>
<DD><CODE><A HREF="../../../../javax/mail/MessagingException.html" title="class in javax.mail">MessagingException</A></CODE> - if the server doesn't support the
<
A NAME="setQuota(javax.mail.Quota)"><!-- --><
/A><
H3>
public void <
B>setQuota<
/B>
(<
A HREF="../../../../javax/mail/Quota.html" title="class in javax.mail">Quota<
/A> quota
)
throws <
A HREF="../../../../javax/mail/MessagingException.html" title="class in javax.mail">MessagingException<
/A><
/PRE>
<
DD>Set the quotas
for the quotaroot specified in the quota argument.
Typically this will be one of the quotaroots associated with this
folder, as obtained from the <
code>getQuota<
/code>
method, but it
need not be.
<
DD><
CODE><
A HREF="../../../../javax/mail/MessagingException.html" title="class in javax.mail">MessagingException<
/A><
/CODE> - if the server doesn
't support the
QUOTA extension</DL>
</DD>
</DL>
<HR>
<A NAME="getACL()"><!-- --></A><H3>
getACL</H3>
<PRE>
public <A HREF="../../../../com/sun/mail/imap/ACL.html" title="class in com.sun.mail.imap">ACL</A>[] <B>getACL</B>()
throws <A HREF="../../../../javax/mail/MessagingException.html" title="class in javax.mail">MessagingException</A></PRE>
<DL>
<DD>Get the access control list entries for this folder.
<P>
<DD><DL>
</DL>
</DD>
<DD><DL>
<DT><B>Returns:</B><DD>array of access control list entries
<DT><B>Throws:</B>
<DD><CODE><A HREF="../../../../javax/mail/MessagingException.html" title="class in javax.mail">MessagingException</A></CODE> - if the server doesn't support the
<
A NAME="addACL(com.sun.mail.imap.ACL)"><!-- --><
/A><
H3>
public void <
B>addACL<
/B>
(<
A HREF="../../../../com/sun/mail/imap/ACL.html" title="class in com.sun.mail.imap">ACL<
/A> acl
)
throws <
A HREF="../../../../javax/mail/MessagingException.html" title="class in javax.mail">MessagingException<
/A><
/PRE>
<
DD>Add an access control list entry to the access control list
for this folder.
<
DT><
B>Parameters:<
/B><
DD><
CODE>acl<
/CODE> - the access control list entry to add
<
DD><
CODE><
A HREF="../../../../javax/mail/MessagingException.html" title="class in javax.mail">MessagingException<
/A><
/CODE> - if the server doesn
't support the
ACL extension</DL>
</DD>
</DL>
<HR>
<A NAME="removeACL(java.lang.String)"><!-- --></A><H3>
removeACL</H3>
<PRE>
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> name)
throws <A HREF="../../../../javax/mail/MessagingException.html" title="class in javax.mail">MessagingException</A></PRE>
<DL>
<DD>Remove any access control list entry for the given identifier
from the access control list for this folder.
<P>
<DD><DL>
</DL>
</DD>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>name</CODE> - the identifier for which to remove all ACL entries
<DT><B>Throws:</B>
<DD><CODE><A HREF="../../../../javax/mail/MessagingException.html" title="class in javax.mail">MessagingException</A></CODE> - if the server doesn't support the
<
A NAME="addRights(com.sun.mail.imap.ACL)"><!-- --><
/A><
H3>
public void <
B>addRights<
/B>
(<
A HREF="../../../../com/sun/mail/imap/ACL.html" title="class in com.sun.mail.imap">ACL<
/A> acl
)
throws <
A HREF="../../../../javax/mail/MessagingException.html" title="class in javax.mail">MessagingException<
/A><
/PRE>
<
DD>Add the rights specified in the ACL to the entry
for the
identifier specified in the ACL. If an entry for the identifier
doesn't already exist, add one.
<P>
<DD><DL>
</DL>
</DD>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>acl</CODE> - the identifer and rights to add
<DT><B>Throws:</B>
<DD><CODE><A HREF="../../../../javax/mail/MessagingException.html" title="class in javax.mail">MessagingException</A></CODE> - if the server doesn't support the
<
A NAME="removeRights(com.sun.mail.imap.ACL)"><!-- --><
/A><
H3>
public void <
B>removeRights<
/B>
(<
A HREF="../../../../com/sun/mail/imap/ACL.html" title="class in com.sun.mail.imap">ACL<
/A> acl
)
throws <
A HREF="../../../../javax/mail/MessagingException.html" title="class in javax.mail">MessagingException<
/A><
/PRE>
<
DD>Remove the rights specified in the ACL from the entry
for the
identifier specified in the ACL.
<
DT><
B>Parameters:<
/B><
DD><
CODE>acl<
/CODE> - the identifer and rights to remove
<
DD><
CODE><
A HREF="../../../../javax/mail/MessagingException.html" title="class in javax.mail">MessagingException<
/A><
/CODE> - if the server doesn
't support the
ACL extension</DL>
</DD>
</DL>
<HR>
<A NAME="listRights(java.lang.String)"><!-- --></A><H3>
listRights</H3>
<PRE>
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> name)
throws <A HREF="../../../../javax/mail/MessagingException.html" title="class in javax.mail">MessagingException</A></PRE>
<DL>
<DD>Get all the rights that may be allowed to the given identifier.
Rights are grouped per RFC 2086 and each group is returned as an
element of the array. The first element of the array is the set
of rights that are always granted to the identifier. Later
elements are rights that may be optionally granted to the
identifier. <p>
Note that this method lists the rights that it is possible to
assign to the given identifier, <em>not</em> the rights that are
actually granted to the given identifier. For the latter, see
the <code>getACL</code> method.
<P>
<DD><DL>
</DL>
</DD>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>name</CODE> - the identifier to list rights for
<DT><B>Returns:</B><DD>array of Rights objects representing possible
rights for the identifier
<DT><B>Throws:</B>
<DD><CODE><A HREF="../../../../javax/mail/MessagingException.html" title="class in javax.mail">MessagingException</A></CODE> - if the server doesn't support the
<
A NAME="myRights()"><!-- --><
/A><
H3>
public <
A HREF="../../../../com/sun/mail/imap/Rights.html" title="class in com.sun.mail.imap">Rights<
/A> <
B>myRights<
/B>
()
throws <
A HREF="../../../../javax/mail/MessagingException.html" title="class in javax.mail">MessagingException<
/A><
/PRE>
<
DD>Get the rights allowed to the currently authenticated user.
<
DT><
B>Returns:<
/B><
DD>the rights granted to the current user
<
DD><
CODE><
A HREF="../../../../javax/mail/MessagingException.html" title="class in javax.mail">MessagingException<
/A><
/CODE> - if the server doesn
't support the
ACL extension</DL>
</DD>
</DL>
<HR>
<A NAME="getAttributes()"><!-- --></A><H3>
getAttributes</H3>
<PRE>
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>()
throws <A HREF="../../../../javax/mail/MessagingException.html" title="class in javax.mail">MessagingException</A></PRE>
<DL>
<DD>Get the attributes that the IMAP server returns with the
LIST response.
<P>
<DD><DL>
</DL>
</DD>
<DD><DL>
<DT><B>Throws:</B>
<DD><CODE><A HREF="../../../../javax/mail/MessagingException.html" title="class in javax.mail">MessagingException</A></CODE><DT><B>Since:</B></DT>
<DD>JavaMail 1.3.3</DD>
</DL>
</DD>
</DL>
<HR>
<A NAME="idle()"><!-- --></A><H3>
idle</H3>
<PRE>
public void <B>idle</B>()
throws <A HREF="../../../../javax/mail/MessagingException.html" title="class in javax.mail">MessagingException</A></PRE>
<DL>
<DD>Use the IMAP IDLE command (see
<A HREF="http://www.ietf.org/rfc/rfc2177.txt">RFC 2177</A>),
if supported by the server, to enter idle mode so that the server
can send unsolicited notifications of new messages arriving, etc.
without the need for the client to constantly poll the server.
Use an appropriate listener to be notified of new messages or
other events. When another thread (e.g., the listener thread)
needs to issue an IMAP comand for this folder, the idle mode will
be terminated and this method will return. Typically the caller
will invoke this method in a loop. <p>
The mail.imap.minidletime property enforces a minimum delay
before returning from this method, to ensure that other threads
have a chance to issue commands before the caller invokes this
method again. The default delay is 10 milliseconds.
<P>
<DD><DL>
</DL>
</DD>
<DD><DL>
<DT><B>Throws:</B>
<DD><CODE><A HREF="../../../../javax/mail/MessagingException.html" title="class in javax.mail">MessagingException</A></CODE> - if the server doesn't support the
IDLE extension
<
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>
<DD>JavaMail 1.4.1</DD>
</DL>
</DD>
</DL>
<HR>
<A NAME="idle(boolean)"><!-- --></A><H3>
idle</H3>
<PRE>
public void <B>idle</B>(boolean once)
throws <A HREF="../../../../javax/mail/MessagingException.html" title="class in javax.mail">MessagingException</A></PRE>
<DL>
<DD>Like <A HREF="../../../../com/sun/mail/imap/IMAPFolder.html#idle()"><CODE>idle()</CODE></A>, but if <code>once</code> is true, abort the
IDLE command after the first notification, to allow the caller
to process any notification synchronously.
<P>
<DD><DL>
</DL>
</DD>
<DD><DL>
<DT><B>Throws:</B>
<DD><CODE><A HREF="../../../../javax/mail/MessagingException.html" title="class in javax.mail">MessagingException</A></CODE> - if the server doesn't support the
IDLE extension
<
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>
<DD>JavaMail 1.4.3</DD>
</DL>
</DD>
</DL>
<HR>
<A NAME="handleResponse(com.sun.mail.iap.Response)"><!-- --></A><H3>
handleResponse</H3>
<PRE>
public void <B>handleResponse</B>(com.sun.mail.iap.Response r)</PRE>
<DL>
<DD>The response handler. This is the callback routine that is
invoked by the protocol layer.
<P>
<DD><DL>
<DT><B>Specified by:</B><DD><CODE>handleResponse</CODE> in interface <CODE>com.sun.mail.iap.ResponseHandler</CODE></DL>
</DD>
<DD><DL>
</DL>
</DD>
</DL>
<HR>
<A NAME="getStoreProtocol()"><!-- --></A><H3>
getStoreProtocol</H3>
<PRE>
protected com.sun.mail.imap.protocol.IMAPProtocol <B>getStoreProtocol</B>()
throws com.sun.mail.iap.ProtocolException</PRE>
<DL>
<DD>Get this folder's Store's protocol connection.
When acquiring a store protocol object, it is important to
use the following steps:
IMAPProtocol p = null;
try {
p = getStoreProtocol();
// perform the command
} catch (WhateverException ex) {
// handle it
} finally {
releaseStoreProtocol(p);
}
<P>
<DD><DL>
</DL>
</DD>
<DD><DL>
<DT><B>Throws:</B>
<DD><CODE>com.sun.mail.iap.ProtocolException</CODE></DL>
</DD>
</DL>
<HR>
<A NAME="doCommand(com.sun.mail.imap.IMAPFolder.ProtocolCommand)"><!-- --></A><H3>
doCommand</H3>
<PRE>
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> cmd)
throws <A HREF="../../../../javax/mail/MessagingException.html" title="class in javax.mail">MessagingException</A></PRE>
<DL>
<DD>Execute a user-supplied IMAP command. The command is executed
in the appropriate context with the necessary locks held and
using the appropriate <code>IMAPProtocol</code> object. <p>
This method returns whatever the <code>ProtocolCommand</code>
object's <
code>doCommand<
/code>
method returns. If the
it is translated into a <
code>StoreClosedException<
/code> or
<
code>FolderClosedException<
/code> as appropriate. If the
it is translated into a <
code>MessagingException<
/code>. <
p>
The following example shows how to execute the IMAP NOOP command.
Executing more complex IMAP commands requires intimate knowledge
of the <
code>com.sun.mail.iap<
/code> and
<
code>com.sun.mail.imap.protocol<
/code> packages, best acquired by
reading the source
code. <
p>
import com.sun.mail.iap.*;
import com.sun.mail.imap.*;
import com.sun.mail.imap.protocol.*;
...
IMAPFolder f = (IMAPFolder)folder;
Object val = f.doCommand(new IMAPFolder.ProtocolCommand() {
public Object doCommand(IMAPProtocol p)
throws ProtocolException {
p.simpleCommand("NOOP", null);
return null;
}
});
Here's a more complex example showing how to use the proposed
IMAP SORT extension: <p>
<pre><blockquote>
import com.sun.mail.iap.*;
import com.sun.mail.imap.*;
import com.sun.mail.imap.protocol.*;
...
IMAPFolder f = (IMAPFolder)folder;
Object val = f.doCommand(new IMAPFolder.ProtocolCommand() {
public Object doCommand(IMAPProtocol p)
throws ProtocolException {
// Issue command
Argument args = new Argument();
Argument list = new Argument();
list.writeString("SUBJECT");
args.writeArgument(list);
args.writeString("UTF-8");
args.writeString("ALL");
Response[] r = p.command("SORT", args);
Response response = r[r.length-1];
// Grab response
Vector v = new Vector();
if (response.isOK()) { // command succesful
for (int i = 0, len = r.length; i < len; i++) {
if (!(r[i] instanceof IMAPResponse))
continue;
IMAPResponse ir = (IMAPResponse)r[i];
if (ir.keyEquals("SORT")) {
String num;
while ((num = ir.readAtomString()) != null)
System.out.println(num);
r[i] = null;
}
}
}
// dispatch remaining untagged responses
p.notifyResponseHandlers(r);
p.handleResult(response);
return null;
}
});
</pre></blockquote>
<P>
<DD><DL>
</DL>
</DD>
<DD><DL>
<DT><B>Throws:</B>
<DD><CODE><A HREF="../../../../javax/mail/MessagingException.html" title="class in javax.mail">MessagingException</A></CODE></DL>
</DD>
</DL>
<HR>
<A NAME="doOptionalCommand(java.lang.String, com.sun.mail.imap.IMAPFolder.ProtocolCommand)"><!-- --></A><H3>
doOptionalCommand</H3>
<PRE>
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> err,
<A HREF="../../../../com/sun/mail/imap/IMAPFolder.ProtocolCommand.html" title="interface in com.sun.mail.imap">IMAPFolder.ProtocolCommand</A> cmd)
throws <A HREF="../../../../javax/mail/MessagingException.html" title="class in javax.mail">MessagingException</A></PRE>
<DL>
<DD><DL>
</DL>
</DD>
<DD><DL>
<DT><B>Throws:</B>
<DD><CODE><A HREF="../../../../javax/mail/MessagingException.html" title="class in javax.mail">MessagingException</A></CODE></DL>
</DD>
</DL>
<HR>
<A NAME="doCommandIgnoreFailure(com.sun.mail.imap.IMAPFolder.ProtocolCommand)"><!-- --></A><H3>
doCommandIgnoreFailure</H3>
<PRE>
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> cmd)
throws <A HREF="../../../../javax/mail/MessagingException.html" title="class in javax.mail">MessagingException</A></PRE>
<DL>
<DD><DL>
</DL>
</DD>
<DD><DL>
<DT><B>Throws:</B>
<DD><CODE><A HREF="../../../../javax/mail/MessagingException.html" title="class in javax.mail">MessagingException</A></CODE></DL>
</DD>
</DL>
<HR>
<A NAME="doProtocolCommand(com.sun.mail.imap.IMAPFolder.ProtocolCommand)"><!-- --></A><H3>
doProtocolCommand</H3>
<PRE>
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> cmd)
throws com.sun.mail.iap.ProtocolException</PRE>
<DL>
<DD><DL>
</DL>
</DD>
<DD><DL>
<DT><B>Throws:</B>
<DD><CODE>com.sun.mail.iap.ProtocolException</CODE></DL>
</DD>
</DL>
<HR>
<A NAME="releaseStoreProtocol(com.sun.mail.imap.protocol.IMAPProtocol)"><!-- --></A><H3>
releaseStoreProtocol</H3>
<PRE>
protected void <B>releaseStoreProtocol</B>(com.sun.mail.imap.protocol.IMAPProtocol p)</PRE>
<DL>
<DD>Release the store protocol object. If we borrowed a protocol
object from the connection pool, give it back. If we used our
own protocol object, nothing to do.
<P>
<DD><DL>
</DL>
</DD>
<DD><DL>
</DL>
</DD>
</DL>
<!-- ========= END OF CLASS DATA ========= -->
<HR>
<!-- ======= 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="">
<TR>
<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="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A> </TD>
<TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> <FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT> </TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="class-use/IMAPFolder.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>
</TR>
</TABLE>
</TD>
<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
</EM>
</TD>
</TR>
<TR>
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
<A HREF="../../../../com/sun/mail/imap/ACL.html" title="class in com.sun.mail.imap"><B>PREV CLASS</B></A>
<A HREF="../../../../com/sun/mail/imap/IMAPFolder.FetchProfileItem.html" title="class in com.sun.mail.imap"><B>NEXT CLASS</B></A></FONT></TD>
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
<A HREF="../../../../index.html?com/sun/mail/imap/IMAPFolder.html" target="_top"><B>FRAMES</B></A>
<A HREF="IMAPFolder.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>
');
}
//-->
</SCRIPT>
<NOSCRIPT>
<A HREF="../../../../allclasses-noframe.html"><B>All Classes</B></A>
</NOSCRIPT>
</FONT></TD>
</TR>
<TR>
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
SUMMARY: <A HREF="#nested_class_summary">NESTED</A> | <A HREF="#field_summary">FIELD</A> | <A HREF="#constructor_summary">CONSTR</A> | <A HREF="#method_summary">METHOD</A></FONT></TD>
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
DETAIL: <A HREF="#field_detail">FIELD</A> | <A HREF="#constructor_detail">CONSTR</A> | <A HREF="#method_detail">METHOD</A></FONT></TD>
</TR>
</TABLE>
<A NAME="skip-navbar_bottom"></A>
<!-- ======== END OF BOTTOM NAVBAR ======= -->
<HR>
Copyright © 2009 <a href="http://www.sun.com">Sun Microsystems, Inc.</a>. All Rights Reserved.
</BODY>
</HTML>