Options
All
  • Public
  • Public/Protected
  • All
Menu

External module "src/crud/email"

Index

Functions

Const checkIfNewEmail

  • checkIfNewEmail(email: string): Promise<void>
  • Parameters

    • email: string

    Returns Promise<void>

Const createEmail

  • createEmail(email: Email, sendVerification?: boolean, sendPasswordSet?: boolean): Promise<InsertResult>
  • Create a new email for a user

    Parameters

    • email: Email
    • Default value sendVerification: boolean = true

      Whether to send an email verification link to new email

    • Default value sendPasswordSet: boolean = false

    Returns Promise<InsertResult>

Const deleteAllUserEmails

  • deleteAllUserEmails(userId: string): Promise<any>
  • Delete a user's email

    Parameters

    • userId: string

    Returns Promise<any>

Const deleteEmail

  • deleteEmail(id: string): Promise<any>
  • Delete a user's email

    Parameters

    • id: string

    Returns Promise<any>

Const getEmail

  • getEmail(id: string): Promise<Email>
  • Get details about a user's email

    Parameters

    • id: string

    Returns Promise<Email>

Const getEmailObject

  • getEmailObject(email: string): Promise<Email>
  • Get the detailed email object from an email

    Parameters

    • email: string

    Returns Promise<Email>

Const getUserBestEmail

  • getUserBestEmail(userId: string): Promise<string>
  • Gets the best email to get in touch with a user

    Parameters

    • userId: string

    Returns Promise<string>

Const getUserEmails

  • getUserEmails(userId: string): Promise<Email[]>
  • Get a list of all emails added by a user

    Parameters

    • userId: string

    Returns Promise<Email[]>

Const getUserPrimaryEmail

  • getUserPrimaryEmail(user: User | string): Promise<string>
  • Get a user's primary email

    Parameters

    • user: User | string

    Returns Promise<string>

Const getUserPrimaryEmailObject

  • getUserPrimaryEmailObject(user: User | string): Promise<Email>
  • Get a user's primary email's detailed object

    Parameters

    • user: User | string

    Returns Promise<Email>

Const getUserVerifiedEmails

  • getUserVerifiedEmails(user: User | string): Promise<Email[]>
  • Get a list of all verified emails of a user

    Parameters

    • user: User | string

    Returns Promise<Email[]>

Const getVerifiedEmailObject

  • getVerifiedEmailObject(email: string): Promise<Email>
  • Get the detailed email object from a verified email

    Parameters

    • email: string

    Returns Promise<Email>

Const resendEmailVerification

  • resendEmailVerification(id: string): Promise<void>
  • Resend an email verification link

    Parameters

    • id: string

    Returns Promise<void>

Const sendEmailVerification

  • sendEmailVerification(id: string, email: string, user: User): Promise<void>
  • Send an email verification link

    Parameters

    • id: string
    • email: string
    • user: User

    Returns Promise<void>

Const updateEmail

  • updateEmail(id: string, email: KeyValue): Promise<any>
  • Update a user's email details

    Parameters

    Returns Promise<any>

Generated using TypeDoc