KMFolder Class Reference

Mail folder. More...

#include <kmfolder.h>

Inheritance diagram for KMFolder:

[legend]

List of all members.

Public Types
enum	CompactOptions { CompactLater, CompactNow, CompactSilentlyNow }
enum	ExpireAction { ExpireDelete, ExpireMove }
Public Slots
void	reallyAddCopyOfMsg (KMMessage *aMsg)
void	reallyAddMsg (KMMessage *aMsg)
int	updateIndex ()
Signals
void	changed ()
void	cleared ()
void	closed ()
void	compacted ()
void	expunged (KMFolder *)
void	folderSizeChanged (KMFolder *)
void	iconsChanged ()
void	msgAdded (KMFolder *, quint32 sernum)
void	msgAdded (int idx)
void	msgChanged (KMFolder *, quint32 sernum, int delta)
void	msgHeaderChanged (KMFolder *, int)
void	msgRemoved (KMFolder *)
void	msgRemoved (int idx, const QString &msgIdMD5)
void	msgRemoved (KMFolder *, quint32 sernum)
void	nameChanged ()
void	noContentChanged ()
void	numUnreadMsgsChanged (KMFolder *)
void	removed (KMFolder *, bool)
void	shortcutChanged (KMFolder *)
void	statusMsg (const QString &)
void	viewConfigChanged ()
Public Member Functions
	KMFolder (KMFolderDir *parent, const QString &name, KMFolderType aFolderType, bool withIndex=true, bool exportedSernums=true)
	~KMFolder ()
