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

NAME

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

SYNOPSIS

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

USAGE

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

RETURN CODES AND CALLBACKS

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

SEE ALSO

89       mail::ACCOUNT::delRights(3x), mail::ACCOUNT::getFolderIndexInfo(3x),
90       mail::ACCOUNT::getRights(3x), mail::ACCOUNT::setRights(3x).
91

AUTHOR

93       Sam Varshavchik
94
95
96
97Cone©                             08/25/2016          MAIL::ACCOUNT::GETMY(3x)
Impressum