Basic Configuration Information

Before you can do anything with TFS Spam (even the debug console project), you need to edit the appropriate configuration file.

Configuration File Information

In the Console Test project configuration file, the sections that need to be updated are marked with the <!-- !Configure! --> comment tag:

mailSettings element

This is the stanard .NET SMTP configuration section, you should enter the sender e-mail address to use as the sender address for e-mails coming from TFS Spam. You also need to provide the name of your SMTP server (or SMTP relay host).

teamProjects element

You need to specify the URL of your TFS server in the serverUrl attribute (e.g. Additionally, each TFS project that e-mails should be sent for needs to be listed as an individual project element with the name of the project in the name attribute and the fully qualified TFS path of the file containing the e-mail addresses of the subscribers for the e-mail notifications in the subscribersItemPath attribute.

ignoreUsers element

You can define the user name of users whose changesets should be ignored for notification purposes. This is useful if you have changesets created as part of your build process for instance.

listeners element

This element defines (among other things) the path of the log file TFS Spam uses. TFS Spam uses the Enterprise Application Block Logging library, so this should be relatively straight-forward.

Configuring the web service

There is no installer for the web service, so you'll need to manually configure it in IIS. Once the service is up and running, you need to register it with TFS. You can use a batch file similar to this to register it:

@echo off
echo Registering the TFS Spam service for checkin events
"C:\Program Files\Microsoft Visual Studio 2008 Team Foundation Server\TF Setup\bissubscribe" /eventType CheckinEvent /address http://mytfsspamhost:8081/checkin/checkinevent.asmx /deliveryType Soap /server http://mytfsserver:8080 > "C:\TFS Spam Logs\LastRegisteredEventHandler.txt"
type "C:\TFS Spam Logs\LastRegisteredEventHandler.txt"

This batch file writes the subscription id to a log file so you can use it to unsubscribe from the events should you need to.

Last edited Nov 9, 2009 at 10:49 PM by mlanner, version 2


No comments yet.