AccountList *	acctList ()
int	addMessages (QList< KMMessage * > &, QList< int > &index_return)
int	addMsg (KMMessage *msg, int *index_return=0)
int	addMsgKeepUID (KMMessage *msg, int *index_return=0)
virtual bool	canAccess () const
bool	canDeleteMessages () const
KMFolderDir *	child () const
void	close (const char *owner, bool force=false)
void	compact (CompactOptions options)
QString	configGroupName () const
void	correctUnreadMsgsCount ()
int	count (bool cache=false) const
int	countUnread ()
int	countUnreadRecursive ()
KMFolderDir *	createChildFolder ()
FolderJob *	createJob (QList< KMMessage * > &msgList, const QString &sets, FolderJob::JobType jt=FolderJob::tGetMessage, KMFolder *folder=0) const
FolderJob *	createJob (KMMessage *msg, FolderJob::JobType jt=FolderJob::tGetMessage, KMFolder *folder=0, const QString &partSpecifier=QString(), const AttachmentStrategy *as=0) const
void	daysToExpire (int &unreadDays, int &readDays)
bool	dirty () const
void	emitMsgAddedSignals (int idx)
ExpireAction	expireAction () const
void	expireOldMessages (bool immediate)
QString	expireToFolderId () const
int	expunge ()
int	expungeOldMsg (int days)
QString	fileName () const
int	find (const KMMessage *msg) const
int	find (const KMMsgBase *msg) const
KMFolderType	folderType () const
DwString	getDwString (int idx)
KMMessage *	getMsg (int idx)
KMMsgBase *	getMsgBase (int idx)
const KMMsgBase *	getMsgBase (int idx) const
int	getReadExpireAge () const
ExpireUnits	getReadExpireUnits () const
int	getUnreadExpireAge () const
ExpireUnits	getUnreadExpireUnits () const
bool	hasAccounts () const
bool	hasDescendant (KMFolder *fld) const
bool	hideInSelectionDialog () const
uint	identity () const
virtual QString	idsLocation () const
QString	idString () const
void	ignoreJobsForMessage (KMMessage *)
bool	ignoreNewMail () const
virtual QString	indexLocation () const
bool	isAutoExpire () const
bool	isDrafts ()
bool	isMailingListEnabled () const
bool	isMainInbox ()
bool	isMessage (int idx)
bool	isMoveable () const
bool	isOpened () const
bool	isOutbox ()
bool	isReadOnly () const
bool	isSent ()
bool	isSystemFolder () const
bool	isTemplates ()
bool	isTrash ()
bool	isWritable () const
virtual QString	label () const
QString	location () const
MailingList	mailingList () const
QString	mailingListPostAddress () const
void	markNewAsUnread ()
void	markUnreadAsRead ()
bool	moveInProgress () const
int	moveMsg (QList< KMMessage * >, int *index_return=0)
int	moveMsg (KMMessage *msg, int *index_return=0)
void	msgStatusChanged (const MessageStatus &oldStatus, const MessageStatus &newStatus, int idx)
void	msgTagListChanged (int idx)
bool	needsCompacting () const
bool	noChildren () const
bool	noContent () const
QString	normalIconPath () const
int	open (const char *owner)
KMMsgBase *	operator[] (int idx)
const KMMsgBase *	operator[] (int idx) const
KMFolder *	ownerFolder () const
virtual QString	prettyUrl () const
bool	putRepliesInSameFolder () const
void	quiet (bool beQuiet)
void	readConfig (KConfigGroup &config)
void	remove ()
void	removeJobs ()
void	removeMessages (QList< KMMessage * > msgList, bool imapQuiet=false)
void	removeMsg (int i, bool imapQuiet=false)
int	rename (const QString &newName, KMFolderDir *aParent=0)
void	setAcctList (AccountList *list)
void	setAutoExpire (bool enabled)
void	setChild (KMFolderDir *aChild)
void	setDirty (bool f)
void	setExpireAction (ExpireAction a)
void	setExpireToFolderId (const QString &id)
void	setHideInSelectionDialog (bool hide)
void	setIconPaths (const QString &normalPath, const QString &unreadPath)
void	setIdentity (uint identity)
void	setIgnoreNewMail (bool b)
void	setLabel (const QString &l)
void	setMailingList (const MailingList &mlist)
void	setMailingListEnabled (bool enabled)
void	setMoveInProgress (bool b)
void	setNeedsCompacting (bool f)
void	setNoChildren (bool aNoChildren)
void	setNoContent (bool aNoContent)
void	setPutRepliesInSameFolder (bool b)
void	setReadExpireAge (int age)
void	setReadExpireUnits (ExpireUnits units)
void	setShortcut (const KShortcut &)
void	setStatus (QList< int > &ids, const MessageStatus &status, bool toggle=false)
void	setStatus (int idx, const MessageStatus &status, bool toggle=false)
void	setSystemFolder (bool itIs)
void	setSystemLabel (const QString &l)
void	setUnreadExpireAge (int age)
void	setUnreadExpireUnits (ExpireUnits units)
void	setUseCustomIcons (bool useCustomIcons)
void	setUseDefaultIdentity (bool useDefaultIdentity)
void	setUserWhoField (const QString &whoField, bool writeConfig=true)
void	setWhoField (const QString &aWhoField)
const KShortcut &	shortcut () const
virtual QString	sortedLocation () const
const FolderStorage *	storage () const
FolderStorage *	storage ()
QString	subdirLocation () const
void	sync ()
virtual QString	systemLabel () const
KMMessage *	take (int idx)
void	takeMessages (const QList< KMMessage * > &msgList)
KMFolder *	trashFolder () const
KMMsgInfo *	unGetMsg (int idx)
QString	unreadIconPath () const
bool	useCustomIcons () const
bool	useDefaultIdentity () const
QString	userWhoField (void)
QString	whoField () const
void	writeConfig (KConfigGroup &config) const
int	writeIndex (bool createEmptyIndex=false)

---

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 76 of file kmfolder.h.

---

Member Enumeration Documentation

enum KMFolder::CompactOptions

Enumerator:

CompactLater
CompactNow
CompactSilentlyNow

Definition at line 355 of file kmfolder.h.

enum KMFolder::ExpireAction

Enumerator:

ExpireDelete
ExpireMove

Definition at line 513 of file kmfolder.h.

---

Constructor & Destructor Documentation

