Skip to main content :: ::

KDE PIM API Reference

:: Skip to Link Menu

/ API Reference / kmail

kmail kmaccount.h Go to the documentation of this file. /* -*- mode: C++ -*- * kmail: KDE mail client * Copyright (c) 1996-1998 Stefan Taferner <taferner@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; either version 2 of the License, or * (at your option) any later version. * * 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 kmaccount_h #define kmaccount_h #include <kprocess.h> #include <kaccount.h> #include <qstring.h> #include <qguardedptr.h> #include <qvaluelist.h> #include <qmap.h> #include "kmmessage.h" class QTimer; class KMFolder; class KMAcctFolder; class KConfig; class KMFolderJob; class KMFolderCachedImap; class AccountsPageReceivingTab; namespace KMail { class FolderJob; class AccountManager; } using KMail::AccountManager; namespace KPIM { class ProgressItem; } using KMail::FolderJob; using KPIM::ProgressItem; class KMAccount; typedef QValueList< ::KMAccount* > AccountList; class KMPrecommand : public QObject { Q_OBJECT public: KMPrecommand(const QString &precommand, QObject *parent = 0); virtual ~KMPrecommand(); bool start(); protected slots: void precommandExited(KProcess *); signals: void finished(bool); protected: KProcess mPrecommandProcess; QString mPrecommand; }; class KMAccount: public QObject, public KAccount { Q_OBJECT friend class KMail::AccountManager; friend class ::KMail::FolderJob; friend class ::AccountsPageReceivingTab; // part of the config dialog friend class ::KMFolderCachedImap; /* HACK for processNewMSg() */ public: virtual ~KMAccount(); enum CheckStatus { CheckOK, CheckIgnored, CheckCanceled, CheckAborted, CheckError }; static const int DefaultCheckInterval = 5; virtual QString type() const { return QString::null; } virtual void setName(const QString&); virtual QString name() const { return KAccount::name(); } virtual void clearPasswd(); virtual void init(); virtual void pseudoAssign(const KMAccount * a ); KMFolder* folder(void) const { return ((KMFolder*)((KMAcctFolder*)mFolder)); } virtual void setFolder(KMFolder*, bool addAccount = false); QString trash() const { return mTrash; } virtual void setTrash(const QString& aTrash) { mTrash = aTrash; } virtual void processNewMail(bool interactive) = 0; virtual void readConfig(KConfig& config); void readTimerConfig(); virtual void writeConfig(KConfig& config); virtual void setCheckInterval(int aInterval); int checkInterval() const; inline int defaultCheckInterval(void) const { return DefaultCheckInterval; } void deleteFolderJobs(); virtual void ignoreJobsForMessage( KMMessage* ); virtual void setCheckExclude(bool aExclude); bool checkExclude(void) const { return mExclude; } const QString& precommand(void) const { return mPrecommand; } virtual void setPrecommand(const QString &cmd) { mPrecommand = cmd; } bool runPrecommand(const QString &precommand); static QString encryptStr(const QString& inStr); static QString decryptStr(const QString& inStr) { return encryptStr(inStr); } static QString importPassword(const QString &); bool hasInbox() const { return mHasInbox; } virtual void setHasInbox( bool has ) { mHasInbox = has; } virtual void invalidateIMAPFolders(); virtual bool mailCheckCanProceed() const { return true; } bool checkingMail() { return mCheckingMail; } virtual void setCheckingMail( bool checking ) { mCheckingMail = checking; } void checkDone( bool newMail, CheckStatus status ); virtual void cancelMailCheck() {} ProgressItem *mailCheckProgressItem() const { return mMailCheckProgressItem; } void setIdentityId(uint identityId ) { mIdentityId = identityId; } uint identityId() const{ return mIdentityId; } signals: virtual void finishedCheck( bool newMail, CheckStatus status ); virtual void newMailsProcessed( const QMap<QString, int> & newInFolder ); protected slots: virtual void mailCheck(); virtual void sendReceipts(); virtual void precommandExited(bool); protected: KMAccount( AccountManager* owner, const QString& accountName, uint id); virtual bool processNewMsg(KMMessage* msg); virtual void sendReceipt(KMMessage* msg); virtual void installTimer(); virtual void deinstallTimer(); void addToNewInFolder( QString folderId, int num ); protected: QString mPrecommand; QString mTrash; AccountManager* mOwner; QGuardedPtr<KMAcctFolder> mFolder; QTimer *mTimer; int mInterval; // this is a switch and a scalar at the same time. If it is 0, // interval mail checking is turned off and the interval spinbox proposes a // default value. If it is non-null, it is the count of minutes between two // automated mail checks. This means that as soon as you disable interval // mail checking, the value in the spin box returns to a default value. bool mExclude; bool mCheckingMail : 1; bool mPrecommandSuccess; QValueList<KMMessage*> mReceipts; QPtrList<FolderJob> mJobList; bool mHasInbox : 1; QGuardedPtr<ProgressItem> mMailCheckProgressItem; uint mIdentityId; private: virtual void setName( const char *name ) { QObject::setName( name ); } private: // for detailed (per folder) new mail notification QMap<QString, int> mNewInFolder; }; #endif /*kmaccount_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