Skip to Content

The LabelInfo type of the TypeScript SDK, part of LabelListPage and 1 more types.

type LabelInfo = {
  bytes: number
  color: string | null
  deletedCount: number
  highestModseq: number
  id: number
  isSubscribed: boolean
  messageCount: number
  name: string
  role: ('inbox' | 'sent' | 'drafts' | 'trash' | 'archive' | 'junk') | null
  sortOrder: number
  uidNext: number
  uidValidity: number
  unseenCount: number
}

Fields

FieldTypeDescription
bytesnumberTotal storage size of live messages in this label in bytes
colorstring | nullHex color code (#rrggbb) or null
deletedCountnumberNumber of live messages marked with \Deleted flag
highestModseqnumberCurrent RFC 7162 HIGHESTMODSEQ change tracker for this label
idnumberInternal label numeric ID
isSubscribedbooleanTrue if folder is subscribed for client synchronization
messageCountnumberTotal number of live messages in this label
namestringLabel or folder name (e.g. INBOX, Archive, custom name)
role('inbox' | 'sent' | 'drafts' | 'trash' | 'archive' | 'junk') | nullSystem role if special folder, or null for custom user labels
sortOrdernumberDisplay sort order index for mailbox list
uidNextnumberNext message UID that will be assigned in this label
uidValiditynumberIMAP UIDVALIDITY epoch for this label
unseenCountnumberNumber of unread messages in this label

Used in

LabelListPage, MessageChangesFeed.

On this page