Akonadi::SpecialMailCollections
#include <specialmailcollections.h>
Public Types | |
enum | Type { Invalid = -1 , Root = 0 , Inbox , Outbox , SentMail , Trash , Drafts , Templates , Spam , LastType } |
Public Types inherited from QObject | |
typedef | QObjectList |
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 | |
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) | |
QBindable< QString > | bindableObjectName () |
bool | blockSignals (bool block) |
const QObjectList & | children () const const |
QMetaObject::Connection | connect (const QObject *sender, const char *signal, const char *method, Qt::ConnectionType type) const const |
void | deleteLater () |
void | destroyed (QObject *obj) |
bool | disconnect (const char *signal, const QObject *receiver, const char *method) const const |
bool | disconnect (const QObject *receiver, const char *method) const const |
void | dumpObjectInfo () const const |
void | dumpObjectTree () const const |
QList< QByteArray > | dynamicPropertyNames () const const |
virtual bool | event (QEvent *e) |
virtual bool | eventFilter (QObject *watched, QEvent *event) |
T | findChild (const QString &name, Qt::FindChildOptions options) const const |
QList< T > | findChildren (const QRegularExpression &re, Qt::FindChildOptions options) const const |
QList< T > | findChildren (const QString &name, Qt::FindChildOptions options) const const |
QList< T > | findChildren (Qt::FindChildOptions options) const const |
bool | inherits (const char *className) const const |
void | installEventFilter (QObject *filterObj) |
bool | isQuickItemType () const const |
bool | isWidgetType () const const |
bool | isWindowType () const const |
void | killTimer (int id) |
virtual const QMetaObject * | metaObject () const const |
void | moveToThread (QThread *targetThread) |
QString | objectName () const const |
void | objectNameChanged (const QString &objectName) |
QObject * | parent () const const |
QVariant | property (const char *name) const const |
Q_CLASSINFO (Name, Value) | |
Q_EMIT Q_EMIT | |
Q_ENUM (...) | |
Q_ENUM_NS (...) | |
Q_ENUMS (...) | |
Q_FLAG (...) | |
Q_FLAG_NS (...) | |
Q_FLAGS (...) | |
Q_GADGET Q_GADGET | |
Q_GADGET_EXPORT (EXPORT_MACRO) | |
Q_INTERFACES (...) | |
Q_INVOKABLE Q_INVOKABLE | |
Q_MOC_INCLUDE Q_MOC_INCLUDE | |
Q_NAMESPACE Q_NAMESPACE | |
Q_NAMESPACE_EXPORT (EXPORT_MACRO) | |
Q_OBJECT Q_OBJECT | |
Q_PROPERTY (...) | |
Q_REVISION Q_REVISION | |
Q_SET_OBJECT_NAME (Object) | |
Q_SIGNAL Q_SIGNAL | |
Q_SIGNALS Q_SIGNALS | |
Q_SLOT Q_SLOT | |
Q_SLOTS Q_SLOTS | |
T | qobject_cast (const QObject *object) |
T | qobject_cast (QObject *object) |
QT_NO_NARROWING_CONVERSIONS_IN_CONNECT QT_NO_NARROWING_CONVERSIONS_IN_CONNECT | |
void | removeEventFilter (QObject *obj) |
void | setObjectName (const QString &name) |
void | setObjectName (QAnyStringView name) |
void | setParent (QObject *parent) |
bool | setProperty (const char *name, const QVariant &value) |
bool | setProperty (const char *name, QVariant &&value) |
bool | signalsBlocked () const const |
int | startTimer (int interval, Qt::TimerType timerType) |
int | startTimer (std::chrono::milliseconds interval, Qt::TimerType timerType) |
QThread * | thread () const 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 | |
QMetaObject::Connection | connect (const QObject *sender, const char *signal, const QObject *receiver, const char *method, Qt::ConnectionType type) |
QMetaObject::Connection | connect (const QObject *sender, const QMetaMethod &signal, const QObject *receiver, const QMetaMethod &method, Qt::ConnectionType type) |
QMetaObject::Connection | connect (const QObject *sender, PointerToMemberFunction signal, const QObject *context, Functor functor, Qt::ConnectionType type) |
QMetaObject::Connection | connect (const QObject *sender, PointerToMemberFunction signal, const QObject *receiver, PointerToMemberFunction method, Qt::ConnectionType type) |
QMetaObject::Connection | connect (const QObject *sender, PointerToMemberFunction signal, Functor functor) |
bool | disconnect (const QMetaObject::Connection &connection) |
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) |
bool | disconnect (const QObject *sender, PointerToMemberFunction signal, const QObject *receiver, PointerToMemberFunction method) |
QString | tr (const char *sourceText, const char *disambiguation, int n) |
Additional Inherited Members | |
Properties inherited from QObject | |
objectName | |
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=nullptr) | |
Protected Member Functions inherited from QObject | |
virtual void | childEvent (QChildEvent *event) |
virtual void | connectNotify (const QMetaMethod &signal) |
virtual void | customEvent (QEvent *event) |
virtual void | disconnectNotify (const QMetaMethod &signal) |
bool | isSignalConnected (const QMetaMethod &signal) const const |
int | receivers (const char *signal) const const |
QObject * | sender () const const |
int | senderSignalIndex () const const |
virtual void | timerEvent (QTimerEvent *event) |
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 53 of file specialmailcollections.h.
Member Enumeration Documentation
◆ 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.
Definition at line 64 of file specialmailcollections.h.
Member Function Documentation
◆ collection()
|
nodiscard |
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 86 of file specialmailcollections.cpp.
◆ defaultCollection()
|
nodiscard |
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 110 of file specialmailcollections.cpp.
◆ hasCollection()
|
nodiscard |
Returns whether the given agent instance
has a special collection of the given type
.
Definition at line 81 of file specialmailcollections.cpp.
◆ hasDefaultCollection()
|
nodiscard |
Returns whether the default resource has a special mail collection of the given type
.
Definition at line 105 of file specialmailcollections.cpp.
◆ registerCollection()
|
nodiscard |
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 91 of file specialmailcollections.cpp.
◆ self()
|
static |
Returns the global SpecialMailCollections instance.
Definition at line 76 of file specialmailcollections.cpp.
◆ specialCollectionType()
|
staticnodiscard |
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 164 of file specialmailcollections.cpp.
◆ unregisterCollection()
|
nodiscard |
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 96 of file specialmailcollections.cpp.
◆ verifyI18nDefaultCollection()
void SpecialMailCollections::verifyI18nDefaultCollection | ( | Type | type | ) |
Definition at line 115 of file specialmailcollections.cpp.
The documentation for this class was generated from the following files:
Documentation copyright © 1996-2024 The KDE developers.
Generated on Fri Dec 6 2024 12:12:56 by doxygen 1.12.0 written by Dimitri van Heesch, © 1997-2006
KDE's Doxygen guidelines are available online.