Sign inGet Started

List a mailbox's labels

GET
/v1/email/mailboxes/{mailbox_id}/labels
const labels = await bird.email.mailboxes.labels("mbx_01abc");
console.log(labels.data.map((label) => label.name));
Antwort200
{
  "data": [
    {
      "name": "inbox",
      "type": "system"
    }
  ]
}

Returns the labels available in a mailbox. First, the built-in system labels:

  • The placements inbox, archive, spam, blocked, and sent.
  • trash.
  • unread.

Then, every custom label in the workspace, ordered by name. All of a workspace's mailboxes share its custom labels. Apply and remove custom labels through the conversation and message update endpoints; applying a custom label name the workspace does not have yet creates that label, and reserved names are refused. Removing a custom label only unassigns it: the label stays in the workspace and in this list until it is deleted. System labels change state instead: a message update takes unread and trash. A conversation's read state changes through read and its folder through folder (inbox, archive or spam). Deleting it moves it to the trash, or removes it for good with permanent=true; sent and blocked are set automatically.

Parameter

mailbox_idstring

Mailbox ID or email address in this workspace.

Antwort-Payload

data
array of object
erforderlich
Untergeordnete Attribute anzeigen