EmailAddress
verification
These are all methods on the EmailAddress
class that allow you to verify a user's email address.
prepareVerification()
function prepareVerification(params: PrepareEmailAddressVerificationParams): Promise<EmailAddress>;
Kick off the verification process for this email address. An email message with a one-time code or a magic-link will be sent to the email address box.
PrepareEmailAddressVerificationParams
Name | Type | Description |
---|---|---|
strategy | 'email_link' | 'email_code' | The verification strategy. Possible strategy values are:
|
redirectUrl | string | undefined | The magic link target URL. Users will be redirected here once they click the magic link from their email. This param only applies if strategy is email_link . |
attemptVerification()
function attemptVerification(params: AttemptEmailAddressVerificationParams): Promise<EmailAddress>;
Attempts to verify this email address, passing the one-time code that was sent as an email message. The code will be sent when calling the EmailAddress.prepareVerification() method.
AttemptEmailAddressVerificationParams
Name | Type | Description |
---|---|---|
code | string | The one-time code that was sent to the user's email address when EmailAddress.prepareVerification() was called with strategy set to email_code . |