Jenkins之邮件通知

完成基于jenkins的持续集成部署后，任务构建执行完成，测试结果需要通知到相关人员。这篇博客，介绍如何在jenkins中配置邮件通知的方法。。。

一、安装邮件插件

由于Jenkins自带的邮件功能比较鸡肋，因此这里推荐安装专门的邮件插件，不过下面也会顺带介绍如何配置Jenkins自带的邮件功能作用。

可以通过系统管理→管理插件→可选插件，选择Email Extension Plugin插件进行安装：

由于我已经安装了该插件，因此这里显示在已安装目录下,还未安装的童鞋可以通过右上角的搜索框搜索改插件，然后在线安装，安装好之后重启Jenkins。

二、系统设置

通过系统管理→系统设置，进行邮件配置：

1、设置jenkins地址和管理员邮箱地址

2、设置发件人等信息

PS：这里的发件人邮箱地址切记要和系统管理员邮件地址保持一致（当然，也可以设置专门的发件人邮箱，不过不影响使用，根据具体情况设置即可）

上图的默认收件人邮箱可以添加多人，中间用英文半角逗号隔开即可。

3、配置邮件内容模版

附：邮箱内容模版（Default Content）：

<!DOCTYPE html>
<html>
<head>
<meta charset="UTF-8">
<title>${ENV, var="JOB_NAME"}-第${BUILD_NUMBER}次构建日志</title>
</head>    <body leftmargin="8" marginwidth="0" topmargin="8" marginheight="4"    offset="0">    <table width="95%" cellpadding="0" cellspacing="0"  style="font-size: 11pt; font-family: Tahoma, Arial, Helvetica, sans-serif">    <tr>    本邮件由系统自动发出，无需回复！<br/>            各位同事，大家好，以下为${PROJECT_NAME }项目构建信息</br> <td><font color="#CC0000">构建结果 - ${BUILD_STATUS}</font></td>   </tr>    <tr>    <td><br />    <b><font color="#0B610B">构建信息</font></b>    <hr size="2" width="100%" align="center" /></td>    </tr>    <tr>    <td>    <ul>    <li>项目名称 ： ${PROJECT_NAME}</li>    <li>构建编号 ： 第${BUILD_NUMBER}次构建</li>    <li>触发原因： ${CAUSE}</li>    <li>构建状态： ${BUILD_STATUS}</li>    <li>构建日志： <a href="${BUILD_URL}console">${BUILD_URL}console</a></li>    <li>构建  Url ： <a href="${BUILD_URL}">${BUILD_URL}</a></li>    <li>工作目录 ： <a href="${PROJECT_URL}ws">${PROJECT_URL}ws</a></li>    <li>项目  Url ： <a href="${PROJECT_URL}">${PROJECT_URL}</a></li>    </ul>    <h4><font color="#0B610B">失败用例</font></h4>
<hr size="2" width="100%" />
$FAILED_TESTS<br/><h4><font color="#0B610B">最近提交(#$SVN_REVISION)</font></h4>
<hr size="2" width="100%" />
<ul>
${CHANGES_SINCE_LAST_SUCCESS, reverse=true, format="%c", changesFormat="<li>%d [%a] %m</li>"}
</ul>
详细提交: <a href="${PROJECT_URL}changes">${PROJECT_URL}changes</a><br/></td>    </tr>    </table>
</body>
</html>

4、设置邮件触发机制

上面的几步完成后，点击应用，保存即可。

5、配置Jenkins自带的邮件功能

配置内容如下，和Email Extension Plugin插件同样的配置，可以通过勾选通过发送测试邮件测试配置按钮来测试配置是否成功发送邮件，如下图：

完成上面的系统设置后，点击保存即可。

三、项目配置

在完成系统设置后，还需要给需要构建的项目进行邮件配置。

1、进入项目配置界面

进入新建的项目界面，点击配置按钮，进入系统配置页面：

2、配置构建后操作模块

进入系统配置页面后，点击上方的构建后操作选项，配置内容如下：

进入构建后操作的模块，然后会看到下面的内容，具体的配置信息如图中标注：

接上图：

配置内容默认即可，邮件内容类型可以根据自己的配置选择，收件人列表可以从前面的系统设置中默认收件人选项配置。

四、构建触发邮件测试

如下图，为我收到的测试邮件，邮件内容可以通过系统设置里面进行个性化的配置，可参考我上面的模板，或者自定义即可。

以上内容，即Jenkins配置自动发送邮件的方法，仅供参考。。。

======================================
邮件通知配置相关的全局属性详解
1. Override Global Settings：如果不选，该插件将使用默认的E-mail Notification通知选项。反之，您可以通过指定不同于( 默认选项)的设置来进行覆盖。
2. Default Content Type：指定构建后发送邮件内容的类型，有Text和HTML两种.
3. Use List-ID Email Header：为所有的邮件设置一个List-ID的邮件信头
4. Add 'Precedence: bulk' Email Header：设置优先级
5. Default Recipients：自定义默认电子邮件收件人列表。如果没有被项目配置覆盖,该插件会使用这个列表。您可以在项目配置使用$ DEFAULT_RECIPIENTS参数包括此默认列表，以及添加新的地址在项目级别。添加抄送：cc:电子邮件地址例如,CC:someone@somewhere.com
6. Reply To List：回复列表, A comma separated list of e-mail addresses to use in the Reply-To header of the email. This value will be available as $DEFAULT_REPLYTO in the project configuration.
7. Emergency reroute：如果这个字段不为空，所有的电子邮件将被单独发送到该地址（或地址列表）。
8. Excluded Committers：防止邮件被邮件系统认为是垃圾邮件,邮件列表应该没有扩展的账户名(如:@domain.com),并且使用逗号分隔
9. Default Subject：自定义邮件通知的默认主题名称。该选项能在邮件的主题字段中替换一些参数，这样你就可以在构建中包含指定的输出信息。
10. Maximum Attachment Size：邮件最大附件大小。
11. Default Content：自定义邮件通知的默认内容主体。该选项能在邮件的内容中替换一些参数，这样你就可以在构建中包含指定的输出信息。
12. Default Pre-send Script：默认发送前执行的脚本（注：grooy脚本，这是我在某篇文章上看到的，不一定准确）。
13. Enable Debug Mode：启用插件的调试模式。这将增加额外的日志输出，构建日志以及Jenkins的日志。在调试时是有用的，但不能用于生产。
14. Enable Security：启用时，会禁用发送脚本的能力，直接进入Jenkins实例。如果用户试图访问Jenkins管理对象实例，将抛出一个安全异常。
15. Content Token Reference：邮件中可以使用的变量，所有的变量都是可选的。
全局邮件变量
email-ext插件允许使用变量来动态插入数据到邮件的主题和内容主体中。变量是一个以$(美元符号)开始，并以空格结束的字符串。当一个邮件触发时，主题和内容主体字段的所有变量都会通过真实的值动态地替换。同样，变量中的“值”能包含其它的变量，都将被替换成真实的内容。
比如，项目配置页的默认主题和内容分别对应的是全局配置页面的DEFAULT_SUBJECT和DEFAULT_CONTENT，因此它会自动地使用全局的配置。同理，触发器中的Subject和Content分别对应的是项目配置页面的DEFAULT_SUBJECT和DEFAULT_CONTENT，所以它也会自动地使用项目的配置。由于变量中的“值”能包含其它的变量，所以就能为变量快速地创建不同的切入点：全局级别(所有项目)，专属级别(单一项目)，触发器级别(构建结果)。
如果你要查看所有可用的变量，你可以点击配置页的Content Token Reference的问号获取详细的信息。
所有的变量都是可选的，每个变量可以如下表示，字符串类型使用name=“value”，而布尔型和数字型使用name=value。如果{和}标记里面没有变量，则不会被解析。示例：$TOKEN,${TOKEN},${TOKEN,count=100},${ENV,var=”PATH”}
提示：用英文逗号分隔变量的参数。
常用的属性如下：
${FILE,path="PATH"} 包括指定文件（路径）的含量相对于工作空间根目录。
path文件路径，注意：是工作区目录的相对路径。
${BUILD_NUMBER} 显示当前构建的编号。
${JOB_DESCRIPTION} 显示项目描述。
${SVN_REVISION} 显示svn版本号。还支持Subversion插件出口的SVN_REVISION_n版本。
${CAUSE} 显示谁、通过什么渠道触发这次构建。
${CHANGES } -显示上一次构建之后的变化。
showPaths 如果为 true,显示提交修改后的地址。默认false。
showDependencies 如果为true，显示项目构建依赖。默认为false
format 遍历提交信息，一个包含%X的字符串，其中%a表示作者，%d表示日期，%m表示消息，%p表示路径，%r表示版本。注意，并不是所有的版本系统都支持%d和%r。如果指定showPaths将被忽略。默认“[%a] %m\\n”。
pathFormat 一个包含“%p”的字符串，用来标示怎么打印路径。
${BUILD_ID}显示当前构建生成的ID。
${PROJECT_NAME} 显示项目的全名。
${PROJECT_DISPLAY_NAME} 显示项目的显示名称。
${SCRIPT} 从一个脚本生成自定义消息内容。自定义脚本应该放在"$JENKINS_HOME/email-templates"。当使用自定义脚本时会默认搜索$JENKINS_HOME/email-templatesdirectory目录。其他的目录将不会被搜索。
script 当其使用的时候，仅仅只有最后一个值会被脚本使用（不能同时使用script和template）。
template常规的simpletemplateengine格式模板。
${JENKINS_URL} 显示Jenkins服务器的url地址（你可以再系统配置页更改）。
${BUILD_LOG_MULTILINE_REGEX}按正则表达式匹配并显示构建日志。
regex java.util.regex.Pattern 生成正则表达式匹配的构建日志。无默认值，可为空。
maxMatches 匹配的最大数量。如果为0，将匹配所有。默认为0。
showTruncatedLines 如果为true，包含[...truncated ### lines...]行。默认为true。
substText 如果非空，就把这部分文字（而不是整行）插入该邮件。默认为空。
escapeHtml 如果为true，格式化HTML。默认为false。
matchedSegmentHtmlStyle 如果非空，输出HTML。匹配的行数将变为<b style=”your-style-value”> html escaped matched line </b>格式。默认为空。
${BUILD_LOG} 显示最终构建日志。
maxLines 日志最多显示的行数，默认250行。
escapeHtml 如果为true，格式化HTML。默认false。
${PROJECT_URL} 显示项目的URL地址。
${BUILD_STATUS} -显示当前构建的状态(失败、成功等等)
${BUILD_URL} -显示当前构建的URL地址。
${CHANGES_SINCE_LAST_SUCCESS} -显示上一次成功构建之后的变化。
reverse在顶部标示新近的构建。默认false。
format遍历构建信息，一个包含%X的字符串，其中%c为所有的改变，%n为构建编号。默认”Changes for Build #%n\n%c\n”。
showPaths,changesFormat,pathFormat分别定义如${CHANGES}的showPaths、format和pathFormat参数。
${CHANGES_SINCE_LAST_UNSTABLE} -显示显示上一次不稳固或者成功的构建之后的变化。
reverse在顶部标示新近的构建。默认false
format遍历构建信息，一个包含%X的字符串，其中%c为所有的改变，%n为构建编号。默认”Changes for Build #%n\n%c\n”。
showPaths,changesFormat,pathFormat分别定义如${CHANGES}的showPaths、format和pathFormat参数。
${ENV} –显示一个环境变量。
var– 显示该环境变量的名称。如果为空，显示所有，默认为空。
${FAILED_TESTS} -如果有失败的测试，显示这些失败的单元测试信息。
${JENKINS_URL} -显示Jenkins服务器的地址。(你能在“系统配置”页改变它)。
${HUDSON_URL} -不推荐，请使用$JENKINS_URL
${PROJECT_URL} -显示项目的URL。
${SVN_REVISION} -显示SVN的版本号。
${JELLY_SCRIPT} -从一个Jelly脚本模板中自定义消息内容。有两种模板可供配置：HTML和TEXT。你可以在$JENKINS_HOME/email-templates下自定义替换它。当使用自动义模板时，”template”参数的名称不包含“.jelly”。
template模板名称，默认”html”。
${TEST_COUNTS} -显示测试的数量。
var– 默认“total”。
total -所有测试的数量。
fail -失败测试的数量。
skip -跳过测试的数量。

Jenkins之邮件通知相关推荐

Jenkins 配置邮件通知
Jenkins是一个很受欢迎的CI持续集成工具,能够实现项目的自动构建.打包.测试.发布等.还可以在构建失败.构建不稳定等状态后发送邮件通知.现介绍一下如何在Jenkins中配置实现邮件通知. 在Je ...
jenkins的邮件通知设置
本文主要对Windows环境 jenkins 的邮件通知进行介绍 jenkins 内置的邮件功能使用email-ext插件扩展的邮件功能邮件通知功能主要包含两个部分:全局配置和项目配置. 一. 先 ...
Jenkins配置邮件通知服务，完整教程（含发送成功无法接收邮件处理方案）
前言:涂涂改改,查查找找,不知不觉又三点了,废话不多说直接上教程. 准备事项: 1.安装Email Extension Plugin插件 2.安装Date Parameter插件(一个可使用的时间函数 ...
Jenkins配置邮件通知（2）——配置邮件模板
最终,还是要写这篇文章哦-- 不知道你是不是和我一样,是把Jenkins部署在windows上的, 先说一下我的背景:我是使用Pytest+Selenium+Allure来做UI的自动化测试,我需要把 ...
Jenkins进阶系列之——01使用email-ext替换Jenkins的默认邮件通知
1 简述众所周知,Jenkins默认提供了一个邮件通知,能在构建失败.构建不稳定等状态后发送邮件.但是它本身有很多局限性,比如它的邮件通知无法提供详细的邮件内容.无法定义发送邮件的格式.无法定义灵活 ...
第三章：使用email-ext替换Jenkins的默认邮件通知
1 简述众所周知,Jenkins默认提供了一个邮件通知,能在构建失败.构建不稳定等状态后发送邮件.但是它本身有很多局限性,比如它的邮件通知无法提供详细的邮件内容.无法定义发送邮件的格式.无法定义灵活 ...
docker启动jenkins部署springboot到tomcat(集成：企业微信和邮件通知)
前言: 文章是图文教程,内容略长,你可以选择部分需要集成的内容查看如果是从零部署,建议仔细阅读每一个步骤开发环境: docker : 20.10.2 jenkins : 2.303.1 tomca ...
用Mailgun方式在Drone pipeline中集成SMTP邮件通知
文章目录用Mailgun方式在Drone pipeline中集成SMTP邮件通知前言在Mailgun中开启SMTP服务在Drone pipeline中集成邮件通知小结用Mailgun方式在 ...
jenkins邮件通知功能
第部分:全局设置第一步:进入jenkins的系统设置第二步:设置管理员邮件地址: 第三步:下载email-ext插件并填写对应的内容: 第四部:填写邮件通知第五步:以上就是系统管理里需要填写的全 ...

Jenkins之邮件通知

Jenkins之邮件通知相关推荐

最新文章

热门文章