Interface CreateOptions

Options for creating or updating a masked email

interface CreateOptions {
    description?: string;
    emailPrefix?: string;
    forDomain?: string;
    state?: MaskedEmailState;
}

Hierarchy (view full)

Properties

description? emailPrefix? forDomain? state?

Properties

Optional description

description?: string

The description to set fpr the masked email

Optional emailPrefix

emailPrefix?: string

If supplied, the server-assigned email will start with the given prefix.

Optional forDomain

forDomain?: string

The domain to be associated with the masked email

Optional state

state?: MaskedEmailState

The state to set for the masked email

Default Value

'enabled'

See

MaskedEmailState for valid values

Settings

Member Visibility

Theme

On This Page

descriptionemailPrefixforDomainstate