IMAPFolder.FetchProfileItem (JavaMail API documentation)

This documentation differs from the official API. Jadeite adds extra features to the API including: variable font sizes, constructions examples, placeholders for classes and methods, and auto-generated “See Also” links. Additionally it is missing some items found in standard Javadoc documentation, including: generics type information, “Deprecated” tags and comments, “See Also” links, along with other minor differences. Please send any questions or feedback to bam@cs.cmu.edu.

Overview

Package

Class

PREV CLASS NEXT CLASS

FRAMES NO FRAMES

SUMMARY: NESTED | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

com.sun.mail.imap
class IMAPFolder.FetchProfileItem

javax.mail.FetchProfile.Item
  com.sun.mail.imap.IMAPFolder.FetchProfileItem

Enclosing class:: IMAPFolder

public static class IMAPFolder.FetchProfileItem
extends FetchProfile.Item

A fetch profile item for fetching headers. This inner class extends the FetchProfile.Item class to add new FetchProfile item types, specific to IMAPFolders.

Field Summary
`static IMAPFolder.FetchProfileItem`	`HEADERS` HEADERS is a fetch profile item that can be included in a `FetchProfile` during a fetch request to a Folder.
`static IMAPFolder.FetchProfileItem`	`SIZE` SIZE is a fetch profile item that can be included in a `FetchProfile` during a fetch request to a Folder.

Fields inherited from class javax.mail.FetchProfile.Item
`CONTENT_INFO, ENVELOPE, FLAGS`

Constructor Summary
`protected`	`IMAPFolder.FetchProfileItem(String name)`

Field Detail

HEADERS

public static final IMAPFolder.FetchProfileItem HEADERS

HEADERS is a fetch profile item that can be included in a FetchProfile during a fetch request to a Folder. This item indicates that the headers for messages in the specified range are desired to be prefetched.

An example of how a client uses this is below:


 	FetchProfile fp = new FetchProfile();
	fp.add(IMAPFolder.FetchProfileItem.HEADERS);
	folder.fetch(msgs, fp);

SIZE

public static final IMAPFolder.FetchProfileItem SIZE

SIZE is a fetch profile item that can be included in a FetchProfile during a fetch request to a Folder. This item indicates that the sizes of the messages in the specified range are desired to be prefetched.

SIZE should move to FetchProfile.Item in JavaMail 1.3.

Constructor Detail