lib/auth/verify-email

Functions

'Read the “', Functions, '” section'

createEmailVerificationRequest()

'Read the “', createEmailVerificationRequest(), '” section'

function createEmailVerificationRequest(userId: string): Promise<{
  expiresAt: Date;
  id: string;
  token: string;
  userId: string;
}>

Defined in: studiocms/packages/studiocms/src/lib/auth/verify-email.ts:83

Creates an email verification request for a given user.

This function first deletes any existing email verification requests for the user, and then creates a new email verification request using the studioCMS SDK.

Parameters

'Read the “', Parameters, '” section'

userId

'Read the “', userId, '” section'

string

The unique identifier of the user for whom the email verification request is being created.

Returns

'Read the “', Returns, '” section'

Promise<{ expiresAt: Date; id: string; token: string; userId: string; }>

A promise that resolves to the result of the email verification request creation.

---

deleteEmailVerificationRequest()

'Read the “', deleteEmailVerificationRequest(), '” section'

function deleteEmailVerificationRequest(id: string): Promise<void>

Defined in: studiocms/packages/studiocms/src/lib/auth/verify-email.ts:70

Deletes an email verification request by its ID.

Parameters

'Read the “', Parameters, '” section'

id

'Read the “', id, '” section'

string

The unique identifier of the email verification request to be deleted.

Returns

'Read the “', Returns, '” section'

Promise<void>

A promise that resolves when the email verification request is successfully deleted.

---

getEmailVerificationRequest()

'Read the “', getEmailVerificationRequest(), '” section'

function getEmailVerificationRequest(id: string): Promise<
  | null
  | {
  expiresAt: Date;
  id: string;
  token: string;
  userId: string;
}>

Defined in: studiocms/packages/studiocms/src/lib/auth/verify-email.ts:58

Retrieves an email verification request by its ID.

Parameters

'Read the “', Parameters, '” section'

id

'Read the “', id, '” section'

string

The unique identifier of the email verification request.

Returns

'Read the “', Returns, '” section'

Promise< | null | { expiresAt: Date; id: string; token: string; userId: string; }>

A promise that resolves to the email verification request.

---

isEmailVerificationEnabled()

'Read the “', isEmailVerificationEnabled(), '” section'

function isEmailVerificationEnabled(): Promise<boolean>

Defined in: studiocms/packages/studiocms/src/lib/auth/verify-email.ts:44

Checks if email verification is enabled in the StudioCMS configuration.

This function retrieves the notification settings from the database and returns the value of the emailVerification property. If the settings are not available, it defaults to false.

Returns

'Read the “', Returns, '” section'

Promise<boolean>

A promise that resolves to true if email verification is enabled, otherwise false.

---

isEmailVerified()

'Read the “', isEmailVerified(), '” section'

function isEmailVerified(user:
  | undefined
  | CombinedUserData
| UserSessionData): Promise<boolean>

Defined in: studiocms/packages/studiocms/src/lib/auth/verify-email.ts:165

Checks if the user’s email is verified based on various conditions.

Parameters

'Read the “', Parameters, '” section'

user

'Read the “', user, '” section'

The user data which includes email verification status and permissions.

undefined | CombinedUserData | UserSessionData

Returns

'Read the “', Returns, '” section'

Promise<boolean>

A promise that resolves to a boolean indicating whether the user’s email is verified.

The function performs the following checks:

1. If the user is undefined, returns false.
2. If the mailer is not enabled, returns true.
3. If email verification is not required in settings, returns true.
4. If OAuth bypass verification is enabled and the user has OAuth data, returns true.
5. Based on the user’s rank:
   • ‘owner’: Always returns true.
   • ‘admin’: Returns the user’s email verification status if admin verification is required, otherwise returns true.
   • ‘editor’: Returns the user’s email verification status if editor verification is required, otherwise returns true.
   • Default: Returns the user’s email verification status.

---

sendVerificationEmail()

'Read the “', sendVerificationEmail(), '” section'

function sendVerificationEmail(userId: string, isOAuth: boolean): Promise<
  | undefined
| MailerResponse>

Defined in: studiocms/packages/studiocms/src/lib/auth/verify-email.ts:100

Sends a verification email to the user with the given userId.

Parameters

'Read the “', Parameters, '” section'

userId

'Read the “', userId, '” section'

string

The ID of the user to send the verification email to.

isOAuth

'Read the “', isOAuth, '” section'

boolean = false

Optional. Indicates if the user is authenticated via OAuth. Defaults to false.

Returns

'Read the “', Returns, '” section'

Promise< | undefined | MailerResponse>

A promise that resolves to the response of the mail sending operation.

Throws

'Read the “', Throws, '” section'

Will throw an error if the user is not found, if the verification token creation fails, or if the user does not have an email.