store.html
来自「SUN公司官方J2EE中文帮助文档 应该不错 有兴趣的下来看看 html格式的」· HTML 代码 · 共 577 行 · 第 1/2 页
HTML
577 行
<TABLE BORDER="1" CELLPADDING="3" CELLSPACING="0" WIDTH="100%">
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
<TD COLSPAN=1><FONT SIZE="+2">
<B>Method Detail</B></FONT></TD>
</TR>
</TABLE>
<A NAME="getDefaultFolder()"><!-- --></A><H3>
getDefaultFolder</H3>
<PRE>
public abstract <A HREF="../../javax/mail/Folder.html">Folder</A> <B>getDefaultFolder</B>()
throws <A HREF="../../javax/mail/MessagingException.html">MessagingException</A></PRE>
<DL>
<DD>Returns a Folder object that represents the 'root' of
the default namespace presented to the user by the Store.<DD><DL>
<DT><B>Returns:</B><DD>the root Folder<DT><B>Throws:</B><DD><CODE>java.lang.IllegalStateException</CODE> - if this Store is not connected.</DL>
</DD>
</DL>
<HR>
<A NAME="getFolder(java.lang.String)"><!-- --></A><H3>
getFolder</H3>
<PRE>
public abstract <A HREF="../../javax/mail/Folder.html">Folder</A> <B>getFolder</B>(java.lang.String name)
throws <A HREF="../../javax/mail/MessagingException.html">MessagingException</A></PRE>
<DL>
<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
exists. <p>
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.<DD><DL>
<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<DT><B>Throws:</B><DD><CODE>java.lang.IllegalStateException</CODE> - if this Store is not connected.<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>
</DD>
</DL>
<HR>
<A NAME="getFolder(javax.mail.URLName)"><!-- --></A><H3>
getFolder</H3>
<PRE>
public abstract <A HREF="../../javax/mail/Folder.html">Folder</A> <B>getFolder</B>(<A HREF="../../javax/mail/URLName.html">URLName</A> url)
throws <A HREF="../../javax/mail/MessagingException.html">MessagingException</A></PRE>
<DL>
<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.<DD><DL>
<DT><B>Parameters:</B><DD><CODE>url</CODE> - URLName that denotes a folder<DT><B>Returns:</B><DD>Folder object<DT><B>Throws:</B><DD><CODE>java.lang.IllegalStateException</CODE> - if this Store is not connected.<DT><B>See Also: </B><DD><A HREF="../../javax/mail/URLName.html"><CODE>URLName</CODE></A></DL>
</DD>
</DL>
<HR>
<A NAME="getPersonalNamespaces()"><!-- --></A><H3>
getPersonalNamespaces</H3>
<PRE>
public <A HREF="../../javax/mail/Folder.html">Folder</A>[] <B>getPersonalNamespaces</B>()
throws <A HREF="../../javax/mail/MessagingException.html">MessagingException</A></PRE>
<DL>
<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.<DD><DL>
<DT><B>Returns:</B><DD>array of Folder objects<DT><B>Throws:</B><DD><CODE>java.lang.IllegalStateException</CODE> - if this Store is not connected.<DT><B>Since: </B><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">Folder</A>[] <B>getUserNamespaces</B>(java.lang.String user)
throws <A HREF="../../javax/mail/MessagingException.html">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
mail folders. <p>
This implementation returns an empty array. Subclasses should
override this method to return appropriate information.<DD><DL>
<DT><B>Returns:</B><DD>array of Folder objects<DT><B>Throws:</B><DD><CODE>java.lang.IllegalStateException</CODE> - if this Store is not connected.<DT><B>Since: </B><DD>JavaMail 1.2</DD>
</DL>
</DD>
</DL>
<HR>
<A NAME="getSharedNamespaces()"><!-- --></A><H3>
getSharedNamespaces</H3>
<PRE>
public <A HREF="../../javax/mail/Folder.html">Folder</A>[] <B>getSharedNamespaces</B>()
throws <A HREF="../../javax/mail/MessagingException.html">MessagingException</A></PRE>
<DL>
<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.<DD><DL>
<DT><B>Returns:</B><DD>array of Folder objects<DT><B>Throws:</B><DD><CODE>java.lang.IllegalStateException</CODE> - if this Store is not connected.<DT><B>Since: </B><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">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.<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"><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">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.<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,
java.lang.String 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.</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">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.<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"><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">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.<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">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.<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">Folder</A> oldF,
<A HREF="../../javax/mail/Folder.html">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.<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><DD>JavaMail 1.1</DD>
</DL>
</DD>
</DL>
<!-- ========= END OF CLASS DATA ========= -->
<HR>
<!-- ========== START OF NAVBAR ========== -->
<A NAME="navbar_bottom"><!-- --></A>
<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0">
<TR>
<TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
<A NAME="navbar_bottom_firstrow"><!-- --></A>
<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3">
<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="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-all.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"><B>PREV CLASS</B></A>
<A HREF="../../javax/mail/Transport.html"><B>NEXT CLASS</B></A></FONT></TD>
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
<A HREF="../../index.html" TARGET="_top"><B>FRAMES</B></A>
<A HREF="Store.html" TARGET="_top"><B>NO FRAMES</B></A></FONT></TD>
</TR>
<TR>
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
SUMMARY: INNER | <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>
<!-- =========== END OF NAVBAR =========== -->
<HR>
</BODY>
</HTML>
⌨️ 快捷键说明
复制代码Ctrl + C
搜索代码Ctrl + F
全屏模式F11
增大字号Ctrl + =
减小字号Ctrl + -
显示快捷键?