Class: MailboxRole

MailboxRole

new MailboxRole(role)

The MailboxRole class is simply a holder for predefined JMAP mailbox roles.
It exposes class constants for every predefined roles (trash, inbox, etc.)

Parameters:
Name Type Description
role String

The JMAP mailbox role. This is exposed as the value property.

Source:
See:

Methods

(static) fromRole(role) → {MailboxRole}

Returns the class constant mapping to the given JMAP role, or MailboxRole.UNKNOWN if the role is undefined, null or isn't a predefined role.

Parameters:
Name Type Description
role String

The JMAP role to find the MailboxRole for.

Source:
Returns:
Type
MailboxRole