IMAPCommand Class Reference

Inheritance diagram for IMAPCommand:

Collaboration diagram for IMAPCommand:

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

Static Public Member Functions
static shared_ptr< IMAPCommand >	LOGIN (const string &username, const string &password)
static shared_ptr< IMAPCommand >	AUTHENTICATE (const string &mechName)
static shared_ptr< IMAPCommand >	AUTHENTICATE (const string &mechName, const string &initialResponse)
static shared_ptr< IMAPCommand >	LIST (const string &refName, const string &mailboxName)
static shared_ptr< IMAPCommand >	SELECT (const bool readOnly, const string &mailboxName, const std::vector< string > &params)
static shared_ptr< IMAPCommand >	STATUS (const string &mailboxName, const std::vector< string > &attribs)
static shared_ptr< IMAPCommand >	CREATE (const string &mailboxName, const std::vector< string > &params)
static shared_ptr< IMAPCommand >	DELETE (const string &mailboxName)
static shared_ptr< IMAPCommand >	RENAME (const string &mailboxName, const string &newMailboxName)
static shared_ptr< IMAPCommand >	FETCH (const messageSet &msgs, const std::vector< string > &params)
static shared_ptr< IMAPCommand >	STORE (const messageSet &msgs, const int mode, const std::vector< string > &flags)
static shared_ptr< IMAPCommand >	APPEND (const string &mailboxName, const std::vector< string > &flags, vmime::datetime *date, const size_t size)
static shared_ptr< IMAPCommand >	COPY (const messageSet &msgs, const string &mailboxName)
static shared_ptr< IMAPCommand >	SEARCH (const std::vector< string > &keys, const vmime::charset *charset)
static shared_ptr< IMAPCommand >	STARTTLS ()
static shared_ptr< IMAPCommand >	CAPABILITY ()
static shared_ptr< IMAPCommand >	NOOP ()
static shared_ptr< IMAPCommand >	EXPUNGE ()
static shared_ptr< IMAPCommand >	CLOSE ()
static shared_ptr< IMAPCommand >	LOGOUT ()
static shared_ptr< IMAPCommand >	createCommand (const string &text, const string &traceText="")

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

Detailed Description

An IMAP command that will be sent to the server.

Constructor & Destructor Documentation

IMAPCommand() [1/2]

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

protected

Referenced by IMAPCommand::createCommand().

IMAPCommand() [2/2]

IMAPCommand ( const IMAPCommand &  )

protected

Member Function Documentation

APPEND()

shared_ptr< IMAPCommand > APPEND ( const string &  mailboxName, const std::vector< string > &  flags, vmime::datetime *  date, const size_t  size  )

static

References IMAPCommand::COPY(), and IMAPCommand::createCommand().

Referenced by IMAPFolder::addMessage(), and IMAPCommand::STORE().

AUTHENTICATE() [1/2]

shared_ptr< IMAPCommand > AUTHENTICATE ( const string &  mechName )

static

References IMAPCommand::createCommand().

AUTHENTICATE() [2/2]

shared_ptr< IMAPCommand > AUTHENTICATE ( const string &  mechName, const string &  initialResponse  )

static

References IMAPCommand::createCommand().

CAPABILITY()

shared_ptr< IMAPCommand > CAPABILITY ( )

static

References IMAPCommand::createCommand().

CLOSE()

shared_ptr< IMAPCommand > CLOSE ( )

static

References IMAPCommand::createCommand().

Referenced by IMAPFolder::close().

COPY()

shared_ptr< IMAPCommand > COPY ( const messageSet &  msgs, const string &  mailboxName  )

static

References IMAPCommand::createCommand(), messageSet::isUIDSet(), and IMAPCommand::SEARCH().

Referenced by IMAPCommand::APPEND(), and IMAPFolder::copyMessages().

CREATE()

shared_ptr< IMAPCommand > CREATE ( const string &  mailboxName, const std::vector< string > &  params  )

static

References IMAPCommand::createCommand().

Referenced by IMAPFolder::create(), and IMAPCommand::STATUS().

createCommand()

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

static

Creates a new IMAP command with the specified text.

Parameters

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

Returns

a new IMAPCommand object

References IMAPCommand::IMAPCommand().

