Checkmate

Email configuration

SMTP server setup for notifications.

Overview

Checkmate needs an SMTP server to send email notifications and team invitations. Configure it once under Settings > Email. The settings build an SMTP transport for NodeMailer.

Email (SMTP) settings

Set it up

  1. Open Settings in the sidebar and select the Email tab.
  2. Enter the server hostname and port.
  3. Enter the authentication credentials.
  4. Adjust the TLS options if your server needs it.
  5. Click Send test email to verify, then Save.
Note

Only Admins and Superadmins can configure SMTP settings.

Connection

FieldNotes
Email hostHostname or IP address to connect to, e.g. smtp.gmail.com
Email portPort to connect to, e.g. 587
Email connection hostHostname used in the HELO/EHLO greeting. Defaults to localhost

Authentication

FieldNotes
Email addressUsed for authentication and as the sender address
Email userUsername for authentication. Overrides the email address if set
Email passwordPassword for authentication. Once saved, the field shows that it is set. Click Reset to change it
Sender nameOptional friendly name shown in the From field, e.g. Checkmate notifications

TLS and connections

FieldNotes
Use SSLEncrypt the connection using SSL/TLS. Recommended
Force STARTTLSRequire a TLS upgrade and fail if the server does not support it
Disable STARTTLSDo not use TLS even if the server supports it
Reject invalid certificatesReject self-signed or untrusted certificates. Turn this off only for an internal server with its own CA
TLS servernameHostname used for TLS validation when the host is an IP address
Enable connection poolingReuse existing connections to improve performance
Warning

Force STARTTLS and Disable STARTTLS are opposites, enabling both leaves the connection unencrypted. If your provider requires TLS on a non-SSL port, use Force STARTTLS and leave Disable STARTTLS off.

For an internal mail server with a private CA, see Custom CA trust.

See also