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

akonadi/kmime

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

#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();
...
}
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 ( 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 82 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 91 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 86 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-2014 The KDE developers.
Generated on Tue Oct 14 2014 23:00:55 by doxygen 1.8.7 written by Dimitri van Heesch, © 1997-2006

KDE's Doxygen guidelines are available online.

akonadi/kmime

Skip menu "akonadi/kmime"
  • Main Page
  • Namespace List
  • Namespace Members
  • Alphabetical List
  • Class List
  • Class Members
  • File List
  • Related Pages

kdepimlibs API Reference

Skip menu "kdepimlibs API Reference"
  • akonadi
  •   contact
  •   kmime
  •   socialutils
  • kabc
  • kalarmcal
  • kblog
  • kcal
  • kcalcore
  • kcalutils
  • kholidays
  • kimap
  • kldap
  • kmbox
  • kmime
  • kpimidentities
  • kpimtextedit
  • kresources
  • ktnef
  • kxmlrpcclient
  • microblog

Search



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