sendEmailLink

suspend fun SignIn.sendEmailLink(emailAddressId: String? = null): ClerkResult<SignIn, ClerkErrorResponse>

Sends a verification link to the user's email address for first factor authentication.

This is a convenience method that prepares the email link verification strategy. The link will be sent to the email address associated with the sign-in. After the user opens the link, handle the deep link callback with com.clerk.api.auth.Auth.handle.

Return

A ClerkResult containing the updated SignIn object on success, or a ClerkErrorResponse on failure.

Parameters

emailAddressId

Optional ID of the email address to send the link to. If not provided, the email address ID will be automatically retrieved from the supported first factors.