public class FetchProfile extends Object
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.
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.
Sample code that illustrates the use of a FetchProfile is given below:
Message[] msgs = folder.getMessages();
FetchProfile fp = new FetchProfile();
fp.add(FetchProfile.Item.ENVELOPE);
fp.add("X-mailer");
folder.fetch(msgs, fp);
Folder.fetch(javax.mail.Message[], javax.mail.FetchProfile) | Modifier and Type | Class and Description |
|---|---|
static class |
FetchProfile.Item
This inner class is the base class of all items that
can be requested in a FetchProfile.
|
| Constructor and Description |
|---|
FetchProfile ()
Create an empty FetchProfile.
|
| Modifier and Type | Method and Description |
|---|---|
void |
add (FetchProfile.Item item)
Add the given special item as one of the attributes to
be prefetched.
|
void |
add (String headerName)
Add the specified header-field to the list of attributes
to be prefetched.
|
boolean |
contains (FetchProfile.Item item)
Returns true if the fetch profile contains given special item.
|
boolean |
contains (String headerName)
Returns true if the fetch profile contains given header name.
|
String[] |
getHeaderNames ()
Get the names of the header-fields set in this profile.
|
FetchProfile.Item[] |
getItems ()
Get the items set in this profile.
|
public FetchProfile()
public void add(FetchProfile.Item item)
item - the special item to be fetchedFetchProfile.Item.ENVELOPE,
FetchProfile.Item.CONTENT_INFO,
FetchProfile.Item.FLAGS public void add(String headerName)
headerName - header to be prefetchedpublic boolean contains(FetchProfile.Item item)
public boolean contains(String headerName)
public FetchProfile.Item[] getItems()
public String[] getHeaderNames()
Copyright © 1996-2015, Oracle and/or its affiliates. All Rights Reserved. Use is subject to license terms.