KMail::ACLJobs Namespace Reference

Classes
class	GetACLJob
class	GetUserRightsJob
class	DeleteACLJob
class	MultiSetACLJob

Enumerations
enum	ACLFetchState { NotFetchedYet , Ok , FetchFailed }
enum	ACLPermissions {   List = 1 , Read = 2 , WriteFlags = 4 , Insert = 8 ,   Create = 16 , Delete = 32 , Administer = 64 , Post = 128 ,   WriteSeenFlag = 256 , AllWrite = List | Read | WriteFlags | Insert | Post | Create | Delete | WriteSeenFlag , All = List | Read | WriteFlags | Insert | Post | Create | Delete | Administer | WriteSeenFlag }

Functions
TDEIO::SimpleJob *	setACL (TDEIO::Slave *slave, const KURL &url, const TQString &user, unsigned int permissions)
DeleteACLJob *	deleteACL (TDEIO::Slave *slave, const KURL &url, const TQString &user)
GetACLJob *	getACL (TDEIO::Slave *slave, const KURL &url)
GetUserRightsJob *	getUserRights (TDEIO::Slave *slave, const KURL &url)
MultiSetACLJob *	multiSetACL (TDEIO::Slave *slave, const KURL &url, const ACLList &acl)
TQString	permissionsToString (unsigned int permissions)

Detailed Description

This namespace contains functions that return jobs for ACL operations.

The current implementation is tied to IMAP. If someone wants to extend this to other protocols, turn the class into a namespace and use virtual methods.

Enumeration Type Documentation

ACLFetchState

enum KMail::ACLJobs::ACLFetchState

Enumerator
NotFetchedYet	The user rights/ACL have not been fetched from the server yet, we don't know them.
Ok	The user rights/ACL have been fetched from the server sucessfully.
FetchFailed	The attempt to fetch the user rights/ACL from the server failed.

Definition at line 64 of file acljobs.h.

ACLPermissions

enum KMail::ACLJobs::ACLPermissions

Bitfield modelling the possible permissions.

This is modelled after the imap4 permissions except that Read is "rs". The semantics of the bits is protocol-dependent.

Definition at line 73 of file acljobs.h.

Function Documentation

deleteACL()

ACLJobs::DeleteACLJob * KMail::ACLJobs::deleteACL	(	TDEIO::Slave *	slave,
		const KURL &	url,
		const TQString &	user
	)

Delete the permissions for a given user on a given url.

Definition at line 136 of file acljobs.cpp.

getACL()

ACLJobs::GetACLJob * KMail::ACLJobs::getACL	(	TDEIO::Slave *	slave,
		const KURL &	url
	)

List all ACLs for a given url.

Definition at line 147 of file acljobs.cpp.

getUserRights()

ACLJobs::GetUserRightsJob * KMail::ACLJobs::getUserRights	(	TDEIO::Slave *	slave,
		const KURL &	url
	)

Get the users' rights for a given url.

Definition at line 158 of file acljobs.cpp.

multiSetACL()

ACLJobs::MultiSetACLJob * KMail::ACLJobs::multiSetACL	(	TDEIO::Slave *	slave,
		const KURL &	url,
		const ACLList &	acl
	)

Set and delete a list of permissions for different users on a given url.

Definition at line 258 of file acljobs.cpp.

setACL()

TDEIO::SimpleJob * KMail::ACLJobs::setACL	(	TDEIO::Slave *	slave,
		const KURL &	url,
		const TQString &	user,
		unsigned int	permissions
	)

Set the permissions for a given user on a given url.

Definition at line 123 of file acljobs.cpp.