Type alias MaskedEmailState

MaskedEmailState: "enabled" | "disabled" | "pending" | "deleted"

Represents the state of a masked email address.

The state of a masked email address can be one of the following:

  • enabled
    • The address is active and receiving mail normally.
  • disabled
    • The address is active, but mail is sent straight to trash.
  • deleted
    • The address is inactive; any mail sent to the address is bounced.
  • pending
    • The initial state. Once set to anything else, it cannot be set back to pending.
    • If a message is received by an address in the "pending" state, it will automatically be converted to "enabled".
    • Pending email addresses are automatically deleted 24h after creation.