PreauthResponse Class Reference

Inheritance diagram for PreauthResponse:

Detailed Description

PreauthResponse is a class that represents an IMAP4 PREAUTH response.

A PREAUTH response indicates that the session has been authenticated by some means other than IMAP4, so that a LOGIN command or AUTHENTICATE command is not necessary. The PREAUTH response is allowed only when the connection is first opened.

Public Member Functions

PreauthResponse ()

Default constructor.

PreauthResponse (const PreauthResponse &other)

Copy constructor.

virtual ~PreauthResponse ()

Destructor.

PreauthResponse & operator= (const PreauthResponse &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

PreauthResponse ( )

Default constructor.

PreauthResponse ( const PreauthResponse & other )

Copy constructor.

Parameters:

other other object to copy

~PreauthResponse ( ) [virtual]

Destructor.

Member Function Documentation

PreauthResponse & operator= ( const PreauthResponse & 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


Public Member Functions
	PreauthResponse ()
	Default constructor.
	PreauthResponse (const PreauthResponse &other)
	Copy constructor.
virtual	~PreauthResponse ()
	Destructor.
PreauthResponse &	operator= (const PreauthResponse &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.