KDE API Referenceakonadi
#include <specialmailcollections.h>
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) |
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) |
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) | |
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).
- Since
- 4.4
Definition at line 67 of file specialmailcollections.h.
Member Enumeration Documentation
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.
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.
|
static |
Returns the global SpecialMailCollections instance.
Definition at line 97 of file specialmailcollections.cpp.
|
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:
Documentation copyright © 1996-2014 The KDE developers.
Generated on Tue Oct 14 2014 23:00:29 by doxygen 1.8.7 written by Dimitri van Heesch, © 1997-2006
KDE's Doxygen guidelines are available online.
