1 Cone©
2MAIL::FOLDER::DELRIG(3x)Cone: COnsole Newsreader And EMAIL::FOLDER::DELRIG(3x)
4
8 mail::folder::delRights - Delete an access control list identifier
9
11 #include <libmail/mail.H>
12 class myCallback : public mail::callback {
15 public:
16 void success(std::string msg);
17 void fail(std::string msg);
18 };
19 folder->delRights(myCallback &callback, std::string &errorIdentifier,
21 std::vector<std::string> &errorRights,
22 std::string identifier);
23
25 This function implements folder access control lists (ACLs). Access
26 control lists define who is allowed to do certain operations on a
27 folder, or on messages in the folder. Folder ACLs are implement only
28 for IMAP accounts on IMAP servers that implement access control lists.
29 This function will fail if folder is not a folder on an IMAP server
30 that supports access control lists.
31 This function removes identifier from folder's access control list.
33 Identifier
35 Not all servers support every one of the following access control list
36 identifiers. See the server's documentation to check which access
37 control list identifiers are implemented by the server:
38 “anonymous”, or “anyone”
40 This identifier refers to universal access rights given to
41 everyone, including anonymous users (if supported by server).
42 “authuser”
44 Same as “anyone”, except for anonymous users. If the server does
45 not implement anonymous access, then “anonymous”, “anyone”, and
46 “authuser” are equivalent.
47 “owner”
49 The owner of the mailbox that contains the folder.
50 “administrators”
52 Any member of a group that's defined as an administrator group, in
53 an implementation-defined way.
54 “user=username”
56 A single system user, identified by username.
57 “group=groupname”
59 Any system user that's part of a group identified by groupname.
60 Groups are created and managed by IMAP server-specific tools. See
61 the server's documentation for information on creating and managing
62 groups (if the groups are even implemented by the server in the
63 first place).
64 “-identifier”
66 An access control list identifier may be prefixed by a “-”, which
67 refers to a “negative right”. Negative rights explicitly revoke the
68 associated access rights from the identifier instead of granting
69 the right.
70 Negative rights are not implemented by all servers. See the
72 server's documentation to check if the server implements negative
73 access rights.
74 Note
76 username and groupname must specified using the UTF-8 character
77 set.
78 Access rights
80 At this time, the following access rights are supported:
81 “a”
83 Administrator access: view and change folder access control lists.
84 “c”
86 Create subfolders.
87 “e”
89 Expunge deleted messages from the folder.
90 “i”
92 Insert, or add messages to the folder.
93 “l”
95 List, or view the folder's existence. If a folder does not have the
96 “l” access right, the server will not include this folder when it's
97 asked to list all folders in the folder directory. However, if the
98 “r” access right is present, the folder may be opened if the
99 folder's name is known.
100 “r”
102 Read, or open the folder. An attempt to open the folder will fail
103 without the “r” access right, even if the folder's name is known.
104 “p”
106 “Post messages” to the folder. This access right is currently
107 listed in the ACL specification; however its intention is not
108 clear, and most servers do not do anything useful with this access
109 right. It is listed here for information purposes only.
110 “s”
112 Allow changing the read/unread status of messages in the folder.
113 The server will not automatically clear the unread message status
114 flag on messages after they are read, or let this status flag be
115 explicitly changed, without the “s” access right.
116 “t”
118 Allow tagging of messages as deleted or undeleted. The server will
119 prohibit changing the messages' deleted message status flag without
120 the “t” access right.
121 “w”
123 Allow changing the draft, replied, and marked message status flags.
124 The server will not allow changes to these flags without the “w”
125 access right.
126 “x”
128 Allow this folder to be removed. The server will not this folder to
129 be deleted without the “x” access right.
130 Extended error reporting
132 Most IMAP servers have restrictions on which combinations of access
133 rights are valid for which folders. See the IMAP server's documentation
134 to check for any access rights restrictions. The most common
135 restriction is that the “e”, “t”, and “x” access rights must either be
136 set together, as a group, or not. The server will reject or ignore an
137 attempt to set prohibited combinations of access rights for a given
138 folder.
139 Some IMAP servers implement an extended form of the access control list
141 protocol which makes it possible to obtain the server's restrictions.
142 When an attempt to set an invalid access right combination is rejected,
143 errorIdentifier will be set to indicate which identifier's access right
144 combination was rejected (usually it will be set to the same value as
145 identifier.
146 errorRights will be set to an array of strings, each strings consisting
148 of one or more access rights. The first array element, errorRights[0]
149 will contain the minimum access rights required for this folder (which
150 may be an empty string if the folder does not require any minimum
151 access rights for the identifier). Each remaining string lists an
152 optional access right allowed for this folder. If a string contains
153 more than one access right, it means that these access rights must be
154 added or removed from the access control list together, as a group.
155
157 The application must wait until callback's success or fail method is
158 invoked. The success method is invoked when this request is succesfully
159 processed. The fail method is invoked if this request cannot be
160 processed. The application must not destroy callback until either the
161 success or fail method is invoked.
162 Note
164 callback's fail method may be invoked even after other callback
165 methods were invoked. This indicates that the request was partially
166 completed before the error was encountered.
167
169 mail::account::getMyRights(3x), mail::account::getRights(3x),
170 mail::account::setRights(3x).
171
173 Sam Varshavchik
174Cone© 08/25/2016 MAIL::FOLDER::DELRIG(3x)