jmap-kit
    Preparing search index...

    Type Alias MailboxRights

    The set of rights (Access Control Lists (ACLs)) the user has in relation to this Mailbox. These are backwards compatible with IMAP ACLs, as defined in RFC 4314.

    type MailboxRights = {
        mayAddItems: boolean;
        mayCreateChild: boolean;
        mayDelete: boolean;
        mayReadItems: boolean;
        mayRemoveItems: boolean;
        mayRename: boolean;
        maySetKeywords: boolean;
        maySetSeen: boolean;
        maySubmit: boolean;
    }
    Index

    Properties

    mayAddItems mayCreateChild mayDelete mayReadItems mayRemoveItems mayRename maySetKeywords maySetSeen maySubmit

    Properties

    mayAddItems: boolean

    The user may add mail to this Mailbox (by either creating a new Email or moving an existing one). Corresponds to IMAP ACL i.

    mayCreateChild: boolean

    The user may create a Mailbox with this Mailbox as its parent. Corresponds to IMAP ACL k.

    mayDelete: boolean

    The user may delete the Mailbox itself. Corresponds to IMAP ACL x (although this covers both rename and delete permissions).

    mayReadItems: boolean

    If true, the user may use this Mailbox as part of a filter in an Email/query call, and the Mailbox may be included in the mailboxIds property of Email objects. Email objects may be fetched if they are in at least one Mailbox with this permission. If a sub-Mailbox is shared but not the parent Mailbox, this may be false. Corresponds to IMAP ACLs lr (if mapping from IMAP, both are required for this to be true).

    mayRemoveItems: boolean

    The user may remove mail from this Mailbox (by either changing the Mailboxes of an Email or destroying the Email). Corresponds to IMAP ACLs te (if mapping from IMAP, both are required for this to be true).

    mayRename: boolean

    The user may rename the Mailbox or make it a child of another Mailbox. Corresponds to IMAP ACL x (although this covers both rename and delete permissions).

    maySetKeywords: boolean

    The user may add or remove any keyword other than $seen to/from an Email. If an Email belongs to multiple Mailboxes, the user may only modify keywords if they have this permission for all of the Mailboxes. Corresponds to IMAP ACL w.

    maySetSeen: boolean

    The user may add or remove the $seen keyword to/from an Email. If an Email belongs to multiple Mailboxes, the user may only modify $seen if they have this permission for all of the Mailboxes. Corresponds to IMAP ACL s.

    maySubmit: boolean

    Messages may be submitted directly to this Mailbox. Corresponds to IMAP ACL p.

    Settings

    Member Visibility

    On This Page

    Properties