#include <specialmailcollectionsrequestjob.h>

Inheritance diagram for Akonadi::SpecialMailCollectionsRequestJob:

Public Member Functions
	SpecialMailCollectionsRequestJob (QObject *parent=0)

	~SpecialMailCollectionsRequestJob ()

void	requestCollection (SpecialMailCollections::Type type, const AgentInstance &instance)

void	requestDefaultCollection (SpecialMailCollections::Type type)

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

Collection	collection () const

void	requestCollection (const QByteArray &type, const AgentInstance &instance)

void	requestDefaultCollection (const QByteArray &type)

Public Member Functions inherited from Akonadi::TransactionSequence
	TransactionSequence (QObject *parent=0)

	~TransactionSequence ()

void	commit ()

void	rollback ()

void	setAutomaticCommittingEnabled (bool enable)

void	setIgnoreJobFailure (KJob *job)

Public Member Functions inherited from Akonadi::Job
	Job (QObject *parent=0)

virtual	~Job ()

virtual QString	errorString () const

void	start ()

Additional Inherited Members
Public Types inherited from Akonadi::Job
enum	Error { ConnectionFailed = UserDefinedError, ProtocolVersionMismatch, UserCanceled, Unknown, UserError = UserDefinedError + 42 }

typedef QList< Job * >	List

Signals inherited from Akonadi::Job
void	aboutToStart (Akonadi::Job *job)

void	writeFinished (Akonadi::Job *job)

Protected Slots inherited from Akonadi::TransactionSequence
void	slotResult (KJob *job)

Protected Slots inherited from Akonadi::Job
Protected Member Functions inherited from Akonadi::SpecialCollectionsRequestJob
	SpecialCollectionsRequestJob (SpecialCollections collections, QObject parent=0)

virtual void	doStart ()

void	setDefaultResourceOptions (const QVariantMap &options)

void	setDefaultResourceType (const QString &type)

void	setIconForTypeMap (const QMap< QByteArray, QString > &map)

void	setNameForTypeMap (const QMap< QByteArray, QString > &map)

void	setTypes (const QList< QByteArray > &types)

virtual void	slotResult (KJob *job)

Protected Member Functions inherited from Akonadi::TransactionSequence
bool	addSubjob (KJob *job)

void	doStart ()

Protected Member Functions inherited from Akonadi::Job
virtual void	doHandleResponse (const QByteArray &tag, const QByteArray &data)

virtual bool	doKill ()

void	emitWriteFinished ()

virtual bool	removeSubjob (KJob *job)

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();
  ...
}