#include <imapcommand.h>

Public Member Functions
	imapCommand ()

	imapCommand (const QString &command, const QString &parameter)

const QString &	command ()

const QString	getStr ()

const QString &	id ()

bool	isComplete ()

const QString &	parameter ()

const QString &	result ()

const QString &	resultInfo ()

void	setCommand (const QString &)

void	setComplete ()

void	setId (const QString &)

void	setParameter (const QString &)

void	setResult (const QString &)

void	setResultInfo (const QString &)

Static Public Member Functions
static CommandPtr	clientAppend (const QString &box, const QString &flags, ulong size)

static CommandPtr	clientClose ()

static CommandPtr	clientCopy (const QString &box, const QString &sequence, bool nouid=false)

static CommandPtr	clientCreate (const QString &path)

static CommandPtr	clientCustom (const QString &command, const QString &arguments)

static CommandPtr	clientDelete (const QString &path)

static CommandPtr	clientDeleteACL (const QString &box, const QString &user)

static CommandPtr	clientExpunge ()

static CommandPtr	clientFetch (ulong uid, const QString &fields, bool nouid=false)

static CommandPtr	clientFetch (ulong fromUid, ulong toUid, const QString &fields, bool nouid=false)

static CommandPtr	clientFetch (const QString &sequence, const QString &fields, bool nouid=false)

static CommandPtr	clientGetACL (const QString &box)

static CommandPtr	clientGetAnnotation (const QString &box, const QString &entry, const QStringList &attributeNames)

static CommandPtr	clientGetQuotaroot (const QString &box)

static CommandPtr	clientList (const QString &reference, const QString &path, bool lsub=false)

static CommandPtr	clientListRights (const QString &box, const QString &user)

static CommandPtr	clientLogout ()

static CommandPtr	clientMyRights (const QString &box)

static CommandPtr	clientNamespace ()

static CommandPtr	clientNoop ()

static CommandPtr	clientRename (const QString &src, const QString &dest)

static CommandPtr	clientSearch (const QString &search, bool nouid=false)

static CommandPtr	clientSelect (const QString &path, bool examine=false)

static CommandPtr	clientSetACL (const QString &box, const QString &user, const QString &acl)

static CommandPtr	clientSetAnnotation (const QString &box, const QString &entry, const QMap< QString, QString > &attributes)

static CommandPtr	clientStartTLS ()

static CommandPtr	clientStatus (const QString &path, const QString &parameters)

static CommandPtr	clientStore (const QString &set, const QString &item, const QString &data, bool nouid=false)

static CommandPtr	clientSubscribe (const QString &path)

static CommandPtr	clientUnsubscribe (const QString &path)

Protected Attributes
QString	aCommand

QString	aParameter

bool	mComplete

QString	mId

QString	mResult

QString	mResultInfo

Detailed Description

encapulate a IMAP command

Author: Svenn Carstens

Date: 2000

Todo:: fix the documentation

Definition at line 42 of file imapcommand.h.

Constructor & Destructor Documentation

imapCommand::imapCommand ( )

Constructor.

Definition at line 60 of file imapcommand.cpp.

imapCommand::imapCommand	(	const QString &	command,
		const QString &	parameter
	)

Constructor.

Parameters

command	Imap command
parameter	Parameters to the command

Returns: none

Definition at line 66 of file imapcommand.cpp.

Member Function Documentation

CommandPtr imapCommand::clientAppend	(	const QString &	box,
		const QString &	flags,
		ulong	size
	)

static

Create a APPEND command.

Parameters

box
flags
size

Returns: a APPEND imapCommand

Definition at line 233 of file imapcommand.cpp.

static imapCommand * imapCommand::clientClose ( )

static

Create a CLOSE command.

Returns: a CLOSE imapCommand

Definition at line 219 of file imapcommand.cpp.

CommandPtr imapCommand::clientCopy	(	const QString &	box,
		const QString &	sequence,
		bool	nouid = `false`
	)

static

Create a COPY command.

Parameters

box
sequence
nouid	Perform a COPY or UID COPY command

Returns: a COPY imapCommand

Definition at line 225 of file imapcommand.cpp.

CommandPtr imapCommand::clientCreate ( const QString & path )

static

Create a CREATE command.

Parameters

path

Returns: a CREATE imapCommand

Definition at line 255 of file imapcommand.cpp.

CommandPtr imapCommand::clientCustom	(	const QString &	command,
		const QString &	arguments
	)

static

Create a custom command.

Parameters

command	The custom command
arguments	The custom arguments

Returns: a custom imapCommand

Definition at line 412 of file imapcommand.cpp.

CommandPtr imapCommand::clientDelete ( const QString & path )

static

Create a DELETE command.

Parameters

path

Returns: a DELETE imapCommand

