Linux Certif

Toute la documentation sur la certification Linux LPI

mail::ACCOUNT::getMyRights.3x

NAME

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

SYNOPSIS

 
 
 
 #include <libmail/sync.H>
 
 mail::ACCOUNT *mail;
 mail::folder *folder;
 

bool ok=mail->getMyRights(mail::folder *folder, std::string &rights);

USAGE

This function implements folder access control lists (ACLs). Access control lists define who is allowed to do certain operations on a folder, or on messages in the folder. Folder ACLs are implement only for IMAP accounts on IMAP servers that implement access control lists. This function will fail if folder is not a folder on an IMAP server that supports access control lists.

This function computes application's access rights on the folder. If this function succeeds (this function may fail if the requesting client does not have the required access to the folder), rights will be initialized by a text string that contains a list of character which describe the requested client's access rights on the folder.

At this time, the following access rights are supported:

lqarq

Administrator access: view and change folder access control lists.

lqcrq

Create subfolders.

lqerq

Expunge deleted messages from the folder.

lqirq

Insert, or add messages to the folder.

lqlrq

List, or view the folder's existence. If a folder does not have the lqlrq access right, the server will not include this folder when it's asked to list all folders in the folder directory. However, if the lqrrq access right is present, the folder may be opened if the folder's name is known.

lqrrq

Read, or open the folder. An attempt to open the folder will fail without the lqrrq access right, even if the folder's name is known.

lqprq

lqPost messagesrq to the folder. This access right is currently listed in the ACL specification; however its intention is not clear, and most servers do not do anything useful with this access right. It is listed here for information purposes only.

lqsrq

Allow changing the read/unread status of messages in the folder. The server will not automatically clear the unread message status flag on messages after they are read, or let this status flag be explicitly changed, without the lqsrq access right.

lqtrq

Allow tagging of messages as deleted or undeleted. The server will prohibit changing the messages' deleted message status flag without the lqtrq access right.

lqwrq

Allow changing the draft, replied, and marked message status flags. The server will not allow changes to these flags without the lqwrq access right.

lqxrq

Allow this folder to be removed. The server will not this folder to be deleted without the lqxrq access right.

RETURN CODES AND CALLBACKS

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

SEE ALSO

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