Removed useless functions and updated comments

ref #151
This commit is contained in:
Nicolai Ort 2021-03-04 16:13:36 +01:00
parent 9a1678acf0
commit ada679823c

View File

@ -4,14 +4,14 @@ import { MailSendingError } from './errors/MailErrors';
/** /**
* This class is responsible for all things mail sending. * This class is responsible for all things mail sending.
* This uses the mail emplates from src/static/mail_templates * This uses axios to communicate with the mailer api (https://git.odit.services/lfk/mailer).
*/ */
export class Mailer { export class Mailer {
public static base: string = config.mailer_url; public static base: string = config.mailer_url;
public static key: string = config.mailer_key; public static key: string = config.mailer_key;
/** /**
* Function for sending a test mail from the test mail template. * Function for sending a password reset mail.
* @param to_address The address the mail will be sent to. Should always get pulled from a user object. * @param to_address The address the mail will be sent to. Should always get pulled from a user object.
* @param token The requested password reset token - will be combined with the app_url to generate a password reset link. * @param token The requested password reset token - will be combined with the app_url to generate a password reset link.
*/ */
@ -25,17 +25,4 @@ export class Mailer {
throw new MailSendingError(); throw new MailSendingError();
} }
} }
/**
* Function for sending a test mail from the test mail template.
* @param to_address The address the test mail will be sent to - this is the configured from-address by default.
*/
public static async sendTestMail(locale: string = "en") {
try {
await axios.post(`${Mailer.base}/test?locale=${locale}&key=${Mailer.key}`);
} catch (error) {
throw new MailSendingError();
}
}
} }