Connectors

SMTP Connector

The SMTP connector configures the outgoing email server used by Kiwire for all system-generated emails. Without a working SMTP configuration, email-based features — OTP delivery, welcome messages, password resets, voucher notifications, and security alerts — are unavailable. The connector supports any standards-compliant SMTP server, including cloud relay services like Amazon SES, SendGrid, Mailgun, and Microsoft 365.

'alt' => 'Dashboard overview', 'caption' => 'The default Kiwire dashboard layout', 'screenshot' => true, 'class' => '', ]) Drop images into: public/assets/img/docs/{page}/{filename} --}}
Image not uploaded yet public/assets/img/docs/connector-smtp/overview.png
The SMTP connector configuration — server details, encryption, authentication, and sender identity.

Configuration Fields

FieldDescription
hostSMTP server hostname or IP address (e.g., smtp.gmail.com, email-smtp.ap-southeast-1.amazonaws.com, smtp.office365.com)
portSMTP port number. Common values: 25 (unauthenticated relay, often blocked), 465 (SMTPS / SSL), 587 (STARTTLS / TLS submission — recommended).
encryptionTransport encryption type: none (plain SMTP), ssl (SMTPS on port 465), tls (STARTTLS on port 587). Always use ssl or tls in production.
usernameSMTP authentication username. For most cloud providers this is the full sender email address or an API key value.
passwordSMTP authentication password or API secret. Stored encrypted at rest. Never logged or displayed after saving.
from_addressThe sender email address shown in the From header of all outgoing emails (e.g., noreply@yourcompany.com). Must be an address authorised to send from the configured SMTP server.
from_nameThe sender display name shown alongside the from address in email clients (e.g., Kiwire WiFi or your organisation name).

Port and Encryption Reference

PortEncryptionWhen to use
25NoneServer-to-server relay only. Rarely suitable for application-level email sending. Many ISPs and cloud providers block outbound port 25.
465SSL (SMTPS)Legacy SSL-wrapped SMTP. Still supported by many providers. Use encryption = ssl.
587TLS (STARTTLS)Modern standard for authenticated email submission. Recommended for all cloud relay services. Use encryption = tls.
2525TLSAlternative port used by some providers (Mailgun, SendGrid) when port 587 is blocked by hosting firewalls.

What SMTP Powers

A working SMTP connector enables the following Kiwire features:

FeatureEmail sent
Email OTP loginOne-time password code to the user's registered email address
New user welcomeAccount confirmation and login details on first registration
Voucher by emailVoucher code and access instructions delivered directly to the guest
Admin password resetSecure password reset link to the admin's registered email
Security alertsFailed login threshold alerts, MFA disabled notifications, superuser activity warnings
Account expiry noticeReminder email to users approaching their account expiry date

If the SMTP connector is not configured or is disabled, email-dependent login methods (Email OTP) will be unavailable on the captive portal, and admin password reset will not function. Admins will see a configuration warning banner on affected pages.

Testing the Configuration

After saving, click Send Test Email to verify the configuration. Enter any valid recipient email address — Kiwire will attempt to connect to the SMTP server, authenticate, and deliver a test message. The test result shows:

  • Success — test email delivered; the Last Tested timestamp updates on the connector card
  • Connection refused — check host and port; ensure firewall allows outbound traffic to the SMTP server
  • Authentication failed — check username and password; for Gmail, ensure an App Password is used (not your account password) when 2FA is enabled
  • Certificate error — the SMTP server's SSL/TLS certificate is not trusted; ensure the server presents a valid, non-expired certificate signed by a public CA

For Gmail personal accounts, use an App Password (Google Account → Security → App Passwords) rather than your main account password. For Google Workspace, use a dedicated service account or configure Gmail SMTP relay in the Admin Console to avoid per-user App Password management.

Common Cloud Provider Settings

ProviderHostPortEncryption
Amazon SESemail-smtp.{region}.amazonaws.com587tls
SendGridsmtp.sendgrid.net587tls
Mailgunsmtp.mailgun.org587tls
Microsoft 365smtp.office365.com587tls
Gmailsmtp.gmail.com587tls
Brevo (Sendinblue)smtp-relay.brevo.com587tls

Required Permissions

view-connector-smtp · edit-connector-smtp