How to: Configure SMTP Server and E-mail Notification Settings in the Services Web.Config File

You can configure Team Foundation Server to use an existing SMTP server to send e-mail alerts. Users can configure alerts for various project, work item, and build event notifications. Although you can specify the SMTP server during Team Foundation Server installation, you might want to change the STMP server later. Similarly, if you to change the application pool service account by using the TFSAdminUtil ChangeAccount command, you must manually change the sender account e-mail address to the new service account's e-mail address.

Note

The content of Team Foundation Server alert e-mails is not customizable. The content of the e-mails is automatically generated from the TeamFoundation.xsl file. Modifying this file is not recommended. If you do modify the contents of this file, be sure to thoroughly test your modifications. Incorrect modifications of this file can result in the failure of Team Foundation Server e-mail alerts and the inability to view Team Foundation work items, changesets, or files in a Web browser.

Required Permissions

To perform this procedure, you must be a member of the Administrators group on the Team Foundation application-tier server. For more information, see Team Foundation Server Permissions.

Note

Do not use the ASP.NET tab of the Internet Information Services (IIS) Manager (inetmgr) to edit a configuration file. If you use this tab, an attribute is added to the configuration element of the configuration file. This attribute interferes with normal functioning.

To designate or change the SMTP server for sending e-mail alerts

  1. On the application-tier server for Team Foundation, locate the installation directory for the application tier.

  2. Open the Web Services directory, and then open the Services subdirectory.

  3. In a text or XML editor, open the Web.Config file, and locate the <add key="smtpServer"> element.

  4. Update the element by typing the fully qualified domain name of the SMTP server. For example, type the following string:

    <add key="smtpServer" value="SMTPServerLocation" />
    
  5. Save and close the Web.Config file.

    You must close and restart the Web services application for Team Foundation before your changes will take effect.

To designate or change the sender e-mail address for e-mail alerts

  1. On the application-tier server for Team Foundation, locate the installation directory for the application tier.

  2. Open the Web Services directory, and then open the Services subdirectory.

  3. In a text or XML editor, open the Web.Config file, and locate the <add key="emailNotificationFromAddress"> element.

  4. Update the element by typing the e-mail address that is associated with the service account (for example, Domain/TFSService). that is used for the application pool identity for Team Foundation. For example, type the following string:

    <add key="emailNotificationFromAddress" value="TFSService@domain.com" />
    
  5. Save and close the file.

    You must close and restart the Web services application for Team Foundation before your changes will take effect.

See Also

Tasks

How to: Add or Edit Alerts
How to: Receive Build Notification E-Mail

Reference

ChangeAccount Command

Concepts

Services Web.Config File Settings in Team Foundation Server Components
Managing and Resetting Service Accounts and Passwords

Other Resources

TFSAdminUtil Command-Line Commands