Skip to Content

The MailboxRestoreResult type of the TypeScript SDK, which identities.restore take or answer.

type MailboxRestoreResult = {
  accountId: string | null
  addressChanged: boolean
  id: string
  primaryAddress: string | null
  quotaBytes: number | null
  restored: boolean
}

Fields

FieldTypeDescription
accountIdstring | nullAccount ID, or null
addressChangedbooleanTrue if the primary address had to be cleared because it was claimed while deleted
idstringMailbox ULID
primaryAddressstring | nullRestored primary address, or null
quotaBytesnumber | nullStorage quota in bytes, or null
restoredbooleanTrue if the mailbox was restored

Used by

MethodWhat it does
identities.restoreRestore a deleted mailbox

On this page