Configure Email

Prev Next

Your workspace needs a working email server to send invitations, verification emails, password resets, and two-factor authentication (2FA) codes. This guide shows you how to connect your SMTP server, test the connection, and turn on the email-based security settings.

Cloud-hosted workspaces come with email pre-configured, so you can skip the SMTP steps. To turn on email verification, go straight to Step 3.

Self-managed workspaces are deployed on your own infrastructure. Cloud-hosted workspaces use Rocket.Chat's cloud-hosting service.

Before you begin

Get these details from your email provider or IT team:

  • The SMTP server hostname and port

  • A username and password for the SMTP server

  • The email address to send from, for example, no-reply@example.com

Configure SMTP settings

Step 1: Enter the SMTP settings

  1. Go to Manage → Workspace → Settings → Email.

  2. Expand the SMTP section.

  3. Fill in the fields:

Field

Description

Protocol

Select smtp or smtps, as your provider requires. Providers usually use smtp on port 587 and smtps on port 465.

Host

Your SMTP server hostname, for example, mail.example.com.

Port

The SMTP port. Most modern secured SMTP servers use 587.

IgnoreTLS

On by default, and only applies when Protocol is smtp. When it's on, emails are sent without TLS encryption. Turn it off if your provider supports TLS, which most providers do.

Pool

On by default. Reuses connections to the SMTP server. When it's off, a new connection is opened for every email.

Username

Your SMTP username.

Password

Your SMTP password.

From email

The address that appears as the sender on all outgoing emails.

Click Save changes.

Step 2: Send a test email

Click Send a test mail to my user. Rocket.Chat sends a test email to the email address of your own account.

If the email doesn't arrive, check your spam folder and the SMTP details. To find the cause of the error, check the workspace logs.

Step 3: Turn on email-based security

Now that email works, you can turn on the security settings that depend on it. For details on each setting, see Secure Sign-up and Sign-in.

  • Email verification: To require new users to verify their email address before they can sign in, go to Manage → Workspace → Settings → Accounts → Registration and turn on Require email verification to login.

  • Two-factor authentication by email: This is on by default. From now on, users with a verified email address receive their 2FA codes by email.

Before you turn on Require email verification to login, check that your existing users, including your own admin account, have verified email addresses. To mark a user's email as verified, edit the user on the Users page and turn on Mark email as verified.


Customize your emails (optional)

You can change how emails look and what they say, and set up other email features. You don't need to do this during setup.

Next steps

Add your organization's branding before you invite users, so they see it from their first sign-in. For instructions, see White-labeling & Customizing Your Workspace.