#include <specialmailcollections.h>

Inheritance diagram for Akonadi::SpecialMailCollections:

Public Types
enum	Type { Invalid = -1, Root = 0, Inbox, Outbox, SentMail, Trash, Drafts, Templates, LastType }

Public Member Functions
Akonadi::Collection	collection (Type type, const AgentInstance &instance) const

Akonadi::Collection	defaultCollection (Type type) const

bool	hasCollection (Type type, const AgentInstance &instance) const

bool	hasDefaultCollection (Type type) const

bool	registerCollection (Type type, const Akonadi::Collection &collection)

bool	unregisterCollection (const Collection &collection)

void	verifyI18nDefaultCollection (Type type)

Public Member Functions inherited from Akonadi::SpecialCollections
	~SpecialCollections ()

Akonadi::Collection	collection (const QByteArray &type, const AgentInstance &instance) const

Akonadi::Collection	defaultCollection (const QByteArray &type) const

bool	hasCollection (const QByteArray &type, const AgentInstance &instance) const

bool	hasDefaultCollection (const QByteArray &type) const

bool	registerCollection (const QByteArray &type, const Akonadi::Collection &collection)

bool	unregisterCollection (const Collection &collection)

Public Member Functions inherited from QObject
	QObject (QObject *parent)

	QObject (QObject parent, const char name)

bool	blockSignals (bool block)

QObject *	child (const char objName, const char inheritsClass, bool recursiveSearch) const

const QObjectList &	children () const

const char *	className () const

bool	connect (const QObject sender, const char signal, const char *method, Qt::ConnectionType type) const

void	deleteLater ()

void	destroyed (QObject *obj)

bool	disconnect (const QObject receiver, const char method)

bool	disconnect (const char signal, const QObject receiver, const char *method)

void	dumpObjectInfo ()

void	dumpObjectTree ()

QList< QByteArray >	dynamicPropertyNames () const

virtual bool	event (QEvent *e)

virtual bool	eventFilter (QObject watched, QEvent event)

T	findChild (const QString &name) const

QList< T >	findChildren (const QRegExp &regExp) const

QList< T >	findChildren (const QString &name) const

bool	inherits (const char *className) const

void	insertChild (QObject *object)

void	installEventFilter (QObject *filterObj)

bool	isA (const char *className) const

bool	isWidgetType () const

void	killTimer (int id)

virtual const QMetaObject *	metaObject () const

void	moveToThread (QThread *targetThread)

const char *	name () const

const char *	name (const char *defaultName) const

QString	objectName () const

QObject *	parent () const

QVariant	property (const char *name) const

void	removeChild (QObject *object)

void	removeEventFilter (QObject *obj)

void	setName (const char *name)

void	setObjectName (const QString &name)

void	setParent (QObject *parent)

bool	setProperty (const char *name, const QVariant &value)

bool	signalsBlocked () const

int	startTimer (int interval)

QThread *	thread () const

Static Public Member Functions
static SpecialMailCollections *	self ()

static Type	specialCollectionType (const Akonadi::Collection &collection)

Static Public Member Functions inherited from Akonadi::SpecialCollections
static void	setSpecialCollectionType (const QByteArray &type, const Akonadi::Collection &collection)

static void	unsetSpecialCollection (const Akonadi::Collection &collection)

Static Public Member Functions inherited from QObject
bool	connect (const QObject sender, const char signal, const QObject receiver, const char method, Qt::ConnectionType type)

bool	connect (const QObject sender, const QMetaMethod &signal, const QObject receiver, const QMetaMethod &method, Qt::ConnectionType type)

bool	disconnect (const QObject sender, const char signal, const QObject receiver, const char method)

bool	disconnect (const QObject sender, const QMetaMethod &signal, const QObject receiver, const QMetaMethod &method)

QString	tr (const char sourceText, const char disambiguation, int n)

QString	trUtf8 (const char sourceText, const char disambiguation, int n)

Additional Inherited Members
Signals inherited from Akonadi::SpecialCollections
void	collectionsChanged (const Akonadi::AgentInstance &instance)

void	defaultCollectionsChanged ()

Protected Member Functions inherited from Akonadi::SpecialCollections
	SpecialCollections (KCoreConfigSkeleton config, QObject parent=0)

Protected Member Functions inherited from QObject
bool	checkConnectArgs (const char signal, const QObject object, const char *method)

virtual void	childEvent (QChildEvent *event)

virtual void	connectNotify (const char *signal)

virtual void	customEvent (QEvent *event)

