JavaMail API 1.6.2 · com.sun.mail.imap.protocol.FetchResponse

Modifier and Type	Field and Description
private Map<String, Object>	extensionItems
private final FetchItem[]	fitems
private static final char[]	HEADER
private Item[]	items
private static final char[]	TEXT

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

Method Summary

Modifier and Type	Method and Description
public Map<String, Object>	Returns: Map of extension items, or null if none getExtensionItems() Return a map of the extension items found in this fetch response.
public Item	getItem(int index)
public <T extends Item> T	getItem(Class<T> c)
public static < the type of fetch item T extends Item> T	Returns: the fetch item getItem(Response[] the responses r, int the message number msgno, Class<T> the class c) Return the first fetch response item of the given class for the given message number.
public int	getItemCount()
public static < the type of fetch items T extends Item> List<T>	Returns: the list of fetch items getItems(Response[] the responses r, int the message number msgno, Class<T> the class c) Return all fetch response items of the given class for the given message number.
private boolean	match(char[] itemName) Does the current buffer match the given item name?
private boolean	match(String itemName) Does the current buffer match the given item name?
private String	next20() Return the next 20 characters in the buffer, for exception messages.
private void	parse() Hides com.sun.mail.iap.Response.parse.
private boolean	parseExtensionItem() If this item is a known extension item, parse it.
private Item	parseItem() Parse the item at the current position in the buffer, skipping over the item if successful.

Inherited from com.sun.mail.imap.protocol.IMAPResponse:: getKey getNumber keyEquals readSimpleList

Field Detail

extensionItems	back to summary
private Map<String, Object> extensionItems

fitems	back to summary
private final FetchItem[] fitems

HEADER	back to summary
private static final char[] HEADER

items	back to summary
private Item[] items

TEXT	back to summary
private static final char[] TEXT

Constructor Detail

FetchResponse	back to summary
public FetchResponse(Protocol p) throws IOException, ProtocolException

FetchResponse	back to summary
public FetchResponse(IMAPResponse r) throws IOException, ProtocolException

FetchResponse	back to summary
public FetchResponse(IMAPResponse r, FetchItem[] fitems) throws IOException, ProtocolException Construct a FetchResponse that handles the additional FetchItems. Parameters r:IMAPResponse the IMAPResponse fitems:FetchItem[] the fetch items Exceptions IOException: for I/O errors ProtocolException: for protocol failures Since JavaMail 1.4.6

FetchResponse

back to summary

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

Construct a FetchResponse that handles the additional FetchItems.

Parameters

r:IMAPResponse: the IMAPResponse
fitems:FetchItem[]: the fetch items

Exceptions

IOException:: for I/O errors
ProtocolException:: for protocol failures

Since

JavaMail 1.4.6

Method Detail

getExtensionItems	back to summary
public Map<String, Object> 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. Returns:Map<String, Object> Map of extension items, or null if none Since JavaMail 1.4.6

getExtensionItems

back to summary

public Map<String, Object> 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.

Returns:Map<String, Object>: Map of extension items, or null if none
Since: JavaMail 1.4.6

getItem	back to summary
public Item getItem(int index)

getItem	back to summary
public <T extends Item> T getItem(Class<T> c)

getItem	back to summary
public static <T extends Item> T getItem(Response[] r, int msgno, Class<T> c) Return the first fetch response item of the given class for the given message number. Parameters <T> the type of fetch item r:Response[] the responses msgno:int the message number c:Class<T> the class Returns:T the fetch item

getItem

back to summary

public static <T extends Item> T getItem(Response[] r, int msgno, Class<T> c)

Return the first fetch response item of the given class for the given message number.

Parameters

<T>: the type of fetch item
r:Response[]: the responses
msgno:int: the message number
c:Class<T>: the class

Returns:T

the fetch item

getItemCount	back to summary
public int getItemCount()

getItems	back to summary
public static <T extends Item> List<T> getItems(Response[] r, int msgno, Class<T> c) Return all fetch response items of the given class for the given message number. Parameters <T> the type of fetch items r:Response[] the responses msgno:int the message number c:Class<T> the class Returns:List<T> the list of fetch items Since JavaMail 1.5.2

getItems

back to summary

public static <T extends Item> List<T> getItems(Response[] r, int msgno, Class<T> c)

Return all fetch response items of the given class for the given message number.

Parameters

<T>: the type of fetch items
r:Response[]: the responses
msgno:int: the message number
c:Class<T>: the class

Returns:List<T>

the list of fetch items

Since

JavaMail 1.5.2

match	back to summary
private boolean match(char[] itemName) Does the current buffer match the given item name? itemName is the name of the IMAP item to compare against. NOTE that itemName must be all uppercase. If the match is successful, the buffer pointer (index) is incremented past the matched item.

match	back to summary
private boolean match(String itemName) Does the current buffer match the given item name? itemName is the name of the IMAP item to compare against. NOTE that itemName must be all uppercase. If the match is successful, the buffer pointer (index) is incremented past the matched item.

next20	back to summary
private String next20() Return the next 20 characters in the buffer, for exception messages.

parse	back to summary
private void parse() throws ParsingException Hides com.sun.mail.iap.Response.parse.

parseExtensionItem	back to summary
private boolean parseExtensionItem() throws ParsingException If this item is a known extension item, parse it.

parseItem	back to summary
private Item parseItem() throws ParsingException Parse the item at the current position in the buffer, skipping over the item if successful. Otherwise, return null and leave the buffer position unmodified. Annotations @SuppressWarnings:empty

parseItem

back to summary

private Item parseItem() throws ParsingException

Parse the item at the current position in the buffer, skipping over the item if successful. Otherwise, return null and leave the buffer position unmodified.

Annotations

@SuppressWarnings:empty

public Class FetchResponse

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail