GetMailboxACL Method
Retrieves mailbox access control rights.
Syntax
pimap.getMailboxACL([callback])
Callback
The 'callback' parameter specifies a function which will be called when the operation completes (or an error is encountered). If the 'callback' parameter is not specified, then the method will block and will not return until the operation completes (or an error is encountered).
The callback for this method is defined as:
function(err){ }
'err' is the error that occurred. If there was no error, then 'err' is 'null'.
'err' has 2 properties which hold detailed information:
err.code err.message
Remarks
This method retrieves the mailbox access control rights, which are provided through one or more MailboxACL events. Standard rights include:
| l | Lookup (visible to be listed) |
| r | Read (Can be selected, fetched, searched, and copied) |
| s | Keep seen/unseen information across sessions |
| w | Write (Store flags other than SEEN and DELETED) |
| i | Insert (Can be appended, and copied into) |
| p | Post (Can send mail to submission address for mailbox) |
| c | Create (Can create new sub-mailboxes) |
| d | Delete (Store DELETED flag, perform EXPUNGE) |
| a | Administer (Set access permissions) |