<!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:38 PST 2009 -->
<
META http-equiv="Content-Type" content="text/html; charset=ISO-8859-1">
Store (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="Store (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/Store.html"><
FONT CLASS="NavBarFont1"><
B>Use<
/B><
/FONT><
/A> <
/TD>
<
TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <
A HREF="package-tree.html"><
FONT CLASS="NavBarFont1"><
B>Tree<
/B><
/FONT><
/A> <
/TD>
<
TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <
A HREF="../../deprecated-list.html"><
FONT CLASS="NavBarFont1"><
B>Deprecated<
/B><
/FONT><
/A> <
/TD>
<
TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <
A HREF="../../index-files/index-1.html"><
FONT CLASS="NavBarFont1"><
B>Index<
/B><
/FONT><
/A> <
/TD>
<
TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <
A HREF="../../help-doc.html"><
FONT CLASS="NavBarFont1"><
B>Help<
/B><
/FONT><
/A> <
/TD>
<
TD ALIGN="right" VALIGN="top" ROWSPAN=3><
EM>
<
TD BGCOLOR="white" CLASS="NavBarCell2"><
FONT SIZE="-2">
<
A HREF="../../javax/mail/Session.html" title="class in javax.mail"><
B>PREV CLASS<
/B><
/A>
<
A HREF="../../javax/mail/StoreClosedException.html" title="class in javax.mail"><
B>NEXT CLASS<
/B><
/A><
/FONT><
/TD>
<
TD BGCOLOR="white" CLASS="NavBarCell2"><
FONT SIZE="-2">
<
A HREF="../../index.html?javax/mail/Store.html" target="_top"><
B>FRAMES<
/B><
/A>
<
A HREF="Store.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: NESTED | <
A HREF="#fields_inherited_from_class_javax.mail.Service">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: FIELD | <
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/Service.html" title="class in javax.mail">javax.mail.Service<
/A>
<
IMG SRC="../../resources/inherit.gif" ALT="extended by "><
B>javax.mail.Store<
/B>
<
DT><
B>Direct Known Subclasses:<
/B> <
DD><
A HREF="../../com/sun/mail/imap/IMAPStore.html" title="class in com.sun.mail.imap">IMAPStore<
/A>, <
A HREF="../../com/sun/mail/pop3/POP3Store.html" title="class in com.sun.mail.pop3">POP3Store<
/A><
/DD>
<
DT><
PRE>public abstract
class <
B>Store<
/B><
DT>extends <
A HREF="../../javax/mail/Service.html" title="class in javax.mail">Service<
/A><
/DL>
An abstract class that models a message store and its
access protocol, for storing and retrieving messages.
Subclasses provide actual implementations. <
p>
class, which provides many common methods for naming stores,
connecting to stores, and listening to connection events.
<
DT><
B>See Also:<
/B><
DD><
A HREF="../../javax/mail/Service.html" title="class in javax.mail"><
CODE>Service<
/CODE><
/A>,
<
A HREF="../../javax/mail/event/ConnectionEvent.html" title="class in javax.mail.event"><
CODE>ConnectionEvent<
/CODE><
/A>,
<
A HREF="../../javax/mail/event/StoreEvent.html" title="class in javax.mail.event"><
CODE>StoreEvent<
/CODE><
/A><
/DL>
<!-- =========== 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">
<
A NAME="fields_inherited_from_class_javax.mail.Service"><!-- --><
/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/Service.html" title="class in javax.mail">Service<
/A><
/B><
/TH>
<
TR BGCOLOR="white" CLASS="TableRowColor">
<
TD><
CODE><
A HREF="../../javax/mail/Service.html#debug">debug<
/A>, <
A HREF="../../javax/mail/Service.html#session">session<
/A>, <
A HREF="../../javax/mail/Service.html#url">url<
/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="../../javax/mail/Store.html#Store(javax.mail.Session, javax.mail.URLName)">Store<
/A><
/B>
(<
A HREF="../../javax/mail/Session.html" title="class in javax.mail">Session<
/A> session,
<
A HREF="../../javax/mail/URLName.html" title="class in javax.mail">URLName<
/A> urlname
)<
/CODE>
Constructor.<
/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="../../javax/mail/Store.html#addFolderListener(javax.mail.event.FolderListener)">addFolderListener<
/A><
/B>
(<
A HREF="../../javax/mail/event/FolderListener.html" title="interface in javax.mail.event">FolderListener<
/A> l
)<
/CODE>
Add a listener for Folder events on any Folder object
obtained from this Store.<
/TD>
<
TR BGCOLOR="white" CLASS="TableRowColor">
<
TD ALIGN="right" VALIGN="top" WIDTH="1%"><
FONT SIZE="-1">
<
TD><
CODE><
B><
A HREF="../../javax/mail/Store.html#addStoreListener(javax.mail.event.StoreListener)">addStoreListener<
/A><
/B>
(<
A HREF="../../javax/mail/event/StoreListener.html" title="interface in javax.mail.event">StoreListener<
/A> l
)<
/CODE>
Add a listener
for StoreEvents on this Store.<
/TD>
<
TR BGCOLOR="white" CLASS="TableRowColor">
<
TD ALIGN="right" VALIGN="top" WIDTH="1%"><
FONT SIZE="-1">
<
CODE>abstract <
A HREF="../../javax/mail/Folder.html" title="class in javax.mail">Folder<
/A><
/CODE><
/FONT><
/TD>
<
TD><
CODE><
B><
A HREF="../../javax/mail/Store.html#getDefaultFolder()">getDefaultFolder<
/A><
/B>
()<
/CODE>
Returns a Folder object that represents the 'root' of
the default namespace presented to the user by the Store.<
/TD>
<
TR BGCOLOR="white" CLASS="TableRowColor">
<
TD ALIGN="right" VALIGN="top" WIDTH="1%"><
FONT SIZE="-1">
<
CODE>abstract <
A HREF="../../javax/mail/Folder.html" title="class in javax.mail">Folder<
/A><
/CODE><
/FONT><
/TD>
<
TD><
CODE><
B><
A HREF="../../javax/mail/Store.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>
Return the Folder
object corresponding to the given
name.<
/TD>
<
TR BGCOLOR="white" CLASS="TableRowColor">
<
TD ALIGN="right" VALIGN="top" WIDTH="1%"><
FONT SIZE="-1">
<
CODE>abstract <
A HREF="../../javax/mail/Folder.html" title="class in javax.mail">Folder<
/A><
/CODE><
/FONT><
/TD>
<
TD><
CODE><
B><
A HREF="../../javax/mail/Store.html#getFolder(javax.mail.URLName)">getFolder<
/A><
/B>
(<
A HREF="../../javax/mail/URLName.html" title="class in javax.mail">URLName<
/A> url
)<
/CODE>
Return a closed Folder object, corresponding to the given
<
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="../../javax/mail/Store.html#getPersonalNamespaces()">getPersonalNamespaces<
/A><
/B>
()<
/CODE>
Return a set of folders representing the <
i>personal<
/i> namespaces
for the current user.<
/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="../../javax/mail/Store.html#getSharedNamespaces()">getSharedNamespaces<
/A><
/B>
()<
/CODE>
Return a set of folders representing the <
i>shared<
/i> namespaces.<
/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="../../javax/mail/Store.html#getUserNamespaces(java.lang.String)">getUserNamespaces<
/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> user
)<
/CODE>
Return a set of folders representing the namespaces for
<
TR BGCOLOR="white" CLASS="TableRowColor">
<
TD ALIGN="right" VALIGN="top" WIDTH="1%"><
FONT SIZE="-1">
<
TD><
CODE><
B><
A HREF="../../javax/mail/Store.html#notifyFolderListeners(int, javax.mail.Folder)">notifyFolderListeners<
/A><
/B>
(int
type,
<
A HREF="../../javax/mail/Folder.html" title="class in javax.mail">Folder<
/A> folder
)<
/CODE>
Notify all FolderListeners.<
/TD>
<
TR BGCOLOR="white" CLASS="TableRowColor">
<
TD ALIGN="right" VALIGN="top" WIDTH="1%"><
FONT SIZE="-1">
<
TD><
CODE><
B><
A HREF="../../javax/mail/Store.html#notifyFolderRenamedListeners(javax.mail.Folder, javax.mail.Folder)">notifyFolderRenamedListeners<
/A><
/B>
(<
A HREF="../../javax/mail/Folder.html" title="class in javax.mail">Folder<
/A> oldF,
<
A HREF="../../javax/mail/Folder.html" title="class in javax.mail">Folder<
/A> newF
)<
/CODE>
Notify all FolderListeners about the renaming of a folder.<
/TD>
<
TR BGCOLOR="white" CLASS="TableRowColor">
<
TD ALIGN="right" VALIGN="top" WIDTH="1%"><
FONT SIZE="-1">
<
TD><
CODE><
B><
A HREF="../../javax/mail/Store.html#notifyStoreListeners(int, java.lang.String)">notifyStoreListeners<
/A><
/B>
(int
type,
<
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> message
)<
/CODE>
Notify all StoreListeners.<
/TD>
<
TR BGCOLOR="white" CLASS="TableRowColor">
<
TD ALIGN="right" VALIGN="top" WIDTH="1%"><
FONT SIZE="-1">
<
TD><
CODE><
B><
A HREF="../../javax/mail/Store.html#removeFolderListener(javax.mail.event.FolderListener)">removeFolderListener<
/A><
/B>
(<
A HREF="../../javax/mail/event/FolderListener.html" title="interface in javax.mail.event">FolderListener<
/A> l
)<
/CODE>
Remove a listener
for Folder events.<
/TD>
<
TR BGCOLOR="white" CLASS="TableRowColor">
<
TD ALIGN="right" VALIGN="top" WIDTH="1%"><
FONT SIZE="-1">
<
TD><
CODE><
B><
A HREF="../../javax/mail/Store.html#removeStoreListener(javax.mail.event.StoreListener)">removeStoreListener<
/A><
/B>
(<
A HREF="../../javax/mail/event/StoreListener.html" title="interface in javax.mail.event">StoreListener<
/A> l
)<
/CODE>
Remove a listener
for Store events.<
/TD>
<
A NAME="methods_inherited_from_class_javax.mail.Service"><!-- --><
/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/Service.html" title="class in javax.mail">Service<
/A><
/B><
/TH>
<
TR BGCOLOR="white" CLASS="TableRowColor">
<
TD><
CODE><
A HREF="../../javax/mail/Service.html#addConnectionListener(javax.mail.event.ConnectionListener)">addConnectionListener<
/A>, <
A HREF="../../javax/mail/Service.html#close()">close<
/A>, <
A HREF="../../javax/mail/Service.html#connect()">connect<
/A>, <
A HREF="../../javax/mail/Service.html#connect(java.lang.String, int, java.lang.String, java.lang.String)">connect<
/A>, <
A HREF="../../javax/mail/Service.html#connect(java.lang.String, java.lang.String)">connect<
/A>, <
A HREF="../../javax/mail/Service.html#connect(java.lang.String, java.lang.String, java.lang.String)">connect<
/A>, <
A HREF="../../javax/mail/Service.html#finalize()">finalize<
/A>, <
A HREF="../../javax/mail/Service.html#getURLName()">getURLName<
/A>, <
A HREF="../../javax/mail/Service.html#isConnected()">isConnected<
/A>, <
A HREF="../../javax/mail/Service.html#notifyConnectionListeners(int)">notifyConnectionListeners<
/A>, <
A HREF="../../javax/mail/Service.html#protocolConnect(java.lang.String, int, java.lang.String, java.lang.String)">protocolConnect<
/A>, <
A HREF="../../javax/mail/Service.html#queueEvent(javax.mail.event.MailEvent, java.util.Vector)">queueEvent<
/A>, <
A HREF="../../javax/mail/Service.html#removeConnectionListener(javax.mail.event.ConnectionListener)">removeConnectionListener<
/A>, <
A HREF="../../javax/mail/Service.html#setConnected(boolean)">setConnected<
/A>, <
A HREF="../../javax/mail/Service.html#setURLName(javax.mail.URLName)">setURLName<
/A>, <
A HREF="../../javax/mail/Service.html#toString()">toString<
/A><
/CODE><
/TD>
<
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 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>
<!-- ========= 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">
<
A NAME="Store(javax.mail.Session, javax.mail.URLName)"><!-- --><
/A><
H3>
protected <
B>Store<
/B>
(<
A HREF="../../javax/mail/Session.html" title="class in javax.mail">Session<
/A> session,
<
A HREF="../../javax/mail/URLName.html" title="class in javax.mail">URLName<
/A> urlname
)<
/PRE>
<
DT><
B>Parameters:<
/B><
DD><
CODE>session<
/CODE> - Session
object for this Store.<
DD><
CODE>urlname<
/CODE> - URLName
object to be used
for this Store<
/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">
<
A NAME="getDefaultFolder()"><!-- --><
/A><
H3>
public abstract <
A HREF="../../javax/mail/Folder.html" title="class in javax.mail">Folder<
/A> <
B>getDefaultFolder<
/B>
()
throws <
A HREF="../../javax/mail/MessagingException.html" title="class in javax.mail">MessagingException<
/A><
/PRE>
<
DD>Returns a Folder
object that represents the
'root' of
the default namespace presented to the user by the Store.
<
DT><
B>Returns:<
/B><
DD>the root Folder
<
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 this Store is not connected.
<
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 abstract <
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>Return the Folder
object corresponding to the given
name. Note
that a Folder object is returned even if the named folder does
not physically exist on the Store. The <
code>exists
()<
/code>
method on the folder object indicates whether this folder really
Folder objects are not cached by the Store, so invoking this
method on the same name multiple times will return that many
distinct Folder objects.
<
DT><
B>Parameters:<
/B><
DD><
CODE>name<
/CODE> - The
name of the Folder. In some Stores,
name can
be an absolute path if it starts with the
hierarchy delimiter. Else it is interpreted
relative to the 'root' of this namespace.
<
DT><
B>Returns:<
/B><
DD>Folder
object
<
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 this Store is not connected.
<
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#exists()"><
CODE>Folder.exists
()<
/CODE><
/A>,
<
A HREF="../../javax/mail/Folder.html#create(int)"><
CODE>Folder.create
(int
)<
/CODE><
/A><
/DL>
<
A NAME="getFolder(javax.mail.URLName)"><!-- --><
/A><
H3>
public abstract <
A HREF="../../javax/mail/Folder.html" title="class in javax.mail">Folder<
/A> <
B>getFolder<
/B>
(<
A HREF="../../javax/mail/URLName.html" title="class in javax.mail">URLName<
/A> url
)
throws <
A HREF="../../javax/mail/MessagingException.html" title="class in javax.mail">MessagingException<
/A><
/PRE>
<
DD>Return a closed Folder
object, corresponding to the given
URLName. The store specified in the given URLName should
refer to this Store
object. <
p>
Implementations of this method may obtain the name of the
actual folder using the <
code>getFile
()<
/code>
method on
URLName, and use that name to create the folder.
<
DT><
B>Parameters:<
/B><
DD><
CODE>url<
/CODE> - URLName that denotes a folder
<
DT><
B>Returns:<
/B><
DD>Folder
object
<
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 this Store is not connected.
<
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/URLName.html" title="class in javax.mail"><
CODE>URLName<
/CODE><
/A><
/DL>
<
A NAME="getPersonalNamespaces()"><!-- --><
/A><
H3>
getPersonalNamespaces<
/H3>
public <
A HREF="../../javax/mail/Folder.html" title="class in javax.mail">Folder<
/A>
[] <
B>getPersonalNamespaces<
/B>
()
throws <
A HREF="../../javax/mail/MessagingException.html" title="class in javax.mail">MessagingException<
/A><
/PRE>
<
DD>Return a set of folders representing the <
i>personal<
/i> namespaces
for the current user. A personal namespace is a set of names that
is considered within the personal scope of the authenticated user.
Typically, only the authenticated user has access to mail folders
in their personal namespace. If an INBOX exists for a user, it
must appear within the user's personal namespace. In the
typical case, there should be only one personal namespace for each
user in each Store. <p>
This implementation returns an array with a single entry containing
the return value of the <code>getDefaultFolder</code> method.
Subclasses should override this method to return appropriate information.
<P>
<DD><DL>
<DT><B>Returns:</B><DD>array of Folder objects
<DT><B>Throws:</B>
<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 this Store is not connected.
<DD><CODE><A HREF="../../javax/mail/MessagingException.html" title="class in javax.mail">MessagingException</A></CODE><DT><B>Since:</B></DT>
<DD>JavaMail 1.2</DD>
</DL>
</DD>
</DL>
<HR>
<A NAME="getUserNamespaces(java.lang.String)"><!-- --></A><H3>
getUserNamespaces</H3>
<PRE>
public <A HREF="../../javax/mail/Folder.html" title="class in javax.mail">Folder</A>[] <B>getUserNamespaces</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> user)
throws <A HREF="../../javax/mail/MessagingException.html" title="class in javax.mail">MessagingException</A></PRE>
<DL>
<DD>Return a set of folders representing the namespaces for
<code>user</code>. The namespaces returned represent the
personal namespaces for the user. To access mail folders in the
other user's namespace, the currently authenticated user must be
explicitly granted access rights. For example, it is common for
a manager to grant to their secretary access rights to their
This implementation returns an empty array. Subclasses should
override this method to return appropriate information.
<
DT><
B>Returns:<
/B><
DD>array of Folder objects
<
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 this Store is not connected.
<
DD><
CODE><
A HREF="../../javax/mail/MessagingException.html" title="class in javax.mail">MessagingException<
/A><
/CODE><
DT><
B>Since:<
/B><
/DT>
<
A NAME="getSharedNamespaces()"><!-- --><
/A><
H3>
public <
A HREF="../../javax/mail/Folder.html" title="class in javax.mail">Folder<
/A>
[] <
B>getSharedNamespaces<
/B>
()
throws <
A HREF="../../javax/mail/MessagingException.html" title="class in javax.mail">MessagingException<
/A><
/PRE>
<
DD>Return a set of folders representing the <
i>shared<
/i> namespaces.
A shared namespace is a namespace that consists of mail folders
that are intended to be shared amongst users and do not exist
within a user's personal namespace. <p>
This implementation returns an empty array. Subclasses should
override this method to return appropriate information.
<P>
<DD><DL>
<DT><B>Returns:</B><DD>array of Folder objects
<DT><B>Throws:</B>
<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 this Store is not connected.
<DD><CODE><A HREF="../../javax/mail/MessagingException.html" title="class in javax.mail">MessagingException</A></CODE><DT><B>Since:</B></DT>
<DD>JavaMail 1.2</DD>
</DL>
</DD>
</DL>
<HR>
<A NAME="addStoreListener(javax.mail.event.StoreListener)"><!-- --></A><H3>
addStoreListener</H3>
<PRE>
public void <B>addStoreListener</B>(<A HREF="../../javax/mail/event/StoreListener.html" title="interface in javax.mail.event">StoreListener</A> l)</PRE>
<DL>
<DD>Add a listener for StoreEvents on this Store. <p>
The default implementation provided here adds this listener
to an internal list of StoreListeners.
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>l</CODE> - the Listener for Store events<DT><B>See Also:</B><DD><A HREF="../../javax/mail/event/StoreEvent.html" title="class in javax.mail.event"><CODE>StoreEvent</CODE></A></DL>
</DD>
</DL>
<HR>
<A NAME="removeStoreListener(javax.mail.event.StoreListener)"><!-- --></A><H3>
removeStoreListener</H3>
<PRE>
public void <B>removeStoreListener</B>(<A HREF="../../javax/mail/event/StoreListener.html" title="interface in javax.mail.event">StoreListener</A> l)</PRE>
<DL>
<DD>Remove a listener for Store events. <p>
The default implementation provided here removes this listener
from the internal list of StoreListeners.
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>l</CODE> - the listener<DT><B>See Also:</B><DD><A HREF="../../javax/mail/Store.html#addStoreListener(javax.mail.event.StoreListener)"><CODE>addStoreListener(javax.mail.event.StoreListener)</CODE></A></DL>
</DD>
</DL>
<HR>
<A NAME="notifyStoreListeners(int, java.lang.String)"><!-- --></A><H3>
notifyStoreListeners</H3>
<PRE>
protected void <B>notifyStoreListeners</B>(int type,
<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> message)</PRE>
<DL>
<DD>Notify all StoreListeners. Store implementations are
expected to use this method to broadcast StoreEvents. <p>
The provided default implementation queues the event into
an internal event queue. An event dispatcher thread dequeues
events from the queue and dispatches them to the registered
StoreListeners. Note that the event dispatching occurs
in a separate thread, thus avoiding potential deadlock problems.
<P>
<DD><DL>
</DL>
</DD>
</DL>
<HR>
<A NAME="addFolderListener(javax.mail.event.FolderListener)"><!-- --></A><H3>
addFolderListener</H3>
<PRE>
public void <B>addFolderListener</B>(<A HREF="../../javax/mail/event/FolderListener.html" title="interface in javax.mail.event">FolderListener</A> l)</PRE>
<DL>
<DD>Add a listener for Folder events on any Folder object
obtained from this Store. FolderEvents are delivered to
FolderListeners on the affected Folder as well as to
FolderListeners on the containing Store. <p>
The default implementation provided here adds this listener
to an internal list of FolderListeners.
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>l</CODE> - the Listener for Folder events<DT><B>See Also:</B><DD><A HREF="../../javax/mail/event/FolderEvent.html" title="class in javax.mail.event"><CODE>FolderEvent</CODE></A></DL>
</DD>
</DL>
<HR>
<A NAME="removeFolderListener(javax.mail.event.FolderListener)"><!-- --></A><H3>
removeFolderListener</H3>
<PRE>
public void <B>removeFolderListener</B>(<A HREF="../../javax/mail/event/FolderListener.html" title="interface in javax.mail.event">FolderListener</A> l)</PRE>
<DL>
<DD>Remove a listener for Folder events. <p>
The default implementation provided here removes this listener
from the internal list of FolderListeners.
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>l</CODE> - the listener<DT><B>See Also:</B><DD><A HREF="../../javax/mail/Store.html#addFolderListener(javax.mail.event.FolderListener)"><CODE>addFolderListener(javax.mail.event.FolderListener)</CODE></A></DL>
</DD>
</DL>
<HR>
<A NAME="notifyFolderListeners(int, javax.mail.Folder)"><!-- --></A><H3>
notifyFolderListeners</H3>
<PRE>
protected void <B>notifyFolderListeners</B>(int type,
<A HREF="../../javax/mail/Folder.html" title="class in javax.mail">Folder</A> folder)</PRE>
<DL>
<DD>Notify all FolderListeners. Store implementations are
expected to use this method to broadcast Folder events. <p>
The provided default implementation queues the event into
an internal event queue. An event dispatcher thread dequeues
events from the queue and dispatches them to the registered
FolderListeners. Note that the event dispatching occurs
in a separate thread, thus avoiding potential deadlock problems.
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>type</CODE> - type of FolderEvent<DD><CODE>folder</CODE> - affected Folder<DT><B>See Also:</B><DD><A HREF="../../javax/mail/Store.html#notifyFolderRenamedListeners(javax.mail.Folder, javax.mail.Folder)"><CODE>notifyFolderRenamedListeners(javax.mail.Folder, javax.mail.Folder)</CODE></A></DL>
</DD>
</DL>
<HR>
<A NAME="notifyFolderRenamedListeners(javax.mail.Folder, javax.mail.Folder)"><!-- --></A><H3>
notifyFolderRenamedListeners</H3>
<PRE>
protected void <B>notifyFolderRenamedListeners</B>(<A HREF="../../javax/mail/Folder.html" title="class in javax.mail">Folder</A> oldF,
<A HREF="../../javax/mail/Folder.html" title="class in javax.mail">Folder</A> newF)</PRE>
<DL>
<DD>Notify all FolderListeners about the renaming of a folder.
Store implementations are expected to use this method to broadcast
Folder events indicating the renaming of folders. <p>
The provided default implementation queues the event into
an internal event queue. An event dispatcher thread dequeues
events from the queue and dispatches them to the registered
FolderListeners. Note that the event dispatching occurs
in a separate thread, thus avoiding potential deadlock problems.
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>oldF</CODE> - the folder being renamed<DD><CODE>newF</CODE> - the folder representing the new name.<DT><B>Since:</B></DT>
<DD>JavaMail 1.1</DD>
</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/Store.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="../../javax/mail/Session.html" title="class in javax.mail"><B>PREV CLASS</B></A>
<A HREF="../../javax/mail/StoreClosedException.html" title="class in javax.mail"><B>NEXT CLASS</B></A></FONT></TD>
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
<A HREF="../../index.html?javax/mail/Store.html" target="_top"><B>FRAMES</B></A>
<A HREF="Store.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: NESTED | <A HREF="#fields_inherited_from_class_javax.mail.Service">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: FIELD | <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>