Index

Type aliases

Properties

Variables

Type aliases

Operation

Operation: string

Properties

data

data: object

The data associated with the action code.

For the PASSWORD_RESET, VERIFY_EMAIL, and RECOVER_EMAIL actions, this object contains an email field with the address the email was sent to.

For the RECOVER_EMAIL action, which allows a user to undo an email address change, this object also contains a fromEmail field with the user account's new email address. After the action completes, the user's email address will revert to the value in the email field from the value in fromEmail field.

Type declaration

  • Optional email?: string | null
  • Optional fromEmail?: string | null

operation

operation: string

The type of operation that generated the action code. This could be:

Variables

Operation

Operation: object

An enumeration of the possible email action types.

Type declaration

  • EMAIL_SIGNIN: Operation

    The email link sign-in action.

  • PASSWORD_RESET: Operation

    The password reset action.

  • RECOVER_EMAIL: Operation

    The email revocation action.

  • VERIFY_EMAIL: Operation

    The email verification action.