Main Page | Namespace List | Class Hierarchy | Class List | Namespace Members | Class Members

ContinuationResponse Class Reference

Inheritance diagram for ContinuationResponse:

Response List of all members.

Detailed Description

ContinuationResponse is a class that represents an IMAP4 continuation response.

A continuation response indicates a positive, but non-final, result at the server. A continuation response is sent, for example, to indicate to the client that the server is prepared to receive a literal string.

This class is used internally by the library.


Public Member Functions

 ContinuationResponse ()
 Default constructor.
 ContinuationResponse (const ContinuationResponse &other)
 Copy constructor.
virtual ~ContinuationResponse ()
 Destructor.
ContinuationResponseoperator= (const ContinuationResponse &other)
 Assignment operator.
const char * ResponseCode () const
 Returns the response code.
const char * ResponseText () const
 Returns the response text.
void SetParams (const char *s)
 Sets parameters for the response.


Constructor & Destructor Documentation

ContinuationResponse  ) 
 

Default constructor.

ContinuationResponse const ContinuationResponse other  ) 
 

Copy constructor

Parameters:
other other object to copy

~ContinuationResponse  )  [virtual]
 

Destructor


Member Function Documentation

ContinuationResponse & operator= const ContinuationResponse other  ) 
 

Assignment operator.

Parameters:
other other object to copy
Returns:
*this

const char * ResponseCode  )  const
 

Returns the response code.

Response codes are delimited in the response by square bracket characters ([...]). See the IMAP4 spec for the possible response codes and their meanings.

Returns:
the response code, if present; otherwise, an empty string

const char * ResponseText  )  const
 

Returns the response text.

The response text is intended to be meaningful to humans, for example, for debugging. (However, it's a mistake to assume that the response text will be meaningful to a user who is not familiar with IMAP4!)

Returns:
the response text, if present; otherwise, an empty string

void SetParams const char *  s  ) 
 

Sets parameters for the response.

Only the parser should call this function.

Parameters:
s string that contains unparsed parameters

Copyright © 2001-2005 Hunny Software, Inc. All rights reserved.