Type Alias MaskedEmailObjectSettable

Settable properties for MaskedEmail objects

type MaskedEmailObjectSettable = {
    description: string;
    emailPrefix?: string;
    forDomain: string;
    state?: MaskedEmailState;
    url?: string | null;
}

Properties

description: string

A short description of what this email address is for.

emailPrefix?: string

The prefix for the generated email address (optional, create-only). Must be <= 64 chars, only a-z, 0-9, _

forDomain: string

The domain name of the site this address was created for, e.g. “https://example.com”.

The state of the masked email address (default: pending).

url?: string | null

A URL pointing back to the integrator’s use of this email address, e.g. a custom-uri to open a password manager (nullable).