• Skip to content
  • Skip to link menu
  • KDE API Reference
  • kdepimlibs-4.14.10 API Reference
  • KDE Home
  • Contact Us
 

akonadi

  • Akonadi
  • SpecialMailCollectionsRequestJob
Public Member Functions | List of all members
Akonadi::SpecialMailCollectionsRequestJob Class Reference

#include <specialmailcollectionsrequestjob.h>

Inheritance diagram for Akonadi::SpecialMailCollectionsRequestJob:
Akonadi::SpecialCollectionsRequestJob Akonadi::TransactionSequence Akonadi::Job

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
virtual void slotResult (KJob *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 bool addSubjob (KJob *job)
 
virtual void doHandleResponse (const QByteArray &tag, const QByteArray &data)
 
virtual bool doKill ()
 
virtual void doStart ()=0
 
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();
...
}
Akonadi::Collection
Represents a collection of PIM items.
Definition: collection.h:76
Akonadi::SpecialCollectionsRequestJob::collection
Collection collection() const
Returns the requested collection.
Definition: specialcollectionsrequestjob.cpp:308
Akonadi::SpecialMailCollectionsRequestJob
A job to request SpecialMailCollections.
Definition: specialmailcollectionsrequestjob.h:73
Akonadi::SpecialMailCollectionsRequestJob::requestDefaultCollection
void requestDefaultCollection(SpecialMailCollections::Type type)
Requests a special mail collection of the given type in the default resource.
Definition: specialmailcollectionsrequestjob.cpp:102
Akonadi::SpecialMailCollections::Outbox
@ Outbox
The outbox collection.
Definition: specialmailcollections.h:82
Author
Constantin Berzan exit3.nosp@m.219@.nosp@m.gmail.nosp@m..com
Since
4.4

Definition at line 72 of file specialmailcollectionsrequestjob.h.

Constructor & Destructor Documentation

◆ SpecialMailCollectionsRequestJob()

SpecialMailCollectionsRequestJob::SpecialMailCollectionsRequestJob ( QObject *  parent = 0)
explicit

Creates a new special mail collections request job.

Definition at line 63 of file specialmailcollectionsrequestjob.cpp.

◆ ~SpecialMailCollectionsRequestJob()

SpecialMailCollectionsRequestJob::~SpecialMailCollectionsRequestJob ( )

Destroys the special mail collections request job.

Definition at line 98 of file specialmailcollectionsrequestjob.cpp.

Member Function Documentation

◆ requestCollection()

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 107 of file specialmailcollectionsrequestjob.cpp.

◆ requestDefaultCollection()

void SpecialMailCollectionsRequestJob::requestDefaultCollection ( SpecialMailCollections::Type  type)

Requests a special mail collection of the given type in the default resource.

Definition at line 102 of file specialmailcollectionsrequestjob.cpp.


The documentation for this class was generated from the following files:
  • specialmailcollectionsrequestjob.h
  • specialmailcollectionsrequestjob.cpp
This file is part of the KDE documentation.
Documentation copyright © 1996-2022 The KDE developers.
Generated on Thu Jul 21 2022 00:00:00 by doxygen 1.9.5 written by Dimitri van Heesch, © 1997-2006

KDE's Doxygen guidelines are available online.

akonadi

Skip menu "akonadi"
  • Main Page
  • Namespace List
  • Namespace Members
  • Alphabetical List
  • Class List
  • Class Hierarchy
  • Class Members
  • File List
  • Modules
  • Related Pages

kdepimlibs-4.14.10 API Reference

Skip menu "kdepimlibs-4.14.10 API Reference"
  • akonadi
  •   contact
  •   kmime
  •   socialutils
  • kabc
  • kalarmcal
  • kblog
  • kcal
  • kcalcore
  • kcalutils
  • kholidays
  • kimap
  • kioslave
  •   imap4
  •   mbox
  •   nntp
  • kldap
  • kmbox
  • kmime
  • kontactinterface
  • kpimidentities
  • kpimtextedit
  • kpimutils
  • kresources
  • ktnef
  • kxmlrpcclient
  • mailtransport
  • microblog
  • qgpgme
  • syndication
  •   atom
  •   rdf
  •   rss2
Report problems with this website to our bug tracking system.
Contact the specific authors with questions and comments about the page contents.

KDE® and the K Desktop Environment® logo are registered trademarks of KDE e.V. | Legal