Skip to main content

Configuration

Default configuration keys for @quik/communication. See Config Keys for the full generated table.

Each channel (communication.email, communication.sms, communication.whatsapp) shares the same shape:

  • enabled — whether QCommunicationEngine.send actually dispatches (send is a silent no-op when false).
  • engine — default engine name resolved by GetEmailEngine()/GetSMSEngine()/GetWhatsAppEngine() when no name is given.
  • from — default sender used by the engine.
  • config.* — provider-specific credentials (SMTP address/password/server/port/secure for email, client identifier/secret for SMS, access token/phone number identifier for WhatsApp).
  • timeoutMilliseconds — per-send timeout; 0 disables the timeout.
  • retry.attempts / retry.delayMilliseconds / retry.backoffFactor — retry policy applied around each provider call.

Built-in engines registered by @quik/communication's setup:

  • Email: test (QTestEmailEngine), smtp (QSMTPEmailEngine) — only registered if nodemailer is installed.
  • SMS: test (QTestSMSEngine), vonage/twilio — only registered if their respective client packages are installed.
  • WhatsApp: test (QTestWhatsAppEngine), meta (QMetaWhatsAppEngine).