util.h

/*
   SPDX-FileCopyrightText: 2005 Till Adam <adam@kde.org>
 
   SPDX-License-Identifier: GPL-2.0-or-later
*/
 
#pragma once
 
#include "ksievecore_export.h"
#include <KSieveCore/SieveImapAccountSettings>
#include <KSieveCore/SieveImapInstance>
#include <QUrl>
#include <memory>
class QString;
#include <QStringList>
namespace KSieveCore
{
/**
 * The Util namespace contains a collection of helper functions use in
 * various places.
 */
namespace Util
{
/**
 * Returns whether the availability of a vacation sieve script shall
 * be checked at the start up of an application.
 */
KSIEVECORE_EXPORT bool checkOutOfOfficeOnStartup();
 
/**
 * Returns whether the functionality of vacation sieve script editing shall
 * be available at all.
 */
KSIEVECORE_EXPORT bool allowOutOfOfficeSettings();
 
struct KSIEVECORE_EXPORT AccountInfo {
    KSieveCore::SieveImapAccountSettings sieveImapAccountSettings;
    QUrl sieveUrl;
    bool operator==(const AccountInfo &other) const;
};
KSIEVECORE_EXPORT QDebug operator<<(QDebug d, const Util::AccountInfo &info);
 
/**
 * Returns the list of configured IMAP agent instances.
 */
[[nodiscard]] KSIEVECORE_EXPORT QList<KSieveCore::SieveImapInstance> sieveImapInstances();
[[nodiscard]] KSIEVECORE_EXPORT QStringList sieveImapResourceNames();
 
/**
 * Checks if a server has KEP:14 support
 */
[[nodiscard]] KSIEVECORE_EXPORT bool hasKep14Support(const QStringList &sieveCapabilities, const QStringList &availableScripts, const QString &activeScript);
 
[[nodiscard]] KSIEVECORE_EXPORT bool hasKep14CapabilitySupport(const QStringList &sieveCapabilities);
 
/**
 * Is the given scriptName a protected KEP:14 name, that a normal user should not touch directly.
 * it tests against MASTER, USER and MANAGEMENT script
 */
[[nodiscard]] KSIEVECORE_EXPORT bool isKep14ProtectedName(const QString &scriptName);
}
}
 
Q_DECLARE_METATYPE(KSieveCore::Util::AccountInfo)