mail::ACCOUNT::getMyRights(3x)

1mail::ACCOUNT::getMyRmiagihlt:s:(A3CxC)OUNT Synchronous APImarielf:e:rAeCnCcOeUNT::getMyRights(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
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  ini‐
29       tialized  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''  Administrator access: view  and  change  folder  access  control
35              lists.
36
37       ``c''  Create subfolders.
38
39       ``e''  Expunge deleted messages from the folder.
40
41       ``i''  Insert, or add messages to the folder.
42
43       ``l''  List, or view the folder's existence.  If a folder does not have
44              the ``l'' access right, the server will not include this  folder
45              when  it's  asked  to  list all folders in the folder directory.
46              However, if the ``r'' access right is present, the folder may be
47              opened if the folder's name is known.
48
49       ``r''  Read,  or  open  the folder.  An attempt to open the folder will
50              fail without the ``r'' access right, even if the  folder's  name
51              is known.
52
53       ``p''  ``Post messages'' to the folder.  This access right is currently
54              listed in the ACL specification; however its  intention  is  not
55              clear,  and  most  servers  do  not do anything useful with this
56              access right.  It is listed here for information purposes only.
57
58       ``s''  Allow changing the read/unread status of messages in the folder.
59              The  server will not automatically clear the unread message sta‐
60              tus flag on messages after they are read,  or  let  this  status
61              flag be explicitly changed, without the ``s'' access right.
62
63       ``t''  Allow  tagging  of messages as deleted or undeleted.  The server
64              will prohibit changing the messages' deleted message status flag
65              without the ``t'' access right.
66
67       ``w''  Allow  changing  the  draft,  replied, and marked message status
68              flags.  The server will not allow changes to these flags without
69              the ``w'' access right.
70
71       ``x''  Allow  this  folder  to  be  removed.   The server will not this
72              folder to be deleted without the ``x'' access right.
73

RETURN CODES AND CALLBACKS

75       This method returns true if it succeeds, or false if it fails.  If  the
76       method  fails,  use mail::ACCOUNT::getErrmsg() to read a brief descrip‐
77       tion of the error.
78

NAME

SYNOPSIS

USAGE

RETURN CODES AND CALLBACKS

SEE ALSO