Understanding SMTP profiles in VisualSVN Server

Applies to: VisualSVN Server 5.0 and later

This article describes VisualSVN Server SMTP profile settings. You can find these settings on the Email Settings tab in the VisualSVN Server Properties dialog.

VisualSVN Server can use an SMTP server to deliver email messages to users. For this to be possible, VisualSVN Server needs to have an SMTP profile configured. VisualSVN Server allows having several such profiles, with each one being used for email notifications about different kinds of events. For example, one profile to notify an administrator of the background job completion, and the other to notify users of new commits via a post-commit email notifications hook.

By default, VisualSVN Server does not have any SMTP profiles. To configure a new profile, click Add on the Email Settings tab, or click Edit to make changes to an existing profile.

SMTP profile settings

The SMTP profile configuration consists of several settings that are described below.

Tip

You may need to contact your system administrator or service provider to find out the outgoing SMTP server settings.

Profile name

Profile name is a name by which a profile is referred to. Pick any name that is convenient to use.

Profile description

Profile description may contain any additional information. Use this field to optionally include a description of the profile’s purpose.

SMTP server name

This field specifies an SMTP server name. For example: smtp.contoso.com

SMTP port

This field specifies the TCP port that will be used for email submission. SMTP servers commonly use the TCP port 25 or 587. Specify a custom port if necessary.

Enable and require TLS encryption (STARTTLS)

This option allows you to choose whether an SMTP session will be encrypted with TLS. It is strongly recommended that messages between VisualSVN Server and an SMTP server are sent over an encrypted connection.

When the Enable and require TLS encryption (STARTTLS) check box is selected, VisualSVN Server issues a STARTTLS command to negotiate the use of TLS encryption with the SMTP server. The email message is submitted to the SMTP server only after establishing an encrypted connection. If the encrypted connection cannot be established, the submission will be canceled.

When the Enable and require TLS encryption (STARTTLS) check box is cleared, VisualSVN Server does not issue a STARTTLS command. As a result, the connection will not be encrypted. Instead, an email message and authentication details will be sent to the SMTP server in plain text.

Note

Some SMTP servers may refuse to accept an email message if the connection is not encrypted.

Default mail from address

This value specifies the default SMTP sender's email address. This is the default address that will be used as the origin (From:) of the email messages unless overridden by a more specific setting.

For example: john.doe@contoso.com

SMTP authentication

Some SMTP servers require that clients perform authentication prior to email submission. Select one of the options below depending on your SMTP server authentication settings. Contact your network administrator or service provider to obtain these settings.

Anonymous authentication

Select this option if your SMTP server does not require authentication.
Basic authentication

Select this option if your SMTP server requires authentication. Provide your credentials using the Username and Password fields.

Note
It is strongly recommended to use Basic authentication along with the Enable and require TLS (STARTTLS) option. This ensures that credentials are always sent in a secure fashion.

Send test email

Use the Send test email button to check that the profile works as expected. In the opened dialog, enter an email address that you want to send the test email to, and click OK. Receiving the test email confirms that the profile was configured correctly.