com.sun.mail.imap.protocol

Class FetchResponse

java.lang.Object

com.sun.mail.iap.Response

com.sun.mail.imap.protocol.IMAPResponse

com.sun.mail.imap.protocol.FetchResponse

public class FetchResponse
extends IMAPResponse

This class represents a FETCH response obtained from the input stream of an IMAP server.

Author:

John Mani, Bill Shannon

Field Summary

Fields inherited from class com.sun.mail.iap.Response

BAD, buffer, BYE, CONTINUATION, index, NO, OK, pindex, size, SYNTHETIC, tag, TAG_MASK, TAGGED, type, TYPE_MASK, UNTAGGED

Constructor Summary

Constructors

Constructor and Description
FetchResponse(IMAPResponse r)
FetchResponse(IMAPResponse r, FetchItem[] fitems) Construct a FetchResponse that handles the additional FetchItems.
FetchResponse(Protocol p)

Method Summary

Modifier and Type	Method and Description
Map	getExtensionItems() Return a map of the extension items found in this fetch response.
Item	getItem(Class c)
Item	getItem(int index)
static Item	getItem(Response[] r, int msgno, Class c)
int	getItemCount()

Methods inherited from class com.sun.mail.imap.protocol.IMAPResponse

getKey, getNumber, keyEquals, readSimpleList

Methods inherited from class com.sun.mail.iap.Response

byeResponse, getRest, getTag, getType, isBAD, isBYE, isContinuation, isNO, isOK, isSynthetic, isTagged, isUnTagged, peekByte, readAtom, readAtom, readAtomString, readAtomStringList, readByte, readByteArray, readBytes, readLong, readNumber, readString, readString, readStringList, reset, skip, skipSpaces, skipToken, toString

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

FetchResponse

public FetchResponse(Protocol p)
              throws IOException,
                     ProtocolException

Throws:

IOException

ProtocolException

FetchResponse

public FetchResponse(IMAPResponse r)
              throws IOException,
                     ProtocolException

Throws:

IOException

ProtocolException

FetchResponse

public FetchResponse(IMAPResponse r,
                     FetchItem[] fitems)
              throws IOException,
                     ProtocolException

Construct a FetchResponse that handles the additional FetchItems.

Throws:

IOException

ProtocolException

Since:

JavaMail 1.4.6

Method Detail

getItemCount

public int getItemCount()

getItem

public Item getItem(int index)

getItem

public Item getItem(Class c)

getItem

public static Item getItem(Response[] r,
                           int msgno,
                           Class c)

getExtensionItems

public Map getExtensionItems()

Return a map of the extension items found in this fetch response. The map is indexed by extension item name. Callers should not modify the map.

Since:

JavaMail 1.4.6