MailCommon::Util

MailCommon::Util Namespace Reference

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 void expireOldMessages (const Akonadi::Collection &collection, bool immediate)
 
MAILCOMMON_EXPORT uint folderIdentity (const Akonadi::Item &item)
 
MAILCOMMON_EXPORT QStringList foundMailer ()
 
MAILCOMMON_EXPORT void foundMailer (QStringList &lst, const QString &name)
 
MAILCOMMON_EXPORT QString fullCollectionPath (const Akonadi::Collection &collection, bool addAccountName=true)
 
MAILCOMMON_EXPORT QString fullCollectionRemoveIdPath (const Akonadi::Collection &collection, bool addAccountName=true)
 
MAILCOMMON_EXPORT bool isLocalCollection (const QString &resource)
 
MAILCOMMON_EXPORT bool isMailAgent (const Akonadi::AgentInstance &instance, bool excludeMailTransport=true)
 
MAILCOMMON_EXPORT bool isUnifiedMailboxesAgent (const Akonadi::Collection &col)
 
MAILCOMMON_EXPORT bool isVirtualCollection (const Akonadi::Collection &col)
 
MAILCOMMON_EXPORT bool isVirtualCollection (const QString &resource)
 
MAILCOMMON_EXPORT QString realFolderPath (const QString &path)
 
MAILCOMMON_EXPORT bool showJobErrorMessage (KJob *job)
 

Detailed Description

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

Function Documentation

◆ agentInstances()

Akonadi::AgentInstance::List MailCommon::Util::agentInstances ( bool excludeMailTransport = true)
nodiscard

Definition at line 144 of file mailutil.cpp.

◆ convertFolderPathToCollectionId()

Akonadi::Collection::Id MailCommon::Util::convertFolderPathToCollectionId ( const QString & folder)
nodiscard

Definition at line 218 of file mailutil.cpp.

◆ convertFolderPathToCollectionStr()

QString MailCommon::Util::convertFolderPathToCollectionStr ( const QString & folder)
nodiscard

Definition at line 235 of file mailutil.cpp.

◆ createPop3SettingsInterface()

OrgKdeAkonadiPOP3SettingsInterface * MailCommon::Util::createPop3SettingsInterface ( const QString & ident)
nodiscard

Definition at line 48 of file mailutil.cpp.

◆ expireOldMessages()

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

Definition at line 212 of file mailutil.cpp.

◆ folderIdentity()

uint MailCommon::Util::folderIdentity ( const Akonadi::Item & item)
nodiscard

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

Definition at line 176 of file mailutil.cpp.

◆ foundMailer() [1/2]

QStringList MailCommon::Util::foundMailer ( )
nodiscard

Definition at line 251 of file mailutil.cpp.

◆ foundMailer() [2/2]

void MailCommon::Util::foundMailer ( QStringList & lst,
const QString & name )

Definition at line 244 of file mailutil.cpp.

◆ fullCollectionPath()

QString MailCommon::Util::fullCollectionPath ( const Akonadi::Collection & collection,
bool addAccountName = true )
nodiscard

Definition at line 75 of file mailutil.cpp.

◆ fullCollectionRemoveIdPath()

QString MailCommon::Util::fullCollectionRemoveIdPath ( const Akonadi::Collection & collection,
bool addAccountName = true )
nodiscard

Definition at line 103 of file mailutil.cpp.

◆ isLocalCollection()

bool MailCommon::Util::isLocalCollection ( const QString & resource)
nodiscard

Definition at line 69 of file mailutil.cpp.

◆ isMailAgent()

bool MailCommon::Util::isMailAgent ( const Akonadi::AgentInstance & instance,
bool excludeMailTransport = true )
nodiscard

Definition at line 154 of file mailutil.cpp.

◆ isUnifiedMailboxesAgent()

bool MailCommon::Util::isUnifiedMailboxesAgent ( const Akonadi::Collection & col)
nodiscard

Definition at line 171 of file mailutil.cpp.

◆ isVirtualCollection() [1/2]

bool MailCommon::Util::isVirtualCollection ( const Akonadi::Collection & col)
nodiscard

Definition at line 54 of file mailutil.cpp.

◆ isVirtualCollection() [2/2]

bool MailCommon::Util::isVirtualCollection ( const QString & resource)
nodiscard

Definition at line 59 of file mailutil.cpp.

◆ realFolderPath()

QString MailCommon::Util::realFolderPath ( const QString & path)
nodiscard

Definition at line 201 of file mailutil.cpp.

◆ showJobErrorMessage()

bool MailCommon::Util::showJobErrorMessage ( KJob * job)

Definition at line 131 of file mailutil.cpp.

This file is part of the KDE documentation.
Documentation copyright © 1996-2024 The KDE developers.
Generated on Fri Dec 6 2024 12:02:04 by doxygen 1.12.0 written by Dimitri van Heesch, © 1997-2006

KDE's Doxygen guidelines are available online.