• Skip to content
  • Skip to link menu
KDE 4.6 API Reference
  • KDE API Reference
  • KDE-PIM Libraries
  • KDE Home
  • Contact Us
 

akonadi

  • Akonadi
  • SpecialMailCollectionsRequestJob
Public Member Functions

Akonadi::SpecialMailCollectionsRequestJob Class Reference

A job to request SpecialMailCollections. More...

#include <specialmailcollectionsrequestjob.h>

Inheritance diagram for Akonadi::SpecialMailCollectionsRequestJob:
Inheritance graph
[legend]

List of all members.

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();
   ...
 }
Author:
Constantin Berzan <exit3219@gmail.com>
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.

SpecialMailCollectionsRequestJob::~SpecialMailCollectionsRequestJob ( )

Destroys the special mail collections request job.

Definition at line 81 of file specialmailcollectionsrequestjob.cpp.


Member Function Documentation

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

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

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

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


The documentation for this class was generated from the following files:
  • specialmailcollectionsrequestjob.h
  • specialmailcollectionsrequestjob.cpp

akonadi

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

KDE-PIM Libraries

Skip menu "KDE-PIM Libraries"
  • akonadi
  •   contact
  •   kmime
  • kabc
  • kblog
  • kcal
  • kcalcore
  • kcalutils
  • kholidays
  • kimap
  • kioslave
  •   imap4
  •   mbox
  •   nntp
  • kldap
  • kmbox
  • kmime
  • kontactinterface
  • kpimidentities
  • kpimtextedit
  •   richtextbuilders
  • kpimutils
  • kresources
  • ktnef
  • kxmlrpcclient
  • mailtransport
  • microblog
  • qgpgme
  • syndication
  •   atom
  •   rdf
  •   rss2
Generated for KDE-PIM Libraries by doxygen 1.7.3
This website is maintained by Adriaan de Groot and Allen Winter.
KDE® and the K Desktop Environment® logo are registered trademarks of KDE e.V. | Legal