SudoSOS Back-end API / notifications/channels/mail-channel / EmailChannel

Class: EmailChannel

A channel capable of delivering a notification (email, signal, SMS, etc.) using a specific template type, parameter type, and rendered output type.

Extends

• NotificationChannel<EmailTemplate<any>, TemplateOptions, MailMessage<EmailTemplate<any>>>

Constructors

Constructor

new EmailChannel(): EmailChannel;

Returns

EmailChannel

Inherited from

NotificationChannel.constructor

Properties

Property	Modifier	Type	Default value	Overrides
name	readonly	EMAIL	NotificationChannels.EMAIL	NotificationChannel.name
templates	readonly	object	undefined	NotificationChannel.templates
templates.ChangedPin	public	EmailTemplate<ChangedPinOptions>	ChangedPinTemplate	-
templates.ForgotEventPlanning	public	EmailTemplate<ForgotEventPlanningOptions>	ForgotEventPlanningTemplate	-
templates.HelloWorld	public	EmailTemplate<HelloWorldOptions>	HelloWorldTemplate	-
templates.InactiveAdministrativeCostNotification	public	EmailTemplate<InactiveAdministrativeCostNotificationOptions>	InactiveAdministrativeCostNotificationTemplate	-
templates.MembershipExpiryNotification	public	EmailTemplate<MembershipExpiryNotificationOptions>	MembershipExpiryNotificationTemplate	-
templates.PasswordReset	public	EmailTemplate<WelcomeWithResetOptions>	PasswordResetTemplate	-
templates.TransactionNotificationChargedByOther	public	EmailTemplate<TransactionNotificationOptions>	TransactionNotificationTemplate	-
templates.TransactionNotificationSelf	public	EmailTemplate<TransactionNotificationOptions>	TransactionNotificationTemplate	-
templates.UserDebtNotification	public	EmailTemplate<UserDebtNotificationOptions>	UserDebtNotificationTemplate	-
templates.UserGotFined	public	EmailTemplate<UserGotFinedOptions>	UserGotFinedTemplate	-
templates.UserGotInactiveAdministrativeCost	public	EmailTemplate<UserGotInactiveAdministrativeCostOptions>	UserGotInactiveAdministrativeCostTemplate	-
templates.UserTypeUpdated	public	EmailTemplate<UserTypeUpdatedOptions>	UserTypeUpdatedTemplate	-
templates.UserTypeUpdatedWithReset	public	EmailTemplate<UserTypeUpdatedWithResetOptions>	UserTypeUpdatedWithResetTemplate	-
templates.UserWillGetFined	public	EmailTemplate<UserWillGetFinedOptions>	UserWillGetFinedTemplate	-
templates.WelcomeToSudosos	public	EmailTemplate<WelcomeToSudososOptions>	WelcomeToSudososTemplate	-
templates.WelcomeWithReset	public	EmailTemplate<WelcomeWithResetOptions>	WelcomeWithResetTemplate	-

Methods

apply()

apply(template, params): Promise<MailMessage<EmailTemplate<any>>>;

Parameters

Parameter	Type
template	EmailTemplate<any>
params	TemplateOptions

Returns

Promise<MailMessage<EmailTemplate<any>>>

Overrides

NotificationChannel.apply

---

getTemplate()

getTemplate(type): EmailTemplate<any>;

Parameters

Parameter	Type
type	string

Returns

EmailTemplate<any>

Inherited from

NotificationChannel.getTemplate

---

log()

log(user, code): Promise<void>;

Parameters

Parameter	Type
user	User
code	NotificationTypes

Returns

Promise<void>

Inherited from

NotificationChannel.log

---

send()

send(user, email): Promise<void>;

Parameters

Parameter	Type
user	User
email	MailMessage<EmailTemplate<any>>

Returns

Promise<void>

Overrides

NotificationChannel.send

---

supports()

supports(type): boolean;

Parameters

Parameter	Type
type	string

Returns

boolean

Inherited from

NotificationChannel.supports