Interface MaskedEmail

Represents a masked email address.

See

https://www.fastmail.com/developer/maskedemail/

interface MaskedEmail {
    createdAt: string;
    createdBy: string;
    description: string;
    email: string;
    emailPrefix?: string;
    forDomain: string;
    id: string;
    lastMessageAt: string;
    state: MaskedEmailState;
    url: null | string;
}

Properties

createdAt createdBy description email emailPrefix? forDomain id lastMessageAt state url

Properties

createdAt

createdAt: string

The date-time the most recent message was received at this email address, if any.

createdBy

createdBy: string

The name of the client that created this masked email address

description

description: string

A short user-supplied description of what this masked email address is for.

email

email: string

The email address.

Optional emailPrefix

emailPrefix?: string

(create-only) This is only used on create and otherwise ignored; it is not returned when masked email objects are fetched.

forDomain

forDomain: string

The protocol and domain (i.e. origin) of the site the user is using the masked email for.

id

id: string

The id of the masked email address.

lastMessageAt

lastMessageAt: string

The date-time the email address was created.

state

state: MaskedEmailState

The current state of the masked email address.

url

url: null | string

A deep link to the credential or other record related to this masked email

Settings

Member Visibility

Theme

On This Page

createdAtcreatedBydescriptionemailemailPrefixforDomainidlastMessageAtstateurl