RecoveryInvitationSent
The RecoveryInvitationSent type of the TypeScript SDK, which passwords.invite take or answer.
type RecoveryInvitationSent = {
address: string
expiresAt: number
kind: ('invitation' | 'nomination')
retained: boolean
}Fields
| Field | Type | Description |
|---|---|---|
address | string | The nominated address, masked |
expiresAt | number | Epoch seconds at which the mailed code stops working |
kind | ('invitation' | 'nomination') | invitation: the mailbox had no password credential, so the mailed code SETS one and verifies the address in the same act. nomination: it already had one, so the mailed code is an ordinary 24h confirmation code that sets nothing and can only be spent from the mailbox's own session |
retained | boolean | True if the address was stored as this mailbox's pending recovery address. False when the account policy is admin_only: the address was used once as a delivery destination and never stored |
Used by
| Method | What it does |
|---|---|
passwords.invite | Invite a mailbox user to set their own password |