File indexing completed on 2025-03-09 04:54:13

 /*
  * SPDX-License-Identifier: LGPL-2.1-or-later
  *
  */
 
 #pragma once
 
 #include "messagecore_export.h"
 
 #include <KMime/KMimeMessage>
 #include <QUrl>
 
 #include <QByteArray>
 #include <QSharedDataPointer>
 #include <QString>
 
 class KConfigGroup;
 
 namespace MessageCore
 {
 /**
  * @short A class to extract information about mailing lists from emails.
  *
  * The mailing list header fields are defined as the following:
  *   - "List-*" in RFC2369
  *   - "List-ID" in RFC2919.
  *   - "Archive-At" in RFC5064
  *
  * @author Zack Rusin <zack@kde.org>
  */
 class MESSAGECORE_EXPORT MailingList
 {
 public:
     /**
      * Defines what entity should manage the mailing list.
      */
     enum Handler {
         KMail, ///< The list is handled by KMail
         Browser, ///< The list is handled by a browser.
     };
 
     /**
      * Defines the features a mailinglist can support.
      */
     enum Feature {
         None = 0 << 0, ///< No mailing list fields exist.
         Post = 1 << 0, ///< List-Post header exists.
         Subscribe = 1 << 1, ///< List-Subscribe header exists.
         Unsubscribe = 1 << 2, ///< List-Unsubscribe header exists.
         Help = 1 << 3, ///< List-Help header exists.
         Archive = 1 << 4, ///< List-Archive header exists.
         Id = 1 << 5, ///< List-ID header exists.
         Owner = 1 << 6, ///< List-Owner header exists.
         ArchivedAt = 1 << 7 ///< Archive-At header exists.
     };
     Q_DECLARE_FLAGS(Features, Feature)
 
 public:
     /**
      * Extracts the information about a mailing list from the given @p message.
      */
     static MailingList detect(const KMime::Message::Ptr &message);
 
     static QString name(const KMime::Message::Ptr &message, QByteArray &headerName, QString &headerValue);
 
 public:
     /**
      * Creates an empty mailing list.
      */
     MailingList();
 
     /**
      * Creates a mailing list from an @p other mailing list.
      */
     MailingList(const MailingList &other);
 
     /**
      * Overwrites this mailing list with an @p other mailing list.
      */
     MailingList &operator=(const MailingList &other);
 
     [[nodiscard]] bool operator==(const MailingList &other) const;
     /**
      * Destroys the mailing list.
      */
     ~MailingList();
 
     /**
      * Returns the features the mailing list supports.
      */
     [[nodiscard]] Features features() const;
 
     /**
      * Sets the @p handler for the mailing list.
      */
     void setHandler(Handler handler);
 
     /**
      * Returns the handler for the mailing list.
      */
     [[nodiscard]] Handler handler() const;
 
     /**
      * Sets the list of List-Post @p urls.
      */
     void setPostUrls(const QList<QUrl> &urls);
 
     /**
      * Returns the list of List-Post urls.
      */
     [[nodiscard]] QList<QUrl> postUrls() const;
 
     /**
      * Sets the list of List-Subscribe @p urls.
      */
     void setSubscribeUrls(const QList<QUrl> &urls);
 
     /**
      * Returns the list of List-Subscribe urls.
      */
     [[nodiscard]] QList<QUrl> subscribeUrls() const;
 
     /**
      * Sets the list of List-Unsubscribe @p urls.
      */
     void setUnsubscribeUrls(const QList<QUrl> &urls);
 
     /**
      * Returns the list of List-Unsubscribe urls.
      */
     [[nodiscard]] QList<QUrl> unsubscribeUrls() const;
 
     /**
      * Sets the list of List-Help @p urls.
      */
     void setHelpUrls(const QList<QUrl> &urls);
 
     /**
      * Returns the list of List-Help urls.
      */
     [[nodiscard]] QList<QUrl> helpUrls() const;
 
     /**
      * Sets the list of List-Archive @p urls.
      */
     void setArchiveUrls(const QList<QUrl> &urls);
 
     /**
      * Returns the list of List-Archive urls.
      */
     [[nodiscard]] QList<QUrl> archiveUrls() const;
 
     /**
      * Sets the list of List-Owner @p urls.
      */
     void setOwnerUrls(const QList<QUrl> &urls);
 
     /**
      * Returns the list of List-Owner urls.
      */
     [[nodiscard]] QList<QUrl> ownerUrls() const;
 
     /**
      * Sets the Archived-At @p url.
      */
     void setArchivedAtUrls(const QList<QUrl> &url);
 
     /**
      * Returns the Archived-At @p url.
      */
     [[nodiscard]] QList<QUrl> archivedAtUrls() const;
 
     /**
      * Sets the @p id of the mailing list.
      */
     void setId(const QString &id);
 
     /**
      * Returns the @p id of the mailing list.
      */
     [[nodiscard]] QString id() const;
 
     /**
      * Saves the configuration for the mailing list to the config @p group.
      */
     void writeConfig(KConfigGroup &group) const;
 
     /**
      * Restores the configuration for the mailing list from the config @p group.
      */
     void readConfig(const KConfigGroup &group);
 
 private:
     class MailingListPrivate;
     QSharedDataPointer<MailingListPrivate> d;
 };
 }
 
 Q_DECLARE_OPERATORS_FOR_FLAGS(MessageCore::MailingList::Features)
 Q_DECLARE_METATYPE(MessageCore::MailingList::Features)