Referenced by IMAPCommand::APPEND(), IMAPCommand::AUTHENTICATE(), IMAPCommand::CAPABILITY(), IMAPCommand::CLOSE(), IMAPCommand::COPY(), IMAPCommand::CREATE(), IMAPCommand::DELETE(), IMAPCommand::EXPUNGE(), IMAPCommand::FETCH(), IMAPCommand::LIST(), IMAPCommand::LOGIN(), IMAPCommand::LOGOUT(), IMAPCommand::NOOP(), IMAPCommand::RENAME(), IMAPCommand::SEARCH(), IMAPCommand::SELECT(), IMAPCommand::STARTTLS(), IMAPCommand::STATUS(), and IMAPCommand::STORE().

DELETE()

shared_ptr< IMAPCommand > DELETE ( const string &  mailboxName )

static

References IMAPCommand::createCommand(), and IMAPCommand::RENAME().

Referenced by IMAPFolder::destroy().

EXPUNGE()

shared_ptr< IMAPCommand > EXPUNGE ( )

static

References IMAPCommand::createCommand().

Referenced by IMAPFolder::expunge().

FETCH()

shared_ptr< IMAPCommand > FETCH ( const messageSet &  msgs, const std::vector< string > &  params  )

static

References IMAPCommand::createCommand(), messageSet::isUIDSet(), and IMAPCommand::STORE().

Referenced by IMAPMessage::fetchPartHeader(), IMAPFolder::getMessages(), and IMAPCommand::RENAME().

getText()

const string getText ( ) const

virtual

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

This is the text that will be sent to the server.

Returns

command text (eg. "LOGIN myusername mypassword")

getTraceText()

const string getTraceText ( ) const

virtual

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

Returns

trace text (eg. "LOGIN {username} {password}")

LIST()

shared_ptr< IMAPCommand > LIST ( const string &  refName, const string &  mailboxName  )

static

References IMAPCommand::createCommand(), and IMAPCommand::SELECT().

Referenced by IMAPFolder::exists(), and IMAPFolder::getFolders().

LOGIN()

shared_ptr< IMAPCommand > LOGIN ( const string &  username, const string &  password  )

static

References IMAPCommand::createCommand().

LOGOUT()

shared_ptr< IMAPCommand > LOGOUT ( )

static

References IMAPCommand::createCommand().

NOOP()

shared_ptr< IMAPCommand > NOOP ( )

static

References IMAPCommand::createCommand().

Referenced by IMAPStore::noop(), and IMAPFolder::noop().

RENAME()

shared_ptr< IMAPCommand > RENAME ( const string &  mailboxName, const string &  newMailboxName  )

static

References IMAPCommand::createCommand(), and IMAPCommand::FETCH().

Referenced by IMAPCommand::DELETE(), and IMAPFolder::rename().

SEARCH()

shared_ptr< IMAPCommand > SEARCH ( const std::vector< string > &  keys, const vmime::charset *  charset  )

static

References IMAPCommand::createCommand(), and charset::getName().

Referenced by IMAPCommand::COPY(), and IMAPFolder::getMessageNumbersStartingOnUID().

SELECT()

shared_ptr< IMAPCommand > SELECT ( const bool  readOnly, const string &  mailboxName, const std::vector< string > &  params  )

static

References IMAPCommand::createCommand(), and IMAPCommand::STATUS().

Referenced by IMAPCommand::LIST(), and IMAPFolder::open().

send()

void send ( shared_ptr< IMAPConnection >  conn )

virtual

Sends this command over the specified connection.

Parameters

conn	connection onto which the command will be sent

Referenced by IMAPFolder::addMessage().

STARTTLS()

shared_ptr< IMAPCommand > STARTTLS ( )

static

References IMAPCommand::createCommand().

STATUS()

shared_ptr< IMAPCommand > STATUS ( const string &  mailboxName, const std::vector< string > &  attribs  )

static

References IMAPCommand::CREATE(), and IMAPCommand::createCommand().

Referenced by IMAPFolder::getStatus(), and IMAPCommand::SELECT().

STORE()

shared_ptr< IMAPCommand > STORE ( const messageSet &  msgs, const int  mode, const std::vector< string > &  flags  )

static

References IMAPCommand::APPEND(), IMAPCommand::createCommand(), message::FLAG_MODE_ADD, message::FLAG_MODE_REMOVE, and messageSet::isUIDSet().

Referenced by IMAPFolder::deleteMessages(), IMAPCommand::FETCH(), and IMAPFolder::setMessageFlags().

---

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

• IMAPCommand.hpp
• IMAPCommand.cpp