QuotaResponse Class Reference

Inheritance diagram for QuotaResponse:

Detailed Description

QuotaResponse is a class that represents an IMAP4 QUOTA response.

Some IMAP4 servers support resource quotas, which place limits on resource usage. For example, a server may limit the maximum amount of storage available per account. The IMAP4 QUOTA extension allows an IMAP4 client to discover information about quota limits and resource usage. It also allows administrators to use an IMAP4 client to set quota limits.

An IMAP4 server reports quota information in a QUOTA response. A QUOTA response contains a quota root name and a list that contains information about resource quotas and limits. A QuotaResponse object contains the information from a single QUOTA response. You may call the member functions in QuotaResponse to get the information from the QUOTA response.

See also:

Imap4Client::GetQuota()

Imap4Client::GetQuotaRoot()

QuotaRootResponse

RFC 2087: IMAP4 QUOTA Extension

Public Member Functions

QuotaResponse ()

Default constructor.

QuotaResponse (const QuotaResponse &other)

Copy constructor.

virtual ~QuotaResponse ()

Destructor.

QuotaResponse & operator= (const QuotaResponse &other)

Assignment operator.

const char * QuotaRootName () const

Gets the name of the quota root.

unsigned NumItems () const

Gets the number of quota list items.

const QuotaListItem & ItemAt (unsigned index) const

Gets the quota list item at the specified position.

void ImportData (ListItem *root)

Called by the parser to set the data for this object.

Constructor & Destructor Documentation

QuotaResponse ( )

Default constructor.

QuotaResponse ( const QuotaResponse & other )

Copy constructor.

Parameters:

other QuotaResponse object to copy

~QuotaResponse ( ) [virtual]

Destructor.

Member Function Documentation

void ImportData ( ListItem * root )

Called by the parser to set the data for this object.
Only the parser should call this function.

Parameters:

root root item of parse tree

const QuotaListItem & ItemAt ( unsigned index ) const

Gets the quota list item at the specified position.
The parameter index must satisfy the constraint index < NumItems().

Parameters:

index position of item to get

Returns:
item at the specified position

unsigned NumItems ( ) const

Gets the number of quota list items.

Returns:
number of items in the quota list

QuotaResponse & operator= ( const QuotaResponse & other )

Assignment operator.

Parameters:

other other object to copy

Returns:
*this

const char * QuotaRootName ( ) const

Gets the name of the quota root.
The name of the quota root may be empty.

Returns:
name of the quota root


Public Member Functions
	QuotaResponse ()
	Default constructor.
	QuotaResponse (const QuotaResponse &other)
	Copy constructor.
virtual	~QuotaResponse ()
	Destructor.
QuotaResponse &	operator= (const QuotaResponse &other)
	Assignment operator.
const char *	QuotaRootName () const
	Gets the name of the quota root.
unsigned	NumItems () const
	Gets the number of quota list items.
const QuotaListItem &	ItemAt (unsigned index) const
	Gets the quota list item at the specified position.
void	ImportData (ListItem *root)
	Called by the parser to set the data for this object.