Skip to main content

Namespaces

This should be the first function ran after the connect() function as it returns the prefixes and hierarchy delimiters of the namespaces available to the logged in user. This is a crucial component for the GET folders function.

Usage​

let namespaces = await imap.getNamespaces()

Response​

The response is a typed object containing the personal, other and shared namespaces:

{
    personal: [
        { prefix: "INBOX/", delimiter: "/" }
    ],
    other: [],
    shared: []
}
KeyTypeDescription
personalNamespace[]Namespaces that are personal to the logged in user.
otherNamespace[]Namespaces that belong to other users.
sharedNamespace[]Namespaces that are shared between users.

Where Namespace is:

type Namespace = {
    prefix: string,     // e.g. "INBOX/"
    delimiter: string   // e.g. "/" (empty string if NIL)
}

A namespace with a prefix of "" is the root namespace — pass the prefix as the first argument to getFolders().