目录[-]




环境介绍：

  • Jenkins： 2.172

一、设置邮箱开启 POP3/SMTP/IMAP 设置

这里用的是 163 邮箱

jenkins添加QQ邮箱跟授权码 jenkins email_ide

二、安装 Email Extension Template 插件

系统管理->插件管理：

这里安装插件“Email Extension Template”用于设置邮件模板。

jenkins添加QQ邮箱跟授权码 jenkins email_发送邮件_02

三、配置系统默认邮件参数

系统管理->系统设置：

配置“Jenkins Location”和“Extended E-mail Notification”，其中系统管理员邮件地址一定要和“User Name”值一致。

1、Jenkins Location 设置

设置参数：

  • Jenkins URL： Jenkins 地址，用于发送邮件时写入内容之中
  • 系统管理员邮件地址： 邮件服务器账户

jenkins添加QQ邮箱跟授权码 jenkins email_ide_03

2、Extended E-mail Notification 设置

设置参数：

  • SMTP server： smtp 邮箱服务的地址
  • Default user E-mail suffix： 邮件服务器后缀
  • User Name： 邮件服务器账户
  • Password： 邮件服务器 SMTP 授权码
  • Default Content Type： 设置邮件文本格式
  • Enable Debug Mode： 启用 Debug 模式

四、测试发送邮件

1、创建流水线项目

创建一个流水线项目，用于写 Pipeline 脚本测试邮件发送。

jenkins添加QQ邮箱跟授权码 jenkins email_ide_04

2、配置 Pipeline 脚本

这里写一个简单的 Pipeline 脚本，调用 emailext 方法执行发送邮件。

参考：https://jenkins.io/doc/pipeline/steps/email-ext/

jenkins添加QQ邮箱跟授权码 jenkins email_jenkins添加QQ邮箱跟授权码_05

脚本内容：

node () {
    stage('email'){
        echo "测试发送邮件"
        emailext(subject: '任务执行失败',to: '324******47@qq.com',body: '''测试邮件内容...''')
    }
}

3、运行项目查看日志

查看日志，看是否执行发送操作以及运行状况。

Started by user admin
Running in Durability level: PERFORMANCE_OPTIMIZED
[Pipeline] Start of Pipeline
[Pipeline] node
Running on Jenkins in /var/jenkins_home/workspace/email-test
[Pipeline] {
[Pipeline] stage
[Pipeline] { (email)
[Pipeline] echo
测试发送邮件
[Pipeline] emailext
Sending email to: 32*****47@qq.com
[Pipeline] }
[Pipeline] // stage
[Pipeline] }
[Pipeline] // node
[Pipeline] End of Pipeline
Finished: SUCCESS

4、查看邮件

查看邮件，可以看到已经收到设置邮箱发来的邮件信息。

jenkins添加QQ邮箱跟授权码 jenkins email_发送邮件_06

五、配置邮件模板

在之前安装 Jenkins 时选择安装了 “Config File Provider”、“Pipeline Utility Steps”两个插件。

  • Config File Provider： 提供文件的存储插件。
  • Pipeline Utility Steps： 提供文件的读写的插件。

1、添加模板文件

系统管理->Managed files->Add a new Config

选择“Extended Email Publisher Groovy Template”类型，然后添加邮件模板。

jenkins添加QQ邮箱跟授权码 jenkins email_发送邮件_07

jenkins添加QQ邮箱跟授权码 jenkins email_ide_08

模板内容如下：

<!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>  
            <td>各位同事，大家好，以下为${PROJECT_NAME }项目构建信息</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>  
            </td>  
        </tr>  
        <tr>
            <td><b><font color="#0B610B">历史变更记录:</font></b>
            <hr size="2" width="100%" align="center" /></td>
        </tr>
        <tr>
            <td>
                ${CHANGES_SINCE_LAST_SUCCESS,reverse=true, format="Changes for Build #%n:<br />%c<br />",showPaths=true,changesFormat="<pre>[%a]<br />%m</pre>",pathFormat="    %p"}
            </td>
        </tr>
    </table>  
</body>  
</html>

2、测试发送模板邮件

修改上面测试的 Pipeline 项目，替换脚本：

jenkins添加QQ邮箱跟授权码 jenkins email_Jenkins_09

脚本内容：

node () {
    stage('email'){
        echo "测试发送邮件"
        // 设置生成模板文件
        configFileProvider([configFile(fileId: '0ad43176-c202-4ebc-aaff-441ef79f49d8',
                                       targetLocation: 'email.html', 
                                       variable: 'failt_email_template')]) {
            //  读取模板
            template = readFile encoding: 'UTF-8', file: "${failt_email_template}"
            //  发送邮件
            emailext(subject: '任务执行失败',
            	     attachLog: true,
            	     recipientProviders: [requestor()], 
            	     to: '32*****47@qq.com',
            	     body: """${template}""")
        }
    }
}
  • body： 邮件内容
  • subject： 邮件主题
  • to： 指定邮件接收者
  • attachLog： 附加构建日志信息到附件中
  • recipientProviders： 设置邮件接收者，可以设置向任务请求触发人员、项目组、整个团体等发生邮件，这样既可以发生邮件到 to 中的设置人员，也可以发生给对应触发人员。

3、运行项目查看日志

Started by user admin
Running in Durability level: PERFORMANCE_OPTIMIZED
[Pipeline] Start of Pipeline (hide)
[Pipeline] node
Running on Jenkins in /var/jenkins_home/workspace/email-test
[Pipeline] {
[Pipeline] stage
[Pipeline] { (email)
[Pipeline] echo
测试发送邮件
[Pipeline] configFileProvider
provisioning config files...
copy managed file [Fail  Email Template] to file:/var/jenkins_home/workspace/email-test/aa.html
[Pipeline] {
[Pipeline] readFile
[Pipeline] emailext
Sending email to: 32******47@qq.com
[Pipeline] }
[Pipeline] // configFileProvider
[Pipeline] }
[Pipeline] // stage
[Pipeline] }
[Pipeline] // node
[Pipeline] End of Pipeline
Finished: SUCCESS

4、查看邮件

可以看到构建内容如下：

jenkins添加QQ邮箱跟授权码 jenkins email_Jenkins_10