Skip to main content :: ::

KDE PIM API Reference

:: Skip to Link Menu

/ API Reference / kmail

kmail kmailicalifaceimpl.h Go to the documentation of this file. /* This file is part of KMail. Copyright (c) 2003 Steffen Hansen <steffen@klaralvdalens-datakonsult.se> Copyright (c) 2003 - 2004 Bo Thorsen <bo@sonofthor.dk> This library is free software; you can redistribute it and/or modify it under the terms of the GNU Library General Public License as published by the Free Software Foundation; either version 2 of the License, or (at your option) any later version. This library 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 Library General Public License for more details. You should have received a copy of the GNU Library General Public License along with this library; see the file COPYING.LIB. 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 KMAILICALIFACEIMPL_H #define KMAILICALIFACEIMPL_H #include "kmailicalIface.h" #include "kmfoldertype.h" #include <kfoldertree.h> #include <qdict.h> #include <qguardedptr.h> #include <qmap.h> class KMFolder; class KMMessage; class KMFolderDir; class KMFolderTreeItem; namespace KMail { // Local helper class class ExtraFolder { public: ExtraFolder( KMFolder* f ); ~ExtraFolder(); QGuardedPtr<KMFolder> folder; }; class Accumulator { public: Accumulator( const QString& t, const QString& f, int c ) :type( t ), folder( f ), count( c ) {} void add( const QString& incidence ) { incidences << incidence; count--; } bool isFull() { return count == 0; } const QString type; const QString folder; QStringList incidences; int count; }; } class KMailICalIfaceImpl : public QObject, virtual public KMailICalIface { Q_OBJECT public: KMailICalIfaceImpl(); bool isWritableFolder( const QString& type, const QString& resource ); StorageFormat storageFormat( const QString &resource ); Q_UINT32 update( const QString& resource, Q_UINT32 sernum, const QString& subject, const QString& plainTextBody, const QMap<QCString, QString>& customHeaders, const QStringList& attachmentURLs, const QStringList& attachmentMimetypes, const QStringList& attachmentNames, const QStringList& deletedAttachments ); bool deleteIncidenceKolab( const QString& resource, Q_UINT32 sernum ); int incidencesKolabCount( const QString& mimetype, const QString& resource ); QMap<Q_UINT32, QString> incidencesKolab( const QString& mimetype, const QString& resource, int startIndex, int nbMessages ); QValueList<SubResource> subresourcesKolab( const QString& contentsType ); bool triggerSync( const QString& contentsType ); // "Get" an attachment. This actually saves the attachment in a file // and returns a URL to it KURL getAttachment( const QString& resource, Q_UINT32 sernum, const QString& filename ); QString attachmentMimetype( const QString &resource, Q_UINT32 sernum, const QString &filename ); QStringList listAttachments( const QString &resource, Q_UINT32 sernum ); bool removeSubresource( const QString& ); bool addSubresource( const QString& resource, const QString& parent, const QString& contentsType ); // tell KOrganizer about messages to be deleted void msgRemoved( KMFolder*, KMMessage* ); void initFolders(); void cleanup(); bool isResourceFolder( KMFolder* folder ) const; /* Returns true if the folder is one of the standard resource folders, as * opposed to an extra folder. */ bool isStandardResourceFolder( KMFolder* folder ) const; bool hideResourceFolder( KMFolder* folder ) const; bool hideResourceAccountRoot( KMFolder* folder ) const; KFolderTreeItem::Type folderType( KMFolder* folder ) const; QString folderPixmap( KFolderTreeItem::Type type ) const; QString folderName( KFolderTreeItem::Type type, int language = -1 ) const; KMFolder* folderFromType( const QString& type, const QString& folder ); QString icalFolderType( KMFolder* folder ) const; KMMessage* findMessageByUID( const QString& uid, KMFolder* folder ); static KMMessage* findMessageBySerNum( Q_UINT32 serNum, KMFolder* folder ); void deleteMsg( KMMessage* msg ); bool isEnabled() const { return mUseResourceIMAP; } void folderContentsTypeChanged( KMFolder*, KMail::FolderContentsType ); StorageFormat storageFormat( KMFolder* folder ) const; void setStorageFormat( KMFolder* folder, StorageFormat format ); static const char* annotationForContentsType( KMail::FolderContentsType type ); // Called after a folder was synced with the server void folderSynced( KMFolder* folder, const KURL& folderURL ); // Called when deletion of a folder from the server suceeded, // triggers fb re-generation void folderDeletedOnServer( const KURL& folderURL ); void addFolderChange( KMFolder* folder, FolderChanges changes ); // See CachedImapJob::slotPutMessageResult bool isResourceQuiet() const; void setResourceQuiet(bool q); public slots: /* (Re-)Read configuration file */ void readConfig(); void slotFolderRemoved( KMFolder* folder ); void slotIncidenceAdded( KMFolder* folder, Q_UINT32 sernum ); void slotIncidenceDeleted( KMFolder* folder, Q_UINT32 sernum ); void slotRefresh( const QString& type); // Called when a folder is made readonly or readwrite, or renamed, // or any other similar change that affects the resources void slotFolderPropertiesChanged( KMFolder* folder ); private slots: void slotRefreshFolder( KMFolder* ); void slotCheckDone(); void slotFolderLocationChanged( const QString&, const QString& ); void slotFolderRenamed(); void slotMessageRetrieved( KMMessage* ); private: KMFolder* initFolder( KMail::FolderContentsType contentsType ); KMFolder* initScalixFolder( KMail::FolderContentsType contentsType ); void connectFolder( KMFolder* folder ); KMFolder* extraFolder( const QString& type, const QString& folder ); void syncFolder( KMFolder* folder ) const; struct StandardFolderSearchResult { enum FoundEnum { FoundAndStandard, NotFound, FoundByType, FoundByName }; StandardFolderSearchResult() : folder( 0 ) {} StandardFolderSearchResult( KMFolder* f, FoundEnum e ) : folder( f ), found( e ) {} KMFolder* folder; // NotFound implies folder==0 of course. FoundEnum found; }; StandardFolderSearchResult findStandardResourceFolder( KMFolderDir* folderParentDir, KMail::FolderContentsType contentsType ); KMFolder* findResourceFolder( const QString& resource ); bool updateAttachment( KMMessage& msg, const QString& attachmentURL, const QString& attachmentName, const QString& attachmentMimetype, bool lookupByName ); bool deleteAttachment( KMMessage& msg, const QString& attachmentURL ); Q_UINT32 addIncidenceKolab( KMFolder& folder, const QString& subject, const QString& plainTextBody, const QMap<QCString, QString>& customHeaders, const QStringList& attachmentURLs, const QStringList& attachmentNames, const QStringList& attachmentMimetypes ); static bool kolabXMLFoundAndDecoded( const KMMessage& msg, const QString& mimetype, QString& s ); void handleFolderSynced( KMFolder* folder, const KURL& folderURL, int _changes ); void triggerKolabFreeBusy( const KURL& folderURL ); StorageFormat globalStorageFormat() const; static bool folderIsAlarmRelevant( const KMFolder * ); private: QGuardedPtr<KMFolder> mContacts; QGuardedPtr<KMFolder> mCalendar; QGuardedPtr<KMFolder> mNotes; QGuardedPtr<KMFolder> mTasks; QGuardedPtr<KMFolder> mJournals; // The extra IMAP resource folders // Key: folder location. Data: folder. QDict<KMail::ExtraFolder> mExtraFolders; // used for collecting incidences during async loading QDict<KMail::Accumulator> mAccumulators; // More info for each folder we care about (mContacts etc. as well as the extra folders) // The reason for storing it here is that it can be shared between // kmfoldercachedimap and kmfolderimap, and that it's groupware data anyway. struct FolderInfo { FolderInfo() {} // for QMap FolderInfo( StorageFormat f, FolderChanges c ) : mStorageFormat( f ), mChanges( c ) {} StorageFormat mStorageFormat; FolderChanges mChanges; }; // The storage format used for each folder that we care about typedef QMap<KMFolder*, FolderInfo> FolderInfoMap; // helper for reading the FolderInfo from the config file FolderInfo readFolderInfo( const KMFolder * const folder ) const; FolderInfoMap mFolderInfoMap; unsigned int mFolderLanguage; KMFolderDir* mFolderParentDir; KMFolder* mFolderParent; KMFolderType mFolderType; bool mUseResourceIMAP; bool mResourceQuiet; bool mHideFolders; /* * Bunch of maps to keep track of incidents currently in transfer, ones * which need to be ungotten, once we are done, once with updates pending. * Since these are transient attributes of only a small but changing number * of incidences they are not encapsulated in a struct or somesuch. */ QMap<QString, Q_UINT32> mUIDToSerNum; QMap<Q_UINT32, bool> mTheUnGetMes; QMap<QString, QString> mPendingUpdates; QMap<QString, bool> mInTransit; }; #endif // KMAILICALIFACEIMPL_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