Skip to content

whpptjs/whppt-api-express

Repository files navigation

@whppt/api-express

npm version npm downloads Github Actions CI Codecov License

Full Documentation Coming Soon.

📖 Release Notes

Table of Contents

Features

Email

The email service is a provider for a few email options. The following providers are available:

  • Fake: The fake provider is the default. It is used when no EMAIL_PROVIDER env var is supplied. It does not send an email but logs the email object. To see the log turn on the whppt:* debug env var. eg: DEBUG=whppt:*
  • AwsSmpt: The aws smpt provider sends and email using aws smtp. To use it sent EMAIL_PROVER=AwsSmtp.

The following env vars are used for the AwsSmtp provider:

  • SMTP_HOST
  • SMTP_PORT
  • SMTP_AUTH_USER
  • SMTP_AUTH_PASS
  • SMTP_SECURE
  • SMTP_TLS
  • EMAIL_FROM_NAME
  • EMAIL_FROM_ADDRESS

Usage

Options

License

MIT License

Powered By Vercel