Hunny Software Home || Hunny MIME++ Home || Hunny Mail++ Home

ByeResponse Class Reference

Inheritance diagram for ByeResponse:

List of all members.

---

Detailed Description

ByeResponse is a class that represents an IMAP4 BYE response.

A BYE response indicates that the server is closing the connection.

Typically, a BYE response contains human-readable text. You can get this text by calling the ResponseText member function.

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

ByeResponse (   )

Default constructor.

ByeResponse (  const ByeResponse &  other  )

Copy constructor Parameters: other  other object to copy

~ByeResponse (   )  [virtual]

Destructor.

---

Member Function Documentation

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