|
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>FetchProfile (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.FetchProfile class"/><meta name="keywords" content="add()"/><meta name="keywords" content="contains()"/><meta name="keywords" content="getItems()"/><meta name="keywords" content="getHeaderNames()"/><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="FetchProfile-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/BodyPart.html">Prev Class</a> | <a href="../../javax/mail/FetchProfile.Item.html">Next Class</a></td><td class="navi"><a href="../../index.html" title="Show in a frameset" target="_top">Frames</a> | <a href="FetchProfile.html" title="Show without frames" target="_top">No Frames</a> </td></tr><tr><td class="navi">Summary: <a href="#summary-inner">Nested</a> | Field | <a href="#summary-methods">Method</a> | <a href="#summary-constructors">Constr</a></td><td class="navi">Detail: <a href="#detail-inner">Nested</a> | Field | <a href="#detail-methods">Method</a> | <a href="#detail-constructors">Constr</a></td></tr></table><div class="class title outer"><h3 class="class title-package">javax.mail</h3><h1 class="class title-class">Class FetchProfile</h1></div><div class="class inheritance-tree"><ul class="inheritance 0"><li class="inheritance 0"><code><a href="file:/usr/share/javadoc/java/java/lang/Object.html">java.lang.Object</a></code></li><li><ul class="inheritance 1"><li class="inheritance 1"><code>javax.mail.FetchProfile</code></li><li></li></ul></li></ul></div><hr/><div class="class synopsis outer"><div class="class synopsis declaration"><code>public class <b class="class synopsis name">FetchProfile</b></code></div><div class="class synopsis superclass"><code>extends <a href="file:/usr/share/javadoc/java/java/lang/Object.html" title="Class in ">Object</a></code></div></div><hr/><div class="class description"> Clients use a FetchProfile to list the Message attributes that it
wishes to prefetch from the server for a range of messages.
<p/>
Messages obtained from a Folder are light-weight objects that typically
start off as empty references to the actual messages. Such a Message
object is filled in "on-demand" when the appropriate get*() methods are
invoked on that particular Message. Certain server-based message access
protocols (Ex: IMAP) allow batch fetching of message attributes for a
range of messages in a single request. Clients that want to use message
attributes for a range of Messages (Example: to display the top-level
headers in a headerlist) might want to use the optimization provided by
such servers. The FetchProfile allows the client to indicate this desire
to the server.
<p/>
Note that implementations are not obligated to support FetchProfiles, since
there might be cases where the backend service does not allow easy,
efficient fetching of such profiles.
<p/>
Sample code that illustrates the use of a FetchProfile is given below:
<pre>
Message[] msgs = folder.getMessages();
FetchProfile fp = new FetchProfile();
fp.add(FetchProfile.Item.ENVELOPE);
fp.add("X-mailer");
folder.fetch(msgs, fp);
</pre>
</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/FetchProfile.Item.html">FetchProfile.Item</a></code></dt><dd class="description"> This inner class is the base class of all items that can be requested
in a FetchProfile.</dd></dl></td></tr></table></dd></dl><a name="summary-constructors" id="summary-constructors"/><dl class="table container"><dd><table class="class summary" border="1" width="100%"><tr class="table header"><td colspan="2"><h2 class="table header">Constructor Summary</h2></td></tr><tr><td class="right"><dl class="list"><dt class="synopsis"><code><a href="#FetchProfile()">FetchProfile</a>()</code></dt><dd class="description"> Create an empty FetchProfile.</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"> void</code></td><td class="right"><dl class="list"><dt class="synopsis"><code><a href="#add(String)">add</a>(String header)</code></dt><dd class="description"> Add the specified header-field to the list of attributes to be prefetched.</dd></dl></td></tr><tr><td class="left" valign="top"><code class="synopsis"> void</code></td><td class="right"><dl class="list"><dt class="synopsis"><code><a href="#add(javax.mail.FetchProfile.Item)">add</a>(<a href="../../javax/mail/FetchProfile.Item.html" title="Class in javax.mail">FetchProfile.Item</a> item)</code></dt><dd class="description"> Add the given special item as one of the attributes to be prefetched.</dd></dl></td></tr><tr><td class="left" valign="top"><code class="synopsis"> boolean</code></td><td class="right"><dl class="list"><dt class="synopsis"><code><a href="#contains(String)">contains</a>(String header)</code></dt><dd class="description"> Returns true if the fetch profile contains the given header name.</dd></dl></td></tr><tr><td class="left" valign="top"><code class="synopsis"> boolean</code></td><td class="right"><dl class="list"><dt class="synopsis"><code><a href="#contains(javax.mail.FetchProfile.Item)">contains</a>(<a href="../../javax/mail/FetchProfile.Item.html" title="Class in javax.mail">FetchProfile.Item</a> item)</code></dt><dd class="description"> Returns true if the fetch profile contains given special item.</dd></dl></td></tr><tr><td class="left" valign="top"><code class="synopsis"> String[]</code></td><td class="right"><dl class="list"><dt class="synopsis"><code><a href="#getHeaderNames()">getHeaderNames</a>()</code></dt><dd class="description"> Get the names of the header-fields set in this profile.</dd></dl></td></tr><tr><td class="left" valign="top"><code class="synopsis"> <a href="../../javax/mail/FetchProfile.Item.html" title="Class in javax.mail">FetchProfile.Item</a>[]</code></td><td class="right"><dl class="list"><dt class="synopsis"><code><a href="#getItems()">getItems</a>()</code></dt><dd class="description"> Get the items set in this profile.</dd></dl></td></tr></table></dd></dl><a name="detail-constructors" id="detail-constructors"/><h2 class="section header">Constructor Details</h2><div class="section"><a name="FetchProfile()" id="FetchProfile()"/><div class="member detail outer"><h3 class="member detail name">FetchProfile</h3><pre class="member detail synopsis">public FetchProfile()</pre><blockquote class="member detail name"><div class="member detail description"> Create an empty FetchProfile.
</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="add(String)" id="add(String)"/><div class="member detail outer"><h3 class="member detail name">add</h3><pre class="member detail synopsis">public void add(String header)</pre><blockquote class="member detail name"><div class="member detail description"> Add the specified header-field to the list of attributes to be prefetched.
</div><div class="parameter"><dl><dt class="header"><b>Parameters:</b></dt><dd class="item"><code class="name">header</code><span class="separator"> - </span><span class="description">the header to be prefetched</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="add(javax.mail.FetchProfile.Item)" id="add(javax.mail.FetchProfile.Item)"/><div class="member detail outer"><h3 class="member detail name">add</h3><pre class="member detail synopsis">public void add(<a href="../../javax/mail/FetchProfile.Item.html" title="Class in javax.mail">FetchProfile.Item</a> item)</pre><blockquote class="member detail name"><div class="member detail description"> Add the given special item as one of the attributes to be prefetched.
</div><div class="parameter"><dl><dt class="header"><b>Parameters:</b></dt><dd class="item"><code class="name">item</code><span class="separator"> - </span><span class="description">the special item to be fetched</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="contains(String)" id="contains(String)"/><div class="member detail outer"><h3 class="member detail name">contains</h3><pre class="member detail synopsis">public boolean contains(String header)</pre><blockquote class="member detail name"><div class="member detail description"> Returns true if the fetch profile contains the given header name.
</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="contains(javax.mail.FetchProfile.Item)" id="contains(javax.mail.FetchProfile.Item)"/><div class="member detail outer"><h3 class="member detail name">contains</h3><pre class="member detail synopsis">public boolean contains(<a href="../../javax/mail/FetchProfile.Item.html" title="Class in javax.mail">FetchProfile.Item</a> item)</pre><blockquote class="member detail name"><div class="member detail description"> Returns true if the fetch profile contains given special item.
</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="getHeaderNames()" id="getHeaderNames()"/><div class="member detail outer"><h3 class="member detail name">getHeaderNames</h3><pre class="member detail synopsis">public String[] getHeaderNames()</pre><blockquote class="member detail name"><div class="member detail description"> Get the names of the header-fields set in this profile.
</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="getItems()" id="getItems()"/><div class="member detail outer"><h3 class="member detail name">getItems</h3><pre class="member detail synopsis">public <a href="../../javax/mail/FetchProfile.Item.html" title="Class in javax.mail">FetchProfile.Item</a>[] getItems()</pre><blockquote class="member detail name"><div class="member detail description"> Get the items set in this profile.
</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="FetchProfile-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>