Skip to Content

The SendState type of the TypeScript SDK, which mailboxes.getSendState take or answer.

type SendState = {
  canSend: boolean
  sendHold?: ('disabled' | 'paused' | 'unverified' | 'receive_only')
}

Fields

FieldTypeDescription
canSendbooleanTrue if this mailbox may send from its primary address now: the answer /auth/verify gives a login typed as that address
sendHold('disabled' | 'paused' | 'unverified' | 'receive_only')Optional. Why canSend is false, present only then, with /auth/verify's values: 'unverified' = the domain's send records were never published (publish DNS), 'receive_only' = the domain is configured to receive here and send through another provider, 'paused' = a reversible hold at some scope (mailbox, account or domain), 'disabled' = a permanent stop, or a mailbox that cannot send at all. Unlike /send-usage's sendHold, which is the mailbox's own switch only, this is the fold across every scope. Advisory; the submission gate is the authority. Treat an unrecognized value as permanent

Used by

MethodWhat it does
mailboxes.getSendStateGet whether a mailbox may send

On this page