/usr/include/KF5/KIMAP/kimap/setacljob.h is in libkf5imap-dev 17.12.3-0ubuntu1.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 | /*
Copyright (c) 2009 Andras Mantia <amantia@kde.org>
This library is free software; you can redistribute it and/or modify it
under the terms of the GNU Library General Public License as published by
the Free Software Foundation; either version 2 of the License, or (at your
option) any later version.
This library is distributed in the hope that it will be useful, but WITHOUT
ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
FITNESS FOR A PARTICULAR PURPOSE. See the GNU Library General Public
License for more details.
You should have received a copy of the GNU Library General Public License
along with this library; see the file COPYING.LIB. If not, write to the
Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
02110-1301, USA.
*/
#ifndef KIMAP_SETACLJOB_H
#define KIMAP_SETACLJOB_H
#include "kimap_export.h"
#include "acljobbase.h"
namespace KIMAP
{
class Session;
struct Response;
class SetAclJobPrivate;
/**
* Sets the rights that correspond to an identifier on a mailbox
*
* This job can only be run when the session is in the
* authenticated (or selected) state.
*
* This job requires that the server supports the ACL
* capability, defined in
* <a href="http://www.apps.ietf.org/rfc/rfc4314.html">RFC 4314</a>.
*/
class KIMAP_EXPORT SetAclJob : public AclJobBase
{
Q_OBJECT
Q_DECLARE_PRIVATE(SetAclJob)
friend class SessionPrivate;
public:
explicit SetAclJob(Session *session);
virtual ~SetAclJob();
/**
* Sets the rights that will be changed for the identifier
*
* Note that multiple calls to this method will have a
* non-intuitive effect: the @p modifier value of the most
* recent call will be used, but the OR'd-together values
* of all calls to setRights() will be used.
*
* If the server does not recognise any of the rights,
* the job will fail and the ACL for the mailbox will
* remain unchanged.
*
* Note that some rights may be tied together, and must be set
* or removed as a group. See ListRightsJob::possibleRights()
* for more details. The server will only set a tied group
* of rights if you have requested that all the rights in that
* group should be set.
*
* @param modifier determines whether the rights will be
* added to the identifier, removed from
* the identifier or will replace any
* existing rights assigned to the
* identifier
* @param rights the rights to be added, removed or set
*/
void setRights(AclModifier modifier, Acl::Rights rights);
/**
* Sets the identifier the rights will be modified for
*
* The meaning of identifiers depends on the server implementation,
* with the following restrictions:
*
* - "anyone" means any authenticated user, including anonymous
* - an identifier starting with a minus sign ('-') indicates
* "negative rights": rights that should be taken away from
* matching users
*
* Other than the above restrictions, ACL identifiers are usually
* IMAP usernames, but could potentially be group names as well.
*
* Note that negative rights override positive rights: if
* "fred" and "-fred" are both assigned the 'w' right, the
* user "fred" will not have the 'w' right.
* @param identifier the identifier to set
*/
void setIdentifier(const QByteArray &identifier);
/**
* The identifier that rights will be associated with
*/
QByteArray identifier();
protected:
void doStart() override;
};
}
#endif
|