LabelInfo
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
| Field | Type | Description |
|---|---|---|
bytes | number | Total storage size of live messages in this label in bytes |
color | string | null | Hex color code (#rrggbb) or null |
deletedCount | number | Number of live messages marked with \Deleted flag |
highestModseq | number | Current RFC 7162 HIGHESTMODSEQ change tracker for this label |
id | number | Internal label numeric ID |
isSubscribed | boolean | True if folder is subscribed for client synchronization |
messageCount | number | Total number of live messages in this label |
name | string | Label or folder name (e.g. INBOX, Archive, custom name) |
role | ('inbox' | 'sent' | 'drafts' | 'trash' | 'archive' | 'junk') | null | System role if special folder, or null for custom user labels |
sortOrder | number | Display sort order index for mailbox list |
uidNext | number | Next message UID that will be assigned in this label |
uidValidity | number | IMAP UIDVALIDITY epoch for this label |
unseenCount | number | Number of unread messages in this label |