Skip to Content

The MessageLabel type of the TypeScript SDK, part of MessageMeta and 2 more types.

type MessageLabel = {
  deleted: boolean
  modseq: number
  name: string
  uid: number
  uidValidity: number
}

Fields

FieldTypeDescription
deletedbooleanThis membership's IMAP \Deleted mark (set with flagLabel on PATCH, acted on by POST /labels/{label}/expunge). Always present; false when unmarked. Per label, so the same message can be marked in one folder and clean in another
modseqnumberRFC 7162 MODSEQ change sequence number
namestringLabel name
uidnumberMessage UID inside this label
uidValiditynumberUID validity epoch of the label

Used in

MessageMeta, MessageSyncEntry, MessageUpdated.

On this page