SetMailboxACL Method
Sets mailbox access control rights for a specific user.
Syntax
pimap.setMailboxACL(user, rights, [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 changes the access control list for the mailbox specified in the Mailbox property so that User is granted the permissions specified in Rights.
Rights is a string containing an optional plus ("+") or minus ("-") prefix, followed by zero or more rights characters. If the string starts with a plus, the rights are added to any existing rights for the identifier. If the string starts with a minus, the rights are removed from any existing rights for the identifier. If the string does not start with a plus or minus, the rights replace any existing rights for the identifier.
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) |