KMFolder::KMFolder	(	KMFolderDir *	parent,
		const QString &	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	Whether 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 56 of file kmfolder.cpp.

KMFolder::~KMFolder

(

)

Definition at line 165 of file kmfolder.cpp.

---

Member Function Documentation

AccountList* KMFolder::acctList

(

)

[inline]

Definition at line 133 of file kmfolder.h.

int KMFolder::addMessages	(	QList< KMMessage * > &	list,
		QList< int > &	index_return
	)

Adds the given messages to the folder.

Behaviour is identical to addMsg(msg)

Definition at line 456 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 446 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 451 of file kmfolder.cpp.

bool KMFolder::canAccess

(

)

const [virtual]

Check folder for permissions.

Returns:

true if readable and writable.

Definition at line 546 of file kmfolder.cpp.

bool KMFolder::canDeleteMessages

(

)

const

Can messages in this folder be deleted?

Definition at line 633 of file kmfolder.cpp.

void KMFolder::changed

(

)

[signal]

Emitted when the status, name, or associated accounts of this folder changed.

KMFolderDir* KMFolder::child

(

)

const [inline]

Returns the folder directory associated with this node or 0 if no such directory exists.

Definition at line 171 of file kmfolder.h.

void KMFolder::cleared

(

)

[signal]

Emitted when the contents of a folder have been cleared (new search in a search folder, for example).

void KMFolder::close	(	const char *	owner,
		bool	force = false
	)

Close folder.

open() and close() use reference counting. If force is true the files are closed even if others are still using it (e.g. other mail reader windows). owner is for debugging.

Definition at line 551 of file kmfolder.cpp.

void KMFolder::closed

(

)

[signal]

Emitted when the folder is closed for real - ticket holders should discard any messages.

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 896 of file kmfolder.cpp.

void KMFolder::compacted

(

)

[signal]

Emitted at the end of a compaction job step.

in order to reload the views.

QString KMFolder::configGroupName

(

)

const [inline]

Returns the config group name for this folder.

Definition at line 450 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 785 of file kmfolder.cpp.

int KMFolder::count

(

bool

cache = false

)

const

Number of messages in this folder.

Definition at line 501 of file kmfolder.cpp.

int KMFolder::countUnread

(

)

Number of new or unread messages in this folder.

Definition at line 506 of file kmfolder.cpp.

int KMFolder::countUnreadRecursive

(

)

Number of new or unread messages in this folder and all folders contained by this folder.

Definition at line 511 of file kmfolder.cpp.

KMFolderDir * KMFolder::createChildFolder

(

)

Create a child folder directory and associates it with this folder.

Definition at line 318 of file kmfolder.cpp.

FolderJob * KMFolder::createJob	(	QList< KMMessage * > &	msgList,
		const QString &	sets,
		FolderJob::JobType	jt = FolderJob::tGetMessage,
		KMFolder *	folder = 0
	)			const

Definition at line 409 of file kmfolder.cpp.

FolderJob * KMFolder::createJob	(	KMMessage *	msg,
		FolderJob::JobType	jt = FolderJob::tGetMessage,
		KMFolder *	folder = 0,
		const QString &	partSpecifier = QString(),
		const AttachmentStrategy *	as = 0
	)			const

These methods create respective FolderJob (You should derive FolderJob for each derived KMFolder).

Definition at line 402 of file kmfolder.cpp.

void KMFolder::daysToExpire	(	int &	unreadDays,
		int &	readDays
	)

Definition at line 881 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 598 of file kmfolder.cpp.

void KMFolder::emitMsgAddedSignals

(

int

idx

)

Called by derived classes implementation of addMsg.

Emits msgAdded signals

Definition at line 461 of file kmfolder.cpp.

ExpireAction KMFolder::expireAction

(

)

const [inline]

What should expiry do? Delete or move to another folder?

Definition at line 517 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 886 of file kmfolder.cpp.

QString KMFolder::expireToFolderId

(

)

const [inline]

If expiry should move to folder, return the ID of that folder.

Definition at line 523 of file kmfolder.h.

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 588 of file kmfolder.cpp.

void KMFolder::expunged

(

KMFolder *

)

[signal]

Emitted after an expunge.

If not quiet, changed() will be emmitted first.

int KMFolder::expungeOldMsg

(

int

days

)

Delete messages in the folder that are older than days.

Return the number of deleted messages.

Definition at line 476 of file kmfolder.cpp.

QString KMFolder::fileName

(

)

const

Returns the filename of the folder (reimplemented in KMFolderImap).

Definition at line 282 of file kmfolder.cpp.

int KMFolder::find

(

const KMMessage *

msg

)

const

Definition at line 496 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 491 of file kmfolder.cpp.

void KMFolder::folderSizeChanged

(

KMFolder *

)

[signal]

Emitted when the folder's size changes.

KMFolderType KMFolder::folderType

(

)

const

Returns the type of this folder.

Definition at line 277 of file kmfolder.cpp.

DwString KMFolder::getDwString

(

int

idx

)

Read a message and returns a DwString.

Definition at line 392 of file kmfolder.cpp.

KMMessage * KMFolder::getMsg

(

int

idx

)

Read message at given index.

Indexing starts at zero

Definition at line 377 of file kmfolder.cpp.

KMMsgBase * KMFolder::getMsgBase

(

int

idx

)

Definition at line 421 of file kmfolder.cpp.

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 416 of file kmfolder.cpp.

int KMFolder::getReadExpireAge

(

)

const [inline]

Get the age at which read messages are expired.

Units are determined by getReadExpireUnits().

Definition at line 499 of file kmfolder.h.

ExpireUnits KMFolder::getReadExpireUnits

(

)

const [inline]

Units getReadExpireAge() is returned in.

1 = days, 2 = weeks, 3 = months.

Definition at line 511 of file kmfolder.h.

int KMFolder::getUnreadExpireAge

(

)

const [inline]

Get the age at which unread messages are expired.

Units are determined by getUnreadExpireUnits().

Definition at line 493 of file kmfolder.h.

ExpireUnits KMFolder::getUnreadExpireUnits

(

)

const [inline]

Units getUnreadExpireAge() is returned in.

1 = days, 2 = weeks, 3 = months.

Definition at line 505 of file kmfolder.h.

bool KMFolder::hasAccounts

(

)

const [inline]

Returns true if accounts are associated with this folder.

Definition at line 136 of file kmfolder.h.

bool KMFolder::hasDescendant

(

KMFolder *

fld

)

const

Returns true if the specified folder is a descendant of this folder (if fld is somewhere in this folder's children subtree).

Returns false otherwise (or if fld is null).

This function assumes that fld, if not null, is a valid pointer to a folder that can be dereferenced.

Definition at line 173 of file kmfolder.cpp.

bool KMFolder::hideInSelectionDialog

(

)

const [inline]

Returns true if this folder should be hidden from all folder selection dialogs.

Definition at line 569 of file kmfolder.h.

void KMFolder::iconsChanged

(

)

[signal]

Emitted when the icon paths are set.

uint KMFolder::identity

(

)

const

Definition at line 724 of file kmfolder.cpp.

QString KMFolder::idsLocation

(

)

const [virtual]

Returns full path to 'ids' file.

Definition at line 302 of file kmfolder.cpp.

QString KMFolder::idString

(

)

const

Returns a string that can be used to identify this folder.

Definition at line 790 of file kmfolder.cpp.

void KMFolder::ignoreJobsForMessage

(

KMMessage *

m

)

Removes and deletes all jobs associated with the particular message.

Definition at line 397 of file kmfolder.cpp.

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 576 of file kmfolder.h.

QString KMFolder::indexLocation

(

)

const [virtual]

Returns full path to index file.

Definition at line 292 of file kmfolder.cpp.

bool KMFolder::isAutoExpire

(

)

const [inline]

Does this folder automatically expire old messages?

Definition at line 461 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 122 of file kmfolder.h.

bool KMFolder::isMailingListEnabled

(

)

const [inline]

Definition at line 418 of file kmfolder.h.

bool KMFolder::isMainInbox

(

)

[inline]

Returns true if this folder is the inbox on the local disk.

Definition at line 103 of file kmfolder.h.

bool KMFolder::isMessage

(

int

idx

)

Checks if the message is already "gotten" with getMsg.

Definition at line 387 of file kmfolder.cpp.

bool KMFolder::isMoveable

(

)

const

Returns true if this folder can be moved.

Definition at line 993 of file kmfolder.cpp.

bool KMFolder::isOpened

(

)

const

Test if folder is opened.

Definition at line 562 of file kmfolder.cpp.

bool KMFolder::isOutbox

(

)

[inline]

Returns true only if this is the outbox for outgoing mail.

Definition at line 107 of file kmfolder.h.

bool KMFolder::isReadOnly

(

)

const

Is the folder read-only?

Definition at line 623 of file kmfolder.cpp.

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 112 of file kmfolder.h.

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 402 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 128 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 117 of file kmfolder.h.

bool KMFolder::isWritable

(

)

const

Can we write into and delete from this folder (on IMAP that's not necessarily !isReadOnly()).

Definition at line 628 of file kmfolder.cpp.

QString KMFolder::label

(

void

)

const [virtual]

Returns the label of the folder for visualization.

Reimplemented from KMFolderNode.

Definition at line 638 of file kmfolder.cpp.

QString KMFolder::location

(

void

)

const

Returns full path to folder file.

Definition at line 287 of file kmfolder.cpp.

MailingList KMFolder::mailingList

(

)

const [inline]

Definition at line 421 of file kmfolder.h.

QString KMFolder::mailingListPostAddress

(

)

const

Definition at line 683 of file kmfolder.cpp.

void KMFolder::markNewAsUnread

(

)

Mark all new messages as unread.

Definition at line 567 of file kmfolder.cpp.

void KMFolder::markUnreadAsRead

(

)

Mark all new and unread messages as read.

Definition at line 572 of file kmfolder.cpp.

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 588 of file kmfolder.h.

int KMFolder::moveMsg	(	QList< KMMessage * >	q,
		int *	index_return = 0
	)

Definition at line 486 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 481 of file kmfolder.cpp.

void KMFolder::msgAdded	(	KMFolder *	,
		quint32	sernum
	)			[signal]

void KMFolder::msgAdded

(

int

idx

)

[signal]

Emitted when a message is added from the folder.

void KMFolder::msgChanged	(	KMFolder *	,
		quint32	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::msgRemoved

(

KMFolder *

)

[signal]

void KMFolder::msgRemoved	(	int	idx,
		const QString &	msgIdMD5
	)			[signal]

Emitted after a message is removed from the folder.

void KMFolder::msgRemoved	(	KMFolder *	,
		quint32	sernum
	)			[signal]

Emitted before a message is removed from the folder.

void KMFolder::msgStatusChanged	(	const MessageStatus &	oldStatus,
		const MessageStatus &	newStatus,
		int	idx
	)

Called by KMMsgBase::setStatus when status of a message has changed required to keep the number of unread messages variable current.

Definition at line 529 of file kmfolder.cpp.

void KMFolder::msgTagListChanged

(

int

idx

)

Called by KMMsgBase::setTagList().

Emits the msgHeaderChanged signal.

Definition at line 535 of file kmfolder.cpp.

void KMFolder::nameChanged

(

)

[signal]

Emitted when the name of the folder changes.

bool KMFolder::needsCompacting

(

)

const

Returns true if the folder contains deleted messages.

Definition at line 608 of file kmfolder.cpp.

bool KMFolder::noChildren

(

)

const

Returns, if the folder can't have children.

Definition at line 367 of file kmfolder.cpp.

bool KMFolder::noContent

(

)

const

Returns, if the folder can't contain mails, but only subfolder.

Definition at line 357 of file kmfolder.cpp.

void KMFolder::noContentChanged

(

)

[signal]

Emitted when the no content state changed.

QString KMFolder::normalIconPath

(

)

const [inline]

Definition at line 545 of file kmfolder.h.

void KMFolder::numUnreadMsgsChanged

(

KMFolder *

)

[signal]

Emitted when number of unread messages has changed.

int KMFolder::open

(

const char *

owner

)

Open folder for access.

open() and close() use reference counting. Returns zero on success and an error code equal to the c-library fopen call otherwise (errno). owner is for debugging.

Definition at line 541 of file kmfolder.cpp.

KMMsgBase * KMFolder::operator[]

(

int

idx

)

Same as getMsgBase(int).

This time non-const.

Definition at line 431 of file kmfolder.cpp.

const KMMsgBase * KMFolder::operator[]

(

int

idx

)

const

Same as getMsgBase(int).

Definition at line 426 of file kmfolder.cpp.

KMFolder * KMFolder::ownerFolder

(

)

const

Returns the parent folder, if any.

Definition at line 186 of file kmfolder.cpp.

QString KMFolder::prettyUrl

(

)

const [virtual]

URL of the node for visualization purposes.

Implements KMFolderNode.

Definition at line 671 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 563 of file kmfolder.h.

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 618 of file kmfolder.cpp.

void KMFolder::readConfig

(

KConfigGroup &

config

)

This is used by the storage to read the folder specific configuration.

Definition at line 194 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 951 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 946 of file kmfolder.cpp.

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 577 of file kmfolder.cpp.

void KMFolder::removed	(	KMFolder *	,
		bool
	)			[signal]

Emitted when a folder was removed.

void KMFolder::removeJobs

(

)

Definition at line 936 of file kmfolder.cpp.

void KMFolder::removeMessages	(	QList< KMMessage * >	msgList,
		bool	imapQuiet = false
	)

Definition at line 471 of file kmfolder.cpp.

void KMFolder::removeMsg	(	int	i,
		bool	imapQuiet = false
	)

Remove (first occurrence of) given message from the folder.

Definition at line 466 of file kmfolder.cpp.

int KMFolder::rename	(	const QString &	newName,
		KMFolderDir *	aParent = 0
	)

Physically rename the folder.

Returns zero on success and an errno on failure.

Definition at line 593 of file kmfolder.cpp.

void KMFolder::setAcctList

(

AccountList *

list

)

[inline]

Definition at line 132 of file kmfolder.h.

void KMFolder::setAutoExpire

(

bool

enabled

)

Set whether this folder automatically expires messages.

Definition at line 810 of file kmfolder.cpp.

void KMFolder::setChild

(

KMFolderDir *

aChild

)

Set the folder directory associated with this node.

Definition at line 351 of file kmfolder.cpp.

void KMFolder::setDirty

(

bool

f

)

Change the dirty flag.

Definition at line 603 of file kmfolder.cpp.

void KMFolder::setExpireAction

(

ExpireAction

a

)

Definition at line 849 of file kmfolder.cpp.

void KMFolder::setExpireToFolderId

(

const QString &

id

)

Definition at line 857 of file kmfolder.cpp.

void KMFolder::setHideInSelectionDialog

(

bool

hide

)

[inline]

Definition at line 570 of file kmfolder.h.

void KMFolder::setIconPaths	(	const QString &	normalPath,
		const QString &	unreadPath
	)

Definition at line 927 of file kmfolder.cpp.

void KMFolder::setIdentity

(

uint

identity

)

Definition at line 718 of file kmfolder.cpp.

void KMFolder::setIgnoreNewMail

(

bool

b

)

Definition at line 956 of file kmfolder.cpp.

void KMFolder::setLabel

(

const QString &

l

)

Definition at line 656 of file kmfolder.cpp.

void KMFolder::setMailingList

(

const MailingList &

mlist

)

Definition at line 704 of file kmfolder.cpp.

void KMFolder::setMailingListEnabled

(

bool

enabled

)

Returns true if this folder is associated with a mailing-list.

Definition at line 698 of file kmfolder.cpp.

void KMFolder::setMoveInProgress

(

bool

b

)

[inline]

Sets the move-in-progress flag.

Definition at line 591 of file kmfolder.h.

void KMFolder::setNeedsCompacting

(

bool

f

)

Definition at line 613 of file kmfolder.cpp.

void KMFolder::setNoChildren

(

bool

aNoChildren

)

Specify, that the folder can't have children.

Definition at line 372 of file kmfolder.cpp.

void KMFolder::setNoContent

(

bool

aNoContent

)

Specify, that the folder can't contain mails.

Definition at line 362 of file kmfolder.cpp.

void KMFolder::setPutRepliesInSameFolder

(

bool

b

)

[inline]

Definition at line 564 of file kmfolder.h.

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 833 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 841 of file kmfolder.cpp.

void KMFolder::setShortcut

(

const KShortcut &

sc

)

Definition at line 985 of file kmfolder.cpp.

void KMFolder::setStatus	(	QList< int > &	ids,
		const MessageStatus &	status,
		bool	toggle = false
	)

Set the status of the message(s) in the QValueList ids to status.

Definition at line 921 of file kmfolder.cpp.

void KMFolder::setStatus	(	int	idx,
		const MessageStatus &	status,
		bool	toggle = false
	)

Set the status of the message at index idx to status.

Definition at line 916 of file kmfolder.cpp.

void KMFolder::setSystemFolder

(

bool

itIs

)

Definition at line 649 of file kmfolder.cpp.

void KMFolder::setSystemLabel

(

const QString &

l

)

Definition at line 663 of file kmfolder.cpp.

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 818 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 826 of file kmfolder.cpp.

void KMFolder::setUseCustomIcons

(

bool

useCustomIcons

)

[inline]

Definition at line 544 of file kmfolder.h.

void KMFolder::setUseDefaultIdentity

(

bool

useDefaultIdentity

)

Get / set whether the default identity should be used instead of the identity specified by setIdentity().

Definition at line 710 of file kmfolder.cpp.

void KMFolder::setUserWhoField	(	const QString &	whoField,
		bool	writeConfig = true
	)

Definition at line 742 of file kmfolder.cpp.

void KMFolder::setWhoField

(

const QString &

aWhoField

)

Definition at line 733 of file kmfolder.cpp.

const KShortcut& KMFolder::shortcut

(

)

const [inline]

Definition at line 579 of file kmfolder.h.

void KMFolder::shortcutChanged

(

KMFolder *

)

[signal]

Emitted when the shortcut associated with this folder changes.

QString KMFolder::sortedLocation

(

)

const [virtual]

Returns full path to 'sorted' file.

Definition at line 297 of file kmfolder.cpp.

void KMFolder::statusMsg

(

const QString &

)

[signal]

Emmited to display a message somewhere in a status line.

const FolderStorage* KMFolder::storage

(

)

const [inline]

if the folder is const, the storage should be as well

Definition at line 146 of file kmfolder.h.

FolderStorage* KMFolder::storage

(

)

[inline]

Definition at line 144 of file kmfolder.h.

QString KMFolder::subdirLocation

(

)

const

Returns full path to sub directory file.

Definition at line 307 of file kmfolder.cpp.

void KMFolder::sync

(

)

fsync buffers to disk

Definition at line 557 of file kmfolder.cpp.

virtual QString KMFolder::systemLabel

(

)

const [inline, virtual]

Set the label that is used as a system default.

Definition at line 410 of file kmfolder.h.

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 436 of file kmfolder.cpp.

void KMFolder::takeMessages

(

const QList< KMMessage * > &

msgList

)

Definition at line 441 of file kmfolder.cpp.

KMFolder * KMFolder::trashFolder

(

)

const

If this folder has a special trash folder set, return it.

Otherwise return 0.

Definition at line 906 of file kmfolder.cpp.

KMMsgInfo * KMFolder::unGetMsg

(

int

idx

)

Replace KMMessage with KMMsgInfo and delete KMMessage.

Definition at line 382 of file kmfolder.cpp.

QString KMFolder::unreadIconPath

(

)

const [inline]

Definition at line 546 of file kmfolder.h.

int KMFolder::updateIndex

(

)

[slot]

Incrementally update the index if possible else call writeIndex.

Definition at line 941 of file kmfolder.cpp.

bool KMFolder::useCustomIcons

(

)

const [inline]

Icon related methods.

Definition at line 543 of file kmfolder.h.

bool KMFolder::useDefaultIdentity

(

)

const [inline]

Definition at line 428 of file kmfolder.h.

QString KMFolder::userWhoField

(

void

)

[inline]

Get / set the user-settings for the WhoField (From/To/Empty).

Definition at line 438 of file kmfolder.h.

void KMFolder::viewConfigChanged

(

)

[signal]

Emitted when the variables for the config of the view have changed.

QString 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 434 of file kmfolder.h.

void KMFolder::writeConfig

(

KConfigGroup &

config

)

const

This is used by the storage to save the folder specific configuration.

Definition at line 239 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 911 of file kmfolder.cpp.

---

The documentation for this class was generated from the following files:

• kmfolder.h
• kmfolder.cpp