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

KIMAP Library

setmetadatajob.h
00001 /*
00002     Copyright (c) 2009 Andras Mantia <amantia@kde.org>
00003 
00004     This library is free software; you can redistribute it and/or modify it
00005     under the terms of the GNU Library General Public License as published by
00006     the Free Software Foundation; either version 2 of the License, or (at your
00007     option) any later version.
00008 
00009     This library is distributed in the hope that it will be useful, but WITHOUT
00010     ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
00011     FITNESS FOR A PARTICULAR PURPOSE.  See the GNU Library General Public
00012     License for more details.
00013 
00014     You should have received a copy of the GNU Library General Public License
00015     along with this library; see the file COPYING.LIB.  If not, write to the
00016     Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
00017     02110-1301, USA.
00018 */
00019 
00020 #ifndef KIMAP_SETMETADATAJOB_H
00021 #define KIMAP_SETMETADATAJOB_H
00022 
00023 #include "kimap_export.h"
00024 
00025 #include "metadatajobbase.h"
00026 
00027 namespace KIMAP {
00028 
00029 class Session;
00030 struct Message;
00031 class SetMetaDataJobPrivate;
00032 
00068 class KIMAP_EXPORT SetMetaDataJob : public MetaDataJobBase
00069 {
00070   Q_OBJECT
00071   Q_DECLARE_PRIVATE(SetMetaDataJob)
00072 
00073   friend class SessionPrivate;
00074 
00075   public:
00076     explicit SetMetaDataJob( Session *session );
00077     virtual ~SetMetaDataJob();
00078 
00136     void addMetaData(const QByteArray &name, const QByteArray &value);
00137 
00167     // KDE5: this API is horrible for Annotatemore mode: use an overload of
00168     //       addMetaData() instead:
00169     //       void addMetaData(const QString &entry, const QByteArray &value,
00170     //                        const QByteArray &encoding = QByteArray(),
00171     //                        const QByteArray &language = QByteArray(),
00172     //                        const QMap<QString,QByteArray> vendorAttributes =
00173     //                        QMap<QString,QByteArray>());
00174     void setEntry(const QByteArray &entry);
00175 
00179     enum MetaDataError {
00180       NoError = 0,  
00181       TooMany = 1,  
00182       TooBig = 2,   
00183       NoPrivate = 4 
00184     };
00185 
00186     // Q_DECLARE_WHATEVER_THAT_WAS missing
00187     Q_DECLARE_FLAGS(MetaDataErrors, MetaDataError)
00188 
00189     
00194     MetaDataErrors metaDataErrors() const;
00204     qint64 maxAcceptedSize();
00205 
00206   protected:
00207     virtual void doStart();
00208     virtual void handleResponse( const Message &response );
00209 
00210 };
00211 
00212 }
00213 
00214 Q_DECLARE_OPERATORS_FOR_FLAGS( KIMAP::SetMetaDataJob::MetaDataErrors )
00215 
00216 #endif
This file is part of the KDE documentation.
Documentation copyright © 1996-2012 The KDE developers.
Generated on Mon May 14 2012 04:39:11 by doxygen 1.7.5 written by Dimitri van Heesch, © 1997-2006

KDE's Doxygen guidelines are available online.

KIMAP Library

Skip menu "KIMAP Library"
  • Main Page
  • Namespace List
  • Namespace Members
  • Alphabetical List
  • Class List
  • Class Hierarchy
  • Class Members
  • File List
  • Related Pages

kdepimlibs-4.8.3 API Reference

Skip menu "kdepimlibs-4.8.3 API Reference"
  • akonadi
  •   contact
  •   kmime
  • kabc
  • kalarmcal
  • 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
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