kmail
KMFolder Class Reference
Mail folder. More...
#include <kmfolder.h>

Public Types | |
enum | CompactOptions { CompactLater, CompactNow, CompactSilentlyNow } |
enum | ExpireAction { ExpireDelete, ExpireMove } |
Public Slots | |
int | updateIndex () |
void | reallyAddMsg (KMMessage *aMsg) |
void | reallyAddCopyOfMsg (KMMessage *aMsg) |
Signals | |
void | changed () |
void | closed () |
void | cleared () |
void | expunged (KMFolder *) |
void | iconsChanged () |
void | nameChanged () |
void | shortcutChanged (KMFolder *) |
void | msgRemoved (KMFolder *, Q_UINT32 sernum) |
void | msgRemoved (int idx, TQString msgIdMD5) |
void | msgRemoved (KMFolder *) |
void | msgAdded (int idx) |
void | msgAdded (KMFolder *, Q_UINT32 sernum) |
void | msgChanged (KMFolder *, Q_UINT32 sernum, int delta) |
void | msgHeaderChanged (KMFolder *, int) |
void | statusMsg (const TQString &) |
void | numUnreadMsgsChanged (KMFolder *) |
void | removed (KMFolder *, bool) |
void | viewConfigChanged () |
void | folderSizeChanged (KMFolder *) |
void | noContentChanged () |
void | syncStateChanged () |
Public Member Functions | |
KMFolder (KMFolderDir *parent, const TQString &name, KMFolderType aFolderType, bool withIndex=true, bool exportedSernums=true) | |
bool | isMainInbox () |
bool | isOutbox () |
bool | isSent () |
bool | isTrash () |
bool | isDrafts () |
bool | isTemplates () |
void | setAcctList (AccountList *list) |
AccountList * | acctList () |
bool | hasAccounts () const |
void | readConfig (KConfig *config) |
void | writeConfig (KConfig *config) const |
FolderStorage * | storage () |
const FolderStorage * | storage () const |
KMFolderType | folderType () const |
TQString | fileName () const |
TQString | location () const |
TQString | indexLocation () const |
TQString | subdirLocation () const |
KMFolderDir * | child () const |
KMFolderDir * | createChildFolder () |
void | setChild (KMFolderDir *aChild) |
bool | noContent () const |
void | setNoContent (bool aNoContent) |
bool | noChildren () const |
void | setNoChildren (bool aNoChildren) |
KMMessage * | getMsg (int idx) |
KMMsgInfo * | unGetMsg (int idx) |
bool | isMessage (int idx) |
DwString | getDwString (int idx) |
void | ignoreJobsForMessage (KMMessage *) |
FolderJob * | createJob (KMMessage *msg, FolderJob::JobType jt=FolderJob::tGetMessage, KMFolder *folder=0, TQString partSpecifier=TQString::null, const AttachmentStrategy *as=0) const |
FolderJob * | createJob (TQPtrList< KMMessage > &msgList, const TQString &sets, FolderJob::JobType jt=FolderJob::tGetMessage, KMFolder *folder=0) const |
const KMMsgBase * | getMsgBase (int idx) const |
KMMsgBase * | getMsgBase (int idx) |
const KMMsgBase * | operator[] (int idx) const |
KMMsgBase * | operator[] (int idx) |
KMMessage * | take (int idx) |
void | take (TQPtrList< KMMessage > msgList) |
int | addMsg (KMMessage *msg, int *index_return=0) |
int | addMsgKeepUID (KMMessage *msg, int *index_return=0) |
int | addMsg (TQPtrList< KMMessage > &, TQValueList< int > &index_return) |
void | emitMsgAddedSignals (int idx) |
void | removeMsg (int i, bool imapQuiet=false) |
void | removeMsg (TQPtrList< KMMessage > msgList, bool imapQuiet=false) |
int | expungeOldMsg (int days) |
int | moveMsg (KMMessage *msg, int *index_return=0) |
int | moveMsg (TQPtrList< KMMessage >, int *index_return=0) |
int | find (const KMMsgBase *msg) const |
int | find (const KMMessage *msg) const |
int | count (bool cache=false) const |
int | countUnread () |
int | countUnreadRecursive () |
void | msgStatusChanged (const KMMsgStatus oldStatus, const KMMsgStatus newStatus, int idx) |
int | open (const char *owner) |
int | canAccess () |
void | close (const char *owner, bool force=false) |
void | sync () |
bool | isOpened () const |
void | markNewAsUnread () |
void | markUnreadAsRead () |
void | remove () |
int | expunge () |
void | compact (CompactOptions options) |
int | rename (const TQString &newName, KMFolderDir *aParent=0) |
bool | dirty () const |
void | setDirty (bool f) |
bool | needsCompacting () const |
void | setNeedsCompacting (bool f) |
void | quiet (bool beQuiet) |
bool | isReadOnly () const |
bool | isWritable () const |
bool | mailCheckInProgress () const |
bool | canDeleteMessages () const |
bool | isSystemFolder () const |
void | setSystemFolder (bool itIs) |
virtual TQString | label () const |
void | setLabel (const TQString &l) |
virtual TQString | systemLabel () const |
void | setSystemLabel (const TQString &l) |
virtual TQString | prettyURL () const |
void | setMailingListEnabled (bool enabled) |
bool | isMailingListEnabled () const |
void | setMailingList (const MailingList &mlist) |
MailingList | mailingList () const |
TQString | mailingListPostAddress () const |
void | setIdentity (uint identity) |
uint | identity () const |
TQString | whoField () const |
void | setWhoField (const TQString &aWhoField) |
TQString | userWhoField (void) |
void | setUserWhoField (const TQString &whoField, bool writeConfig=true) |
void | correctUnreadMsgsCount () |
TQString | idString () const |
void | setAutoExpire (bool enabled) |
bool | isAutoExpire () const |
void | setUnreadExpireAge (int age) |
void | setUnreadExpireUnits (ExpireUnits units) |
void | setReadExpireAge (int age) |
void | setReadExpireUnits (ExpireUnits units) |
int | getUnreadExpireAge () const |
int | getReadExpireAge () const |
ExpireUnits | getUnreadExpireUnits () const |
ExpireUnits | getReadExpireUnits () const |
ExpireAction | expireAction () const |
void | setExpireAction (ExpireAction a) |
TQString | expireToFolderId () const |
void | setExpireToFolderId (const TQString &id) |
void | expireOldMessages (bool immediate) |
int | writeIndex (bool createEmptyIndex=false) |
void | setStatus (int idx, KMMsgStatus status, bool toggle=false) |
void | setStatus (TQValueList< int > &ids, KMMsgStatus status, bool toggle=false) |
bool | useCustomIcons () const |
void | setUseCustomIcons (bool useCustomIcons) |
TQString | normalIconPath () const |
TQString | unreadIconPath () const |
void | setIconPaths (const TQString &normalPath, const TQString &unreadPath) |
void | removeJobs () |
void | daysToExpire (int &unreadDays, int &readDays) |
KMFolder * | trashFolder () const |
bool | putRepliesInSameFolder () const |
void | setPutRepliesInSameFolder (bool b) |
bool | ignoreNewMail () const |
void | setIgnoreNewMail (bool b) |
const KShortcut & | shortcut () const |
void | setShortcut (const KShortcut &) |
bool | isMoveable () const |
bool | moveInProgress () const |
void | setMoveInProgress (bool b) |
bool | isValidName (const TQString &folderName, TQString &message) |
Friends | |
class | ::KMFolderJob |
Detailed Description
Mail folder.(description will be here).
Accounts
The accounts (of KMail) that are fed into the folder are represented as the children of the folder. They are only stored here during runtime to have a reference for which accounts point to a specific folder.Definition at line 68 of file kmfolder.h.
Constructor & Destructor Documentation
KMFolder::KMFolder | ( | KMFolderDir * | parent, | |
const TQString & | name, | |||
KMFolderType | aFolderType, | |||
bool | withIndex = true , |
|||
bool | exportedSernums = true | |||
) |
Constructs a new Folder object.
- Parameters:
-
parent The directory in the folder storage hierarchy under which the folder's storage will be found or created. name If name of the folder. In case there is no parent directory, because the folder is free-standing (/var/spool/mail/foo), this is used for the full path to the folder's storage location. aFolderType The type of folder to create. withIndex Wether this folder has an index. No-index folders are those used by KMail internally, the Outbox, and those of local spool accounts, for example. exportedSernums whether this folder exports its serial numbers to the global MsgDict for lookup.
- Returns:
- A new folder instance.
Definition at line 48 of file kmfolder.cpp.
Member Function Documentation
bool KMFolder::isMainInbox | ( | ) | [inline] |
Returns true if this folder is the inbox on the local disk.
Definition at line 95 of file kmfolder.h.
bool KMFolder::isOutbox | ( | ) | [inline] |
Returns true only if this is the outbox for outgoing mail.
Definition at line 99 of file kmfolder.h.
bool KMFolder::isSent | ( | ) | [inline] |
Returns true if this folder is the sent-mail box of the local account, or is configured to be the sent mail box of any of the users identities.
Definition at line 104 of file kmfolder.h.
bool KMFolder::isTrash | ( | ) | [inline] |
Returns true if this folder is configured as a trash folder, locally or for one of the accounts.
Definition at line 109 of file kmfolder.h.
bool KMFolder::isDrafts | ( | ) | [inline] |
Returns true if this folder is the drafts box of the local account, or is configured to be the drafts box of any of the users identities.
Definition at line 114 of file kmfolder.h.
bool KMFolder::isTemplates | ( | ) | [inline] |
Returns true if this folder is the templates folder of the local account, or is configured to be the templates folder of any of the users identities.
Definition at line 119 of file kmfolder.h.
bool KMFolder::hasAccounts | ( | ) | const [inline] |
Returns TRUE if accounts are associated with this folder.
Definition at line 127 of file kmfolder.h.
void KMFolder::readConfig | ( | KConfig * | config | ) |
This is used by the storage to read the folder specific configuration.
Definition at line 161 of file kmfolder.cpp.
void KMFolder::writeConfig | ( | KConfig * | config | ) | const |
This is used by the storage to save the folder specific configuration.
Definition at line 200 of file kmfolder.cpp.
const FolderStorage* KMFolder::storage | ( | ) | const [inline] |
KMFolderType KMFolder::folderType | ( | ) | const |
TQString KMFolder::fileName | ( | ) | const |
Returns the filename of the folder (reimplemented in KMFolderImap).
Definition at line 238 of file kmfolder.cpp.
TQString KMFolder::location | ( | void | ) | const |
TQString KMFolder::indexLocation | ( | ) | const |
TQString KMFolder::subdirLocation | ( | ) | const |
KMFolderDir* KMFolder::child | ( | ) | const [inline] |
Returns the folder directory associated with this node or 0 if no such directory exists.
Definition at line 156 of file kmfolder.h.
KMFolderDir * KMFolder::createChildFolder | ( | ) |
Create a child folder directory and associates it with this folder.
Definition at line 264 of file kmfolder.cpp.
void KMFolder::setChild | ( | KMFolderDir * | aChild | ) |
bool KMFolder::noContent | ( | ) | const |
Returns, if the folder can't contain mails, but only subfolder.
Definition at line 301 of file kmfolder.cpp.
void KMFolder::setNoContent | ( | bool | aNoContent | ) |
bool KMFolder::noChildren | ( | ) | const |
void KMFolder::setNoChildren | ( | bool | aNoChildren | ) |
KMMessage * KMFolder::getMsg | ( | int | idx | ) |
KMMsgInfo * KMFolder::unGetMsg | ( | int | idx | ) |
bool KMFolder::isMessage | ( | int | idx | ) |
DwString KMFolder::getDwString | ( | int | idx | ) |
void KMFolder::ignoreJobsForMessage | ( | KMMessage * | m | ) |
Removes and deletes all jobs associated with the particular message.
Definition at line 341 of file kmfolder.cpp.
FolderJob* KMFolder::createJob | ( | KMMessage * | msg, | |
FolderJob::JobType | jt = FolderJob::tGetMessage , |
|||
KMFolder * | folder = 0 , |
|||
TQString | partSpecifier = TQString::null , |
|||
const AttachmentStrategy * | as = 0 | |||
) | const |
These methods create respective FolderJob (You should derive FolderJob for each derived KMFolder).
const KMMsgBase * KMFolder::getMsgBase | ( | int | idx | ) | const |
Provides access to the basic message fields that are also stored in the index.
Whenever you only need subject, from, date, status you should use this method instead of getMsg() because getMsg() will load the message if necessary and this method does not.
Definition at line 360 of file kmfolder.cpp.
const KMMsgBase * KMFolder::operator[] | ( | int | idx | ) | const |
KMMsgBase * KMFolder::operator[] | ( | int | idx | ) |
KMMessage * KMFolder::take | ( | int | idx | ) |
Detach message from this folder.
Usable to call addMsg() afterwards. Loads the message if it is not loaded up to now.
Definition at line 380 of file kmfolder.cpp.
int KMFolder::addMsg | ( | KMMessage * | msg, | |
int * | index_return = 0 | |||
) |
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).
Definition at line 390 of file kmfolder.cpp.
int KMFolder::addMsgKeepUID | ( | KMMessage * | msg, | |
int * | index_return = 0 | |||
) |
(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.
Definition at line 395 of file kmfolder.cpp.
int KMFolder::addMsg | ( | TQPtrList< KMMessage > & | list, | |
TQValueList< int > & | index_return | |||
) |
Adds the given messages to the folder.
Behaviour is identical to addMsg(msg)
Definition at line 400 of file kmfolder.cpp.
void KMFolder::emitMsgAddedSignals | ( | int | idx | ) |
Called by derived classes implementation of addMsg.
Emits msgAdded signals
Definition at line 405 of file kmfolder.cpp.
void KMFolder::removeMsg | ( | int | i, | |
bool | imapQuiet = false | |||
) |
Remove (first occurrence of) given message from the folder.
Definition at line 410 of file kmfolder.cpp.
int KMFolder::expungeOldMsg | ( | int | days | ) |
Delete messages in the folder that are older than days.
Return the number of deleted messages.
Definition at line 420 of file kmfolder.cpp.
int KMFolder::moveMsg | ( | KMMessage * | msg, | |
int * | index_return = 0 | |||
) |
Detaches the given message from it's current folder and adds it to this 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.
Definition at line 425 of file kmfolder.cpp.
int KMFolder::find | ( | const KMMsgBase * | msg | ) | const |
Returns the index of the given message or -1 if not found.
Definition at line 435 of file kmfolder.cpp.
int KMFolder::count | ( | bool | cache = false |
) | const |
int KMFolder::countUnread | ( | ) |
int KMFolder::countUnreadRecursive | ( | ) |
Number of new or unread messages in this folder and all folders contained by this folder.
Definition at line 455 of file kmfolder.cpp.
void KMFolder::msgStatusChanged | ( | const KMMsgStatus | oldStatus, | |
const KMMsgStatus | newStatus, | |||
int | idx | |||
) |
Called by KMMsgBase::setStatus when status of a message has changed required to keep the number unread messages variable current.
Definition at line 473 of file kmfolder.cpp.
int KMFolder::open | ( | const char * | owner | ) |
Open folder for access.
Does nothing if the folder is already opened. To reopen a folder call close() first. Returns zero on success and an error code equal to the c-library fopen call otherwise (errno).
Definition at line 479 of file kmfolder.cpp.
int KMFolder::canAccess | ( | ) |
Check folder for permissions Returns zero if readable and writable.
Definition at line 484 of file kmfolder.cpp.
void KMFolder::close | ( | const char * | owner, | |
bool | force = false | |||
) |
Close folder.
If force is true the files are closed even if others still use it (e.g. other mail reader windows).
Definition at line 489 of file kmfolder.cpp.
void KMFolder::sync | ( | ) |
bool KMFolder::isOpened | ( | ) | const |
void KMFolder::markNewAsUnread | ( | ) |
void KMFolder::markUnreadAsRead | ( | ) |
void KMFolder::remove | ( | ) |
Removes the folder physically from disk and empties the contents of the folder in memory.
Note that the folder is closed during this process, whether there are others using it or not. see KMFolder::removeContents
Definition at line 515 of file kmfolder.cpp.
int KMFolder::expunge | ( | ) |
Delete entire folder.
Forces a close *but* opens the folder again afterwards. Returns errno(3) error code or zero on success. see KMFolder::expungeContents
Definition at line 526 of file kmfolder.cpp.
void KMFolder::compact | ( | CompactOptions | options | ) |
Compact this folder.
Options: CompactLater: schedule it as a background task CompactNow: do it now, and inform the user of the result (manual compaction) CompactSilentlyNow: do it now, and keep silent about it (e.g. for outbox)
Definition at line 811 of file kmfolder.cpp.
int KMFolder::rename | ( | const TQString & | newName, | |
KMFolderDir * | aParent = 0 | |||
) |
Physically rename the folder.
Returns zero on success and an errno on failure.
Definition at line 531 of file kmfolder.cpp.
bool KMFolder::dirty | ( | ) | const |
Returns true if the table of contents is dirty.
This happens when a message is deleted from the folder. The toc will then be re-created when the folder is closed.
Definition at line 536 of file kmfolder.cpp.
void KMFolder::setDirty | ( | bool | f | ) |
bool KMFolder::needsCompacting | ( | ) | const |
void KMFolder::quiet | ( | bool | beQuiet | ) |
If set to quiet the folder will not emit msgAdded(idx) signal.
This is necessary because adding the messages to the listview one by one as they come in ( as happens on msgAdded(idx) ) is very slow for large ( >10000 ) folders. For pop, where whole bodies are downloaded this is not an issue, but for imap, where we only download headers it becomes a bottleneck. We therefore set the folder quiet() and rebuild the listview completely once the complete folder has been checked.
Definition at line 556 of file kmfolder.cpp.
bool KMFolder::isReadOnly | ( | ) | const |
bool KMFolder::isWritable | ( | ) | const |
Can we write into and delete from this folder (on IMAP that's not necessarily !isReadOnly()).
Definition at line 571 of file kmfolder.cpp.
bool KMFolder::canDeleteMessages | ( | ) | const |
bool KMFolder::isSystemFolder | ( | ) | const [inline] |
Returns true if the folder is a kmail system folder.
These are the folders 'inbox', 'outbox', 'sent', 'trash', 'drafts', 'templates'. The name of these folders is nationalized in the folder display and they cannot have accounts associated. Deletion is also forbidden. Etc.
Definition at line 368 of file kmfolder.h.
TQString KMFolder::label | ( | void | ) | const [virtual] |
virtual TQString KMFolder::systemLabel | ( | ) | const [inline, virtual] |
TQString KMFolder::prettyURL | ( | ) | const [virtual] |
void KMFolder::setMailingListEnabled | ( | bool | enabled | ) |
Returns true if this folder is associated with a mailing-list.
Definition at line 620 of file kmfolder.cpp.
TQString KMFolder::whoField | ( | ) | const [inline] |
Get / set the name of the field that is used for the Sender/Receiver column in the headers (From/To).
Definition at line 395 of file kmfolder.h.
TQString KMFolder::userWhoField | ( | void | ) | [inline] |
Get / set the user-settings for the WhoField (From/To/Empty).
Definition at line 399 of file kmfolder.h.
void KMFolder::correctUnreadMsgsCount | ( | ) |
A cludge to help make sure the count of unread messges is kept in sync.
Definition at line 700 of file kmfolder.cpp.
TQString KMFolder::idString | ( | ) | const |
Returns a string that can be used to identify this folder.
Definition at line 705 of file kmfolder.cpp.
void KMFolder::setAutoExpire | ( | bool | enabled | ) |
Set whether this folder automatically expires messages.
Definition at line 725 of file kmfolder.cpp.
bool KMFolder::isAutoExpire | ( | ) | const [inline] |
void KMFolder::setUnreadExpireAge | ( | int | age | ) |
Set the maximum age for unread messages in this folder.
Age should not be negative. Units are set using setUnreadExpireUnits().
Definition at line 733 of file kmfolder.cpp.
void KMFolder::setUnreadExpireUnits | ( | ExpireUnits | units | ) |
Set units to use for expiry of unread messages.
Values are 1 = days, 2 = weeks, 3 = months.
Definition at line 741 of file kmfolder.cpp.
void KMFolder::setReadExpireAge | ( | int | age | ) |
Set the maximum age for read messages in this folder.
Age should not be negative. Units are set using setReadExpireUnits().
Definition at line 748 of file kmfolder.cpp.
void KMFolder::setReadExpireUnits | ( | ExpireUnits | units | ) |
Set units to use for expiry of read messages.
Values are 1 = days, 2 = weeks, 3 = months.
Definition at line 756 of file kmfolder.cpp.
int KMFolder::getUnreadExpireAge | ( | ) | const [inline] |
Get the age at which unread messages are expired.
Units are determined by getUnreadExpireUnits().
Definition at line 448 of file kmfolder.h.
int KMFolder::getReadExpireAge | ( | ) | const [inline] |
Get the age at which read messages are expired.
Units are determined by getReadExpireUnits().
Definition at line 454 of file kmfolder.h.
ExpireUnits KMFolder::getUnreadExpireUnits | ( | ) | const [inline] |
Units getUnreadExpireAge() is returned in.
1 = days, 2 = weeks, 3 = months.
Definition at line 460 of file kmfolder.h.
ExpireUnits KMFolder::getReadExpireUnits | ( | ) | const [inline] |
Units getReadExpireAge() is returned in.
1 = days, 2 = weeks, 3 = months.
Definition at line 466 of file kmfolder.h.
ExpireAction KMFolder::expireAction | ( | ) | const [inline] |
TQString KMFolder::expireToFolderId | ( | ) | const [inline] |
If expiry should move to folder, return the ID of that folder.
Definition at line 478 of file kmfolder.h.
void KMFolder::expireOldMessages | ( | bool | immediate | ) |
Expire old messages in this folder.
If immediate is true, do it immediately; otherwise schedule it for later
Definition at line 801 of file kmfolder.cpp.
int KMFolder::writeIndex | ( | bool | createEmptyIndex = false |
) |
Write index to index-file.
Returns 0 on success and errno error on failure.
Definition at line 826 of file kmfolder.cpp.
void KMFolder::setStatus | ( | int | idx, | |
KMMsgStatus | status, | |||
bool | toggle = false | |||
) |
void KMFolder::setStatus | ( | TQValueList< int > & | ids, | |
KMMsgStatus | status, | |||
bool | toggle = false | |||
) |
Set the status of the message(s) in the TQValueList ids
to status
.
Definition at line 836 of file kmfolder.cpp.
bool KMFolder::useCustomIcons | ( | ) | const [inline] |
KMFolder * KMFolder::trashFolder | ( | ) | const |
If this folder has a special trash folder set, return it.
Otherwise return 0.
Definition at line 821 of file kmfolder.cpp.
bool KMFolder::putRepliesInSameFolder | ( | ) | const [inline] |
Returns true if the replies to mails from this folder should be put in the same folder.
Definition at line 518 of file kmfolder.h.
bool KMFolder::ignoreNewMail | ( | ) | const [inline] |
Returns true if the user doesn't want to get notified about new mail in this folder.
Definition at line 525 of file kmfolder.h.
bool KMFolder::isMoveable | ( | ) | const |
bool KMFolder::moveInProgress | ( | ) | const [inline] |
Returns true if there is currently a move or copy operation going on with this folder as target.
Definition at line 537 of file kmfolder.h.
void KMFolder::setMoveInProgress | ( | bool | b | ) | [inline] |
bool KMFolder::isValidName | ( | const TQString & | folderName, | |
TQString & | message | |||
) |
Returns true if the name is valid for a child of this folder.
If the name contains invalid characters then false is returned and message will contain an explanation that can be presented to the user.
Definition at line 899 of file kmfolder.cpp.
void KMFolder::changed | ( | ) | [signal] |
Emitted when the status, name, or associated accounts of this folder changed.
void KMFolder::closed | ( | ) | [signal] |
Emitted when the folder is closed for real - ticket holders should discard any messages.
void KMFolder::cleared | ( | ) | [signal] |
Emitted when the contents of a folder have been cleared (new search in a search folder, for example).
void KMFolder::expunged | ( | KMFolder * | ) | [signal] |
Emitted after an expunge.
If not quiet, changed() will be emmitted first.
void KMFolder::iconsChanged | ( | ) | [signal] |
Emitted when the icon paths are set.
void KMFolder::nameChanged | ( | ) | [signal] |
Emitted when the name of the folder changes.
void KMFolder::shortcutChanged | ( | KMFolder * | ) | [signal] |
Emitted when the shortcut associated with this folder changes.
void KMFolder::msgRemoved | ( | KMFolder * | , | |
Q_UINT32 | sernum | |||
) | [signal] |
Emitted before a message is removed from the folder.
void KMFolder::msgRemoved | ( | int | idx, | |
TQString | msgIdMD5 | |||
) | [signal] |
Emitted after a message is removed from the folder.
void KMFolder::msgAdded | ( | int | idx | ) | [signal] |
Emitted when a message is added from the folder.
void KMFolder::msgChanged | ( | KMFolder * | , | |
Q_UINT32 | sernum, | |||
int | delta | |||
) | [signal] |
Emitted, when the status of a message is changed.
void KMFolder::msgHeaderChanged | ( | KMFolder * | , | |
int | ||||
) | [signal] |
Emitted when a field of the header of a specific message changed.
void KMFolder::statusMsg | ( | const TQString & | ) | [signal] |
Emmited to display a message somewhere in a status line.
void KMFolder::numUnreadMsgsChanged | ( | KMFolder * | ) | [signal] |
Emitted when number of unread messages has changed.
void KMFolder::removed | ( | KMFolder * | , | |
bool | ||||
) | [signal] |
Emitted when a folder was removed.
void KMFolder::viewConfigChanged | ( | ) | [signal] |
Emitted when the variables for the config of the view have changed.
void KMFolder::folderSizeChanged | ( | KMFolder * | ) | [signal] |
Emitted when the folder's size changes.
void KMFolder::noContentChanged | ( | ) | [signal] |
Emitted when the no content state changed.
void KMFolder::syncStateChanged | ( | ) | [signal] |
Emiitted when the sync state, i.e.
mailCheckInProgress(), changes. Currently only supported for disconnected IMAP.
int KMFolder::updateIndex | ( | ) | [slot] |
Incrementally update the index if possible else call writeIndex.
Definition at line 856 of file kmfolder.cpp.
void KMFolder::reallyAddMsg | ( | KMMessage * | aMsg | ) | [slot] |
Add the message to the folder after it has been retrieved from an IMAP server.
Definition at line 861 of file kmfolder.cpp.
void KMFolder::reallyAddCopyOfMsg | ( | KMMessage * | aMsg | ) | [slot] |
Add a copy of the message to the folder after it has been retrieved from an IMAP server.
Definition at line 866 of file kmfolder.cpp.
The documentation for this class was generated from the following files: