Email Publisher¶

Publishes results of integrations via email. This implementation supports plain-text, and Html email formats. Rules regarding who receives email are configurable.

The email publisher can be used to send email to any number of users. It is common to include one user who gets an email for every build and then also send email to every developer who checked code in for this build.

tip

People tend to prefer to use CCTray rather than email for instant notification these days.

warning

Make sure that all of the Merge Publishers, along with the Xml Log Publisher task are done before the <email> publisher, or else you won't be able to include output from the build in the email. A common mistake is to put the email task in the <tasks> section instead of the <publishers> section. If an error occurs in the <tasks> section, the remaining tasks in that section are skipped, and CC.Net goes right to the <publishers> section. So if you put the <email> tasks in the <tasks> section, you'll never get any failure messages.

Version¶

Available from version 1.0

Examples¶

 1<email mailport="25" includeDetails="TRUE" mailhostUsername="smtpuser" mailhostPassword="smtppassword" useSSL="FALSE">
 2  <from>buildmaster@mycompany.com</from>
 3  <mailhost>smtp.mycompany.com</mailhost>
 4  <users>
 5    <user name="BuildGuru" group="buildmaster" address="buildguru@mycompany.com" />
 6    <user name="JoeDeveloper" group="developers" address="joedeveloper@thoughtworks.com" />
 7  </users>
 8  <groups>
 9    <group name="developers">
10      <notifications>
11        <notificationType>Failed</notificationType>
12        <notificationType>Fixed</notificationType>
13      </notifications>
14    </group>
15    <group name="buildmaster">
16      <notifications>
17        <notificationType>Always</notificationType>
18      </notifications>
19    </group>
20  </groups>
21  <converters>
22    <regexConverter find="$" replace="@TheCompany.com" />
23  </converters>
24  <modifierNotificationTypes>
25    <NotificationType>Failed</NotificationType>
26    <NotificationType>Fixed</NotificationType>
27  </modifierNotificationTypes>
28  <subjectSettings>
29    <subject buildResult="StillBroken" value="Build is still broken for {CCNetProject}" />
30  </subjectSettings>
31  <xslFiles>
32    <file>xsl\header.xsl</file>
33    <file>xsl\compile.xsl</file>
34    <file>xsl\unittests.xsl</file>
35    <file>xsl\modifications.xsl</file>
36  </xslFiles>
37  <attachments>
38    <file>C:\Data\AFile.txt</file>
39    <file>Relative.txt</file>
40  </attachments>
41</email>

Configuration Elements¶

1<variable name="name" value="value" />

* Always
* Change
* Failed
* Success
* Fixed
* Exception

Notes¶

HTML E-mails¶

When includedDetails = True, the message body will contain more information. This detailed information is constructed from xsl transformations on the build log. If the xslFiles section is filled these files will be used, if not defined the xls files are defined in the ccnet.exe.config in the xslFiles section. (see also: Server Application Config File). When adjusting one of these, restart the console/service. The benefits of defining the xsl files in the email publisher:

* the xsl files are automatically the same for the console as for the service (no more keeping these 2 in sync)  
* it is possible to give projects different xsl transformations  

The groups node may be empty, but the group section must exist.

GMail¶

For sending mail via gmail :

* mailhost="smtp.gmail.com" 
* mailport="587" 
* mailhostUsername="xxx.yyy@gmail.com" 
* mailhostPassword="yourpassword" 
* useSSL="TRUE"

Automatically Generated¶

Documentation generated on Monday, 26 May 2014 at 7:18:00 AM