|
Server : Apache/2.2.2 (Fedora) System : Linux App1.pathumtani.go.th 2.6.20-1.2320.fc5smp #1 SMP Tue Jun 12 19:40:16 EDT 2007 i686 User : apache ( 48) PHP Version : 5.2.9 Disable Function : NONE Directory : /usr/share/javadoc/javamail/javax/mail/ |
Upload File : |
<?xml version="1.0" encoding="US-ASCII"?>
<!DOCTYPE html PUBLIC "-//gnu.org///DTD XHTML 1.1 plus Target 1.0//EN" "../../resources/xhtml11-target10.dtd"><html xmlns="http://www.w3.org/1999/xhtml" lang="en" xml:lang="en"><head><title>UIDFolder (GNU JavaMail API documentation)</title><script src="../../resources/gjdoc.js" type="text/javascript"><!-- this comment required for konqueror 3.2.2 --></script><meta http-equiv="Content-Type" content="text/html; charset=US-ASCII"/><meta name="generator" content="GNU Gjdoc Standard Doclet"/><meta name="keywords" content="javax.mail.UIDFolder class"/><meta name="keywords" content="LASTUID"/><meta name="keywords" content="getUIDValidity()"/><meta name="keywords" content="getMessageByUID()"/><meta name="keywords" content="getMessagesByUID()"/><meta name="keywords" content="getUID()"/><link rel="stylesheet" type="text/css" href="../../resources/gjdochtml-clean-layout.css" title="GNU Clean"/><link rel="stylesheet" type="text/css" href="../../resources/gjdochtml-clean-color1.css" title="GNU Clean"/></head><body class="content class" onload="if(parent.contentPageLoaded)parent.contentPageLoaded(document.title)"><table class="navbar div top"><tr><td class="navbar div top"><div class="navbar div top"><span class="navbar item enabled"><a href="../../overview-summary.html">Overview</a></span> <span class="navbar item enabled"><a href="package-summary.html">Package</a></span> <span class="navbar item active">Class</span> <span class="navbar item enabled"><a href="UIDFolder-uses.html">Use</a></span> <span class="navbar item enabled"><a href="tree.html">Tree</a></span> <span class="navbar item enabled"><a href="../../alphaindex.html">Index</a></span> <span class="navbar item enabled"><a href="../../deprecated.html">Deprecated</a></span> <span class="navbar item enabled"><a href="../../about.html">About</a></span></div></td></tr><tr><td class="navi"><a href="../../javax/mail/Transport.html">Prev Class</a> | <a href="../../javax/mail/UIDFolder.FetchProfileItem.html">Next Class</a></td><td class="navi"><a href="../../index.html" title="Show in a frameset" target="_top">Frames</a> | <a href="UIDFolder.html" title="Show without frames" target="_top">No Frames</a> </td></tr><tr><td class="navi">Summary: <a href="#summary-inner">Nested</a> | <a href="#summary-fields">Field</a> | <a href="#summary-methods">Method</a> | Constr</td><td class="navi">Detail: <a href="#detail-inner">Nested</a> | <a href="#detail-fields">Field</a> | <a href="#detail-methods">Method</a> | Constr</td></tr></table><div class="class title outer"><h3 class="class title-package">javax.mail</h3><h1 class="class title-class">Interface UIDFolder</h1></div><div class="class synopsis outer"><div class="class synopsis declaration"><code>public interface <b class="class synopsis name">UIDFolder</b></code></div></div><hr/><div class="class description"> The UIDFolder interface is implemented by Folders that can support the
"disconnected" mode of operation, by providing unique-ids for messages in
the folder. This interface is based on the IMAP model for supporting
disconnected operation.
<p/>
A Unique identifier (UID) is a positive long value, assigned to each
message in a specific folder. Unique identifiers are assigned in a strictly
ascending fashion in the mailbox. That is, as each message is added to the
mailbox it is assigned a higher UID than the message(s) which were added
previously. Unique identifiers persist across sessions. This permits a
client to resynchronize its state from a previous session with the server.
<p/>
Associated with every mailbox is a unique identifier validity value. If
unique identifiers from an earlier session fail to persist to this session,
the unique identifier validity value must be greater than the one used in
the earlier session.
<p/>
Refer to RFC 2060 http://www.ietf.org/rfc/rfc2060.txt for more information.
</div><div class="taglet"><dl class="tag list"></dl><dt class="tag section header"><b>Version:</b></dt><dd>1.3</dd></dl></div><div class="taglet"><dl class="tag list"><dt class="tag section header"><b>Author:</b></dt><dd class="tag item"><a href="mailto:dog@gnu.org">Chris Burdess</a></dd></dl></div><div class="taglet"></div><div class="taglet"></div><div class="taglet"></div><div class="taglet"></div><div class="taglet"></div><a name="summary-inner" id="summary-inner"/><dl class="table container"><dd><table class="class summary" border="1" width="100%"><tr class="table header"><td colspan="2"><h2 class="table header">Nested Class Summary</h2></td></tr><tr><td class="left" valign="top"><code class="synopsis">static class</code></td><td class="right"><dl class="list"><dt class="synopsis"><code><a href="../../javax/mail/UIDFolder.FetchProfileItem.html">UIDFolder.FetchProfileItem</a></code></dt><dd class="description"> A fetch profile item for fetching UIDs.</dd></dl></td></tr></table></dd></dl><a name="summary-fields" id="summary-fields"/><dl class="table container"><dd><table class="class summary" border="1" width="100%"><tr class="table header"><td colspan="2"><h2 class="table header">Field Summary</h2></td></tr><tr><td class="left" valign="top"><code class="synopsis">static long</code></td><td class="right"><dl class="list"><dt class="synopsis"><code><a href="#LASTUID">LASTUID</a></code></dt><dd class="description"> This is a special value that can be used as the end parameter in
<code>getMessages(start, end)</code>, to denote the last UID
in this folder.</dd></dl></td></tr></table></dd></dl><a name="summary-methods" id="summary-methods"/><dl class="table container"><dd><table class="class summary" border="1" width="100%"><tr class="table header"><td colspan="2"><h2 class="table header">Method Summary</h2></td></tr><tr><td class="left" valign="top"><code class="synopsis"> <a href="../../javax/mail/Message.html" title="Class in javax.mail">Message</a></code></td><td class="right"><dl class="list"><dt class="synopsis"><code><a href="#getMessageByUID(long)">getMessageByUID</a>(long uid)</code></dt><dd class="description"> Get the Message corresponding to the given UID.</dd></dl></td></tr><tr><td class="left" valign="top"><code class="synopsis"> <a href="../../javax/mail/Message.html" title="Class in javax.mail">Message</a>[]</code></td><td class="right"><dl class="list"><dt class="synopsis"><code><a href="#getMessagesByUID(long,long)">getMessagesByUID</a>(long start, long end)</code></dt><dd class="description"> Get the Messages specified by the given range.</dd></dl></td></tr><tr><td class="left" valign="top"><code class="synopsis"> <a href="../../javax/mail/Message.html" title="Class in javax.mail">Message</a>[]</code></td><td class="right"><dl class="list"><dt class="synopsis"><code><a href="#getMessagesByUID(long[])">getMessagesByUID</a>(long[] uids)</code></dt><dd class="description"> Get the Messages specified by the given array of UIDs.</dd></dl></td></tr><tr><td class="left" valign="top"><code class="synopsis"> long</code></td><td class="right"><dl class="list"><dt class="synopsis"><code><a href="#getUID(javax.mail.Message)">getUID</a>(<a href="../../javax/mail/Message.html" title="Class in javax.mail">Message</a> message)</code></dt><dd class="description"> Get the UID for the specified message.</dd></dl></td></tr><tr><td class="left" valign="top"><code class="synopsis"> long</code></td><td class="right"><dl class="list"><dt class="synopsis"><code><a href="#getUIDValidity()">getUIDValidity</a>()</code></dt><dd class="description"> Returns the UIDValidity value associated with this folder.</dd></dl></td></tr></table></dd></dl><a name="detail-fields" id="detail-fields"/><h2 class="section header">Field Details</h2><div class="section"><a name="LASTUID" id="LASTUID"/><div class="member detail outer"><h3 class="member detail name">LASTUID</h3><pre class="member detail synopsis">public static final long LASTUID</pre><blockquote class="member detail name"><div class="member detail description"> This is a special value that can be used as the end parameter in
<code>getMessages(start, end)</code>, to denote the last UID
in this folder.
</div><div class="member detail thrown list"><dl><dt class="member detail thrown header"><b>Field Value:</b></dt><dd class="member detail thrown item">-1L</dd></dl></div><div class="taglet"></div><div class="taglet"></div><div class="taglet"></div><div class="taglet"></div><div class="taglet"></div></blockquote></div></div><a name="detail-methods" id="detail-methods"/><h2 class="section header">Method Details</h2><div class="section"><a name="getMessageByUID(long)" id="getMessageByUID(long)"/><div class="member detail outer"><h3 class="member detail name">getMessageByUID</h3><pre class="member detail synopsis">public <a href="../../javax/mail/Message.html" title="Class in javax.mail">Message</a> getMessageByUID(long uid)
throws <a href="../../javax/mail/MessagingException.html" title="Class in javax.mail">MessagingException</a></pre><blockquote class="member detail name"><div class="member detail description"> Get the Message corresponding to the given UID.
If no such message exists, null is returned.
</div><div class="parameter"><dl><dt class="header"><b>Parameters:</b></dt><dd class="item"><code class="name">uid</code><span class="separator"> - </span><span class="description">UID for the desired message</span></dd></dl></div><div class="taglet"></div><div class="taglet"></div><div class="taglet"></div><div class="taglet"></div><div class="taglet"></div></blockquote></div><hr/><a name="getMessagesByUID(long,long)" id="getMessagesByUID(long,long)"/><div class="member detail outer"><h3 class="member detail name">getMessagesByUID</h3><pre class="member detail synopsis">public <a href="../../javax/mail/Message.html" title="Class in javax.mail">Message</a>[] getMessagesByUID(long start,
long end)
throws <a href="../../javax/mail/MessagingException.html" title="Class in javax.mail">MessagingException</a></pre><blockquote class="member detail name"><div class="member detail description"> Get the Messages specified by the given range.
The special value LASTUID can be used for the end parameter
to indicate the last available UID.
</div><div class="parameter"><dl><dt class="header"><b>Parameters:</b></dt><dd class="item"><code class="name">start</code><span class="separator"> - </span><span class="description">start UID</span></dd><dd class="item"><code class="name">end</code><span class="separator"> - </span><span class="description">end UID</span></dd></dl></div><div class="taglet"></div><div class="taglet"></div><div class="taglet"></div><div class="taglet"></div><div class="taglet"></div></blockquote></div><hr/><a name="getMessagesByUID(long[])" id="getMessagesByUID(long[])"/><div class="member detail outer"><h3 class="member detail name">getMessagesByUID</h3><pre class="member detail synopsis">public <a href="../../javax/mail/Message.html" title="Class in javax.mail">Message</a>[] getMessagesByUID(long[] uids)
throws <a href="../../javax/mail/MessagingException.html" title="Class in javax.mail">MessagingException</a></pre><blockquote class="member detail name"><div class="member detail description"> Get the Messages specified by the given array of UIDs.
If any UID is invalid, null is returned for that entry.
<p/>
Note that the returned array will be of the same size as the specified
array of UIDs, and null entries may be present in the array to indicate
invalid UIDs.
</div><div class="parameter"><dl><dt class="header"><b>Parameters:</b></dt><dd class="item"><code class="name">uids</code><span class="separator"> - </span><span class="description">array of UIDs</span></dd></dl></div><div class="taglet"></div><div class="taglet"></div><div class="taglet"></div><div class="taglet"></div><div class="taglet"></div></blockquote></div><hr/><a name="getUID(javax.mail.Message)" id="getUID(javax.mail.Message)"/><div class="member detail outer"><h3 class="member detail name">getUID</h3><pre class="member detail synopsis">public long getUID(<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><blockquote class="member detail name"><div class="member detail description"> Get the UID for the specified message.
Note that the message must belong to this folder.
Else NoSuchElementException is thrown.
</div><div class="parameter"><dl><dt class="header"><b>Parameters:</b></dt><dd class="item"><code class="name">message</code><span class="separator"> - </span><span class="description">Message from this folder</span></dd></dl></div><div class="member detail return list"><dl><dt class="member detail return header"><b>Returns:</b></dt><dd class="member detail return item">UID for this message</dd></dl></div><div class="taglet"></div><div class="taglet"></div><div class="taglet"></div><div class="taglet"></div><div class="taglet"></div></blockquote></div><hr/><a name="getUIDValidity()" id="getUIDValidity()"/><div class="member detail outer"><h3 class="member detail name">getUIDValidity</h3><pre class="member detail synopsis">public long getUIDValidity()
throws <a href="../../javax/mail/MessagingException.html" title="Class in javax.mail">MessagingException</a></pre><blockquote class="member detail name"><div class="member detail description"> Returns the UIDValidity value associated with this folder.
<p/>
Clients typically compare this value against a UIDValidity value
saved from a previous session to insure that any cached UIDs not stale.
</div><div class="taglet"></div><div class="taglet"></div><div class="taglet"></div><div class="taglet"></div><div class="taglet"></div></blockquote></div></div><p class="navbar bottom spacer"> </p><table class="navbar div bottom"><tr><td><div class="navbar div top"><span class="navbar item enabled"><a href="../../overview-summary.html">Overview</a></span> <span class="navbar item enabled"><a href="package-summary.html">Package</a></span> <span class="navbar item active">Class</span> <span class="navbar item enabled"><a href="UIDFolder-uses.html">Use</a></span> <span class="navbar item enabled"><a href="tree.html">Tree</a></span> <span class="navbar item enabled"><a href="../../alphaindex.html">Index</a></span> <span class="navbar item enabled"><a href="../../deprecated.html">Deprecated</a></span> <span class="navbar item enabled"><a href="../../about.html">About</a></span></div></td></tr></table><hr/>© Copyright 2003, 2004
The Free Software Foundation, All rights reserved</body></html>