mail::ACCOUNT::getRights(3x)

1MAIL::ACCOUNT::GETRI(3x)Cone: COnsole Newsreader And EMAIL::ACCOUNT::GETRI(3x)
2
3
4

NAME

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

SYNOPSIS

9       #include <libmail/sync.H>
10
11       mail::ACCOUNT *mail;
12       mail::folder *folder;
13
14       bool ok=mail->getRights(mail::folder *folder,
15                               std::list<std::pair<std::string, std::string> > &rights);
16

USAGE

18       This function implements folder access control lists (ACLs). Access
19       control lists define who is allowed to do certain operations on a
20       folder, or on messages in the folder. Folder ACLs are implement only
21       for IMAP accounts on IMAP servers that implement access control lists.
22       This function will fail if folder is not a folder on an IMAP server
23       that supports access control lists.
24
25       This function obtains folder´s entire access control list. If this
26       function succeeds (this function may fail if the requesting client does
27       not have the required access to the folder), rights will be initialized
28       to an array of identifier/accessrights tuples.
29
30   Identifier
31       Not all servers support every one of the following access control list
32       identifiers. See the server´s documentation to check which access
33       control list identifiers are implemented by the server:
34
35       “anonymous”, or “anyone”
36           This identifier refers to universal access rights given to
37           everyone, including anonymous users (if supported by server).
38
39       “authuser”
40           Same as “anyone”, except for anonymous users. If the server does
41           not implement anonymous access, then “anonymous”, “anyone”, and
42           “authuser” are equivalent.
43
44       “owner”
45           The owner of the mailbox that contains the folder.
46
47       “administrators”
48           Any member of a group that´s defined as an administrator group, in
49           an implementation-defined way.
50
51       “user=username”
52           A single system user, identified by username.
53
54       “group=groupname”
55           Any system user that´s part of a group identified by groupname.
56           Groups are created and managed by IMAP server-specific tools. See
57           the server´s documentation for information on creating and managing
58           groups (if the groups are even implemented by the server in the
59           first place).
60
61       “-identifier”
62           An access control list identifier may be prefixed by a “-”, which
63           refers to a “negative right”. Negative rights explicitly revoke the
64           associated access rights from the identifier instead of granting
65           the right.
66
67           Negative rights are not implemented by all servers. See the
68           server´s documentation to check if the server implements negative
69           access rights.
70
71           Note
72           username and groupname must specified using the UTF-8 character
73           set.
74
75   Access rights
76       At this time, the following access rights are supported:
77
78       “a”
79           Administrator access: view and change folder access control lists.
80
81       “c”
82           Create subfolders.
83
84       “e”
85           Expunge deleted messages from the folder.
86
87       “i”
88           Insert, or add messages to the folder.
89
90       “l”
91           List, or view the folder´s existence. If a folder does not have the
92           “l” access right, the server will not include this folder when it´s
93           asked to list all folders in the folder directory. However, if the
94           “r” access right is present, the folder may be opened if the
95           folder´s name is known.
96
97       “r”
98           Read, or open the folder. An attempt to open the folder will fail
99           without the “r” access right, even if the folder´s name is known.
100
101       “p”
102
103           “Post messages” to the folder. This access right is currently
104           listed in the ACL specification; however its intention is not
105           clear, and most servers do not do anything useful with this access
106           right. It is listed here for information purposes only.
107
108       “s”
109           Allow changing the read/unread status of messages in the folder.
110           The server will not automatically clear the unread message status
111           flag on messages after they are read, or let this status flag be
112           explicitly changed, without the “s” access right.
113
114       “t”
115           Allow tagging of messages as deleted or undeleted. The server will
116           prohibit changing the messages´ deleted message status flag without
117           the “t” access right.
118
119       “w”
120           Allow changing the draft, replied, and marked message status flags.
121           The server will not allow changes to these flags without the “w”
122           access right.
123
124       “x”
125           Allow this folder to be removed. The server will not this folder to
126           be deleted without the “x” access right.
127

RETURN CODES AND CALLBACKS

129       This method returns true if it succeeds, or false if it fails. If the
130       method fails, use mail::ACCOUNT::getErrmsg() to read a brief
131       description of the error.
132

NAME

SYNOPSIS

USAGE

RETURN CODES AND CALLBACKS

SEE ALSO