Skip to Content

The BatchUntrashEntry type of the TypeScript SDK, part of BatchUntrashResult.

type BatchUntrashEntry = {
  id: string
  message?: MessageMeta
  status: ('untrashed' | 'not_trashed' | 'not_found')
}

Fields

FieldTypeDescription
idstringMessage ULID
messageMessageMetaOptional. Untrashed message metadata (when status=untrashed)
status('untrashed' | 'not_trashed' | 'not_found')Untrash outcome for this message. not_trashed: the message exists and is readable but does not carry the Trash label, so there is nothing to undo — deliberately distinct from not_found, which means no such live message (an EXPUNGED id is not_found here; use POST /messages/restore for that tier).

Used in

BatchUntrashResult.

On this page