Class BaseEmailSender

Sends e-mails using nodemailer.

Hierarchy

EmailSender
- BaseEmailSender

Index

Constructors

constructor

Properties

Methods

Constructors

constructor

new BaseEmailSender(args: EmailSenderArgs): BaseEmailSender

Overrides EmailSender.constructor
- Defined in src/identity/interaction/util/BaseEmailSender.ts:23
Parameters
- args: EmailSenderArgs
Returns BaseEmailSender

Properties

Private Readonly mailTransporter

mailTransporter: Mail<any>

Private Readonly senderName

senderName: string

Methods

canHandle

canHandle(input: EmailArgs): Promise<void>

Inherited from EmailSender.canHandle
- Defined in src/util/handlers/AsyncHandler.ts:13
Checks if the input data can be handled by this class. Throws an error if it can't handle the data.

Parameters
- input: EmailArgs
  
  Input data that could potentially be handled.
Returns Promise<void>

A promise resolving if the input can be handled, rejecting with an Error if not.

handle

handle(__namedParameters: EmailArgs): Promise<void>

Overrides EmailSender.handle
- Defined in src/identity/interaction/util/BaseEmailSender.ts:31
Handles the given input. This should only be done if the canHandle function returned true. Therefore, consider using the handleSafe function instead.

Parameters
- __namedParameters: EmailArgs
Returns Promise<void>

A promise resolving when the handling is finished. Return value depends on the given type.

handleSafe

handleSafe(input: EmailArgs): Promise<void>

Inherited from EmailSender.handleSafe
- Defined in src/util/handlers/AsyncHandler.ts:35
Helper function that first runs the canHandle function followed by the handle function. Throws the error of the canHandle function if the data can't be handled, or returns the result of the handle function otherwise.

Parameters
- input: EmailArgs
  
  Input data that will be handled if it can be handled.
Returns Promise<void>

A promise resolving if the input can be handled, rejecting with an Error if not. Return value depends on the given type.