Definition at line 262 of file imapcommand.cpp.

CommandPtr imapCommand::clientDeleteACL	(	const QString &	box,
		const QString &	user
	)

static

Create a DELETEACL command.

Parameters

box	mailbox name
user	authentication identifier

Returns: a DELETEACL imapCommand

Definition at line 331 of file imapcommand.cpp.

CommandPtr imapCommand::clientExpunge ( )

static

Create a EXPUNGE command.

Returns: a EXPUNGE imapCommand

Definition at line 283 of file imapcommand.cpp.

static imapCommand * imapCommand::clientFetch	(	ulong	uid,
		const QString &	fields,
		bool	nouid = `false`
	)

static

Create a FETCH command.

Parameters

uid	Uid of the message to fetch
fields	options to pass to the server
nouid	Perform a FETCH or UID FETCH command

Returns: a FETCH imapCommand Fetch a single uid

Definition at line 168 of file imapcommand.cpp.

static imapCommand * imapCommand::clientFetch	(	ulong	fromUid,
		ulong	toUid,
		const QString &	fields,
		bool	nouid = `false`
	)

static

Create a FETCH command.

Parameters

fromUid	start uid of the messages to fetch
toUid	last uid of the messages to fetch
fields	options to pass to the server
nouid	Perform a FETCH or UID FETCH command

Returns: a FETCH imapCommand Fetch a range of uids

Definition at line 174 of file imapcommand.cpp.

static imapCommand * imapCommand::clientFetch	(	const QString &	sequence,
		const QString &	fields,
		bool	nouid = `false`
	)

static

Create a FETCH command.

Parameters

sequence	a IMAP FETCH sequence string
fields	options to pass to the server
nouid	Perform a FETCH or UID FETCH command

Returns: a FETCH imapCommand Fetch a range of uids. The other clientFetch functions are just wrappers around this function.

Definition at line 191 of file imapcommand.cpp.

CommandPtr imapCommand::clientGetACL ( const QString & box )

static

Create a GETACL command.

Parameters

box	mailbox name

Returns: a GETACL imapCommand

Definition at line 339 of file imapcommand.cpp.

CommandPtr imapCommand::clientGetAnnotation	(	const QString &	box,
		const QString &	entry,
		const QStringList &	attributeNames
	)

static

Create a GETANNOTATION command.

Parameters

box	mailbox name
entry	entry specifier
attributeNames	attribute specifier

Returns: a GETANNOTATION imapCommand

Definition at line 380 of file imapcommand.cpp.

CommandPtr imapCommand::clientGetQuotaroot ( const QString & box )

static

Create a GETQUOTAROOT command.

Parameters

box	mailbox name

Returns: a GETQUOTAROOT imapCommand

Definition at line 405 of file imapcommand.cpp.

static imapCommand * imapCommand::clientList	(	const QString &	reference,
		const QString &	path,
		bool	lsub = `false`
	)

static

Create a LIST command.

Parameters

reference
path	The path to list
lsub	Perform a LIST or a LSUB command

Returns: a LIST imapCommand

Definition at line 199 of file imapcommand.cpp.

CommandPtr imapCommand::clientListRights	(	const QString &	box,
		const QString &	user
	)

static

Create a LISTRIGHTS command.

Parameters

box	mailbox name
user	authentication identifier

Returns: a LISTRIGHTS imapCommand

Definition at line 346 of file imapcommand.cpp.

CommandPtr imapCommand::clientLogout ( )

static

Create a LOGOUT command.

Returns: a LOGOUT imapCommand

Definition at line 311 of file imapcommand.cpp.

CommandPtr imapCommand::clientMyRights ( const QString & box )

static

Create a MYRIGHTS command.

Parameters

box	mailbox name

Returns: a MYRIGHTS imapCommand

Definition at line 354 of file imapcommand.cpp.

CommandPtr imapCommand::clientNamespace ( )

static

Create a NAMESPACE command.

Returns: a NAMESPACE imapCommand

Definition at line 399 of file imapcommand.cpp.

static imapCommand * imapCommand::clientNoop ( )

static

Create a NOOP command.

Returns: a NOOP imapCommand

Definition at line 162 of file imapcommand.cpp.

CommandPtr imapCommand::clientRename	(	const QString &	src,
		const QString &	dest
	)

static

Create a RENAME command.

Parameters

src	Source
dest	Destination

Returns: a RENAME imapCommand

Definition at line 289 of file imapcommand.cpp.

CommandPtr imapCommand::clientSearch	(	const QString &	search,
		bool	nouid = `false`
	)

static

Create a SEARCH command.

Parameters

search
nouid	Perform a UID SEARCH or a SEARCH command

Returns: a SEARCH imapCommand

Definition at line 297 of file imapcommand.cpp.

