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

KIMAP Library

  • kimap
getmetadatajob.h
1 /*
2  Copyright (c) 2009 Andras Mantia <amantia@kde.org>
3 
4  This library is free software; you can redistribute it and/or modify it
5  under the terms of the GNU Library General Public License as published by
6  the Free Software Foundation; either version 2 of the License, or (at your
7  option) any later version.
8 
9  This library is distributed in the hope that it will be useful, but WITHOUT
10  ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
11  FITNESS FOR A PARTICULAR PURPOSE. See the GNU Library General Public
12  License for more details.
13 
14  You should have received a copy of the GNU Library General Public License
15  along with this library; see the file COPYING.LIB. If not, write to the
16  Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
17  02110-1301, USA.
18 */
19 
20 #ifndef KIMAP_GETMETADATAJOB_H
21 #define KIMAP_GETMETADATAJOB_H
22 
23 #include "kimap_export.h"
24 
25 #include "metadatajobbase.h"
26 
27 namespace KIMAP {
28 
29 class Session;
30 struct Message;
31 class GetMetaDataJobPrivate;
32 
61 class KIMAP_EXPORT GetMetaDataJob : public MetaDataJobBase
62 {
63  Q_OBJECT
64  Q_DECLARE_PRIVATE( GetMetaDataJob )
65 
66  friend class SessionPrivate;
67 
68  public:
69  explicit GetMetaDataJob( Session *session );
70  virtual ~GetMetaDataJob();
71 
75  enum Depth {
76  NoDepth = 0,
77  OneLevel,
78  AllLevels
79  };
80 
81  Q_DECLARE_FLAGS( Depths, Depth )
82 
83 
96  void addEntry( const QByteArray &entry, const QByteArray &attribute = QByteArray() );
97 
115  void setMaximumSize( qint64 size );
116 
137  void setDepth( Depth depth );
138 
158  // XXX: what's with the mailBox argument in a class that has setMailBox()?
159  // KJobs are not intended to be run more than once
160  QByteArray metaData( const QString &mailBox, const QByteArray &entry,
161  const QByteArray &attribute = QByteArray() ) const;
162 
184  // XXX: what's with the mailBox argument in a class that has setMailBox()?
185  // KJobs are not intended to be run more than once
186  QMap<QByteArray, QMap<QByteArray, QByteArray> > allMetaData( const QString &mailBox ) const;
187 
188  protected:
189  virtual void doStart();
190  virtual void handleResponse( const Message &response );
191 
192 };
193 
194 }
195 
196 #endif
This file is part of the KDE documentation.
Documentation copyright © 1996-2013 The KDE developers.
Generated on Sat Jul 13 2013 01:25:16 by doxygen 1.8.3.1 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.10.5 API Reference

Skip menu "kdepimlibs-4.10.5 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