1        Cone©
2
3MAIL::FOLDER::GETMYR(3x)Cone: COnsole Newsreader And EMAIL::FOLDER::GETMYR(3x)
4
5
6

NAME

8       mail::folder::getMyRights - Compute my access rights on a folder
9

SYNOPSIS

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

USAGE

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

RETURN CODES AND CALLBACKS

88       The application must wait until callback's success or fail method is
89       invoked. The success method is invoked when this request is succesfully
90       processed. The fail method is invoked if this request cannot be
91       processed. The application must not destroy callback until either the
92       success or fail method is invoked.
93
94           Note
95           callback's fail method may be invoked even after other callback
96           methods were invoked. This indicates that the request was partially
97           completed before the error was encountered.
98

SEE ALSO

100       mail::account::delRights(3x), mail::account::getFolderIndexInfo(3x),
101       mail::account::getRights(3x), mail::account::setRights(3x).
102

AUTHOR

104       Sam Varshavchik
105
106
107
108Cone©                             08/25/2016          MAIL::FOLDER::GETMYR(3x)
Impressum