All arguments are optional. Arguments may be given for each token in the form name="value" for strings and in the form name=value for booleans and numbers. The {'s and }'s may be omitted if there are no arguments.

Examples: $TOKEN, ${TOKEN}, ${TOKEN, count=100}, ${ENV, var="PATH"}

• ${DEFAULT_SUBJECT} - This is the default email subject that is configured in Jenkins's system configuration page.
• ${DEFAULT_CONTENT} - This is the default email content that is configured in Jenkins's system configuration page.
• ${PROJECT_DEFAULT_SUBJECT} - This is the default email subject for this project. The result of using this token in the advanced configuration is what is in the Default Subject field above. WARNING: Do not use this token in the Default Subject or Content fields. Doing this has an undefined result.
• ${PROJECT_DEFAULT_CONTENT} - This is the default email content for this project. The result of using this token in the advanced configuration is what is in the Default Content field above. WARNING: Do not use this token in the Default Subject or Content fields. Doing this has an undefined result.
• ${BUILD_LOG, maxLines, escapeHtml} - Displays the end of the build log.
  • maxLines - display at most this many lines of the log.
    Defaults to 250.
  • escapeHtml - If true, HTML is escaped.
    Defaults to false.
• ${BUILD_LOG_REGEX, regex, linesBefore, linesAfter, maxMatches, showTruncatedLines, substText, escapeHtml, matchedLineHtmlStyle} - Displays lines from the build log that match the regular expression.
  regex - Lines that match this regular expression are included. See also java.util.regex.Pattern
  Defaults to "(?i)\b(error|exception|fatal|fail(ed|ure)|un(defined|resolved))\b".
  • linesBefore - The number of lines to include before the matching line. Lines that overlap with another match or linesAfter are only included once.
    Defaults to 0.
  • linesAfter - The number of lines to include after the matching line. Lines that overlap with another match or linesBefore are only included once.
    Defaults to 0.
  • maxMatches - The maximum number of matches to include. If 0, all matches will be included.
    Defaults to 0.
  • showTruncatedLines - If true, include [...truncated ### lines...] lines.
    Defaults to true.
  • substText - If non-null, insert this text into the email rather than the entire line.
    Defaults to null.
  • escapeHtml - If true, escape HTML.
    Defaults to false.
  • matchedLineHtmlStyle - If non-null, output HTML. matched lines will become <b style="your-style-value">html escaped matched line</b>.
    Defaults to null.
• ${BUILD_NUMBER} - Displays the number of the current build.
• ${BUILD_STATUS} - Displays the status of the current build. (failing, success, etc...)
• ${BUILD_URL} - Displays the URL to the current build.
• ${CHANGES, showPaths, format, pathFormat} - Displays the changes since the last build.
  • showPaths - if true, the paths modified by a commit are shown.
    Defaults to false.
  • format - for each commit listed, a string containing %X, where %X is one of %a for author, %d for date, %m for message, %p for paths, or %r for revision. Not all revision systems support %d and %r. If specified, showPaths is ignored.
    Defaults to "[%a] %m\n".
  • pathFormat - a string containing %p to indicate how to print paths.
    Defaults to "\t%p\n".
• ${CHANGES_SINCE_LAST_SUCCESS, reverse, format, showPaths, changesFormat, pathFormat} - Displays the changes since the last successful build.
  • reverse - indicates that most recent builds should be at the top.
    Defaults to false.
  • format - for each build listed, a string containing %X, where %X is one of %c for changes, or %n for build number.
    Defaults to "Changes for Build #%n\n%c\n".
  • showPaths, changesFormat, pathFormat - defined as showPaths, format, and pathFormat from ${CHANGES}, respectively.
• ${CHANGES_SINCE_LAST_UNSTABLE, reverse, format, showPaths, changesFormat, pathFormat} - Displays the changes since the last unstable or successful build.
  • reverse - indicates that most recent builds should be at the top.
    Defaults to false.
  • format - for each build listed, a string containing %X, where %X is one of %c for changes, or %n for build number.
    Defaults to "Changes for Build #%n\n%c\n".
  • showPaths, changesFormat, pathFormat - defined as showPaths, format, and pathFormat from ${CHANGES}, respectively.
• ${ENV, var} - Displays an environment variable.
  • var - the name of the environment variable to display. If "", show all.
    Defaults to "".
• ${FAILED_TESTS} - Displays failing unit test information, if any tests have failed.
• ${JENKINS_URL} - Displays the URL to the Jenkins server. (You can change this on the system configuration page.)
• ${HUDSON_URL} - deprecated, please use $JENKINS_URL
• ${PROJECT_NAME} - Displays the project's name.
• ${PROJECT_URL} - Displays a URL to the project's page.
• ${SVN_REVISION} - Displays the subversion revision number.
• ${CAUSE} - Displays the cause of the build.
• ${JELLY_SCRIPT, template} - Custom message content generated from a Jelly script template. There are two templates provided: "html" and "text". Custom Jelly templates should be placed in $JENKINS_HOME/email-templates. When using custom templates, the template filename without ".jelly" should be used for the "template" argument.
  • template - the template name.
    Defaults to "html".
• ${FILE, path} - Includes the content of a specified file.
  • path - The path to the file. Relative to the workspace root.
• ${TEST_COUNTS, var} - Displays the number of tests.
  • var - Defaults to "total".
    • total - the number of all tests.
    • fail - the number of failed tests.
    • skip - the number of skipped tests.
• ${SCRIPT, script, template, init} - Custom message content generated from a script using JSR 223. Custom scripts should be placed in $JENKINS_HOME/email-templates. When using custom scripts, the script filename WITH .py/.rb/etc should be used for the "script" argument. templates and other items may be loaded using the host.readFile(String fileName) function the function will look in the resources for the email-ext plugin first, and then in the $JENKINS_HOME/email-templates directory. No other directories will be searched.
  • script - the script name.
         Defaults to "email-ext.groovy".
  • template - the template filename.
         Defaults to "groovy-html.template"
  • init - true to run the language's init script.
         Defaults to true
  • Available Script Engines
    • ECMAScript - 1.6 (js)
    • Groovy - 1.8.2-jenkins-1 (groovy)