Skip to Content

The BatchDeleteEntry type of the TypeScript SDK, part of BatchDeleteResult.

type BatchDeleteEntry = {
  blobOrphaned?: boolean
  expungedAt?: number
  id: string
  purgeAfter?: number
  status: ('expunged' | 'purged' | 'gone' | 'not_found')
}

Fields

FieldTypeDescription
blobOrphanedbooleanOptional. True if underlying storage blob was unreferenced and deleted
expungedAtnumberOptional. Expunge timestamp in epoch seconds (when expunged)
idstringMessage ULID
purgeAfternumberOptional. Purge deadline timestamp in epoch seconds (when expunged)
status('expunged' | 'purged' | 'gone' | 'not_found')Deletion outcome. expunged = moved to the Recently-deleted tier, restorable until purgeAfter; purged = permanently removed; gone = a folder-scoped grantee's delete, which detaches the message from the folders they were granted rather than expunging it — the message survives in the owner's own folders, or in Trash if it was in none.

Used in

BatchDeleteResult.

On this page