QuotaRootResponse Class Reference

Inheritance diagram for QuotaRootResponse:

Detailed Description

QuotaRootResponse is a class that represents an IMAP4 QUOTAROOT response.

In order to apply one set of resource limits to multiple mailboxes, the IMAP4 QUOTA extension uses quota roots. For example, an IMAP4 server may allow a user to create many mailboxes (mail folders) and yet limit the total amount of storage available to that user. In that case, all the mailboxes created by that user would have the same quota root.

The QUOTAROOT response reports all the quota roots for a specified mailbox. The client sends a GETQUOTAROOT command with the mailbox name as a parameter, and the server sends a QUOTAROOT response containing the mailbox name and a list of all the quota roots for that mailbox name.

A QuotaRootResponse object contains the information from a single QUOTAROOT response. You may call the member functions in QuotaRootResponse to get the information from the QUOTAROOT response.

See also:

Imap4Client::GetQuota()

Imap4Client::GetQuotaRoot()

QuotaRootResponse

RFC 2087: IMAP4 QUOTA Extension

Public Member Functions

QuotaRootResponse ()

Default constructor.

QuotaRootResponse (const QuotaRootResponse &other)

Copy constructor.

virtual ~QuotaRootResponse ()

Destructor.

QuotaRootResponse & operator= (const QuotaRootResponse &other)

Assignment operator.

const char * MailboxName () const

Gets the name of the mailbox.

unsigned NumQuotaRoots () const

Gets the number of quota roots.

const char * QuotaRootAt (unsigned index) const

Gets the quota root at the specified position.

void ImportData (ListItem *root)

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

Constructor & Destructor Documentation

QuotaRootResponse ( )

Default constructor.

QuotaRootResponse ( const QuotaRootResponse & other )

Copy constructor.

Parameters:

other other object to copy

~QuotaRootResponse ( ) [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 char * MailboxName ( ) const

Gets the name of the mailbox.
This function returns the mailbox name as Unicode characters in the UTF-8 encoding.
Note that the mailbox name in the QUOTAROOT response is encoded with the modified UTF-7 encoding. The Hunny Mail++ library converts the UTF-7 encoding to the UTF-8 encoding.

Returns:
name of the mailbox

unsigned NumQuotaRoots ( ) const

Gets the number of quota roots.

Returns:
number of quota roots

QuotaRootResponse & operator= ( const QuotaRootResponse & other )

Assignment operator.

Parameters:

other other object to copy

Returns:
*this

const char * QuotaRootAt ( unsigned index ) const

Gets the quota root at the specified position.

Returns:
quota root at the specified position


Public Member Functions
	QuotaRootResponse ()
	Default constructor.
	QuotaRootResponse (const QuotaRootResponse &other)
	Copy constructor.
virtual	~QuotaRootResponse ()
	Destructor.
QuotaRootResponse &	operator= (const QuotaRootResponse &other)
	Assignment operator.
const char *	MailboxName () const
	Gets the name of the mailbox.
unsigned	NumQuotaRoots () const
	Gets the number of quota roots.
const char *	QuotaRootAt (unsigned index) const
	Gets the quota root at the specified position.
void	ImportData (ListItem *root)
	Called by the parser to set the data for this object.