VMime
Public Member Functions | Static Public Member Functions | Protected Member Functions | List of all members
POP3Command Class Reference
Inheritance diagram for POP3Command:
Inheritance graph
[legend]
Collaboration diagram for POP3Command:
Collaboration graph
[legend]

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 ( const string &  text,
const string &  traceText 
)
protected
POP3Command ( const POP3Command &  )
protected

Member Function Documentation

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

References POP3Command::createCommand().

shared_ptr< POP3Command > AUTH ( const string &  mechName)
static

References POP3Command::createCommand().

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

References POP3Command::createCommand().

shared_ptr< POP3Command > CAPA ( )
static

References POP3Command::createCommand().

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

Creates a new POP3 command with the specified text.

Parameters
textcommand text
traceTexttrace text (if empty, command text is used)
Returns
a new POP3Command object

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

shared_ptr< POP3Command > DELE ( const unsigned long  msg)
static

References POP3Command::createCommand().

Referenced by POP3Folder::deleteMessages().

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")
const string getTraceText ( ) const
virtual

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

Returns
trace text (eg. "USER myusername")
shared_ptr< POP3Command > LIST ( )
static

References POP3Command::createCommand().

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

shared_ptr< POP3Command > LIST ( const unsigned long  msg)
static

References POP3Command::createCommand().

shared_ptr< POP3Command > NOOP ( )
static

References POP3Command::createCommand().

Referenced by POP3Store::noop().

shared_ptr< POP3Command > PASS ( const string &  password)
static

References POP3Command::createCommand().

shared_ptr< POP3Command > QUIT ( )
static

References POP3Command::createCommand().

shared_ptr< POP3Command > RETR ( const unsigned long  msg)
static

References POP3Command::createCommand().

Referenced by POP3Message::extract().

shared_ptr< POP3Command > RSET ( )
static

References POP3Command::createCommand().

Referenced by POP3Folder::close().

void send ( shared_ptr< POP3Connection >  conn)
virtual

Sends this command over the specified connection.

Parameters
connconnection onto which the command will be sent
shared_ptr< POP3Command > STAT ( )
static

References POP3Command::createCommand().

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

shared_ptr< POP3Command > STLS ( )
static

References POP3Command::createCommand().

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

References POP3Command::createCommand().

shared_ptr< POP3Command > UIDL ( )
static

References POP3Command::createCommand().

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

shared_ptr< POP3Command > UIDL ( const unsigned long  msg)
static

References POP3Command::createCommand().

shared_ptr< POP3Command > USER ( const string &  username)
static

References POP3Command::createCommand().

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