KIMAP

deleteacljob.h
1/*
2 SPDX-FileCopyrightText: 2009 Andras Mantia <amantia@kde.org>
3
4 SPDX-License-Identifier: LGPL-2.0-or-later
5*/
6
7#pragma once
8
9#include "kimap_export.h"
10
11#include "acljobbase.h"
12
13namespace KIMAP
14{
15class Session;
16struct Response;
17class DeleteAclJobPrivate;
18
19/**
20 * Removes an identifier from the ACL of a mailbox.
21 *
22 * This job can only be run when the session is in the
23 * authenticated (or selected) state.
24 *
25 * The user must have the Acl::Admin permission
26 * on the mailbox for this job to succeed (see
27 * MyRightsJob).
28 *
29 * This job requires that the server supports the ACL
30 * capability, defined in
31 * <a href="https://tools.ietf.org/html/rfc4314">RFC 4314</a>.
32 */
33class KIMAP_EXPORT DeleteAclJob : public AclJobBase
34{
35 Q_OBJECT
36 Q_DECLARE_PRIVATE(DeleteAclJob)
37
38 friend class SessionPrivate;
39
40public:
41 explicit DeleteAclJob(Session *session);
42 ~DeleteAclJob() override;
43
44 /**
45 * Sets the identifier to remove
46 */
47 void setIdentifier(const QByteArray &identifier);
48 /**
49 * The identifier that will be removed
50 */
51 [[nodiscard]] QByteArray identifier();
52
53protected:
54 void doStart() override;
55};
56
57}
Base class for jobs that operate on mailbox ACLs.
Definition acljobbase.h:30
Removes an identifier from the ACL of a mailbox.
This file is part of the KDE documentation.
Documentation copyright © 1996-2024 The KDE developers.
Generated on Fri May 24 2024 11:55:08 by doxygen 1.10.0 written by Dimitri van Heesch, © 1997-2006

KDE's Doxygen guidelines are available online.