static imapCommand * imapCommand::clientSelect	(	const QString &	path,
		bool	examine = `false`
	)

static

Create a SELECT command.

Parameters

path	The path to select
lsub	Perform a SELECT or a EXAMINE command

Returns: a SELECT imapCommand

Note: We use always SELECT, because UW-IMAP doesn't check for new mail, when used with the "mbox driver" and the folder is opened with EXAMINE and Courier can't append to a mailbox that is in EXAMINE state

Definition at line 208 of file imapcommand.cpp.

CommandPtr imapCommand::clientSetACL	(	const QString &	box,
		const QString &	user,
		const QString &	acl
	)

static

Create a SETACL command.

Parameters

box	mailbox name
user	authentication identifier
acl	access right modification (starting with optional +/-)

Returns: a SETACL imapCommand

Definition at line 323 of file imapcommand.cpp.

CommandPtr imapCommand::clientSetAnnotation	(	const QString &	box,
		const QString &	entry,
		const QMap< QString, QString > &	attributes
	)

static

Create a SETANNOTATION command.

Parameters

box	mailbox name
entry	entry specifier
attributes	map of attribute names + values

Returns: a SETANNOTATION imapCommand

Definition at line 361 of file imapcommand.cpp.

CommandPtr imapCommand::clientStartTLS ( )

static

Create a STARTTLS command.

Returns: a STARTTLS imapCommand

Definition at line 317 of file imapcommand.cpp.

CommandPtr imapCommand::clientStatus	(	const QString &	path,
		const QString &	parameters
	)

static

Create a STATUS command.

Parameters

path
parameters

Returns: a STATUS imapCommand

Definition at line 247 of file imapcommand.cpp.

CommandPtr imapCommand::clientStore	(	const QString &	set,
		const QString &	item,
		const QString &	data,
		bool	nouid = `false`
	)

static

Create a STORE command.

Parameters

set
item
data
nouid	Perform a UID STORE or a STORE command

Returns: a STORE imapCommand

Definition at line 303 of file imapcommand.cpp.

CommandPtr imapCommand::clientSubscribe ( const QString & path )

static

Create a SUBSCRIBE command.

Parameters

path

Returns: a SUBSCRIBE imapCommand

Definition at line 269 of file imapcommand.cpp.

CommandPtr imapCommand::clientUnsubscribe ( const QString & path )

static

Create a UNSUBSCRIBE command.

Parameters

path

Returns: a UNSUBSCRIBE imapCommand

Definition at line 276 of file imapcommand.cpp.

const QString & imapCommand::command ( )

get the command

Returns: the command

Definition at line 108 of file imapcommand.cpp.

const QString imapCommand::getStr ( )

returns the data to send to the server The function returns the complete data to be sent to the server (<id> <command> [<parameter>])

Returns: the data to send to the server

Todo:: possibly rename function to be clear of it's purpose

Definition at line 152 of file imapcommand.cpp.

const QString & imapCommand::id ( )

get the id

Returns: the id

Definition at line 96 of file imapcommand.cpp.

bool imapCommand::isComplete ( )

is it complete?

Returns: whether the command is completed

Definition at line 78 of file imapcommand.cpp.

const QString & imapCommand::parameter ( )

get the parameter

Returns: the parameter

Definition at line 102 of file imapcommand.cpp.

const QString & imapCommand::result ( )

get the result of the command

Returns: The result, i.e. first word of the result line, like OK

Definition at line 84 of file imapcommand.cpp.

const QString & imapCommand::resultInfo ( )

get information about the result

Returns: Information about the result, i.e. the rest of the result line

Definition at line 90 of file imapcommand.cpp.

void imapCommand::setCommand ( const QString & command )

set the command

Parameters

command the imap command

Returns: none

Definition at line 140 of file imapcommand.cpp.

void imapCommand::setComplete ( )

set the completed state

Returns: none

Definition at line 122 of file imapcommand.cpp.

void imapCommand::setId ( const QString & id )

set the id

Parameters

id	the id used by the command

Returns: none

Definition at line 114 of file imapcommand.cpp.

void imapCommand::setParameter ( const QString & parameter )

set the command parameter(s)

Parameters

parameter the comand parameter(s)

Returns: none

Definition at line 146 of file imapcommand.cpp.

void imapCommand::setResult ( const QString & result )

set the completed state

Parameters

result the command result

Returns: none

Definition at line 128 of file imapcommand.cpp.

void imapCommand::setResultInfo ( const QString & result )

set the completed state

Parameters

result the command result information

Returns: none

Definition at line 134 of file imapcommand.cpp.

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

kioslave/imap4

Public Member Functions

Static Public Member Functions

Protected Attributes

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

kioslave/imap4

kdepimlibs API Reference

Search