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

protected

IMAPCommand ( const IMAPCommand & )

protected

Member Function Documentation

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

static

Referenced by IMAPFolder::addMessage().

shared_ptr< IMAPCommand > AUTHENTICATE ( const string & mechName )

static

References IMAPCommand::createCommand().

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

static

References IMAPCommand::createCommand().

shared_ptr< IMAPCommand > CAPABILITY ( )

static

References IMAPCommand::createCommand().

shared_ptr< IMAPCommand > CLOSE ( )

static

References IMAPCommand::createCommand().

Referenced by IMAPFolder::close().

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

static

References messageSet::isUIDSet().

Referenced by IMAPFolder::copyMessages().

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

static

Referenced by IMAPFolder::create().

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

Referenced by IMAPCommand::AUTHENTICATE(), IMAPCommand::CAPABILITY(), IMAPCommand::CLOSE(), IMAPCommand::DELETE(), IMAPCommand::EXPUNGE(), IMAPCommand::LIST(), IMAPCommand::LOGIN(), IMAPCommand::LOGOUT(), IMAPCommand::NOOP(), and IMAPCommand::STARTTLS().

shared_ptr< IMAPCommand > DELETE ( const string & mailboxName )

static

References IMAPCommand::createCommand().

Referenced by IMAPFolder::destroy().

shared_ptr< IMAPCommand > EXPUNGE ( )

static

References IMAPCommand::createCommand().

Referenced by IMAPFolder::expunge().

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

static

References messageSet::isUIDSet().

Referenced by IMAPFolder::getMessages().

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")

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}")

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

static

References IMAPCommand::createCommand().

Referenced by IMAPFolder::getFolders().

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

static

References IMAPCommand::createCommand().

shared_ptr< IMAPCommand > LOGOUT ( )

static

References IMAPCommand::createCommand().

shared_ptr< IMAPCommand > NOOP ( )

static

References IMAPCommand::createCommand().

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

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

static

Referenced by IMAPFolder::rename().

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

static

References charset::getName().

Referenced by IMAPFolder::getMessageNumbersStartingOnUID().

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

static

Referenced by IMAPFolder::open().

void send ( shared_ptr< IMAPConnection > conn )

virtual

Sends this command over the specified connection.

Parameters

conn	connection onto which the command will be sent

shared_ptr< IMAPCommand > STARTTLS ( )

static

References IMAPCommand::createCommand().

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

static

Referenced by IMAPFolder::getStatus().

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

static

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

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

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

Public Member Functions

Static Public Member Functions

Protected Member Functions

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation