ConfigureMail Command

You can support the generation of automatic alerts when changes occur to work items and other conditions by configuring the mail server. The mail server that you specify supports all team projects defined for all project collections that are defined on the application-tier server where you run the command. For e-mail notifications to be sent to team members, you must configure the server that runs Team Foundation Server (TFS) to use an existing SMTP server by using the ConfigureMail command.

Required Permissions

To use the ConfigureMail command, you must be a member of the Team Foundation Administrators security group on the Team Foundation application-tier server. For more information, see Permission reference for Team Foundation Server.

Note

Even if you log on with administrative permissions, you must open an elevated Command Prompt window to perform this function.

TFSConfig ConfigureMail /FromEmailAddress:emailAddress /SmtpHost:SMTPHostName

Parameters

Option

Description

/FromEmailAddress:emailAddress

Specifies the address from which to send e-mail notifications from TFS for a check in, work item assigned to you, or other notifications. This address is also checked for validity and, depending on your server configuration, might have to represent a valid e-mail account on the mail server.

If the address does not exist or is not valid, the default e-mail address is used.

/SmtpHost:SMTPHostName

Specifies the name of the server that hosts the mail server.

Example

The following example shows the syntax used to configure the from e-mail address to TFS@contoso.com and the SMTP mail server as ContosoMailServer:

Note

The examples are for illustration only and are fictitious. No real association is intended or inferred.

TFSConfig ConfigureMail /FromEmailAddress:TFS@contoso.com /SmtpHost:ContosoMailServer

See Also

Other Resources

Configure an SMTP server to support alerts and feedback requests

Command-line tools for TFS