kmail
KMFolderCachedImap Class Reference
Inheritance diagram for KMFolderCachedImap:

Detailed Description
Definition at line 89 of file kmfoldercachedimap.h.
Public Types | |
typedef QValueVector< KMail::ACLListEntry > | ACLList |
enum | imapState { imapNoInformation = 0, imapInProgress = 1, imapFinished = 2 } |
enum | IncidencesFor { IncForNobody, IncForAdmins, IncForReaders } |
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 &) |
Signals | |
void | folderComplete (KMFolderCachedImap *folder, bool success) |
void | listComplete (KMFolderCachedImap *) |
void | syncState (int state, int number) |
Public Member Functions | |
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 |
virtual int | create () |
virtual void | remove () |
virtual void | serverSync (bool recurse) |
void | resetSyncState () |
void | setAlarmsBlocked (bool blocked) |
bool | alarmsBlocked () const |
void | checkUidValidity () |
virtual imapState | getContentState () |
virtual void | setContentState (imapState state) |
virtual imapState | getSubfolderState () |
virtual void | setSubfolderState (imapState state) |
void | setImapPath (const QString &path) |
QString | imapPath () const |
void | setLastUid (ulong uid) |
ulong | lastUid () |
KMMsgBase * | findByUID (ulong uid) |
void | setUidValidity (const QString &validity) |
QString | uidValidity () const |
void | clearUidMap () |
void | setAccount (KMAcctCachedImap *acct) |
KMAcctCachedImap * | account () const |
QString | uidCacheLocation () const |
int | readUidCache () |
int | writeUidCache () |
int | progress () const |
virtual int | rename (const QString &aName, KMFolderDir *aParent=0) |
virtual KMMessage * | take (int idx) |
virtual int | addMsg (KMMessage *msg, int *index_return=0) |
virtual int | addMsgInternal (KMMessage *msg, bool, int *index_return=0) |
virtual int | addMsgKeepUID (KMMessage *msg, int *index_return=0) |
virtual void | removeMsg (int i, bool imapQuiet=false) |
virtual void | removeMsg (QPtrList< KMMessage > msgList, bool imapQuiet=false) |
bool | isReadOnly () const |
void | sendFolderComplete (bool success) |
void | setSilentUpload (bool silent) |
bool | silentUpload () |
virtual int | createIndexFromContents () |
int | createIndexFromContentsRecursive () |
virtual bool | listDirectory () |
virtual void | listNamespaces () |
KMFolder * | trashFolder () const |
int | userRights () const |
void | setUserRights (unsigned int userRights) |
const QuotaInfo | quotaInfo () const |
void | setQuotaInfo (const QuotaInfo &) |
const ACLList & | aclList () const |
void | setACLList (const ACLList &arr) |
virtual void | setStatus (int id, KMMsgStatus status, bool toggle) |
virtual void | setStatus (QValueList< int > &ids, KMMsgStatus status, bool toggle) |
QString | annotationFolderType () const |
void | updateAnnotationFolderType () |
IncidencesFor | incidencesFor () const |
void | setIncidencesFor (IncidencesFor incfor) |
virtual bool | isMoveable () const |
QStringList | namespacesToList () |
void | setNamespacesToList (QStringList list) |
const QString & | imapPathForCreation () |
void | setImapPathForCreation (const QString &path) |
bool | isCloseToQuota () const |
int | permanentFlags () const |
QString | folderAttributes () const |
Static Public Member Functions | |
static QString | cacheLocation () |
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) |
void | slotSubFolderComplete (KMFolderCachedImap *, bool) |
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 Member Functions | |
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 *) |
void | newState (int progress, const QString &syncStatus) |
KMFolderCachedImap * | findParent (const QString &path, const QString &name) |
Member Typedef Documentation
|
Return the list of ACL for this folder.
Definition at line 257 of file kmfoldercachedimap.h. |
Member Enumeration Documentation
|
Free-busy and alarms relevance of this folder, i.e. for whom should events in this calendar lead to "busy" periods in their freebusy lists, and who should get alarms for the incidences in this folder. Applies to Calendar and Task folders only. IncForNobody: not relevant for free-busy and alarms to anybody IncForAdmins: apply to persons with admin permissions on this calendar IncForReaders: apply to all readers of this calendar Definition at line 280 of file kmfoldercachedimap.h. |
Constructor & Destructor Documentation
|
Usually a parent is given. But in some cases there is no fitting parent object available. Then the name of the folder is used as the absolute path to the folder file. Definition at line 179 of file kmfoldercachedimap.cpp. |
Member Function Documentation
|
Add the given message to the folder. Usually the message is added at the end of the folder. Returns zero on success and an errno error code on failure. The index of the new message is stored in index_return if given. Please note that the message is added as is to the folder and the folder takes ownership of the message (deleting it in the destructor). Reimplemented from KMFolderMaildir. Definition at line 512 of file kmfoldercachedimap.cpp. |
|
(Note(bo): This needs to be fixed better at a later point. ) This is overridden by dIMAP because addMsg strips the X-UID header from the mail. Reimplemented from FolderStorage. Definition at line 191 of file kmfoldercachedimap.h. |
|
Should alarms for this folder be blocked? (Only useful for resource folders).
Definition at line 2817 of file kmfoldercachedimap.cpp. |
|
This returns false if we have subfolders. Otherwise it returns canRemoveFolder() Definition at line 539 of file kmfoldercachedimap.cpp. |
|
Forget which mails are considered locally present. Needed when uidvalidity changes. Definition at line 164 of file kmfoldercachedimap.h. |
|
Reimplemented from KMFolderMaildir. Definition at line 367 of file kmfoldercachedimap.cpp. |
|
Create index file from messages file and fill the message-info list mMsgList. Returns 0 on success and an errno value (see fopen) on failure. Reimplemented from KMFolderMaildir. Definition at line 216 of file kmfoldercachedimap.h. |
|
Reimplemented from KMFolder.
Reimplemented from KMFolderMaildir. |
|
Find message by UID. Returns NULL if it doesn't exist Definition at line 613 of file kmfoldercachedimap.cpp. |
|
Utility methods for syncing. Finds new subfolders in the local cache that must be created in the server Definition at line 1500 of file kmfoldercachedimap.cpp. |
|
Utility methods for syncing. Finds new messages in the local cache that must be uploaded Definition at line 1308 of file kmfoldercachedimap.cpp. |
|
See if there is a better parent then this folder.
Definition at line 2221 of file kmfoldercachedimap.cpp. |
|
Returns the type of this folder.
Reimplemented from KMFolderMaildir. Definition at line 116 of file kmfoldercachedimap.h. |
|
Specify an imap path that is used to create the folder on the server Otherwise the parent folder is used to construct the path.
Definition at line 300 of file kmfoldercachedimap.h. |
|
Initialize this storage from another one. Used when creating a child folder Definition at line 228 of file kmfoldercachedimap.cpp. |
|
Reimplemented from FolderStorage. Definition at line 2822 of file kmfoldercachedimap.cpp. |
|
Returns true if this folder can be moved.
Reimplemented from FolderStorage. Definition at line 2776 of file kmfoldercachedimap.cpp. |
|
Is the folder readonly?
Reimplemented from KMFolderMaildir. Definition at line 201 of file kmfoldercachedimap.h. |
|
List a directory and add the contents to kmfoldermgr It uses a ListJob to get the folders returns false if the connection failed.
Definition at line 1966 of file kmfoldercachedimap.cpp. |
|
List of namespaces that need to be queried Is set by the account for the root folder when the listing starts.
Definition at line 293 of file kmfoldercachedimap.h. |
|
Flags that can be permanently stored on the server.
Definition at line 307 of file kmfoldercachedimap.h. |
|
Current progress status (between 0 and 100).
Definition at line 180 of file kmfoldercachedimap.h. |
|
The quota information for this folder.
Definition at line 253 of file kmfoldercachedimap.h. |
|
Read the config file.
Reimplemented from FolderStorage. Definition at line 237 of file kmfoldercachedimap.cpp. |
|
Read the uidValitidy and lastUid values from disk.
Definition at line 397 of file kmfoldercachedimap.cpp. |
|
Reimplemented from KMFolderMaildir. Definition at line 220 of file kmfoldercachedimap.cpp. |
|
Remove this folder.
Reimplemented from FolderStorage. Definition at line 376 of file kmfoldercachedimap.cpp. |
|
Remove (first occurrence of) given message from the folder.
Reimplemented from KMFolderMaildir. Definition at line 531 of file kmfoldercachedimap.cpp. |
|
Physically rename the folder. Returns zero on success and an errno on failure. Reimplemented from FolderStorage. Definition at line 552 of file kmfoldercachedimap.cpp. |
|
Force the sync state to be done.
Definition at line 2403 of file kmfoldercachedimap.cpp. |
|
Emit the folderComplete signal.
Definition at line 207 of file kmfoldercachedimap.h. |
|
Synchronize this folder and it's subfolders with the server.
Definition at line 718 of file kmfoldercachedimap.cpp. |
|
The imap account associated with this folder.
Definition at line 1830 of file kmfoldercachedimap.cpp. |
|
Set the list of ACL for this folder (for FolderDiaACLTab).
Definition at line 2363 of file kmfoldercachedimap.cpp. |
|
Block this folder from generating alarms, even if the annotations on it say otherwise. Used to override alarms for read-only folders. (Only useful for resource folders) Definition at line 2812 of file kmfoldercachedimap.cpp. |
|
The path to the imap folder on the server.
Definition at line 2461 of file kmfoldercachedimap.cpp. |
|
For the folder properties dialog.
Definition at line 2501 of file kmfoldercachedimap.cpp. |
|
The highest UID in the folder.
Definition at line 589 of file kmfoldercachedimap.cpp. |
|
The silentUpload can be set to remove the folder upload error dialog.
Definition at line 213 of file kmfoldercachedimap.h. |
|
Set the status of the message(s) in the QValueList
Reimplemented from FolderStorage. |
|
Set the status of the message at index
Reimplemented from FolderStorage. |
|
The uidvalidity of the last update.
Definition at line 159 of file kmfoldercachedimap.h. |
|
Set the user's rights on this folder - called by getUserRights.
Definition at line 2306 of file kmfoldercachedimap.cpp. |
|
Connected to ListJob::receivedFolders creates namespace folders.
|
|
Connected to ListJob::receivedFolders creates/removes folders.
|
|
Add the data a KIO::Job retrieves to the buffer.
|
|
Troubleshoot the IMAP cache.
Definition at line 672 of file kmfoldercachedimap.cpp. |
|
emitted when we enter the state "state" and have to process "number" items (for example messages
|
|
Detach message from this folder. Usable to call addMsg() afterwards. Loads the message if it is not loaded up to now. Reimplemented from KMFolderMaildir. Definition at line 475 of file kmfoldercachedimap.cpp. |
|
Return the trash folder.
Reimplemented from FolderStorage. Definition at line 583 of file kmfoldercachedimap.cpp. |
|
Returns the filename of the uidcache file.
Definition at line 390 of file kmfoldercachedimap.cpp. |
|
The user's rights on this folder - see bitfield in ACLJobs namespace.
Definition at line 239 of file kmfoldercachedimap.h. |
|
Write the config file.
Reimplemented from FolderStorage. Definition at line 302 of file kmfoldercachedimap.cpp. |
|
Write the uidValitidy and lastUid values to disk.
Definition at line 426 of file kmfoldercachedimap.cpp. |
The documentation for this class was generated from the following files: