kmail
KMFolderImap Class Reference
Inheritance diagram for KMFolderImap:

Detailed Description
Definition at line 77 of file kmfolderimap.h.
Public Types | |
enum | imapState { imapNoInformation = 0, imapListingInProgress = 1, imapDownloadInProgress = 2, imapFinished = 3 } |
Public Slots | |
virtual void | addMsgQuiet (KMMessage *) |
virtual void | addMsgQuiet (QPtrList< KMMessage >) |
virtual int | addMsg (KMMessage *msg, int *index_return=0) |
virtual int | addMsg (QPtrList< KMMessage > &, QValueList< int > &index_return) |
void | copyMsg (QPtrList< KMMessage > &msgList) |
virtual KMMessage * | take (int idx) |
virtual void | take (QPtrList< KMMessage >) |
void | slotSimpleData (KIO::Job *job, const QByteArray &data) |
static void | flagsToStatus (KMMsgBase *msg, int flags, bool newMsg=TRUE) |
void | slotCopyMsgResult (KMail::FolderJob *job) |
void | slotSearchDone (QValueList< Q_UINT32 > serNums, const KMSearchPattern *pattern, bool complete) |
void | slotSearchDone (Q_UINT32 serNum, const KMSearchPattern *pattern, bool matches) |
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 (KMFolderImap *folder, bool success) |
void | deleted (KMFolderImap *) |
void | directoryListingFinished (KMFolderImap *) |
Public Member Functions | |
virtual imapState | getContentState () |
virtual void | setContentState (imapState state) |
virtual imapState | getSubfolderState () |
virtual void | setSubfolderState (imapState state) |
KMFolderImap (KMFolder *folder, const char *name=0) | |
virtual | ~KMFolderImap () |
virtual KMFolderType | folderType () const |
virtual KMMessage * | getMsg (int idx) |
void | setImapPath (const QString &path) |
QString | imapPath () |
ulong | lastUid () |
void | setUidValidity (const QString &validity) |
QString | uidValidity () |
void | setAccount (KMAcctImap *acct) |
KMAcctImap * | account () const |
virtual void | removeMsg (int i, bool quiet=FALSE) |
virtual void | removeMsg (const QPtrList< KMMessage > &msgList, bool quiet=FALSE) |
virtual int | rename (const QString &newName, KMFolderDir *aParent=0) |
virtual void | remove () |
bool | autoExpunge () |
virtual void | writeConfig () |
virtual void | readConfig () |
virtual bool | listDirectory () |
void | getFolder (bool force=FALSE) |
void | getAndCheckFolder (bool force=FALSE) |
void | getMessage (KMFolder *folder, KMMessage *msg) |
void | createFolder (const QString &name, const QString &imapPath=QString::null, bool askUser=true) |
void | deleteMessage (KMMessage *msg) |
void | deleteMessage (const QPtrList< KMMessage > &msgList) |
virtual void | setStatus (int idx, KMMsgStatus status, bool toggle) |
virtual void | setStatus (QValueList< int > &ids, KMMsgStatus status, bool toggle) |
void | getUids (QValueList< int > &ids, QValueList< ulong > &uids) |
void | getUids (const QPtrList< KMMessage > &msgList, QValueList< ulong > &uids) |
void | expungeFolder (KMFolderImap *aFolder, bool quiet) |
virtual int | compact (bool) |
void | sendFolderComplete (bool success) |
bool | processNewMail (bool interactive) |
void | setSelected (bool selected) |
bool | isSelected () |
virtual QString | fileName () const |
const ulong | serNumForUID (ulong uid) |
void | saveMsgMetaData (KMMessage *msg, ulong uid=0) |
virtual void | ignoreJobsForMessage (KMMessage *) |
bool | includeInMailCheck () |
void | setIncludeInMailCheck (bool check) |
virtual int | create () |
virtual bool | isAutoExpire () const |
virtual void | close (bool force=FALSE) |
void | setCheckingValidity (bool val) |
KMFolder * | trashFolder () const |
void | setAlreadyRemoved (bool removed) |
bool | isReadOnly () const |
unsigned int | userRights () const |
void | setUserRights (unsigned int userRights) |
virtual void | search (const KMSearchPattern *) |
virtual void | search (const KMSearchPattern *, Q_UINT32 serNum) |
virtual bool | isMoveable () const |
void | initializeFrom (KMFolderImap *parent, QString path, QString mimeType) |
Static Public Member Functions | |
static QString | cacheLocation () |
static QStringList | makeSets (QValueList< ulong > &, bool sort=true) |
static QStringList | makeSets (const QStringList &, bool sort=true) |
static QPtrList< KMMessage > | splitMessageList (const QString &set, QPtrList< KMMessage > &msgList) |
static QString | encodeFileName (const QString &) |
static QString | decodeFileName (const QString &) |
static QTextCodec * | utf7Codec () |
static QString | statusToFlags (KMMsgStatus status) |
static QValueList< ulong > | splitSets (const QString) |
Protected Slots | |
void | checkValidity () |
void | slotCheckValidityResult (KIO::Job *job) |
void | reallyGetFolder (const QString &startUid=QString::null) |
void | slotListFolderResult (KIO::Job *job) |
void | slotListFolderEntries (KIO::Job *job, const KIO::UDSEntryList &uds) |
void | slotGetMessagesResult (KIO::Job *job) |
void | slotGetLastMessagesResult (KIO::Job *job) |
void | slotGetMessagesData (KIO::Job *job, const QByteArray &data) |
void | slotCreateFolderResult (KIO::Job *job) |
void | slotRemoveFolderResult (KIO::Job *job) |
void | slotStatResult (KIO::Job *job) |
void | slotCompleteMailCheckProgress () |
void | slotProcessNewMail (int errorCode, const QString &errorMsg) |
void | slotCreatePendingFolders (int errorCode, const QString &errorMsg) |
void | slotListNamespaces () |
Protected Member Functions | |
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 |
void | getMessagesResult (KIO::Job *job, bool lastSet) |
virtual int | expungeContents () |
void | setChildrenState (QString attributes) |
void | initInbox () |
KMFolderImap * | findParent (const QString &path, const QString &name) |
void | checkFolders (const QStringList &folderNames, const QString &ns) |
void | finishMailCheck (imapState state) |
Protected Attributes | |
QString | mImapPath |
ulong | mLastUid |
imapState | mContentState |
imapState | mSubfolderState |
bool | mIsSelected |
bool | mCheckFlags |
bool | mReadOnly |
bool | mCheckMail |
QGuardedPtr< KMAcctImap > | mAccount |
QString | mUidValidity |
unsigned int | mUserRights |
Friends | |
class | ::KMail::ImapJob |
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 63 of file kmfolderimap.cpp. |
Member Function Documentation
|
Adds the given messages to the folder. Behaviour is identical to addMsg(msg) Reimplemented from FolderStorage. Definition at line 372 of file kmfolderimap.cpp. |
|
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 KMFolderMbox. Definition at line 362 of file kmfolderimap.cpp. |
|
Add a message to a folder after is has been added on an IMAP server.
Definition at line 300 of file kmfolderimap.cpp. |
|
Automatically expunge deleted messages when leaving the folder.
Definition at line 1680 of file kmfolderimap.cpp. |
|
See if all folders are still present on server, otherwise delete them.
Definition at line 910 of file kmfolderimap.cpp. |
|
Retrieve the whole folder or only the changes.
Definition at line 986 of file kmfolderimap.cpp. |
|
Close folder. If force is TRUE the files are closed even if others still use it (e.g. other mail reader windows). This also cancels all pending jobs. Reimplemented from KMFolderMbox. Definition at line 108 of file kmfolderimap.cpp. |
|
Remove deleted messages from the folder. Returns zero on success and an errno on failure. Reimplemented from KMFolderMbox. Definition at line 211 of file kmfolderimap.h. |
|
Copy the messages to this folder.
Definition at line 493 of file kmfolderimap.cpp. |
|
Inherited.
Reimplemented from KMFolderMbox. Definition at line 2015 of file kmfolderimap.cpp. |
|
Create a new subfolder You may specify the root imap path or this folder will be used If you set askUser to false and the server can only handle folders that contain messages _or_ folders the new folder is set to "contains messages" by default.
Definition at line 1608 of file kmfolderimap.cpp. |
|
Emitted, when the account is deleted.
|
|
Delete a message.
Definition at line 1702 of file kmfolderimap.cpp. |
|
Emitted at the end of the directory listing.
|
|
These two methods actually create the jobs. They have to be implemented in all folders.
Reimplemented from KMFolderMbox. Definition at line 1533 of file kmfolderimap.cpp. |
|
Encode the given string in a filename save 7 bit string.
Definition at line 1665 of file kmfolderimap.cpp. |
|
Called by KMFolder::expunge() to delete the actual contents. At the time of the call the folder has already been closed, and the various index files deleted. Returns 0 on success. Reimplemented from KMFolderMbox. Definition at line 2074 of file kmfolderimap.cpp. |
|
Expunge deleted messages from the folder.
Definition at line 1905 of file kmfolderimap.cpp. |
|
Return the filename of the folder (reimplemented from KFolder).
Reimplemented from FolderStorage. Definition at line 247 of file kmfolderimap.h. |
|
See if there is a better parent then this folder.
Definition at line 883 of file kmfolderimap.cpp. |
|
Convert IMAP flags to a message status.
Definition at line 1354 of file kmfolderimap.cpp. |
|
Returns the type of this folder.
Reimplemented from KMFolderMbox. Definition at line 107 of file kmfolderimap.h. |
|
same as above but also checks for new mails
Definition at line 1138 of file kmfolderimap.cpp. |
|
Retrieve all mails in a folder.
Definition at line 1152 of file kmfolderimap.cpp. |
|
Get the whole message.
|
|
Read message at given index. Indexing starts at zero Reimplemented from FolderStorage. Definition at line 136 of file kmfolderimap.cpp. |
|
same as above but accepts a Message-List
Definition at line 1891 of file kmfolderimap.cpp. |
|
gets the uids of the given ids
Definition at line 1879 of file kmfolderimap.cpp. |
|
Removes and deletes all jobs associated with the particular message.
Reimplemented from FolderStorage. Definition at line 1400 of file kmfolderimap.cpp. |
|
If this folder should be included in new-mail-check.
Definition at line 271 of file kmfolderimap.h. |
|
Initialize this storage from another one. Used when creating a child folder Definition at line 955 of file kmfolderimap.cpp. |
|
Create or find the INBOX and initialize it.
Definition at line 855 of file kmfolderimap.cpp. |
|
imap folders cannot expire
Definition at line 278 of file kmfolderimap.h. |
|
Returns true if this folder can be moved.
Reimplemented from FolderStorage. Definition at line 2228 of file kmfolderimap.cpp. |
|
Is the folder readonly?
Reimplemented from KMFolderMbox. Definition at line 298 of file kmfolderimap.h. |
|
The highest UID in the folder.
Definition at line 1053 of file kmfolderimap.cpp. |
|
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 704 of file kmfolderimap.cpp. |
|
generates sets of uids
Definition at line 1825 of file kmfolderimap.cpp. |
|
Refresh the number of unseen mails Returns false in an error condition.
Definition at line 1934 of file kmfolderimap.cpp. |
|
Read the config file.
Reimplemented from FolderStorage. Definition at line 169 of file kmfolderimap.cpp. |
|
Get the folder now (internal).
Definition at line 1172 of file kmfolderimap.cpp. |
|
Remove the IMAP folder on the server and if successful also locally.
Reimplemented from FolderStorage. Definition at line 204 of file kmfolderimap.cpp. |
|
Remove (first occurrence of) given message from the folder.
Reimplemented from FolderStorage. Definition at line 251 of file kmfolderimap.cpp. |
|
Physically rename the folder. Returns zero on success and an errno on failure. Reimplemented from FolderStorage. Definition at line 291 of file kmfolderimap.cpp. |
|
Save the metadata for the UID If the UID is not supplied the one from the message is taken.
Definition at line 2247 of file kmfolderimap.cpp. |
|
Check if the message matches the search criteria The end is signaled with searchDone().
Reimplemented from FolderStorage. Definition at line 2206 of file kmfolderimap.cpp. |
|
Search for messages The actual search is done in slotSearch and the end is signaled with searchDone().
Reimplemented from FolderStorage. Definition at line 2182 of file kmfolderimap.cpp. |
|
Emit the folderComplete signal.
Definition at line 216 of file kmfolderimap.h. |
|
Get the serial number for the given UID (if available).
Definition at line 2235 of file kmfolderimap.cpp. |
|
The imap account associated with this folder.
Definition at line 155 of file kmfolderimap.cpp. |
|
Mark the folder as already removed from the server If set to true the folder will only be deleted locally This will recursively be applied to all children.
Definition at line 2149 of file kmfolderimap.cpp. |
|
The path to the imap folder on the server.
Definition at line 2257 of file kmfolderimap.cpp. |
|
Tell the folder, this it is selected and shall also display new mails, not only their number, when checking for mail.
Definition at line 229 of file kmfolderimap.h. |
|
Change the status of several messages indicated by
Reimplemented from FolderStorage. Definition at line 1769 of file kmfolderimap.cpp. |
|
Change the status of the message indicated by
Reimplemented from FolderStorage. Definition at line 1763 of file kmfolderimap.cpp. |
|
The uidvalidity of the last update.
Definition at line 118 of file kmfolderimap.h. |
|
Set the user's rights on this folder - called by getUserRights.
Definition at line 2104 of file kmfolderimap.cpp. |
|
Connected to slotListNamespaces creates/removes namespace folders.
Definition at line 633 of file kmfolderimap.cpp. |
|
notify the progress item that the mail check for this folder is done.
Definition at line 2111 of file kmfolderimap.cpp. |
|
Connected to the result signal of the copy/move job.
Definition at line 486 of file kmfolderimap.cpp. |
|
For creating a new subfolder.
Definition at line 1636 of file kmfolderimap.cpp. |
|
Is connected when there are folders to be created on startup and the account is still connecting. Once the account emits the connected signal this slot is called and the folders created. Definition at line 2167 of file kmfolderimap.cpp. |
|
For retrieving a message digest.
Definition at line 1601 of file kmfolderimap.cpp. |
|
For listing the contents of a folder.
Definition at line 1218 of file kmfolderimap.cpp. |
|
Starts a namespace listing.
Definition at line 577 of file kmfolderimap.cpp. |
|
Connected to ListJob::receivedFolders creates/removes folders.
Definition at line 738 of file kmfolderimap.cpp. |
|
Is called when the slave is connected and triggers a newmail check.
Definition at line 1922 of file kmfolderimap.cpp. |
|
Remove the folder also locally, if removing on the server succeeded.
Definition at line 235 of file kmfolderimap.cpp. |
|
Called from the SearchJob when the message was searched.
Definition at line 2221 of file kmfolderimap.cpp. |
|
Called from the SearchJob when the folder is done or messages where found.
Definition at line 2198 of file kmfolderimap.cpp. |
|
Add the data a KIO::Job retrieves to the buffer.
Definition at line 1690 of file kmfolderimap.cpp. |
|
Update the number of unseen messages.
Definition at line 1986 of file kmfolderimap.cpp. |
|
splits the message list according to sets. Modifies the . Definition at line 517 of file kmfolderimap.cpp. |
|
Splits a uid-set into single uids.
Definition at line 2022 of file kmfolderimap.cpp. |
|
Convert message status to a list of IMAP flags.
Definition at line 1381 of file kmfolderimap.cpp. |
|
Detach message from this folder. Usable to call addMsg() afterwards. Loads the message if it is not loaded up to now. Reimplemented from FolderStorage. Definition at line 555 of file kmfolderimap.cpp. |
|
Return the trash folder.
Reimplemented from FolderStorage. Definition at line 129 of file kmfolderimap.cpp. |
|
The user's rights on this folder - see bitfield in ACLJobs namespace.
Definition at line 304 of file kmfolderimap.h. |
|
Write the config file.
Reimplemented from FolderStorage. Definition at line 191 of file kmfolderimap.cpp. |
The documentation for this class was generated from the following files: