Clerk Android API/com.clerk.api.emailaddress/EmailAddress

EmailAddress

@Serializable

data class EmailAddress(val id: String, val emailAddress: String, val verification: Verification? = null, val linkedTo: List<EmailAddress.LinkedEntity>? = null, val createdAt: Long? = null)

The EmailAddress object represents an email address associated with a user.

This class provides methods to create, retrieve, verify, and delete email addresses.

Parameters

id

The unique identifier for the email address.

emailAddress

The email address value.

verification

The verification status of the email address.

linkedTo

A list of linked accounts or identifiers associated with this email address.

createdAt

The creation timestamp of the email address, as a Unix timestamp in milliseconds.

Constructors

constructor(id: String, emailAddress: String, verification: Verification? = null, linkedTo: List<EmailAddress.LinkedEntity>? = null, createdAt: Long? = null)

Types

object Companion

@Serializable

data class LinkedEntity(val id: String, val type: String)

PrepareVerificationParams

sealed interface PrepareVerificationParams

Properties

@SerialName(value = "created_at")

val createdAt: Long?

Created at timestamp

@SerialName(value = "email_address")

val emailAddress: String

The email address value.

The unique identifier for the email address.

val EmailAddress.isPrimary: Boolean

Convenience function to tell whether the email is the user's primary email.

val EmailAddress.isVerified: Boolean

Convenience function to tell whether the email is verified.

@SerialName(value = "linked_to")

val linkedTo: List<EmailAddress.LinkedEntity>?

A list of linked accounts or identifiers associated with this email address.

val verification: Verification?

The verification status of the email address.

Functions

attemptVerification

suspend fun EmailAddress.attemptVerification(code: String): ClerkResult<EmailAddress, ClerkErrorResponse>

Attempts to verify the email address with the given code.

suspend fun EmailAddress.delete(): ClerkResult<DeletedObject, ClerkErrorResponse>

Deletes the EmailAddress from the server.

suspend fun EmailAddress.get(): ClerkResult<EmailAddress, ClerkErrorResponse>

Retrieves the EmailAddress from the server.

prepareVerification

suspend fun EmailAddress.prepareVerification(params: EmailAddress.PrepareVerificationParams): ClerkResult<EmailAddress, ClerkErrorResponse>

Prepares the email address for verification using the specified strategy.

suspend fun EmailAddress.sendCode(): ClerkResult<EmailAddress, ClerkErrorResponse>

Sends a verification code to this email address.

suspend fun EmailAddress.verifyCode(code: String): ClerkResult<EmailAddress, ClerkErrorResponse>

Verifies this email address using the provided verification code.