storejob.h

00001 /*
00002     Copyright (c) 2009 Kevin Ottens <ervin@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_STOREJOB_H
00021 #define KIMAP_STOREJOB_H
00022 
00023 #include "kimap_export.h"
00024 
00025 #include "job.h"
00026 #include "imapset.h"
00027 
00028 namespace KIMAP {
00029 
00030 class Session;
00031 struct Message;
00032 class StoreJobPrivate;
00033 
00034 typedef QList<QByteArray> MessageFlags;
00035 
00036 class KIMAP_EXPORT StoreJob : public Job
00037 {
00038   Q_OBJECT
00039   Q_DECLARE_PRIVATE(StoreJob)
00040 
00041   friend class SessionPrivate;
00042 
00043   public:
00044     enum StoreMode
00045     {
00046       SetFlags,
00047       AppendFlags,
00048       RemoveFlags
00049     };
00050 
00051     explicit StoreJob( Session *session );
00052     virtual ~StoreJob();
00053 
00054     void setSequenceSet( const ImapSet &set );
00055     ImapSet sequenceSet() const;
00056 
00057     void setUidBased( bool uidBased );
00058     bool isUidBased() const;
00059 
00060     void setFlags( const MessageFlags &flags );
00061     MessageFlags flags() const;
00062 
00063     void setMode( StoreMode mode );
00064     StoreMode mode() const;
00065 
00066     QMap<int, MessageFlags> resultingFlags() const;
00067 
00068   protected:
00069     virtual void doStart();
00070     virtual void handleResponse(const Message &response);
00071 };
00072 
00073 }
00074 
00075 #endif

KIMAP Library

API Dox
KDE Home | KDE Accessibility Home | Description of Access Keys