Skip to main content :: ::

KDE PIM API Reference

:: Skip to Link Menu

/ API Reference / kmail

kmail kmfoldercachedimap.h Go to the documentation of this file. /* * kmfoldercachedimap.cpp * * Copyright (c) 2002-2004 Bo Thorsen <bo@sonofthor.dk> * Copyright (c) 2002-2003 Steffen Hansen <steffen@klaralvdalens-datakonsult.se> * * 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. * * In addition, as a special exception, the copyright holders give * permission to link the code of this program with any edition of * the Qt library by Trolltech AS, Norway (or with modified versions * of Qt that use the same license as Qt), and distribute linked * combinations including the two. You must obey the GNU General * Public License in all respects for all of the code used other than * Qt. If you modify this file, you may extend this exception to * your version of the file, but you are not obligated to do so. If * you do not wish to do so, delete this exception statement from * your version. */ #ifndef kmfoldercachedimap_h #define kmfoldercachedimap_h #include <kdialogbase.h> #include <kstandarddirs.h> #include <qvaluelist.h> #include <qvaluevector.h> #include <qptrlist.h> #include <qdialog.h> #include "kmfoldermaildir.h" #include "kmfolderimap.h" #include "kmacctcachedimap.h" #include "kmfoldertype.h" #include "folderjob.h" #include "cachedimapjob.h" #include "quotajobs.h" using KMail::FolderJob; using KMail::QuotaInfo; class KMCommand; class QComboBox; class QRadioButton; namespace KMail { class AttachmentStrategy; class ImapAccountBase; struct ACLListEntry; } using KMail::AttachmentStrategy; class DImapTroubleShootDialog : public KDialogBase { Q_OBJECT public: enum SelectedOperation { None = -1, ReindexCurrent = 0, ReindexRecursive = 1, ReindexAll = 2, RefreshCache }; DImapTroubleShootDialog( QWidget* parent=0, const char* name=0 ); static int run(); private slots: void slotDone(); private: QRadioButton *mIndexButton, *mCacheButton; QComboBox *mIndexScope; int rc; }; class KMFolderCachedImap : public KMFolderMaildir { Q_OBJECT public: static QString cacheLocation() { return locateLocal("data", "kmail/dimap" ); } KMFolderCachedImap(KMFolder* folder, const char* name=0); virtual ~KMFolderCachedImap(); void reallyDoClose(const char* owner); void initializeFrom( KMFolderCachedImap* parent ); virtual void readConfig(); virtual void writeConfig(); void writeConfigKeysWhichShouldNotGetOverwrittenByReadConfig(); virtual KMFolderType folderType() const { return KMFolderTypeCachedImap; } virtual int create(); virtual void remove(); virtual void serverSync( bool recurse ); void resetSyncState( ); void setAlarmsBlocked( bool blocked ); bool alarmsBlocked() const; void checkUidValidity(); enum imapState { imapNoInformation=0, imapInProgress=1, imapFinished=2 }; virtual imapState getContentState() { return mContentState; } virtual void setContentState(imapState state) { mContentState = state; } virtual imapState getSubfolderState() { return mSubfolderState; } virtual void setSubfolderState(imapState state); void setImapPath(const QString &path); QString imapPath() const { return mImapPath; } void setLastUid( ulong uid ); ulong lastUid(); KMMsgBase* findByUID( ulong uid ); void setUidValidity(const QString &validity) { mUidValidity = validity; } QString uidValidity() const { return mUidValidity; } void clearUidMap() { uidMap.clear(); } void setAccount(KMAcctCachedImap *acct); KMAcctCachedImap* account() const; QString uidCacheLocation() const; int readUidCache(); int writeUidCache(); int progress() const { return mProgress; } /* Reimplemented from KMFolder. Moving is not supported, so aParent must be 0 */ virtual int rename(const QString& aName, KMFolderDir *aParent=0); virtual KMMessage* take(int idx); void takeTemporarily( int idx ); /* Reimplemented from KMFolderMaildir */ virtual int addMsg(KMMessage* msg, int* index_return = 0); /* internal version that doesn't remove the X-UID header */ virtual int addMsgInternal(KMMessage* msg, bool, int* index_return = 0); virtual int addMsgKeepUID(KMMessage* msg, int* index_return = 0) { return addMsgInternal(msg, false, index_return); } /* Reimplemented from KMFolderMaildir */ virtual void removeMsg(int i, bool imapQuiet = false); virtual void removeMsg(QPtrList<KMMessage> msgList, bool imapQuiet = false) { FolderStorage::removeMsg(msgList, imapQuiet); } bool isReadOnly() const { return KMFolderMaildir::isReadOnly() || mReadOnly; } void sendFolderComplete(bool success) { emit folderComplete(this, success); } void setSilentUpload( bool silent ) { mSilentUpload = silent; } bool silentUpload() { return mSilentUpload; } virtual int createIndexFromContents() { const int result = KMFolderMaildir::createIndexFromContents(); reloadUidMap(); return result; } int createIndexFromContentsRecursive(); //virtual void holdSyncs( bool hold ) { mHoldSyncs = hold; } virtual bool listDirectory(); virtual void listNamespaces(); KMFolder* trashFolder() const; int userRights() const { return mUserRights; } void setUserRights( unsigned int userRights ); const QuotaInfo quotaInfo() const { return mQuotaInfo; } void setQuotaInfo( const QuotaInfo & ); typedef QValueVector<KMail::ACLListEntry> ACLList; const ACLList& aclList() const { return mACLList; } void setACLList( const ACLList& arr ); // Reimplemented so the mStatusChangedLocally bool can be set virtual void setStatus( int id, KMMsgStatus status, bool toggle ); virtual void setStatus( QValueList<int>& ids, KMMsgStatus status, bool toggle ); QString annotationFolderType() const { return mAnnotationFolderType; } // For kmailicalifaceimpl only void updateAnnotationFolderType(); enum IncidencesFor { IncForNobody, IncForAdmins, IncForReaders }; IncidencesFor incidencesFor() const { return mIncidencesFor; } void setIncidencesFor( IncidencesFor incfor ); virtual bool isMoveable() const; QStringList namespacesToList() { return mNamespacesToList; } void setNamespacesToList( QStringList list ) { mNamespacesToList = list; } const QString& imapPathForCreation() { return mImapPathCreation; } void setImapPathForCreation( const QString& path ) { mImapPathCreation = path; } bool isCloseToQuota() const; int permanentFlags() const { return mPermanentFlags; } QString folderAttributes() const { return mFolderAttributes; } protected slots: void slotGetMessagesData(KIO::Job * job, const QByteArray & data); void getMessagesResult(KMail::FolderJob *, bool lastSet); void slotGetLastMessagesResult(KMail::FolderJob *); void slotProgress(unsigned long done, unsigned long total); void slotPutProgress( unsigned long, unsigned long ); //virtual void slotCheckValidityResult(KIO::Job * job); void slotSubFolderComplete(KMFolderCachedImap*, bool); // Connected to the imap account void slotConnectionResult( int errorCode, const QString& errorMsg ); void slotCheckUidValidityResult( KMail::FolderJob* job ); void slotPermanentFlags( int flags ); void slotTestAnnotationResult(KIO::Job *job); void slotGetAnnotationResult( KIO::Job* ); void slotMultiUrlGetAnnotationResult( KIO::Job* ); void slotSetAnnotationResult(KIO::Job *job); void slotReceivedUserRights( KMFolder* ); void slotReceivedACL( KMFolder*, KIO::Job*, const KMail::ACLList& ); void slotMultiSetACLResult(KIO::Job *); void slotACLChanged( const QString&, int ); void slotAnnotationResult(const QString& entry, const QString& value, bool found); void slotAnnotationChanged( const QString& entry, const QString& attribute, const QString& value ); void slotDeleteMessagesResult(KMail::FolderJob *); void slotImapStatusChanged(KMFolder* folder, const QString&, bool); void slotStorageQuotaResult( const QuotaInfo& ); void slotQuotaResult( KIO::Job* job ); protected: /* returns true if there were messages to delete on the server */ bool deleteMessages(); void listMessages(); void uploadNewMessages(); void uploadFlags(); void uploadSeenFlags(); void createNewFolders(); void listDirectory2(); void createFoldersNewOnServerAndFinishListing( const QValueVector<int> foldersNewOnServer ); virtual QValueList<unsigned long> findNewMessages(); virtual QValueList<KMFolderCachedImap*> findNewFolders(); virtual bool canRemoveFolder() const; 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; virtual void timerEvent( QTimerEvent* ); /* update progress status */ void newState( int progress, const QString& syncStatus ); KMFolderCachedImap* findParent( const QString& path, const QString& name ); public slots: void slotSimpleData(KIO::Job * job, const QByteArray & data); void slotTroubleshoot(); 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& ); private slots: void serverSyncInternal(); void slotIncreaseProgress(); void slotUpdateLastUid(); void slotFolderDeletionOnServerFinished(); void slotRescueDone( KMCommand* command ); signals: void folderComplete(KMFolderCachedImap *folder, bool success); void listComplete( KMFolderCachedImap* ); void syncState( int state, int number ); private: void setReadOnly( bool readOnly ); QString state2String( int state ) const; void rememberDeletion( int ); KMCommand* rescueUnsyncedMessages(); void rescueUnsyncedMessagesAndDeleteFolder( KMFolder *folder, bool root = true ); enum { SYNC_STATE_INITIAL, SYNC_STATE_TEST_ANNOTATIONS, SYNC_STATE_PUT_MESSAGES, SYNC_STATE_UPLOAD_FLAGS, SYNC_STATE_CREATE_SUBFOLDERS, SYNC_STATE_LIST_NAMESPACES, SYNC_STATE_LIST_SUBFOLDERS, SYNC_STATE_LIST_SUBFOLDERS2, SYNC_STATE_DELETE_SUBFOLDERS, SYNC_STATE_LIST_MESSAGES, SYNC_STATE_DELETE_MESSAGES, SYNC_STATE_EXPUNGE_MESSAGES, SYNC_STATE_GET_MESSAGES, SYNC_STATE_HANDLE_INBOX, SYNC_STATE_GET_USERRIGHTS, SYNC_STATE_GET_ANNOTATIONS, SYNC_STATE_SET_ANNOTATIONS, SYNC_STATE_GET_ACLS, SYNC_STATE_SET_ACLS, SYNC_STATE_GET_QUOTA, SYNC_STATE_FIND_SUBFOLDERS, SYNC_STATE_SYNC_SUBFOLDERS, SYNC_STATE_CHECK_UIDVALIDITY, SYNC_STATE_RENAME_FOLDER } mSyncState; int mProgress; int mStatusFlagsJobs; QString mUidValidity; QString mImapPath; imapState mContentState, mSubfolderState; QStringList mSubfolderNames, mSubfolderPaths, mSubfolderMimeTypes, mSubfolderAttributes; QString mFolderAttributes; QString mAnnotationFolderType; IncidencesFor mIncidencesFor; bool mHasInbox; bool mIsSelected; bool mCheckFlags; bool mReadOnly; mutable QGuardedPtr<KMAcctCachedImap> mAccount; QIntDict<int> uidsOnServer; QValueList<ulong> uidsForDeletionOnServer; QValueList<KMail::CachedImapJob::MsgForDownload> mMsgsForDownload; QValueList<ulong> mUidsForDownload; QStringList foldersForDeletionOnServer; QValueList<KMFolderCachedImap*> mSubfoldersForSync; KMFolderCachedImap* mCurrentSubfolder; QMap<ulong,int> uidMap; bool uidMapDirty; void reloadUidMap(); int uidWriteTimer; ulong mLastUid; ulong mTentativeHighestUid; bool mFoundAnIMAPDigest; int mUserRights, mOldUserRights; ACLList mACLList; bool mSilentUpload; bool mFolderRemoved; //bool mHoldSyncs; bool mRecurse; bool mStatusChangedLocally; bool mAnnotationFolderTypeChanged; bool mIncidencesForChanged; QStringList mNamespacesToList; int mNamespacesToCheck; bool mPersonalNamespacesCheckDone; QString mImapPathCreation; QuotaInfo mQuotaInfo; QMap<ulong,void*> mDeletedUIDsSinceLastSync; bool mAlarmsBlocked; QValueList<KMFolder*> mToBeDeletedAfterRescue; int mRescueCommandCount; int mPermanentFlags; }; #endif /*kmfoldercachedimap_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