1mail::folder::getMyRightmsa(i3lx:):folder Native API refmearieln:c:efolder::getMyRights(3x)
2
6 mail::folder::getMyRights - Compute my access rights on a folder
7
9 #include <libmail/mail.H>
10 class myCallback : public mail::callback {
13 public:
14 void success(std::string msg);
15 void fail(std::string msg);
16 };
17 folder->getMyRights (myCallback &callback, std::string &rights);
21
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 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 ini‐
33 tialized by a text string that contains a list of character which
34 describe the requested client's access rights on the folder.
35 At this time, the following access rights are supported:
37 ``a'' Administrator access: view and change folder access control
39 lists.
40 ``c'' Create subfolders.
42 ``e'' Expunge deleted messages from the folder.
44 ``i'' Insert, or add messages to the folder.
46 ``l'' List, or view the folder's existence. If a folder does not have
48 the ``l'' access right, the server will not include this folder
49 when it's asked to list all folders in the folder directory.
50 However, if the ``r'' access right is present, the folder may be
51 opened if the folder's name is known.
52 ``r'' Read, or open the folder. An attempt to open the folder will
54 fail without the ``r'' access right, even if the folder's name
55 is known.
56 ``p'' ``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
60 access right. It is listed here for information purposes only.
61 ``s'' Allow changing the read/unread status of messages in the folder.
63 The server will not automatically clear the unread message sta‐
64 tus flag on messages after they are read, or let this status
65 flag be explicitly changed, without the ``s'' access right.
66 ``t'' Allow tagging of messages as deleted or undeleted. The server
68 will prohibit changing the messages' deleted message status flag
69 without the ``t'' access right.
70 ``w'' Allow changing the draft, replied, and marked message status
72 flags. The server will not allow changes to these flags without
73 the ``w'' access right.
74 ``x'' Allow this folder to be removed. The server will not this
76 folder to be deleted without the ``x'' access right.
77
79 The application must wait until callback's success or fail method is
80 invoked. The success method is invoked when this request is succes‐
81 fully processed. The fail method is invoked if this request cannot be
82 processed. The application must not destroy callback until either the
83 success or fail method is invoked.
84 Note: callback's fail method may be invoked even after other
86 callback methods were invoked. This indicates that the request
87 was partially completed before the error was encountered.
88
90 mail::account::delRights(3x), mail::account::getFolderIndexInfo(3x),
91 mail::account::getRights(3x), mail::account::setRights(3x).
92 10 April 2006 mail::folder::getMyRights(3x)