CapabilityResponse Class Reference

Inheritance diagram for CapabilityResponse:

Detailed Description

CapabilityResponse is a class that represents an IMAP4 CAPABILITY response. The CAPABILITY response is sent in response to a CAPABILITY command. In a CAPABILITY response, the server lists the features (that is, capabilities) that it supports. The CapabilityResponse class provides an interface to access the list of capabilities via the NumItems() and Item() member functions.

See also:: Imap4Client::Capability

Public Member Functions

CapabilityResponse ()

Default constructor.

CapabilityResponse (const CapabilityResponse &other)

Copy constructor.

virtual ~CapabilityResponse ()

Destructor.

CapabilityResponse & operator= (const CapabilityResponse &other)

Assignment operator.

unsigned NumItems () const

Returns number of items in the list of capabilities.

const char * Item (unsigned index) const

Returns item in the list of capabilities at specified position.

void SetParams (const char *s)

Sets parameters for the response.

Constructor & Destructor Documentation

CapabilityResponse ( )

Default constructor.

CapabilityResponse ( const CapabilityResponse & other )

Copy constructor.

Parameters:

other other object to copy

~CapabilityResponse ( ) [virtual]

Destructor.

Member Function Documentation

const char * Item ( unsigned index ) const

Gets the item in the list of capabilities at position index.
Each item is a string that describes one of the features supported by the server. The index parameter should be in the range index < NumItems().

Returns:
string that describes one feature supported by the server

unsigned NumItems ( ) const

Gets the number of items in the list of capabilities.

Returns:
number of items in the capabilities list

CapabilityResponse & operator= ( const CapabilityResponse & other )

Assignment operator.

Parameters:

other other object to copy

Returns:
*this

void SetParams ( const char * s )

Sets parameters for the response.
Only the parser should call this function.

Parameters:

s string that contains unparsed parameters


Public Member Functions
	CapabilityResponse ()
	Default constructor.
	CapabilityResponse (const CapabilityResponse &other)
	Copy constructor.
virtual	~CapabilityResponse ()
	Destructor.
CapabilityResponse &	operator= (const CapabilityResponse &other)
	Assignment operator.
unsigned	NumItems () const
	Returns number of items in the list of capabilities.
const char *	Item (unsigned index) const
	Returns item in the list of capabilities at specified position.
void	SetParams (const char *s)
	Sets parameters for the response.