Skip to Content

The MessageDeleteResult type of the TypeScript SDK, which messages.delete take or answer.

type MessageDeleteResult = {
  blobOrphaned?: boolean
  deleted?: boolean
  expunged?: boolean
  expungedAt?: number
  purgeAfter?: number
  purged?: boolean
  removedFromLabel?: string
}

Fields

FieldTypeDescription
blobOrphanedbooleanOptional. True if message blob was permanently deleted from storage
deletedbooleanOptional. True if message was deleted
expungedbooleanOptional. True if the message was expunged (Recently deleted tier)
expungedAtnumberOptional. Timestamp when the message was expunged, in epoch seconds
purgeAfternumberOptional. Timestamp when message will be permanently purged
purgedbooleanOptional. True if message was permanently purged
removedFromLabelstringOptional. Label name the message was removed from

Used by

MethodWhat it does
messages.deleteDelete a message

On this page