virtual void	disconnectNotify (const char *signal)

int	receivers (const char *signal) const

QObject *	sender () const

int	senderSignalIndex () const

virtual void	timerEvent (QTimerEvent *event)

Static Protected Member Functions inherited from QObject
QByteArray	normalizeSignalSlot (const char *signalSlot)

Properties inherited from QObject
	objectName

Detailed Description

Interface to special mail collections such as inbox, outbox etc.

This class is the central interface to the local mail folders. These folders can either be in the default resource (stored in ~/.local/share/local-mail) or in any number of custom resources. Special collections of the following types are supported: inbox, outbox, sent-mail, trash, drafts, templates and spam.

To check whether a special mail collection is available, simply use the hasCollection() and hasDefaultCollection() methods. Available special mail collections are accessible through the collection() and defaultCollection() methods.

To create a special mail collection, use a SpecialMailCollectionsRequestJob. This will create the special mail collections you request and automatically register them with SpecialMailCollections, so that it now knows they are available.

This class monitors all special mail collections known to it, and removes it from the known list if they are deleted. Note that this class does not automatically rebuild the collections that disappeared.

The defaultCollectionsChanged() and collectionsChanged() signals are emitted when the special mail collections for a resource change (i.e. some became available or some become unavailable).

if ( SpecialMailCollections::self()->hasDefaultCollection( SpecialMailCollections::Outbox ) ) {
  const Collection col = SpecialMailCollections::self()->defaultCollection( SpecialMailCollections::Outbox );
  // ...
} else {
  // ... use SpecialMailCollectionsRequestJob to request the collection...
}

Author: Constantin Berzan exit3.nosp@m.219@.nosp@m.gmail.nosp@m..com

Since: 4.4

Definition at line 67 of file specialmailcollections.h.

Member Enumeration Documentation

enum Akonadi::SpecialMailCollections::Type

Describes the possible types of special mail collections.

Generally, there may not be two special mail collections of the same type in the same resource.

Enumerator
Invalid	An invalid special collection.
Root	The root collection containing the local folders.
Inbox	The inbox collection.
Outbox	The outbox collection.
SentMail	The sent-mail collection.
Trash	The trash collection.
Drafts	The drafts collection.
Templates	The templates collection.
LastType	marker

Definition at line 78 of file specialmailcollections.h.

Member Function Documentation

Collection SpecialMailCollections::collection	(	Type	type,
		const AgentInstance &	instance
	)		const

Returns the special mail collection of the given type in the given agent instance, or an invalid collection if such a collection is unknown.

Definition at line 107 of file specialmailcollections.cpp.

Collection SpecialMailCollections::defaultCollection ( Type type ) const

Returns the special mail collection of given type in the default resource, or an invalid collection if such a collection is unknown.

Definition at line 131 of file specialmailcollections.cpp.

bool SpecialMailCollections::hasCollection	(	Type	type,
		const AgentInstance &	instance
	)		const

Returns whether the given agent instance has a special collection of the given type.

Definition at line 102 of file specialmailcollections.cpp.

bool SpecialMailCollections::hasDefaultCollection ( Type type ) const

Returns whether the default resource has a special mail collection of the given type.

Definition at line 126 of file specialmailcollections.cpp.

bool SpecialMailCollections::registerCollection	(	Type	type,
		const Akonadi::Collection &	collection
	)

Registers the given collection as a special mail collection with the given type.

Parameters

type	the type of collection
collection	the collection to register The collection must be owned by a valid resource. Registering a new collection of a previously registered type forgets the old collection.

Definition at line 112 of file specialmailcollections.cpp.

SpecialMailCollections * SpecialMailCollections::self ( )

static

Returns the global SpecialMailCollections instance.

Definition at line 97 of file specialmailcollections.cpp.

SpecialMailCollections::Type SpecialMailCollections::specialCollectionType ( const Akonadi::Collection & collection )

static

Returns the special collection type for a given collection, or empty if the collection doesn't have a special type.

Since: 4.11

Definition at line 182 of file specialmailcollections.cpp.

bool SpecialMailCollections::unregisterCollection ( const Collection & collection )

Unregisters the given collection as a special mail collection.

Parameters

collection the collection to unregister The collection must be owned by a valid resource.

Since: 4.12

Definition at line 117 of file specialmailcollections.cpp.

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

akonadi

Public Types

Public Member Functions

Static Public Member Functions

Additional Inherited Members

Detailed Description

Member Enumeration Documentation

Member Function Documentation

akonadi

kdepimlibs API Reference

Search