folder.html

来自「j2ee帮助文档软件设计/软件工程 文件格式」· HTML 代码 · 共 1,396 行 · 第 1/5 页

<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="Folder(javax.mail.Store)"><!-- --></A><H3>
Folder</H3>
<PRE>
protected <B>Folder</B>(<A HREF="../../javax/mail/Store.html" title="class in javax.mail">Store</A>&nbsp;store)</PRE>
<DL>
<DD>Constructor that takes a Store object.
<P>
<DL>
<DT><B>Parameters:</B><DD><CODE>store</CODE> - the Store that holds this folder</DL>
</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 abstract <A HREF="http://java.sun.com/j2se/1.5/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A> <B>getName</B>()</PRE>
<DL>
<DD>Returns the name of this Folder. <p>

 This method can be invoked on a closed Folder.
<P>
<DD><DL>

<DT><B>Returns:</B><DD>name of the Folder</DL>
</DD>
</DL>
<HR>

<A NAME="getFullName()"><!-- --></A><H3>
getFullName</H3>
<PRE>
public abstract <A HREF="http://java.sun.com/j2se/1.5/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A> <B>getFullName</B>()</PRE>
<DL>
<DD>Returns the full name of this Folder. If the folder resides under
 the root hierarchy of this Store, the returned name is relative
 to the root. Otherwise an absolute name, starting with the 
 hierarchy delimiter, is returned. <p>

 This method can be invoked on a closed Folder.
<P>
<DD><DL>

<DT><B>Returns:</B><DD>full name of the Folder</DL>
</DD>
</DL>
<HR>

<A NAME="getURLName()"><!-- --></A><H3>
getURLName</H3>
<PRE>
public <A HREF="../../javax/mail/URLName.html" title="class in javax.mail">URLName</A> <B>getURLName</B>()
                   throws <A HREF="../../javax/mail/MessagingException.html" title="class in javax.mail">MessagingException</A></PRE>
<DL>
<DD>Return a URLName representing this folder.  The returned URLName
 does <em>not</em> include the password used to access the store.
<P>
<DD><DL>

<DT><B>Returns:</B><DD>the URLName representing this folder
<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.1</DD>
<DT><B>See Also:</B><DD><A HREF="../../javax/mail/URLName.html" title="class in javax.mail"><CODE>URLName</CODE></A></DL>
</DD>
</DL>
<HR>

<A NAME="getStore()"><!-- --></A><H3>
getStore</H3>
<PRE>
public <A HREF="../../javax/mail/Store.html" title="class in javax.mail">Store</A> <B>getStore</B>()</PRE>
<DL>
<DD>Returns the Store that owns this Folder object.
 This method can be invoked on a closed Folder.
<P>
<DD><DL>

<DT><B>Returns:</B><DD>the Store</DL>
</DD>
</DL>
<HR>

<A NAME="getParent()"><!-- --></A><H3>
getParent</H3>
<PRE>
public abstract <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>Returns the parent folder of this folder.
 This method can be invoked on a closed Folder. If this folder
 is the top of a folder hierarchy, this method returns null. <p>

 Note that since Folder objects are not cached, invoking this method
 returns a new distinct Folder object.
<P>
<DD><DL>

<DT><B>Returns:</B><DD>Parent folder
<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="exists()"><!-- --></A><H3>
exists</H3>
<PRE>
public abstract boolean <B>exists</B>()
                        throws <A HREF="../../javax/mail/MessagingException.html" title="class in javax.mail">MessagingException</A></PRE>
<DL>
<DD>Tests if this folder physically exists on the Store.
 This method can be invoked on a closed Folder.
<P>
<DD><DL>

<DT><B>Returns:</B><DD>true if the folder exists, otherwise false
<DT><B>Throws:</B>
<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>create(int)</CODE></A></DL>
</DD>
</DL>
<HR>

