Skip to main content

emailService

Workspace API

Workspace API / services/emailService

services/emailService

Classes​

EmailService​

Defined in: services/emailService.ts:241

Constructors​

Constructor​

new EmailService(): EmailService

Defined in: services/emailService.ts:246

Returns​

EmailService

Methods​

sendEmail()​

sendEmail(options, log): Promise<void>

Defined in: services/emailService.ts:255

Send an email using Mailgun

Parameters​
options​

EmailOptions

log​

Logger = logger

Returns​

Promise<void>

sendWelcomeEmail()​

sendWelcomeEmail(email, userName, organizationName, log): Promise<void>

Defined in: services/emailService.ts:300

Send welcome email to new user

Parameters​
email​

string

userName​

string

organizationName​

string

log​

Logger = logger

Returns​

Promise<void>

sendMfaCode()​

sendMfaCode(email, code, userName?, log?): Promise<void>

Defined in: services/emailService.ts:316

Send MFA verification code

Parameters​
email​

string

code​

string

userName?​

string

log?​

Logger = logger

Returns​

Promise<void>

sendPasswordResetEmail()​

sendPasswordResetEmail(email, resetUrl, userName?, log?): Promise<void>

Defined in: services/emailService.ts:332

Send password reset email

Parameters​
email​

string

resetUrl​

string

userName?​

string

log?​

Logger = logger

Returns​

Promise<void>

sendEmailVerification()​

sendEmailVerification(email, verificationUrl, userName?, log?): Promise<void>

Defined in: services/emailService.ts:348

Send email verification

Parameters​
email​

string

verificationUrl​

string

userName?​

string

log?​

Logger = logger

Returns​

Promise<void>

Interfaces​

EmailOptions​

Defined in: services/emailService.ts:231

Properties​

to​

to: string

Defined in: services/emailService.ts:232

subject​

subject: string

Defined in: services/emailService.ts:233

html​

html: string

Defined in: services/emailService.ts:234

text​

text: string

Defined in: services/emailService.ts:235

from?​

optional from: string

Defined in: services/emailService.ts:236

fromName?​

optional fromName: string

Defined in: services/emailService.ts:237

Variables​

emailTemplates​

const emailTemplates: object

Defined in: services/emailService.ts:21

Type Declaration​

welcome()​

welcome: (userName, organizationName) => object

Parameters​
userName​

string

organizationName​

string

Returns​

object

subject​

subject: string

html​

html: string

text​

text: string

mfaCode()​

mfaCode: (code, userName?) => object

Parameters​
code​

string

userName?​

string

Returns​

object

subject​

subject: string

html​

html: string

text​

text: string

passwordReset()​

passwordReset: (resetUrl, userName?) => object

Parameters​
resetUrl​

string

userName?​

string

Returns​

object

subject​

subject: string = 'Password reset request'

html​

html: string

text​

text: string

emailVerification()​

emailVerification: (verificationUrl, userName?) => object

Parameters​
verificationUrl​

string

userName?​

string

Returns​

object

subject​

subject: string = 'Verify your email address'

html​

html: string

text​

text: string

emailService​

const emailService: EmailService

Defined in: services/emailService.ts:363