Docs
Notifications
Email

Email service configuration guide

In JumpServer, the email server is an essential configuration and it is strongly recommended to enable and properly set it up. It is primarily used for communication between the system and users, including account security, notification alerts, and system warnings.

JumpServer supports configuring the email server in two ways: using the standard SMTP protocol or Microsoft Exchange Server.

Configuration guide

1.

In the right area of the top navigation bar, click .

image
2.

In the left menu, click Notifications.

3.

On the right page, click Email tab.

4.

Type the email configuration. About configuration parameters, see Configuration parameters.

5.

Click Submit.

Configuration parameters

Service

  • SMTP

    Standard SMTP protocol

  • Microsoft Exchange Server

    A mail server developed by Microsoft.

Host

required

Email server host address.

Port

required

(SMTP only) Email server port.

Account

Email server authentication account.

Password

Email server authentication account password.

Sender

The sender used to send emails. If not specified, the Account will be used by default.

Use ssl/tls

(SMTP only) Encrypts the communication between the email client and server to protect the email content and account information.

  • None

    No encryption — plain text transmission (low security).

  • SSL

    SSL (Secure Sockets Layer) is an older protocol for establishing secure connections.

  • TLS

    TLS (Transport Layer Security) is an improved version of SSL, providing stronger security.

Template

Email templates are used to provide consistent content and formatting when sending emails.

General

General fields included in every email.

Subject prefix

required

Specifies a prefix to insert at the start of the email subject.

e.g., [JumpServer]

Creating User Content

The following fields are only used in emails sent upon successful user creation.

Subject

Email subject.

e.g., Create account successfully

Honorific

Email honorific.

e.g., Dear / Hello

Content

Email content.

You can use the variables {name}, {username}, and {email} to specify the corresponding user information.

Recipient

This is used only for receiving test emails. Only one email address can be entered at a time.

Test the email service

1.

Finish configuring the email service and submit the form.

Note

Please submit the configuration information before testing.

2.

In the Recipient field, type the email address to which you want to send a test email.

3.

Click Test connection.