Skip to main content :: ::

KDE PIM API Reference

:: Skip to Link Menu

/ API Reference / kmail

kmail kmfolderimap.h Go to the documentation of this file. /* * kmfolderimap.h * * Copyright (c) 2001 Kurt Granroth <granroth@kde.org> * Copyright (c) 2000-2002 Michael Haeckel <haeckel@kde.org> * * This file is based on kmacctimap.h by Michael Haeckel which is * based on popaccount.h by Don Sanders * * This program is free software; you can redistribute it and/or modify * it under the terms of the GNU General Public License as published by * the Free Software Foundation; version 2 of the License * * This program is distributed in the hope that it will be useful, * but WITHOUT ANY WARRANTY; without even the implied warranty of * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the * GNU General Public License for more details. * * You should have received a copy of the GNU General Public License * along with this program; if not, write to the Free Software * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA. */ #ifndef kmfolderimap_h #define kmfolderimap_h #include "kmacctimap.h" #include "kmfoldermbox.h" #include "kmmsgbase.h" #include "kio/job.h" #include "kio/global.h" #include <kstandarddirs.h> #include <qintdict.h> #include <qdict.h> template< typename T> class QPtrList; template< typename T> class QValueList; class KMFolderTreeItem; class KMFolderImap; class KMSearchPattern; class KMMessage; namespace KMail { class FolderJob; class ImapJob; class AttachmentStrategy; class ImapAccountBase; } namespace KPIM { class ProgressItem; } using KMail::FolderJob; using KMail::ImapJob; using KMail::AttachmentStrategy; using KMail::ImapAccountBase; using KPIM::ProgressItem; class KMMsgMetaData { public: KMMsgMetaData(KMMsgStatus aStatus) :mStatus(aStatus), mSerNum(0) {} KMMsgMetaData(KMMsgStatus aStatus, Q_UINT32 aSerNum) :mStatus(aStatus), mSerNum(aSerNum) {} ~KMMsgMetaData() {}; const KMMsgStatus status() const { return mStatus; } const Q_UINT32 serNum() const { return mSerNum; } private: KMMsgStatus mStatus; Q_UINT32 mSerNum; }; class KMFolderImap : public KMFolderMbox { Q_OBJECT friend class ::KMail::ImapJob; public: static QString cacheLocation() { return locateLocal("data", "kmail/imap" ); } enum imapState { imapNoInformation = 0, imapListingInProgress = 1, imapDownloadInProgress = 2, imapFinished = 3 }; virtual imapState getContentState() { return mContentState; } virtual void setContentState(imapState state) { mContentState = state; } virtual imapState getSubfolderState() { return mSubfolderState; } virtual void setSubfolderState(imapState state); KMFolderImap(KMFolder* folder, const char* name=0); virtual ~KMFolderImap(); virtual KMFolderType folderType() const { return KMFolderTypeImap; } virtual KMMessage* getMsg(int idx); void setImapPath( const QString &path ); QString imapPath() const { return mImapPath; } ulong lastUid(); void setUidValidity(const QString &validity) { mUidValidity = validity; } QString uidValidity() { return mUidValidity; } void setAccount(KMAcctImap *acct); KMAcctImap* account() const; virtual void removeMsg(int i, bool quiet = FALSE); virtual void removeMsg(const QPtrList<KMMessage>& msgList, bool quiet = FALSE); virtual int rename( const QString& newName, KMFolderDir *aParent = 0 ); virtual void remove(); bool autoExpunge(); virtual void writeConfig(); virtual void readConfig(); virtual bool listDirectory(); void getFolder(bool force = FALSE); void getAndCheckFolder(bool force = FALSE); void getMessage(KMFolder * folder, KMMessage * msg); void createFolder(const QString &name, const QString& imapPath = QString::null, bool askUser = true); void deleteMessage(KMMessage * msg); void deleteMessage(const QPtrList<KMMessage>& msgList); virtual void setStatus(int idx, KMMsgStatus status, bool toggle); virtual void setStatus(QValueList<int>& _ids, KMMsgStatus status, bool toggle); static QStringList makeSets( QValueList<ulong>&, bool sort = true); static QStringList makeSets(const QStringList&, bool sort = true); static QPtrList<KMMessage> splitMessageList(const QString& set, QPtrList<KMMessage>& msgList); void getUids(QValueList<int>& ids, QValueList<ulong>& uids); void getUids(const QPtrList<KMMessage>& msgList, QValueList<ulong>& uids); void expungeFolder(KMFolderImap * aFolder, bool quiet); virtual int compact( bool ) { expungeFolder(this, false); return 0; }; void sendFolderComplete(bool success) { emit folderComplete(this, success); } bool processNewMail(bool interactive); void setSelected(bool selected) { mIsSelected = selected; } bool isSelected() { return mIsSelected; } static QString encodeFileName(const QString &); static QString decodeFileName(const QString &); static QTextCodec * utf7Codec(); static QString statusToFlags(KMMsgStatus status, int supportedFalgs); virtual QString fileName() const { return encodeFileName( KMFolderMbox::fileName() ); } const ulong serNumForUID( ulong uid ); void saveMsgMetaData( KMMessage* msg, ulong uid = 0 ); static QValueList<ulong> splitSets(const QString); virtual void ignoreJobsForMessage( KMMessage* ); bool includeInMailCheck() { return mCheckMail; } void setIncludeInMailCheck( bool check ); virtual int create(); virtual bool isAutoExpire() const { return false; } virtual void reallyDoClose(const char* owner); void setCheckingValidity( bool val ) { mCheckingValidity = val; } KMFolder* trashFolder() const; void setAlreadyRemoved(bool removed); bool isReadOnly() const { return KMFolderMbox::isReadOnly() || mReadOnly; } unsigned int userRights() const { return mUserRights; } void setUserRights( unsigned int userRights ); virtual void search( const KMSearchPattern* ); virtual void search( const KMSearchPattern*, Q_UINT32 serNum ); virtual bool isMoveable() const; void initializeFrom( KMFolderImap* parent, QString path, QString mimeType ); int permanentFlags() const { return mPermanentFlags; } signals: void folderComplete(KMFolderImap *folder, bool success); void deleted(KMFolderImap*); void directoryListingFinished(KMFolderImap*); void folderCreationResult( const QString &name, bool success ); public slots: virtual void addMsgQuiet(KMMessage *); virtual void addMsgQuiet(QPtrList<KMMessage>); virtual int addMsg(KMMessage* msg, int* index_return = 0); virtual int addMsg(QPtrList<KMMessage>&, QValueList<int>& index_return); void copyMsg(QPtrList<KMMessage>& msgList/*, KMFolder* parent*/); virtual KMMessage* take(int idx); virtual void take(QPtrList<KMMessage>); void slotSimpleData(KIO::Job * job, const QByteArray & data); static void flagsToStatus(KMMsgBase *msg, int flags, bool newMsg = TRUE, int supportedFalgs = 31 ); static void seenFlagToStatus( KMMsgBase *msg, int flags, bool newMsg = true ); void slotCopyMsgResult( KMail::FolderJob* job ); void slotSearchDone( QValueList<Q_UINT32> serNums, const KMSearchPattern* pattern, bool complete ); void slotSearchDone( Q_UINT32 serNum, const KMSearchPattern* pattern, bool matches ); void slotListResult( const QStringList&, const QStringList&, const QStringList&, const QStringList&, const ImapAccountBase::jobData& ); void slotCheckNamespace( const QStringList&, const QStringList&, const QStringList&, const QStringList&, const ImapAccountBase::jobData& ); protected: virtual FolderJob* doCreateJob( KMMessage *msg, FolderJob::JobType jt, KMFolder *folder, QString partSpecifier, const AttachmentStrategy *as ) const; virtual FolderJob* doCreateJob( QPtrList<KMMessage>& msgList, const QString& sets, FolderJob::JobType jt, KMFolder *folder ) const; void getMessagesResult(KIO::Job * job, bool lastSet); virtual int expungeContents(); void setChildrenState( QString attributes ); void initInbox(); KMFolderImap* findParent( const QString& path, const QString& name ); void checkFolders( const QStringList& folderNames, const QString& ns ); void finishMailCheck( const char *func, imapState state ); protected slots: void checkValidity(); void slotCheckValidityResult(KIO::Job * job); void reallyGetFolder(const QString &startUid = QString::null); void slotListFolderResult(KIO::Job * job); void slotListFolderEntries(KIO::Job * job, const KIO::UDSEntryList & uds); void slotGetMessagesResult(KIO::Job * job); void slotGetLastMessagesResult(KIO::Job * job); void slotGetMessagesData(KIO::Job * job, const QByteArray & data); void slotCreateFolderResult(KIO::Job * job); void slotRemoveFolderResult(KIO::Job *job); void slotStatResult(KIO::Job *job); void slotCompleteMailCheckProgress(); void slotProcessNewMail( int errorCode, const QString& errorMsg ); void slotCreatePendingFolders( int errorCode, const QString& errorMsg ); void slotListNamespaces(); protected: QString mImapPath; ulong mLastUid; imapState mContentState, mSubfolderState; bool mIsSelected; bool mCheckFlags; bool mReadOnly; bool mCheckMail; mutable QGuardedPtr<KMAcctImap> mAccount; // the current uidvalidity QString mUidValidity; unsigned int mUserRights; private: // if we're checking validity currently bool mCheckingValidity; // uid - metadata cache QIntDict<KMMsgMetaData> mUidMetaDataMap; // msgidMD5 - status map QDict<KMMsgMetaData> mMetaDataMap; // if the folder should be deleted without server roundtrip bool mAlreadyRemoved; // the progress for mailchecks QGuardedPtr<ProgressItem> mMailCheckProgressItem; // the progress for listings ProgressItem *mListDirProgressItem; // the progress for addMsg ProgressItem *mAddMessageProgressItem; // to-be-added folders QStringList mFoldersPendingCreation; // push all flags to the server instead of just the changed once // when doing a flag change the next time // this is needed for migrating local flags from the time where we didn't // have the ability to store them on the server bool mUploadAllFlags; // PERMANENTFLAGS part of SELECT response, needed to determine if custom flags can be // stored on the server int mPermanentFlags; }; #endif // kmfolderimap_h kmail Skip menu "kmail" Main Page Namespace List Class Hierarchy Alphabetical List Class List File List Namespace Members Class Members Related Pages API Reference Skip menu "API Reference"   doc kioslaves kmail konsolekalendar kpilot libemailfunctions libkcal Generated for API Reference by doxygen 1.5.9 This website is maintained by Adriaan de Groot and Allen Winter. KDE® and the K Desktop Environment® logo are registered trademarks of KDE e.V. | Legal