EmailAddress
@Serializable
The EmailAddress object represents an email address associated with a user.
Constructors
Link copied to clipboard
constructor(id: String, emailAddress: String, verification: Verification? = null, linkedTo: List<EmailAddress.LinkedEntity>? = null)
Properties
Link copied to clipboard
The email address value.
Link copied to clipboard
Convenience function to tell whether the email is the user's primary email.
Link copied to clipboard
Convenience function to tell whether the email is verified.
Link copied to clipboard
A list of linked accounts or identifiers associated with this email address.
Link copied to clipboard
The verification status of the email address.
Functions
Link copied to clipboard
suspend fun EmailAddress.attemptVerification(code: String): ClerkResult<EmailAddress, ClerkErrorResponse>
Attempts to verify the email address with the given code.
Link copied to clipboard
Deletes the EmailAddress from the server.
Link copied to clipboard
Retrieves the EmailAddress from the server.
Link copied to clipboard
suspend fun EmailAddress.prepareVerification(params: EmailAddress.PrepareVerificationParams): ClerkResult<EmailAddress, ClerkErrorResponse>
Prepares the email address for verification using the specified strategy.