Top Description Fields Constructors Methods

com.sun.mail.imap.protocol

public Class IMAPResponse

Class Inheritance

extends Response

java.lang.Object
com.sun.mail.iap.Response
com.sun.mail.imap.protocol.IMAPResponse

Known Direct Subclasses

com.sun.mail.imap.protocol.FetchResponse

Imports

java.io.*, java.util.*, com.sun.mail.util.ASCIIUtility, com.sun.mail.iap.*

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

Author: John Mani

Field Summary

Modifier and Type	Field and Description
private String	key
private int	number

Inherited from com.sun.mail.iap.Response:: BAD buffer BYE CONTINUATION ex index NO OK pindex size SYNTHETIC tag TAG_MASK TAGGED type TYPE_MASK UNTAGGED utf8

Constructor Summary

Access	Constructor and Description
public	IMAPResponse(Protocol c)
public	IMAPResponse(IMAPResponse the IMAPResponse to copy r) Copy constructor.
public	IMAPResponse(String the response string r) For testing.
public	IMAPResponse(String the response string r, boolean UTF-8 allowed? utf8) For testing.

Method Summary

Modifier and Type	Method and Description
public String	getKey()
public int	getNumber()
private void	init()
public boolean	keyEquals(String k)
public String[]	Returns: the list items as a String array readSimpleList() Read a list of space-separated "flag-extension" sequences and return the list as a array of Strings.

Field Detail

key	back to summary
private String key

number	back to summary
private int number

Constructor Detail

IMAPResponse	back to summary
public IMAPResponse(Protocol c) throws IOException, ProtocolException

IMAPResponse	back to summary
public IMAPResponse(IMAPResponse r) Copy constructor. Parameters r:IMAPResponse the IMAPResponse to copy

IMAPResponse

back to summary

public IMAPResponse(IMAPResponse r)

Copy constructor.

Parameters

r:IMAPResponse: the IMAPResponse to copy

IMAPResponse	back to summary
public IMAPResponse(String r) throws IOException, ProtocolException For testing. Parameters r:String the response string Exceptions IOException: for I/O errors ProtocolException: for protocol failures

IMAPResponse

back to summary

public IMAPResponse(String r) throws IOException, ProtocolException

For testing.

Parameters

r:String: the response string

Exceptions

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

IMAPResponse	back to summary
public IMAPResponse(String r, boolean utf8) throws IOException, ProtocolException For testing. Parameters r:String the response string utf8:boolean UTF-8 allowed? Exceptions IOException: for I/O errors ProtocolException: for protocol failures Since JavaMail 1.6.0

IMAPResponse

back to summary

public IMAPResponse(String r, boolean utf8) throws IOException, ProtocolException

For testing.

Parameters

r:String: the response string
utf8:boolean: UTF-8 allowed?

Exceptions

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

Since

JavaMail 1.6.0

Method Detail

getKey	back to summary
public String getKey()

getNumber	back to summary
public int getNumber()

init	back to summary
private void init() throws IOException, ProtocolException

keyEquals	back to summary
public boolean keyEquals(String k)

readSimpleList	back to summary
public String[] readSimpleList() Read a list of space-separated "flag-extension" sequences and return the list as a array of Strings. An empty list is returned as null. Each item is expected to be an atom, possibly preceeded by a backslash, but we aren't that strict; we just look for strings separated by spaces and terminated by a right paren. We assume items are always ASCII. Returns:String[] the list items as a String array

readSimpleList

back to summary

public String[] readSimpleList()

Read a list of space-separated "flag-extension" sequences and return the list as a array of Strings. An empty list is returned as null. Each item is expected to be an atom, possibly preceeded by a backslash, but we aren't that strict; we just look for strings separated by spaces and terminated by a right paren. We assume items are always ASCII.

Returns:String[]: the list items as a String array