#include <specialmailcollectionsrequestjob.h>
Inherits SpecialCollectionsRequestJob.
Public Member Functions | |
SpecialMailCollectionsRequestJob (QObject *parent=0) | |
~SpecialMailCollectionsRequestJob () | |
void | requestCollection (SpecialMailCollections::Type type, const AgentInstance &instance) |
void | requestDefaultCollection (SpecialMailCollections::Type type) |
Detailed Description
A job to request SpecialMailCollections.
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(); ... }
- Since:
- 4.4
Definition at line 72 of file specialmailcollectionsrequestjob.h.
Constructor & Destructor Documentation
SpecialMailCollectionsRequestJob::SpecialMailCollectionsRequestJob | ( | QObject * | parent = 0 | ) | [explicit] |
Creates a new special mail collections request job.
Definition at line 47 of file specialmailcollectionsrequestjob.cpp.
Destroys the special mail collections request job.
Definition at line 81 of file specialmailcollectionsrequestjob.cpp.
Member Function Documentation
void SpecialMailCollectionsRequestJob::requestCollection | ( | SpecialMailCollections::Type | type, |
const AgentInstance & | instance | ||
) |
Requests a special mail collection of the given type
in the given resource instance
.
Definition at line 90 of file specialmailcollectionsrequestjob.cpp.
void SpecialMailCollectionsRequestJob::requestDefaultCollection | ( | SpecialMailCollections::Type | type | ) |
Requests a special mail collection of the given type
in the default resource.
Definition at line 85 of file specialmailcollectionsrequestjob.cpp.
The documentation for this class was generated from the following files: