mail::ACCOUNT::getMyRights(3x)

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

NAME

6       mail::ACCOUNT::getMyRights - Compute my access rights on a folder
7

SYNOPSIS

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

USAGE

17       This function implements folder access control lists (ACLs). Access
18       control lists define who is allowed to do certain operations on a
19       folder, or on messages in the folder. Folder ACLs are implement only
20       for IMAP accounts on IMAP servers that implement access control lists.
21       This function will fail if folder is not a folder on an IMAP server
22       that supports access control lists.
23
24       This function computes application´s access rights on the folder. If
25       this function succeeds (this function may fail if the requesting client
26       does not have the required access to the folder), rights will be
27       initialized by a text string that contains a list of character which
28       describe the requested client´s access rights on the folder.
29
30       At this time, the following access rights are supported:
31
32       “a”
33           Administrator access: view and change folder access control lists.
34
35       “c”
36           Create subfolders.
37
38       “e”
39           Expunge deleted messages from the folder.
40
41       “i”
42           Insert, or add messages to the folder.
43
44       “l”
45           List, or view the folder´s existence. If a folder does not have the
46           “l” access right, the server will not include this folder when it´s
47           asked to list all folders in the folder directory. However, if the
48           “r” access right is present, the folder may be opened if the
49           folder´s name is known.
50
51       “r”
52           Read, or open the folder. An attempt to open the folder will fail
53           without the “r” access right, even if the folder´s name is known.
54
55       “p”
56
57           “Post messages” to the folder. This access right is currently
58           listed in the ACL specification; however its intention is not
59           clear, and most servers do not do anything useful with this access
60           right. It is listed here for information purposes only.
61
62       “s”
63           Allow changing the read/unread status of messages in the folder.
64           The server will not automatically clear the unread message status
65           flag on messages after they are read, or let this status flag be
66           explicitly changed, without the “s” access right.
67
68       “t”
69           Allow tagging of messages as deleted or undeleted. The server will
70           prohibit changing the messages´ deleted message status flag without
71           the “t” access right.
72
73       “w”
74           Allow changing the draft, replied, and marked message status flags.
75           The server will not allow changes to these flags without the “w”
76           access right.
77
78       “x”
79           Allow this folder to be removed. The server will not this folder to
80           be deleted without the “x” access right.
81

RETURN CODES AND CALLBACKS

83       This method returns true if it succeeds, or false if it fails. If the
84       method fails, use mail::ACCOUNT::getErrmsg() to read a brief
85       description of the error.
86

NAME

SYNOPSIS

USAGE

RETURN CODES AND CALLBACKS

SEE ALSO