POP3Response Class Reference

#include <POP3Response.hpp>

Inheritance diagram for POP3Response:

Collaboration diagram for POP3Response:

Public Types
enum	ResponseCode { CODE_OK = 0 , CODE_READY , CODE_ERR }

Public Member Functions
bool	isSuccess () const
ResponseCode	getCode () const
const string	getText () const
const string	getFirstLine () const
const string	getLineAt (const size_t pos) const
size_t	getLineCount () const

Static Public Member Functions
static shared_ptr< POP3Response >	readResponse (shared_ptr< POP3Connection > conn)
static shared_ptr< POP3Response >	readMultilineResponse (shared_ptr< POP3Connection > conn)
static shared_ptr< POP3Response >	readLargeResponse (shared_ptr< POP3Connection > conn, utility::outputStream &os, utility::progressListener *progress, const size_t predictedSize)

Additional Inherited Members
Protected Member Functions inherited from object
	object ()
	object (const object &)
object &	operator= (const object &)
virtual	~object ()

Detailed Description

A POP3 response, as sent by the server.

Member Enumeration Documentation

ResponseCode

enum ResponseCode

Possible response codes.

Enumerator
CODE_OK
CODE_READY
CODE_ERR

Member Function Documentation

getCode()

POP3Response::ResponseCode getCode

(

)

const

Return the POP3 response code.

Returns

response code

getFirstLine()

const string getFirstLine

(

)

const

Return the first POP3 response line.

Returns

first response line

getLineAt()

const string getLineAt

(

const size_t

pos

)

const

Return the response line at the specified position.

Parameters

pos	line index

Returns

line at the specified index

getLineCount()

size_t getLineCount

(

)

const

Return the number of lines in the response.

Returns

number of lines in the response

getText()

const string getText

(

)

const

Return the POP3 response text (first line).

Returns

response text

isSuccess()

bool isSuccess

(

)

const

Returns whether the response is successful ("OK").

Returns

true if the response if successful, false otherwise

readLargeResponse()

shared_ptr< POP3Response > readLargeResponse ( shared_ptr< POP3Connection >  conn, utility::outputStream &  os, utility::progressListener *  progress, const size_t  predictedSize  )

static

Receive and parse a large POP3 response (eg.

message data) from the specified connection.

Parameters

conn	connection from which to read
os	output stream to which response data will be written
progress	progress listener (can be NULL)
predictedSize	estimated size of response data (in bytes)

Returns

POP3 response

Exceptions

exceptions::operation_timed_out

if no data has been received within the granted time

Referenced by POP3Message::extract().

readMultilineResponse()

shared_ptr< POP3Response > readMultilineResponse ( shared_ptr< POP3Connection >  conn )

static

Receive and parse a multiline POP3 response from the specified connection.

Parameters

conn	connection from which to read

Returns

POP3 response

Exceptions

exceptions::operation_timed_out

if no data has been received within the granted time

readResponse()

shared_ptr< POP3Response > readResponse ( shared_ptr< POP3Connection >  conn )

static

Receive and parse a POP3 response from the specified connection.

Parameters

conn	connection from which to read

Returns

POP3 response

Exceptions

exceptions::operation_timed_out

if no data has been received within the granted time

Referenced by POP3Connection::connect(), and POP3Store::noop().

---

The documentation for this class was generated from the following files:

• POP3Response.hpp
• POP3Response.cpp