mail::folder::getMyRights(3x)

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

NAME

6       mail::folder::getMyRights - Compute my access rights on a folder
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->getMyRights(myCallback &callback, std::string &rights);
19

USAGE

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

RETURN CODES AND CALLBACKS

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

NAME

SYNOPSIS

USAGE

RETURN CODES AND CALLBACKS

SEE ALSO