Akonadi::SpecialMailCollectionsRequestJob Class
class Akonadi::SpecialMailCollectionsRequestJobA job to request SpecialMailCollections. More...
| Header: | #include <Akonadi/SpecialMailCollectionsRequestJob> |
| CMake: | find_package(KPim6AkonadiMime REQUIRED)target_link_libraries(mytarget PRIVATE KPim6::AkonadiMime) |
Public Functions
| SpecialMailCollectionsRequestJob(QObject *parent = nullptr) | |
| virtual | ~SpecialMailCollectionsRequestJob() override |
| void | requestCollection(Akonadi::SpecialMailCollections::Type type, const Akonadi::AgentInstance &instance) |
| void | requestDefaultCollection(Akonadi::SpecialMailCollections::Type type) |
Detailed Description
Use this job to request the SpecialMailCollections you need. You can request both default SpecialMailCollections and SpecialMailCollections in a given resource. The default SpecialMailCollections resource is created when the first default SpecialCollection is requested, but if a SpecialCollection in a custom resource is requested, this job expects that resource to exist already.
If the folders you requested already exist, this job simply succeeds. Otherwise, it creates the required collections and registers them with SpecialMailCollections.
Example:
SpecialMailCollectionsRequestJob *job = new SpecialMailCollectionsRequestJob( this );
job->requestDefaultCollection( SpecialMailCollections::Outbox );
connect( job, SIGNAL(result(KJob*)),
this, SLOT(requestDone(KJob*)) );
...
MyClass::requestDone( KJob *job )
{
if ( job->error() )
return;
SpecialMailCollectionsRequestJob *requestJob = qobject_cast<SpecialMailCollectionsRequestJob*>( job );
const Collection collection = requestJob->collection();
...
}
Author: Constantin Berzan <exit3219@gmail.com>
Member Function Documentation
[explicit] SpecialMailCollectionsRequestJob::SpecialMailCollectionsRequestJob(QObject *parent = nullptr)
Creates a new special mail collections request job. parent the parent object
[override virtual noexcept] SpecialMailCollectionsRequestJob::~SpecialMailCollectionsRequestJob()
Destroys the special mail collections request job.
void SpecialMailCollectionsRequestJob::requestCollection(Akonadi::SpecialMailCollections::Type type, const Akonadi::AgentInstance &instance)
Requests a special mail collection of the given type in the given resource instance.
void SpecialMailCollectionsRequestJob::requestDefaultCollection(Akonadi::SpecialMailCollections::Type type)
Requests a special mail collection of the given type in the default resource.