MailCommon::Util Namespace Reference

Enumerations
enum	SearchDirection { ForwardSearch, BackwardSearch }

Functions
MAILCOMMON_EXPORT Akonadi::AgentInstance::List	agentInstances (bool excludeMailTransport=true)
MAILCOMMON_EXPORT Akonadi::Collection::Id	convertFolderPathToCollectionId (const QString &folder)
MAILCOMMON_EXPORT QString	convertFolderPathToCollectionStr (const QString &folder)
MAILCOMMON_EXPORT OrgKdeAkonadiPOP3SettingsInterface *	createPop3SettingsInterface (const QString &ident)
MAILCOMMON_EXPORT QColor	defaultQuotaColor ()
MAILCOMMON_EXPORT bool	ensureKorganizerRunning (bool switchTo)
MAILCOMMON_EXPORT MailCommon::ExpireCollectionAttribute *	expirationCollectionAttribute (const Akonadi::Collection &collection, bool &mustDeleteExpirationAttribute)
MAILCOMMON_EXPORT void	expireOldMessages (const Akonadi::Collection &collection, bool immediate)
MAILCOMMON_EXPORT uint	folderIdentity (const Akonadi::Item &item)
MAILCOMMON_EXPORT bool	foundMailer ()
MAILCOMMON_EXPORT QString	fullCollectionPath (const Akonadi::Collection &collection)
MAILCOMMON_EXPORT bool	ignoreNewMailInFolder (const Akonadi::Collection &collection)
MAILCOMMON_EXPORT bool	isLocalCollection (const QString &resource)
MAILCOMMON_EXPORT bool	isVirtualCollection (const Akonadi::Collection &col)
MAILCOMMON_EXPORT bool	isVirtualCollection (const QString &resource)
MAILCOMMON_EXPORT QModelIndex	nextUnreadCollection (QAbstractItemModel *model, const QModelIndex &current, SearchDirection direction, bool(*ignoreCollectionCallback)(const Akonadi::Collection &collection)=0)
MAILCOMMON_EXPORT Akonadi::Collection	parentCollectionFromItem (const Akonadi::Item &item)
MAILCOMMON_EXPORT QString	realFolderPath (const QString &path)
MAILCOMMON_EXPORT bool	showJobErrorMessage (KJob *job)
MAILCOMMON_EXPORT Akonadi::Collection	updatedCollection (const Akonadi::Collection &col)

Detailed Description

The Util namespace contains a collection of helper functions use in various places.

Enumeration Type Documentation

enum MailCommon::Util::SearchDirection

Describes the direction for searching next unread collection.

Enumerator
ForwardSearch
BackwardSearch

Definition at line 88 of file mailutil.h.

Function Documentation

Akonadi::AgentInstance::List MailCommon::Util::agentInstances

(

bool

excludeMailTransport = true

)

Definition at line 147 of file mailutil.cpp.

Akonadi::Collection::Id MailCommon::Util::convertFolderPathToCollectionId

(

const QString &

folder

)

Definition at line 410 of file mailutil.cpp.

QString MailCommon::Util::convertFolderPathToCollectionStr

(

const QString &

folder

)

Definition at line 427 of file mailutil.cpp.

OrgKdeAkonadiPOP3SettingsInterface * MailCommon::Util::createPop3SettingsInterface

(

const QString &

ident

)

Definition at line 89 of file mailutil.cpp.

QColor MailCommon::Util::defaultQuotaColor

(

)

Definition at line 391 of file mailutil.cpp.

bool MailCommon::Util::ensureKorganizerRunning

(

bool

switchTo

)

Definition at line 168 of file mailutil.cpp.

MailCommon::ExpireCollectionAttribute * MailCommon::Util::expirationCollectionAttribute	(	const Akonadi::Collection &	collection,
		bool &	mustDeleteExpirationAttribute
	)

Definition at line 458 of file mailutil.cpp.

void MailCommon::Util::expireOldMessages	(	const Akonadi::Collection &	collection,
		bool	immediate
	)

Definition at line 397 of file mailutil.cpp.

uint MailCommon::Util::folderIdentity

(

const Akonadi::Item &

item

)

Returns the identity of the folder that contains the given Akonadi::Item.

Definition at line 240 of file mailutil.cpp.

bool MailCommon::Util::foundMailer

(

)

Definition at line 435 of file mailutil.cpp.

QString MailCommon::Util::fullCollectionPath

(

const Akonadi::Collection &

collection

)

Definition at line 115 of file mailutil.cpp.

bool MailCommon::Util::ignoreNewMailInFolder

(

const Akonadi::Collection &

collection

)

Definition at line 365 of file mailutil.cpp.

bool MailCommon::Util::isLocalCollection

(

const QString &

resource

)

Definition at line 107 of file mailutil.cpp.

bool MailCommon::Util::isVirtualCollection

(

const Akonadi::Collection &

col

)

Definition at line 97 of file mailutil.cpp.

bool MailCommon::Util::isVirtualCollection

(

const QString &

resource

)

Definition at line 102 of file mailutil.cpp.

QModelIndex MailCommon::Util::nextUnreadCollection	(	QAbstractItemModel *	model,
		const QModelIndex &	current,
		SearchDirection	direction,
		bool(*)(const Akonadi::Collection &collection)	ignoreCollectionCallback = 0
	)

Returns the index of the next unread collection following a given index.

Parameters

model	The item model to search in.
current	The index of the collection where the search will start.
direction	The direction of search.
ignoreCollectionCallback	A callback method to ignore certain collections by returning true.

Definition at line 327 of file mailutil.cpp.

Akonadi::Collection MailCommon::Util::parentCollectionFromItem

(

const Akonadi::Item &

item

)

Definition at line 375 of file mailutil.cpp.

QString MailCommon::Util::realFolderPath

(

const QString &

path

)

Definition at line 380 of file mailutil.cpp.

bool MailCommon::Util::showJobErrorMessage

(

KJob *

job

)

Definition at line 134 of file mailutil.cpp.

Akonadi::Collection MailCommon::Util::updatedCollection

(

const Akonadi::Collection &

col

)

Definition at line 403 of file mailutil.cpp.