kmail
KMFolderImap Class Reference

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, int supportedFalgs=31) |
static void | seenFlagToStatus (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 *) |
void | folderCreationResult (const QString &name, bool success) |
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 () const |
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 | reallyDoClose (const char *owner) |
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) |
int | permanentFlags () const |
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, int supportedFalgs) |
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 (const char *func, 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 |
Member Enumeration Documentation
Definition at line 87 of file kmfolderimap.h.
Constructor & Destructor Documentation
KMFolderImap::KMFolderImap | ( | KMFolder * | folder, | |
const char * | name = 0 | |||
) |
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
virtual KMFolderType KMFolderImap::folderType | ( | ) | const [inline, virtual] |
Returns the type of this folder.
Reimplemented from KMFolderMbox.
Definition at line 107 of file kmfolderimap.h.
KMMessage * KMFolderImap::getMsg | ( | int | idx | ) | [virtual] |
Read message at given index.
Indexing starts at zero
Reimplemented from FolderStorage.
Definition at line 138 of file kmfolderimap.cpp.
void KMFolderImap::setImapPath | ( | const QString & | path | ) |
ulong KMFolderImap::lastUid | ( | ) |
void KMFolderImap::setUidValidity | ( | const QString & | validity | ) | [inline] |
void KMFolderImap::setAccount | ( | KMAcctImap * | acct | ) |
void KMFolderImap::removeMsg | ( | int | i, | |
bool | quiet = FALSE | |||
) | [virtual] |
Remove (first occurrence of) given message from the folder.
Reimplemented from FolderStorage.
Definition at line 277 of file kmfolderimap.cpp.
int KMFolderImap::rename | ( | const QString & | newName, | |
KMFolderDir * | aParent = 0 | |||
) | [virtual] |
Physically rename the folder.
Returns zero on success and an errno on failure.
Reimplemented from FolderStorage.
Definition at line 317 of file kmfolderimap.cpp.
void KMFolderImap::remove | ( | ) | [virtual] |
Remove the IMAP folder on the server and if successful also locally.
Reimplemented from FolderStorage.
Definition at line 230 of file kmfolderimap.cpp.
bool KMFolderImap::autoExpunge | ( | ) |
Automatically expunge deleted messages when leaving the folder.
Definition at line 1794 of file kmfolderimap.cpp.
void KMFolderImap::writeConfig | ( | void | ) | [virtual] |
Write the config file.
Reimplemented from FolderStorage.
Definition at line 215 of file kmfolderimap.cpp.
void KMFolderImap::readConfig | ( | void | ) | [virtual] |
Read the config file.
Reimplemented from FolderStorage.
Definition at line 191 of file kmfolderimap.cpp.
bool KMFolderImap::listDirectory | ( | ) | [virtual] |
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 737 of file kmfolderimap.cpp.
void KMFolderImap::getFolder | ( | bool | force = FALSE |
) |
void KMFolderImap::getAndCheckFolder | ( | bool | force = FALSE |
) |
void KMFolderImap::createFolder | ( | const QString & | name, | |
const QString & | imapPath = QString::null , |
|||
bool | askUser = true | |||
) |
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 1715 of file kmfolderimap.cpp.
void KMFolderImap::deleteMessage | ( | KMMessage * | msg | ) |
void KMFolderImap::setStatus | ( | int | idx, | |
KMMsgStatus | status, | |||
bool | toggle | |||
) | [virtual] |
Change the status of the message indicated by index
Overloaded function for the following one.
Reimplemented from FolderStorage.
Definition at line 1877 of file kmfolderimap.cpp.
void KMFolderImap::setStatus | ( | QValueList< int > & | _ids, | |
KMMsgStatus | status, | |||
bool | toggle | |||
) | [virtual] |
Change the status of several messages indicated by ids
.
Reimplemented from FolderStorage.
Definition at line 1883 of file kmfolderimap.cpp.
QStringList KMFolderImap::makeSets | ( | QValueList< ulong > & | uids, | |
bool | sort = true | |||
) | [static] |
QPtrList< KMMessage > KMFolderImap::splitMessageList | ( | const QString & | set, | |
QPtrList< KMMessage > & | msgList | |||
) | [static] |
splits the message list according to sets.
Modifies the .
Definition at line 550 of file kmfolderimap.cpp.
void KMFolderImap::getUids | ( | QValueList< int > & | ids, | |
QValueList< ulong > & | uids | |||
) |
void KMFolderImap::getUids | ( | const QPtrList< KMMessage > & | msgList, | |
QValueList< ulong > & | uids | |||
) |
void KMFolderImap::expungeFolder | ( | KMFolderImap * | aFolder, | |
bool | quiet | |||
) |
virtual int KMFolderImap::compact | ( | bool | silent | ) | [inline, virtual] |
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.
void KMFolderImap::sendFolderComplete | ( | bool | success | ) | [inline] |
bool KMFolderImap::processNewMail | ( | bool | interactive | ) |
Refresh the number of unseen mails Returns false in an error condition.
Definition at line 2089 of file kmfolderimap.cpp.
void KMFolderImap::setSelected | ( | bool | selected | ) | [inline] |
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.
QString KMFolderImap::encodeFileName | ( | const QString & | name | ) | [static] |
Encode the given string in a filename save 7 bit string.
Definition at line 1779 of file kmfolderimap.cpp.
QString KMFolderImap::statusToFlags | ( | KMMsgStatus | status, | |
int | supportedFalgs | |||
) | [static] |
virtual QString KMFolderImap::fileName | ( | ) | const [inline, virtual] |
Return the filename of the folder (reimplemented from KFolder).
Reimplemented from FolderStorage.
Definition at line 247 of file kmfolderimap.h.
const ulong KMFolderImap::serNumForUID | ( | ulong | uid | ) |
Get the serial number for the given UID (if available).
Definition at line 2390 of file kmfolderimap.cpp.
void KMFolderImap::saveMsgMetaData | ( | KMMessage * | msg, | |
ulong | uid = 0 | |||
) |
Save the metadata for the UID If the UID is not supplied the one from the message is taken.
Definition at line 2402 of file kmfolderimap.cpp.
QValueList< ulong > KMFolderImap::splitSets | ( | const | QString | ) | [static] |
void KMFolderImap::ignoreJobsForMessage | ( | KMMessage * | msg | ) | [virtual] |
Removes and deletes all jobs associated with the particular message.
Reimplemented from FolderStorage.
Definition at line 1503 of file kmfolderimap.cpp.
bool KMFolderImap::includeInMailCheck | ( | ) | [inline] |
int KMFolderImap::create | ( | ) | [virtual] |
virtual bool KMFolderImap::isAutoExpire | ( | ) | const [inline, virtual] |
void KMFolderImap::reallyDoClose | ( | const char * | owner | ) | [virtual] |
Closes and cancels all pending jobs.
Reimplemented from KMFolderMbox.
Definition at line 109 of file kmfolderimap.cpp.
KMFolder * KMFolderImap::trashFolder | ( | ) | const [virtual] |
Return the trash folder.
Reimplemented from FolderStorage.
Definition at line 131 of file kmfolderimap.cpp.
void KMFolderImap::setAlreadyRemoved | ( | bool | removed | ) |
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 2304 of file kmfolderimap.cpp.
bool KMFolderImap::isReadOnly | ( | ) | const [inline, virtual] |
Is the folder readonly?
Reimplemented from KMFolderMbox.
Definition at line 296 of file kmfolderimap.h.
unsigned int KMFolderImap::userRights | ( | ) | const [inline] |
The user's rights on this folder - see bitfield in ACLJobs namespace.
- Returns:
- 0 when not known yet
Definition at line 302 of file kmfolderimap.h.
void KMFolderImap::setUserRights | ( | unsigned int | userRights | ) |
Set the user's rights on this folder - called by getUserRights.
Definition at line 2259 of file kmfolderimap.cpp.
void KMFolderImap::search | ( | const KMSearchPattern * | pattern | ) | [virtual] |
Search for messages The actual search is done in slotSearch and the end is signaled with searchDone().
Reimplemented from FolderStorage.
Definition at line 2337 of file kmfolderimap.cpp.
void KMFolderImap::search | ( | const KMSearchPattern * | pattern, | |
Q_UINT32 | serNum | |||
) | [virtual] |
Check if the message matches the search criteria The end is signaled with searchDone().
Reimplemented from FolderStorage.
Definition at line 2361 of file kmfolderimap.cpp.
bool KMFolderImap::isMoveable | ( | ) | const [virtual] |
Returns true if this folder can be moved.
Reimplemented from FolderStorage.
Definition at line 2383 of file kmfolderimap.cpp.
void KMFolderImap::initializeFrom | ( | KMFolderImap * | parent, | |
QString | path, | |||
QString | mimeType | |||
) |
Initialize this storage from another one.
Used when creating a child folder
Definition at line 991 of file kmfolderimap.cpp.
int KMFolderImap::permanentFlags | ( | ) | const [inline] |
Returns the IMAP flags that can be stored on the server.
Definition at line 322 of file kmfolderimap.h.
void KMFolderImap::deleted | ( | KMFolderImap * | ) | [signal] |
Emitted, when the account is deleted.
void KMFolderImap::directoryListingFinished | ( | KMFolderImap * | ) | [signal] |
Emitted at the end of the directory listing.
void KMFolderImap::folderCreationResult | ( | const QString & | name, | |
bool | success | |||
) | [signal] |
Emitted when a folder creation has finished.
- Parameters:
-
name The name of the folder that should have been created. success True if the folder was created, false otherwise.
void KMFolderImap::addMsgQuiet | ( | KMMessage * | aMsg | ) | [virtual, slot] |
Add a message to a folder after is has been added on an IMAP server.
Definition at line 326 of file kmfolderimap.cpp.
int KMFolderImap::addMsg | ( | KMMessage * | msg, | |
int * | index_return = 0 | |||
) | [virtual, slot] |
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 388 of file kmfolderimap.cpp.
int KMFolderImap::addMsg | ( | QPtrList< KMMessage > & | msgList, | |
QValueList< int > & | index_return | |||
) | [virtual, slot] |
Adds the given messages to the folder.
Behaviour is identical to addMsg(msg)
Reimplemented from FolderStorage.
Definition at line 398 of file kmfolderimap.cpp.
void KMFolderImap::copyMsg | ( | QPtrList< KMMessage > & | msgList | ) | [slot] |
KMMessage * KMFolderImap::take | ( | int | idx | ) | [virtual, slot] |
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 588 of file kmfolderimap.cpp.
void KMFolderImap::slotSimpleData | ( | KIO::Job * | job, | |
const QByteArray & | data | |||
) | [slot] |
void KMFolderImap::flagsToStatus | ( | KMMsgBase * | msg, | |
int | flags, | |||
bool | newMsg = TRUE , |
|||
int | supportedFalgs = 31 | |||
) | [static, slot] |
Convert IMAP flags to a message status.
- Parameters:
-
newMsg specifies whether unseen messages are new or unread
Definition at line 1418 of file kmfolderimap.cpp.
void KMFolderImap::seenFlagToStatus | ( | KMMsgBase * | msg, | |
int | flags, | |||
bool | newMsg = true | |||
) | [static, slot] |
Convert IMAP seen flag to a message status.
- Parameters:
-
newMsg specifies whether unseen messages are new or unread
Definition at line 1451 of file kmfolderimap.cpp.
void KMFolderImap::slotCopyMsgResult | ( | KMail::FolderJob * | job | ) | [slot] |
Connected to the result signal of the copy/move job.
Definition at line 516 of file kmfolderimap.cpp.
void KMFolderImap::slotSearchDone | ( | QValueList< Q_UINT32 > | serNums, | |
const KMSearchPattern * | pattern, | |||
bool | complete | |||
) | [slot] |
Called from the SearchJob when the folder is done or messages where found.
Definition at line 2353 of file kmfolderimap.cpp.
void KMFolderImap::slotSearchDone | ( | Q_UINT32 | serNum, | |
const KMSearchPattern * | pattern, | |||
bool | matches | |||
) | [slot] |
Called from the SearchJob when the message was searched.
Definition at line 2376 of file kmfolderimap.cpp.
void KMFolderImap::slotListResult | ( | const QStringList & | subfolderNames, | |
const QStringList & | subfolderPaths, | |||
const QStringList & | subfolderMimeTypes, | |||
const QStringList & | subfolderAttributes, | |||
const ImapAccountBase::jobData & | jobData | |||
) | [slot] |
Connected to ListJob::receivedFolders creates/removes folders.
Definition at line 772 of file kmfolderimap.cpp.
void KMFolderImap::slotCheckNamespace | ( | const QStringList & | subfolderNames, | |
const QStringList & | subfolderPaths, | |||
const QStringList & | subfolderMimeTypes, | |||
const QStringList & | subfolderAttributes, | |||
const ImapAccountBase::jobData & | jobData | |||
) | [slot] |
Connected to slotListNamespaces creates/removes namespace folders.
Definition at line 666 of file kmfolderimap.cpp.
FolderJob * KMFolderImap::doCreateJob | ( | KMMessage * | msg, | |
FolderJob::JobType | jt, | |||
KMFolder * | folder, | |||
QString | partSpecifier, | |||
const AttachmentStrategy * | as | |||
) | const [protected, virtual] |
These two methods actually create the jobs.
They have to be implemented in all folders.
- See also:
- createJob
Reimplemented from KMFolderMbox.
Definition at line 1640 of file kmfolderimap.cpp.
int KMFolderImap::expungeContents | ( | ) | [protected, virtual] |
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 2229 of file kmfolderimap.cpp.
void KMFolderImap::initInbox | ( | ) | [protected] |
KMFolderImap * KMFolderImap::findParent | ( | const QString & | path, | |
const QString & | name | |||
) | [protected] |
void KMFolderImap::checkFolders | ( | const QStringList & | folderNames, | |
const QString & | ns | |||
) | [protected] |
See if all folders are still present on server, otherwise delete them.
Definition at line 946 of file kmfolderimap.cpp.
void KMFolderImap::checkValidity | ( | ) | [protected, slot] |
void KMFolderImap::reallyGetFolder | ( | const QString & | startUid = QString::null |
) | [protected, slot] |
void KMFolderImap::slotListFolderResult | ( | KIO::Job * | job | ) | [protected, slot] |
void KMFolderImap::slotGetMessagesResult | ( | KIO::Job * | job | ) | [protected, slot] |
void KMFolderImap::slotCreateFolderResult | ( | KIO::Job * | job | ) | [protected, slot] |
void KMFolderImap::slotRemoveFolderResult | ( | KIO::Job * | job | ) | [protected, slot] |
Remove the folder also locally, if removing on the server succeeded.
Definition at line 261 of file kmfolderimap.cpp.
void KMFolderImap::slotStatResult | ( | KIO::Job * | job | ) | [protected, slot] |
void KMFolderImap::slotCompleteMailCheckProgress | ( | ) | [protected, slot] |
notify the progress item that the mail check for this folder is done.
Definition at line 2266 of file kmfolderimap.cpp.
void KMFolderImap::slotProcessNewMail | ( | int | errorCode, | |
const QString & | errorMsg | |||
) | [protected, slot] |
Is called when the slave is connected and triggers a newmail check.
Definition at line 2077 of file kmfolderimap.cpp.
void KMFolderImap::slotCreatePendingFolders | ( | int | errorCode, | |
const QString & | errorMsg | |||
) | [protected, slot] |
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 2322 of file kmfolderimap.cpp.
void KMFolderImap::slotListNamespaces | ( | ) | [protected, slot] |
The documentation for this class was generated from the following files: