当前位置：首页 > news >正文

Jenkins之Email配置与任务邮件发送实践与踩坑(转)

news 来源：原创 2024/4/19 17:46:06

转载至：https://juejin.cn/post/6844904119707123719

1、插件下载

在配置Email之前我们需要下载两个插件：Email Extension, Email Extension Template，这两个插件可以帮助我们进行邮件的编写发送以及格式化

在系统管理->插件管理中下载插件：

[外链图片转存失败,源站可能有防盗链机制,建议将图片保存下来直接上传(img-7hFdJ4fm-1670389762534)(https://p1-jj.byteimg.com/tos-cn-i-t2oaga2asx/gold-user-assets/2020/4/9/1715f68bc0393ff5~tplv-t2oaga2asx-zoom-in-crop-mark:4536:0:0:0.image)]

2、配置Email(Jenkins自带)

2.1 基础信息查询

找到所要配置邮箱的基础信息，这里以QQ邮箱为例

通过网页端QQ邮箱的设置进入到邮箱客户端设置页面

[外链图片转存失败,源站可能有防盗链机制,建议将图片保存下来直接上传(img-6GUagZ8c-1670389762535)(https://p1-jj.byteimg.com/tos-cn-i-t2oaga2asx/gold-user-assets/2020/4/9/1715f68bc05a0945~tplv-t2oaga2asx-zoom-in-crop-mark:4536:0:0:0.image)]
找到邮箱的基础信息

[外链图片转存失败,源站可能有防盗链机制,建议将图片保存下来直接上传(img-zMSE9ONg-1670389762535)(https://p1-jj.byteimg.com/tos-cn-i-t2oaga2asx/gold-user-assets/2020/4/9/1715f68bc0c78de3~tplv-t2oaga2asx-zoom-in-crop-mark:4536:0:0:0.image)]

2.2 Jenkins邮件通知配置

在Jenkins：系统管理->系统配置中，最底部找到邮件通知，打开高级：

[外链图片转存失败,源站可能有防盗链机制,建议将图片保存下来直接上传(img-dl7ENAJO-1670389762536)(https://p1-jj.byteimg.com/tos-cn-i-t2oaga2asx/gold-user-assets/2020/4/9/1715f68bc0b05f33~tplv-t2oaga2asx-zoom-in-crop-mark:4536:0:0:0.image)]
填入配置信息后如下：

[外链图片转存失败,源站可能有防盗链机制,建议将图片保存下来直接上传(img-1Ec2Ig6i-1670389762536)(https://p1-jj.byteimg.com/tos-cn-i-t2oaga2asx/gold-user-assets/2020/4/9/1715f68bc21285c5~tplv-t2oaga2asx-zoom-in-crop-mark:4536:0:0:0.image)]
注意到在配置的下方有个"通过发送测试邮件测试配置"，我们可以讲其勾选，填入邮箱地址，点击Test configuration来先测试一下邮件的发送

[外链图片转存失败,源站可能有防盗链机制,建议将图片保存下来直接上传(img-vlviUFmB-1670389762536)(https://p1-jj.byteimg.com/tos-cn-i-t2oaga2asx/gold-user-assets/2020/4/9/1715f68bc3dfdaf9~tplv-t2oaga2asx-zoom-in-crop-mark:4536:0:0:0.image)]

2.3 踩坑时刻

如果按照上面的方式，点击Test configuration会出现以下报错：

javax.mail.AuthenticationFailedException: 535 Login Fail. Please enter your authorization code to login. More information in http://service.mail.qq.com/cgi-bin/help?subtype=1&&id=28&&no=1001256

[外链图片转存失败,源站可能有防盗链机制,建议将图片保存下来直接上传(img-cS39vILn-1670389762537)(https://p1-jj.byteimg.com/tos-cn-i-t2oaga2asx/gold-user-assets/2020/4/9/1715f68bea226861~tplv-t2oaga2asx-zoom-in-crop-mark:4536:0:0:0.image)]

这是因为使用QQ邮箱登录，需要填入的是QQ邮箱的授权码，这是用于登录第三方客户端的专用密码。具体的获取方式可参考：service.mail.qq.com/cgi-bin/hel…

修改完授权码后，再次测试,很可能又会收到如下报错:

java.net.SocketException: Connection closed by remote host

[外链图片转存失败,源站可能有防盗链机制,建议将图片保存下来直接上传(img-x7SuLNGt-1670389762537)(https://p1-jj.byteimg.com/tos-cn-i-t2oaga2asx/gold-user-assets/2020/4/9/1715f68bea3aefef~tplv-t2oaga2asx-zoom-in-crop-mark:4536:0:0:0.image)]

这是因为我们还需要在设置Jenkins Location中配置系统管理员邮件地址，此地址要和邮件通知中的用户名一致

[外链图片转存失败,源站可能有防盗链机制,建议将图片保存下来直接上传(img-c9SBwbRV-1670389762537)(https://p1-jj.byteimg.com/tos-cn-i-t2oaga2asx/gold-user-assets/2020/4/9/1715f68bec20ace4~tplv-t2oaga2asx-zoom-in-crop-mark:4536:0:0:0.image)]

2.4 结果验收

做完了上述步骤后再次测试可以看到邮件发送成功

[外链图片转存失败,源站可能有防盗链机制,建议将图片保存下来直接上传(img-Ph8ZmbdY-1670389762538)(https://p1-jj.byteimg.com/tos-cn-i-t2oaga2asx/gold-user-assets/2020/4/9/1715f68bed596529~tplv-t2oaga2asx-zoom-in-crop-mark:4536:0:0:0.image)]

[外链图片转存失败,源站可能有防盗链机制,建议将图片保存下来直接上传(img-JDtn4OyM-1670389762539)(https://p1-jj.byteimg.com/tos-cn-i-t2oaga2asx/gold-user-assets/2020/4/9/1715f68bf0f7941f~tplv-t2oaga2asx-zoom-in-crop-mark:4536:0:0:0.image)]

3、配置Email(Extended E-mail Notification)

记得文章一开头提到的下载Extended插件，没错，Jenkins系统设置里还可以通过Extended E-mail Notification对邮件发送进行模板格式的自定义

3.1 基础信息配置

基础信息配置与上述一致,唯一要注意的是这里需要重新生成一个授权码

[外链图片转存失败,源站可能有防盗链机制,建议将图片保存下来直接上传(img-GzWYXW2n-1670389762539)(https://p1-jj.byteimg.com/tos-cn-i-t2oaga2asx/gold-user-assets/2020/4/9/1715f68c123ef57c~tplv-t2oaga2asx-zoom-in-crop-mark:4536:0:0:0.image)]

3.2 模板格式配置

这里主要就是配置展示的模板格式，常用的格式化的参数有：

- $BUILD_STATUS – 构建结果
- $PROJECT_NAME – 构建脚本名称
- $BUILD_NUMBER – 构建脚本编号
- $JOB_DESCRIPTION – 构建项目描述 
- $CAUSE – 脚本启动原因
- $BUILD_URL – 脚本构建详情URL地址

这里选择以HTML的格式展示，填入模板：

<hr/>(自动化构建邮件，无需回复！)<br/><hr/>
项目名称：$PROJECT_NAME<br/><br/>

项目描述：$JOB_DESCRIPTION<br/><br/>

运行编号：$BUILD_NUMBER<br/><br/>

运行结果：$BUILD_STATUS<br/><br/>

触发原因：${CAUSE}<br/><br/>

构建日志地址：<a href="${BUILD_URL}console">${BUILD_URL}console</a><br/><br/>

构建地址：<a href="$BUILD_URL">$BUILD_URL</a><br/><br/>

详情：${JELLY_SCRIPT,template="html"}<br/>
<hr/>

[外链图片转存失败,源站可能有防盗链机制,建议将图片保存下来直接上传(img-IQ984f1P-1670389762539)(https://p1-jj.byteimg.com/tos-cn-i-t2oaga2asx/gold-user-assets/2020/4/9/1715f68c14349c58~tplv-t2oaga2asx-zoom-in-crop-mark:4536:0:0:0.image)]

3.3 触发条件配置

我们还可以在Default Triggers中根据自己的需要配置邮件的触发条件

[外链图片转存失败,源站可能有防盗链机制,建议将图片保存下来直接上传(img-4mJWb5dl-1670389762540)(https://p1-jj.byteimg.com/tos-cn-i-t2oaga2asx/gold-user-assets/2020/4/9/1715f68c1bdf2aca~tplv-t2oaga2asx-zoom-in-crop-mark:4536:0:0:0.image)]

[外链图片转存失败,源站可能有防盗链机制,建议将图片保存下来直接上传(img-0i4CPS7m-1670389762540)(https://p1-jj.byteimg.com/tos-cn-i-t2oaga2asx/gold-user-assets/2020/4/9/1715f68c2235f893~tplv-t2oaga2asx-zoom-in-crop-mark:4536:0:0:0.image)]

这里为了防止因为构建一直尝试结果均为失败而造成的邮件轰炸，可以设置邮件仅第一次或第二次构建结果为失败时才发送邮件，后续失败的邮件将不再发送

3.4 结果验收

在构建的任务配置中，选择"Editable Email Notification"

[外链图片转存失败,源站可能有防盗链机制,建议将图片保存下来直接上传(img-RURIDD7O-1670389762540)(https://p1-jj.byteimg.com/tos-cn-i-t2oaga2asx/gold-user-assets/2020/4/9/1715f68c4884b9d7~tplv-t2oaga2asx-zoom-in-crop-mark:4536:0:0:0.image)]
配置邮件发送至Recipient List中配置的邮件地址

[外链图片转存失败,源站可能有防盗链机制,建议将图片保存下来直接上传(img-aAelnt4R-1670389762541)(https://p1-jj.byteimg.com/tos-cn-i-t2oaga2asx/gold-user-assets/2020/4/9/1715f68c3307f986~tplv-t2oaga2asx-zoom-in-crop-mark:4536:0:0:0.image)]
保存后构建项目，查看结果，邮件发送成功

[外链图片转存失败,源站可能有防盗链机制,建议将图片保存下来直接上传(img-vi2qwWEw-1670389762541)(https://p1-jj.byteimg.com/tos-cn-i-t2oaga2asx/gold-user-assets/2020/4/9/1715f68c52c6fdb9~tplv-t2oaga2asx-zoom-in-crop-mark:4536:0:0:0.image)]