Module

Email Utilities

This module contains functions for sending emails.

View Source API/src/utils/email/email.js, line 1

Requires

  • module:nodemailer

Methods

# async static sendEmail() → {Promise}

This function sends an email to the specified email address.

Parameters:
Name Type Description
options.email string

Email address to send email to

options.subject string

Subject of the email

options.message string

Message to send in the email

options.html string

HTML to send in the email

View Source API/src/utils/email/email.js, line 24

Throws an error if the email could not be sent

Error

Promise object represents the result of sending the email

Promise