POP3Command Class Reference

#include <POP3Command.hpp>

Inheritance diagram for POP3Command:

Collaboration diagram for POP3Command:

Public Member Functions
virtual void	send (shared_ptr< POP3Connection > conn)
virtual const string	getText () const
virtual const string	getTraceText () const

Static Public Member Functions
static shared_ptr< POP3Command >	CAPA ()
static shared_ptr< POP3Command >	NOOP ()
static shared_ptr< POP3Command >	AUTH (const string &mechName)
static shared_ptr< POP3Command >	AUTH (const string &mechName, const string &initialResponse)
static shared_ptr< POP3Command >	STLS ()
static shared_ptr< POP3Command >	APOP (const string &username, const string &digest)
static shared_ptr< POP3Command >	USER (const string &username)
static shared_ptr< POP3Command >	PASS (const string &password)
static shared_ptr< POP3Command >	STAT ()
static shared_ptr< POP3Command >	LIST ()
static shared_ptr< POP3Command >	LIST (const unsigned long msg)
static shared_ptr< POP3Command >	UIDL ()
static shared_ptr< POP3Command >	UIDL (const unsigned long msg)
static shared_ptr< POP3Command >	DELE (const unsigned long msg)
static shared_ptr< POP3Command >	RETR (const unsigned long msg)
static shared_ptr< POP3Command >	TOP (const unsigned long msg, const unsigned long lines)
static shared_ptr< POP3Command >	RSET ()
static shared_ptr< POP3Command >	QUIT ()
static shared_ptr< POP3Command >	createCommand (const string &text, const string &traceText="")

Protected Member Functions
	POP3Command (const string &text, const string &traceText)
	POP3Command (const POP3Command &)
Protected Member Functions inherited from object
	object ()
	object (const object &)
object &	operator= (const object &)
virtual	~object ()

Detailed Description

A POP3 command that will be sent to the server.

Constructor & Destructor Documentation

POP3Command() [1/2]

POP3Command ( const string & text, const string & traceText )

protected

Referenced by createCommand(), and POP3Command().

POP3Command() [2/2]

POP3Command ( const POP3Command & )

protected

References POP3Command().

Member Function Documentation

APOP()

shared_ptr< POP3Command > APOP ( const string & username, const string & digest )

static

References createCommand().

AUTH() [1/2]

shared_ptr< POP3Command > AUTH ( const string & mechName )

static

References createCommand().

AUTH() [2/2]

shared_ptr< POP3Command > AUTH ( const string & mechName, const string & initialResponse )

static

References createCommand().

CAPA()

shared_ptr< POP3Command > CAPA ( )

static

References createCommand().

createCommand()

shared_ptr< POP3Command > createCommand ( const string & text, const string & traceText = "" )

static

Creates a new POP3 command with the specified text.

Parameters

text	command text
traceText	trace text (if empty, command text is used)

Returns

a new POP3Command object

References POP3Command().

Referenced by APOP(), AUTH(), AUTH(), CAPA(), DELE(), LIST(), LIST(), NOOP(), PASS(), QUIT(), RETR(), RSET(), STAT(), STLS(), TOP(), UIDL(), UIDL(), and USER().

DELE()

shared_ptr< POP3Command > DELE ( const unsigned long msg )

static

References createCommand().

Referenced by POP3Folder::deleteMessages().

getText()

const string getText ( ) const

virtual

Returns the full text of the command, including command name and parameters (if any).

Returns

command text (eg. "LIST 42")

getTraceText()

const string getTraceText ( ) const

virtual

Returns the full text of the command, suitable for outputing to the tracer.

Returns

trace text (eg. "USER myusername")

LIST() [1/2]

shared_ptr< POP3Command > LIST ( )

static

References createCommand().

Referenced by POP3Folder::fetchMessage(), and POP3Folder::fetchMessages().

LIST() [2/2]

shared_ptr< POP3Command > LIST ( const unsigned long msg )

static

References createCommand().

NOOP()

shared_ptr< POP3Command > NOOP ( )

static

References createCommand().

Referenced by POP3Store::noop().

PASS()

shared_ptr< POP3Command > PASS ( const string & password )

static

References createCommand().

QUIT()

shared_ptr< POP3Command > QUIT ( )

static

References createCommand().

RETR()

shared_ptr< POP3Command > RETR ( const unsigned long msg )

static

References createCommand().

Referenced by POP3Message::extract().

RSET()

shared_ptr< POP3Command > RSET ( )

static

References createCommand().

Referenced by POP3Folder::close().

send()

void send ( shared_ptr< POP3Connection > conn )

virtual

Sends this command over the specified connection.

Parameters

conn	connection onto which the command will be sent

STAT()

shared_ptr< POP3Command > STAT ( )

static

References createCommand().

Referenced by POP3Folder::getStatus(), and POP3Folder::open().

STLS()

shared_ptr< POP3Command > STLS ( )

static

References createCommand().

TOP()

shared_ptr< POP3Command > TOP ( const unsigned long msg, const unsigned long lines )

static

References createCommand().

UIDL() [1/2]

shared_ptr< POP3Command > UIDL ( )

static

References createCommand().

Referenced by POP3Folder::fetchMessage(), and POP3Folder::fetchMessages().

UIDL() [2/2]

shared_ptr< POP3Command > UIDL ( const unsigned long msg )

static

References createCommand().

USER()

shared_ptr< POP3Command > USER ( const string & username )

static

References createCommand().

---

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

• POP3Command.hpp
• POP3Command.cpp