KIMAP Library
getmetadatajob.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_GETMETADATAJOB_H 00021 #define KIMAP_GETMETADATAJOB_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 GetMetaDataJobPrivate; 00032 00061 class KIMAP_EXPORT GetMetaDataJob : public MetaDataJobBase 00062 { 00063 Q_OBJECT 00064 Q_DECLARE_PRIVATE( GetMetaDataJob ) 00065 00066 friend class SessionPrivate; 00067 00068 public: 00069 explicit GetMetaDataJob( Session *session ); 00070 virtual ~GetMetaDataJob(); 00071 00075 enum Depth { 00076 NoDepth = 0, 00077 OneLevel, 00078 AllLevels 00079 }; 00080 00081 Q_DECLARE_FLAGS( Depths, Depth ) 00082 00083 00096 void addEntry( const QByteArray &entry, const QByteArray &attribute = QByteArray() ); 00097 00115 void setMaximumSize( qint64 size ); 00116 00137 void setDepth( Depth depth ); 00138 00158 // XXX: what's with the mailBox argument in a class that has setMailBox()? 00159 // KJobs are not intended to be run more than once 00160 QByteArray metaData( const QString &mailBox, const QByteArray &entry, 00161 const QByteArray &attribute = QByteArray() ) const; 00162 00184 // XXX: what's with the mailBox argument in a class that has setMailBox()? 00185 // KJobs are not intended to be run more than once 00186 QMap<QByteArray, QMap<QByteArray, QByteArray> > allMetaData( const QString &mailBox ) const; 00187 00188 protected: 00189 virtual void doStart(); 00190 virtual void handleResponse( const Message &response ); 00191 00192 }; 00193 00194 } 00195 00196 #endif
This file is part of the KDE documentation.
Documentation copyright © 1996-2012 The KDE developers.
Generated on Mon Aug 27 2012 22:08:13 by doxygen 1.7.5 written by Dimitri van Heesch, © 1997-2006
Documentation copyright © 1996-2012 The KDE developers.
Generated on Mon Aug 27 2012 22:08:13 by doxygen 1.7.5 written by Dimitri van Heesch, © 1997-2006
KDE's Doxygen guidelines are available online.