KDE PIM / Developers / API Docs / kmail
KMail::AnnotationJobs

KMail::AnnotationJobs Namespace Reference

This namespace contains functions that return jobs for annotation operations. More...

Classes

Functions

Detailed Description

This namespace contains functions that return jobs for annotation operations.

The current implementation is tied to IMAP. If someone wants to extend this to other protocols, turn the namespace into a class and use virtual methods.

Function Documentation

KIO::SimpleJob* setAnnotation (  KIO::Slave *  slave,
const KURL &  url,
const QString &  entry,
const QMap< QString, QString > &  attributes
) 
 

Set an annotation entry (note that it can have multiple attributes).

Parameters:
slave Slave object the job should be assigned to
url URL for the annotation
entry the name of the annotation entry
attributes attribute name+value pairs

MultiSetAnnotationJob* multiSetAnnotation (  KIO::Slave *  slave,
const KURL &  url,
const AnnotationList &  annotations
) 
 

Set multiple annotation entries.

GetAnnotationJob* getAnnotation (  KIO::Slave *  slave,
const KURL &  url,
const QString &  entry,
const QStringList &  attributes
) 
 

Get an annotation entry.

Parameters:
slave Slave object the job should be assigned to
url URL for the annotation
entry the name of the annotation entry
attributes attribute names

MultiGetAnnotationJob* multiGetAnnotation (  KIO::Slave *  slave,
const KURL &  url,
const QStringList &  entries
) 
 

Get multiple annotation entries Currently we assume we want to get the "value" for each, to simplify the data structure.