IPWorks OpenPGP 2020 Node.js Edition

Questions / Feedback?

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:

lLookup (visible to be listed)
rRead (Can be selected, fetched, searched, and copied)
sKeep seen/unseen information across sessions
wWrite (Store flags other than SEEN and DELETED)
iInsert (Can be appended, and copied into)
pPost (Can send mail to submission address for mailbox)
cCreate (Can create new sub-mailboxes)
dDelete (Store DELETED flag, perform EXPUNGE)
aAdminister (Set access permissions)

Copyright (c) 2022 /n software inc. - All rights reserved.
IPWorks OpenPGP 2020 Node.js Edition - Version 20.0 [Build 8249]