mail::folder::getRights(3x)

1MAIL::FOLDER::GETRIG(3x)Cone: COnsole Newsreader And EMAIL::FOLDER::GETRIG(3x)
2
3
4

NAME

6       mail::folder::getRights - Read access control list
7

SYNOPSIS

9       #include <libmail/mail.H>
10
11
12       class myCallback : public mail::callback {
13       public:
14           void success(std::string msg);
15           void fail(std::string msg);
16       };
17
18       folder->getRights(myCallback &callback,
19                         std::list<std::pair<std::string, std::string> > &rights);
20

USAGE

22       This function implements folder access control lists (ACLs). Access
23       control lists define who is allowed to do certain operations on a
24       folder, or on messages in the folder. Folder ACLs are implement only
25       for IMAP accounts on IMAP servers that implement access control lists.
26       This function will fail if folder is not a folder on an IMAP server
27       that supports access control lists.
28
29       This function obtains folder´s entire access control list. If this
30       function succeeds (this function may fail if the requesting client does
31       not have the required access to the folder), rights will be initialized
32       to an array of identifier/accessrights tuples.
33
34   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
39       “anonymous”, or “anyone”
40           This identifier refers to universal access rights given to
41           everyone, including anonymous users (if supported by server).
42
43       “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
48       “owner”
49           The owner of the mailbox that contains the folder.
50
51       “administrators”
52           Any member of a group that´s defined as an administrator group, in
53           an implementation-defined way.
54
55       “user=username”
56           A single system user, identified by username.
57
58       “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
65       “-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
71           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
75           Note
76           username and groupname must specified using the UTF-8 character
77           set.
78
79   Access rights
80       At this time, the following access rights are supported:
81
82       “a”
83           Administrator access: view and change folder access control lists.
84
85       “c”
86           Create subfolders.
87
88       “e”
89           Expunge deleted messages from the folder.
90
91       “i”
92           Insert, or add messages to the folder.
93
94       “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
101       “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
105       “p”
106
107           “Post messages” to the folder. This access right is currently
108           listed in the ACL specification; however its intention is not
109           clear, and most servers do not do anything useful with this access
110           right. It is listed here for information purposes only.
111
112       “s”
113           Allow changing the read/unread status of messages in the folder.
114           The server will not automatically clear the unread message status
115           flag on messages after they are read, or let this status flag be
116           explicitly changed, without the “s” access right.
117
118       “t”
119           Allow tagging of messages as deleted or undeleted. The server will
120           prohibit changing the messages´ deleted message status flag without
121           the “t” access right.
122
123       “w”
124           Allow changing the draft, replied, and marked message status flags.
125           The server will not allow changes to these flags without the “w”
126           access right.
127
128       “x”
129           Allow this folder to be removed. The server will not this folder to
130           be deleted without the “x” access right.
131

RETURN CODES AND CALLBACKS

133       The application must wait until callback´s success or fail method is
134       invoked. The success method is invoked when this request is succesfully
135       processed. The fail method is invoked if this request cannot be
136       processed. The application must not destroy callback until either the
137       success or fail method is invoked.
138
139           Note
140           callback´s fail method may be invoked even after other callback
141           methods were invoked. This indicates that the request was partially
142           completed before the error was encountered.
143

NAME

SYNOPSIS

USAGE

RETURN CODES AND CALLBACKS

SEE ALSO