Skip to main content :: ::

KDE PIM API Reference

:: Skip to Link Menu

/ API Reference / kmail

kmail imapaccountbase.h Go to the documentation of this file. /* -*- c++ -*- * imapaccountbase.h * * Copyright (c) 2000-2002 Michael Haeckel <haeckel@kde.org> * Copyright (c) 2002 Marc Mutz <mutz@kde.org> * * This file is based on work on pop3 and imap account implementations * by Don Sanders <sanders@kde.org> and Michael Haeckel <haeckel@kde.org> * * 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 __KMAIL_IMAPACCOUNTBASE_H__ #define __KMAIL_IMAPACCOUNTBASE_H__ #include <set> #include "networkaccount.h" #include <qtimer.h> #include <qguardedptr.h> #include <kio/global.h> class AccountManager; class KMFolder; class KConfig/*Base*/; class KMMessagePart; class DwBodyPart; class DwMessage; class FolderStorage; template <typename T> class QValueVector; namespace KIO { class Job; } namespace KPIM { class ProgressItem; } namespace KMail { struct ACLListEntry; struct QuotaInfo; typedef QValueVector<KMail::ACLListEntry> ACLList; class AttachmentStrategy; class ImapAccountBase : public KMail::NetworkAccount { Q_OBJECT protected: ImapAccountBase( AccountManager * parent, const QString & name, uint id ); public: virtual ~ImapAccountBase(); virtual void init(); virtual void pseudoAssign( const KMAccount * a ); bool autoExpunge() const { return mAutoExpunge; } virtual void setAutoExpunge( bool expunge ); bool hiddenFolders() const { return mHiddenFolders; } virtual void setHiddenFolders( bool show ); bool onlySubscribedFolders() const { return mOnlySubscribedFolders; } virtual void setOnlySubscribedFolders( bool show ); bool onlyLocallySubscribedFolders() const { return mOnlyLocallySubscribedFolders; } virtual void setOnlyLocallySubscribedFolders( bool show ); bool loadOnDemand() const { return mLoadOnDemand; } virtual void setLoadOnDemand( bool load ); bool listOnlyOpenFolders() const { return mListOnlyOpenFolders; } virtual void setListOnlyOpenFolders( bool only ); virtual KIO::MetaData slaveConfig() const; virtual void readConfig( KConfig& config ); virtual void writeConfig( KConfig& config ); enum ConnectionState { Error = 0, Connected, Connecting }; // possible list types enum ListType { List, ListSubscribed, ListSubscribedNoCheck, ListFolderOnly, ListFolderOnlySubscribed }; ConnectionState makeConnection(); // namespace defines enum imapNamespace { PersonalNS=0, OtherUsersNS=1, SharedNS=2 }; // map a namespace type to a list of namespaces typedef QMap<imapNamespace, QStringList> nsMap; // map a namespace to a delimiter typedef QMap<QString, QString> namespaceDelim; // map a namespace type to a map with the namespace and the delimiter typedef QMap<imapNamespace, namespaceDelim> nsDelimMap; struct jobData { // Needed by QMap, don't use jobData() : url(QString::null), parent(0), current(0), total(1), done(0), offset(0), progressItem(0), onlySubscribed(false), quiet(false), cancellable(false) {} // Real constructor jobData( const QString& _url, KMFolder *_parent = 0, int _total = 1, int _done = 0, bool _quiet = false, bool _cancelable = false ) : url(_url), parent(_parent), current(0), total(_total), done(_done), offset(0), progressItem(0), quiet(_quiet), cancellable(_cancelable) {} QString path; QString url; QString curNamespace; QByteArray data; QCString cdata; QStringList items; KMFolder *parent, *current; QPtrList<KMMessage> msgList; int total, done, offset; KPIM::ProgressItem *progressItem; bool onlySubscribed, quiet, cancellable; }; typedef QMap<KIO::Job *, jobData>::Iterator JobIterator; void insertJob( KIO::Job* job, const jobData& data ) { mapJobData.insert( job, data ); } JobIterator findJob( KIO::Job* job ) { return mapJobData.find( job ); } JobIterator jobsEnd() { return mapJobData.end(); } void removeJob( JobIterator& it ); void removeJob( KIO::Job* job ); void changeSubscription(bool subscribe, const QString& imapPath); bool locallySubscribedTo( const QString& imapPath ); void changeLocalSubscription( const QString& imapPath, bool subscribe ); void getUserRights( KMFolder* folder, const QString& imapPath ); void getACL( KMFolder* folder, const QString& imapPath ); void getStorageQuotaInfo( KMFolder* folder, const QString& imapPath ); void setImapStatus( KMFolder* folder, const QString& path, const QCString& flags ); void setImapSeenStatus( KMFolder* folder, const QString& path, bool seen ); void slaveDied() { mSlave = 0; killAllJobs(); } void killAllJobs( bool disconnectSlave=false ) = 0; virtual void cancelMailCheck(); void processNewMailSingleFolder(KMFolder* folder); bool checkingSingleFolder() { return mCheckingSingleFolder; } void postProcessNewMail( bool setStatusMsg = true ); bool checkingMail( KMFolder *folder ); bool checkingMail() { return NetworkAccount::checkingMail(); } void handleBodyStructure( QDataStream & stream, KMMessage * msg, const AttachmentStrategy *as ); virtual void setFolder(KMFolder*, bool addAccount = false); bool hasACLSupport() const { return mACLSupport; } bool hasAnnotationSupport() const { return mAnnotationSupport; } void setHasNoAnnotationSupport() { mAnnotationSupport = false; } bool hasQuotaSupport() const { return mQuotaSupport; } void setHasNoQuotaSupport() { mQuotaSupport = false; } bool handleJobError( KIO::Job* job, const QString& context, bool abortSync = false ); virtual FolderStorage* const rootFolder() const = 0; KPIM::ProgressItem* listDirProgressItem(); virtual unsigned int folderCount() const; nsMap namespaces() const { return mNamespaces; } virtual void setNamespaces( nsMap map ) { mNamespaces = map; } nsDelimMap namespacesWithDelimiter(); QString namespaceForFolder( FolderStorage* ); QString addPathToNamespace( const QString& ns ); QString delimiterForNamespace( const QString& prefix ); QString delimiterForFolder( FolderStorage* ); namespaceDelim namespaceToDelimiter() const { return mNamespaceToDelimiter; } void setNamespaceToDelimiter( namespaceDelim map ) { mNamespaceToDelimiter = map; } bool isNamespaceFolder( QString& name ); bool hasCapability( const QString& capa ) { return mCapabilities.contains( capa ); } QString createImapPath( FolderStorage* parent, const QString& folderName ); QString createImapPath( const QString& parent, const QString& folderName ); public slots: void getNamespaces(); private slots: void slotSubscriptionResult(KIO::Job * job); protected slots: virtual void slotCheckQueuedFolders(); void slotSchedulerSlaveConnected(KIO::Slave *aSlave); void slotSchedulerSlaveError(KIO::Slave *aSlave, int, const QString &errorMsg); void slotSetStatusResult(KIO::Job * job); void slotGetUserRightsResult( KIO::Job* _job ); void slotGetACLResult( KIO::Job* _job ); void slotGetStorageQuotaInfoResult( KIO::Job* _job ); void slotNoopTimeout(); void slotIdleTimeout(); void slotAbortRequested( KPIM::ProgressItem* ); void slotSimpleResult(KIO::Job * job); void slotNamespaceResult( KIO::Job*, const QString& str ); void slotSaveNamespaces( const ImapAccountBase::nsDelimMap& map ); void slotCapabilitiesResult( KIO::Job*, const QString& result ); protected: virtual bool handleError( int error, const QString &errorMsg, KIO::Job* job, const QString& context, bool abortSync = false ); bool handlePutError( KIO::Job* job, jobData& jd, KMFolder* folder ); virtual QString protocol() const; virtual unsigned short int defaultPort() const; void constructParts( QDataStream & stream, int count, KMMessagePart* parentKMPart, DwBodyPart * parent, const DwMessage * dwmsg ); void migratePrefix(); // used for writing the blacklist out to the config file QStringList locallyBlacklistedFolders() const; void localBlacklistFromStringList( const QStringList & ); QString prettifyQuotaError( const QString& _error, KIO::Job * job ); protected: QPtrList<QGuardedPtr<KMFolder> > mOpenFolders; QStringList mSubfolderNames, mSubfolderPaths, mSubfolderMimeTypes, mSubfolderAttributes; QMap<KIO::Job *, jobData> mapJobData; QTimer mIdleTimer; QTimer mNoopTimer; int mTotal, mCountUnread, mCountLastUnread; QMap<QString, int> mUnreadBeforeCheck; bool mAutoExpunge : 1; bool mHiddenFolders : 1; bool mOnlySubscribedFolders : 1; bool mOnlyLocallySubscribedFolders : 1; bool mLoadOnDemand : 1; bool mListOnlyOpenFolders : 1; bool mProgressEnabled : 1; bool mErrorDialogIsActive : 1; bool mPasswordDialogIsActive : 1; bool mACLSupport : 1; bool mAnnotationSupport : 1; bool mQuotaSupport : 1; bool mSlaveConnected : 1; bool mSlaveConnectionError : 1; bool mCheckingSingleFolder : 1; // folders that should be checked for new mails QValueList<QGuardedPtr<KMFolder> > mMailCheckFolders; // folders that should be checked after the current check is done QValueList<QGuardedPtr<KMFolder> > mFoldersQueuedForChecking; // holds messageparts from the bodystructure QPtrList<KMMessagePart> mBodyPartList; // the current message for the bodystructure KMMessage* mCurrentMsg; QGuardedPtr<KPIM::ProgressItem> mListDirProgressItem; // our namespaces in the form section=namespaceList nsMap mNamespaces; // namespace - delimiter map namespaceDelim mNamespaceToDelimiter; // old prefix for migration QString mOldPrefix; // capabilities QStringList mCapabilities; std::set<QString> mLocalSubscriptionBlackList; signals: void connectionResult( int errorCode, const QString& errorMsg ); void subscriptionChanged(const QString& imapPath, bool subscribed); void imapStatusChanged( KMFolder*, const QString& imapPath, bool cont ); void receivedUserRights( KMFolder* folder ); void receivedACL( KMFolder* folder, KIO::Job* job, const KMail::ACLList& entries ); void receivedStorageQuotaInfo( KMFolder* folder, KIO::Job* job, const KMail::QuotaInfo& entries ); void namespacesFetched( const ImapAccountBase::nsDelimMap& ); void namespacesFetched(); }; } // namespace KMail #endif // __KMAIL_IMAPACCOUNTBASE_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