<A NAME="list(java.lang.String)"><!-- --></A><H3>
list</H3>
<PRE>
public abstract <A HREF="../../javax/mail/Folder.html" title="class in javax.mail">Folder</A>[] <B>list</B>(<A HREF="http://java.sun.com/j2se/1.5/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A>&nbsp;pattern)
                       throws <A HREF="../../javax/mail/MessagingException.html" title="class in javax.mail">MessagingException</A></PRE>
<DL>
<DD>Returns a list of Folders belonging to this Folder's namespace
 that match the specified pattern. Patterns may contain the wildcard
 characters <code>"%"</code>, which matches any character except hierarchy
 delimiters, and <code>"*"</code>, which matches any character. <p>

 As an example, given the folder hierarchy: <pre>
    Personal/
       Finance/
          Stocks
          Bonus
          StockOptions
       Jokes
 </pre>
 <code>list("*")</code> on "Personal" will return the whole 
 hierarchy. <br>
 <code>list("%")</code> on "Personal" will return "Finance" and 
 "Jokes". <br>
 <code>list("Jokes")</code> on "Personal" will return "Jokes".<br>
 <code>list("Stock*")</code> on "Finance" will return "Stocks"
 and "StockOptions". <p>

 Folder objects are not cached by the Store, so invoking this
 method on the same pattern multiple times will return that many
 distinct Folder objects. <p>

 This method can be invoked on a closed Folder.
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>pattern</CODE> - the match pattern
<DT><B>Returns:</B><DD>array of matching Folder objects. An empty
                        array is returned if no matching Folders exist.
<DT><B>Throws:</B>
<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>listSubscribed(java.lang.String)</CODE></A></DL>
</DD>
</DL>
<HR>

<A NAME="listSubscribed(java.lang.String)"><!-- --></A><H3>
listSubscribed</H3>
<PRE>
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.5/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A>&nbsp;pattern)
                        throws <A HREF="../../javax/mail/MessagingException.html" title="class in javax.mail">MessagingException</A></PRE>
<DL>
<DD>Returns a list of subscribed Folders belonging to this Folder's
 namespace that match the specified pattern. If the folder does
 not support subscription, this method should resolve to
 <code>list</code>.
 (The default implementation provided here, does just this).
 The pattern can contain wildcards as for <code>list</code>. <p>

 Note that, at a given level of the folder hierarchy, a particular
 folder may not be subscribed, but folders underneath that folder
 in the folder hierarchy may be subscribed.  In order to allow
 walking the folder hierarchy, such unsubscribed folders may be
 returned, indicating that a folder lower in the hierarchy is
 subscribed.  The <code>isSubscribed</code> method on a folder will
 tell whether any particular folder is actually subscribed. <p>

 Folder objects are not cached by the Store, so invoking this
 method on the same pattern multiple times will return that many
 distinct Folder objects. <p>

 This method can be invoked on a closed Folder.
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>pattern</CODE> - the match pattern
<DT><B>Returns:</B><DD>array of matching subscribed Folder objects. An
                        empty array is returned if no matching
                        subscribed folders exist.
<DT><B>Throws:</B>
<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>list(java.lang.String)</CODE></A></DL>
</DD>
</DL>
<HR>

<A NAME="list()"><!-- --></A><H3>
list</H3>
<PRE>
public <A HREF="../../javax/mail/Folder.html" title="class in javax.mail">Folder</A>[] <B>list</B>()
              throws <A HREF="../../javax/mail/MessagingException.html" title="class in javax.mail">MessagingException</A></PRE>
<DL>
<DD>Convenience method that returns the list of folders under this
 Folder. This method just calls the <code>list(String pattern)</code>
 method with <code>"%"</code> as the match pattern. This method can
 be invoked on a closed Folder.
<P>
<DD><DL>

<DT><B>Returns:</B><DD>array of Folder objects under this Folder. An
                        empty array is returned if no subfolders exist.
<DT><B>Throws:</B>
<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>list(java.lang.String)</CODE></A></DL>
</DD>
</DL>
<HR>

<A NAME="listSubscribed()"><!-- --></A><H3>
listSubscribed</H3>
<PRE>
public <A HREF="../../javax/mail/Folder.html" title="class in javax.mail">Folder</A>[] <B>listSubscribed</B>()
                        throws <A HREF="../../javax/mail/MessagingException.html" title="class in javax.mail">MessagingException</A></PRE>
<DL>
<DD>Convenience method that returns the list of subscribed folders 
 under this Folder. This method just calls the
 <code>listSubscribed(String pattern)</code> method with <code>"%"</code>
 as the match pattern. This method can be invoked on a closed Folder.
<P>
<DD><DL>

<DT><B>Returns:</B><DD>array of subscribed Folder objects under this 
                        Folder. An empty array is returned if no subscribed 
                        subfolders exist.
<DT><B>Throws:</B>
<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>listSubscribed(java.lang.String)</CODE></A></DL>
</DD>
</DL>
<HR>

<A NAME="getSeparator()"><!-- --></A><H3>
getSeparator</H3>
<PRE>
public abstract char <B>getSeparator</B>()
                           throws <A HREF="../../javax/mail/MessagingException.html" title="class in javax.mail">MessagingException</A></PRE>
<DL>
<DD>Return the delimiter character that separates this Folder's pathname