Class EmailChannel

constructor

• new EmailChannel(name: string, mailer: IMailer): EmailChannel

  Parameters

  • name: string
  • mailer: IMailer

  Returns EmailChannel

Readonlyname

isHealthy

• isHealthy(): Promise<boolean | undefined>

  Reports the mail transport's reachability by asking the injected IMailer, which is the only channel in this package whose transport offers a side-effect-free probe.

  isHealthy is optional on IMailer, so an injected mailer that does not implement it — an application's own stub, or a MailService over a provider with no probe — yields undefined rather than a guess.

  Returns Promise<boolean | undefined>

  true reachable, false contacted and unreachable, undefined when the mailer cannot answer

  Since

  0.6.0

send

• send(notification: NotificationMessage): Promise<void>

  Builds a MailMessage and sends it via IMailer.

  Parameters

  • notification: NotificationMessage

    The notification to send

  Returns Promise<void>

  Throws

  If to.email is absent or mailer rejects