配置普通邮件通知

<p>
  Jenkins配置邮件通知配置普通邮件通知配置扩展邮件通知：配置系统消息扩展邮件的模板解释全局邮件变量解说
</p>

<p style="margin-left: 0in;">
  需求：在每次构建完成后进行邮件通知构建结果，好判断自动化构建后的结果如何！
</p>

<p style="margin-left: 0in;">
  所需要的插件：<span style="color: #ff0000;">Email Extension Plugin</span>
</p>

<p style="margin-left: 0in;">
  第一步安装插件：进入Jenkins的插件管理
</p>

<p style="margin-left: 0in;">
  <img loading="lazy" decoding="async" class="has" src="https://img-blog.csdnimg.cn/20190606161147464.png" alt="" width="576" height="128" />
</p>

<p style="margin-left: 0in;">
  安装插件完成后重启Jenkins
</p>

<p style="margin-left: 0in;">
  第二步进行系统配置：进入Jenkins系统配置
</p>

<p style="margin-left: 0in;">
  注意的一点，先配置邮箱管理员：
</p>

<p style="margin-left: 0in;">
  <img loading="lazy" decoding="async" class="has" src="https://img-blog.csdnimg.cn/20190606161200862.png" alt="" width="576" height="99" />
</p>

<p style="margin-left: 0in;">
  <img loading="lazy" decoding="async" class="has" src="https://img-blog.csdnimg.cn/20190606161215484.png?x-oss-process=image/watermark,type_ZmFuZ3poZW5naGVpdGk,shadow_10,text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzQyNTY4NjEx,size_16,color_FFFFFF,t_70" alt="" width="576" height="221" />
</p>

<p style="margin-left: 0in;">
  第三步：进入job进行配置
</p>

<p style="margin-left: 0in;">
  <img loading="lazy" decoding="async" class="has" src="https://img-blog.csdnimg.cn/20190606161226567.png?x-oss-process=image/watermark,type_ZmFuZ3poZW5naGVpdGk,shadow_10,text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzQyNTY4NjEx,size_16,color_FFFFFF,t_70" alt="" width="576" height="223" />
</p>

<p style="margin-left: 0in;">
  配置完成后便可以完成普通的邮件通知
</p>

<p style="margin-left: 0in;">
  相关说明：
</p>

<p style="margin-left: 0in;">
  ①SMTP服务器：如果你使用的是公司邮箱，那么就询问你自己公司里的运维人员吧；他们一般都知道，至少我就是问公司里的运维人员；要是你打算使用QQ邮箱，那么你需要设置下，网上有教程；网易邮箱默认开启。
</p>

<p style="margin-left: 0in;">
  说明：SMTP是一种协议
</p>

<p style="margin-left: 0in;">
  ②用户默认邮件后缀：根据自己情况去设置
</p>

<p style="margin-left: 0in;">
  ③勾选使用SMTP认证，用户名：根据自己情况设置，密码也是。
</p>

<p style="margin-left: 0in;">
  ④SMTP端口：默认25
</p>

<p style="margin-left: 0in;">
  配置好了后，可以勾选 测试，在Test e-mail recipient输入自己的邮箱，看下能否成功。
</p>

<h1 style="margin-left: 0in;">
  <span style="color: #2e74b5;">配置扩展邮件通知：</span>
</h1>

<p style="margin-left: 0in;">
  设置扩展电子邮件通知的原因：
</p>

<p style="margin-left: 0in;">
  只设置邮件通知的话，只能发送给固定的接收人，并且邮件内容单一，不够自由，因此需要设置扩展邮件通知。
</p>

<p style="margin-left: 0in;">
  所需要的插件：Email Extension
</p>

<p style="margin-left: 0in;">
  这个插件是Jenkins的电子邮件发布者的替代品。它允许配置电子邮件通知的各个方面：发送电子邮件时，应该收到谁以及电子邮件说明的内容
</p>

<p style="margin-left: 0in;">
  <p style="margin-left: 0in;">
    第一步：进入系统配置页面找到下图所示进行配置
  </p>
  
  <p style="margin-left: 0in;">
    <p style="margin-left: 0in;">
      Html的代码网上拉取的参考
    </p>
    
    <pre class="has"><code class="language-html">&lt;!DOCTYPE html&gt;

<html>

<head>

<title>${ENV, var=“JOB_NAME”}-第${BUILD_NUMBER}次构建日志</title>

</head>

<tr>

<td>(本邮件由程序自动下发，请勿回复！)</td>

</tr>

<tr>

<td>

<h2><font color="#FF0000">构建结果 - ${BUILD_STATUS}</font></h2>

</td>

</tr>

<tr>

</td>

</tr>

<tr><a href="${PROJECT_URL}">${PROJECT_URL}</a>

<td>

<ul>

<li>项目名称：${PROJECT_NAME}</li>

<li>GIT路径：<a href="${GIT_URL}">${GIT_URL}</a></li>

<li>构建编号：${BUILD_NUMBER}</li>

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

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

</ul>

</td>

</tr>

<tr>

<td>

</td>

</tr>

<tr>

<td>

<ul>

<li>上次构建成功后变化 : ${CHANGES_SINCE_LAST_SUCCESS}</a></li>

</ul>

</td>

</tr>

<tr>

<td>

<ul>

<li>上次构建不稳定后变化 : ${CHANGES_SINCE_LAST_UNSTABLE}</a></li>

</ul>

</td>

</tr>

<tr>

<td>

<ul>

<li>历史变更记录 : <a href="${PROJECT_URL}changes">${PROJECT_URL}changes</a></li>

</ul>

</td>

</tr>

<tr>

<td>

<ul>

<li>变更集:${JELLY_SCRIPT,template=“html”}</a></li>

</ul>

</td>

</tr>

<!–

<tr>

<td>

<b><font color="#0B610B">Failed Test Results</font></b>

</td>

</tr>

<tr>

<td>

<pre style=“font-size: 11pt; font-family: Tahoma, Arial, Helvetica, sans-serif”>$FAILED_TESTS</pre>

<br />

</td>

</tr>

<tr>

<td>

</td>

</tr>–>

<!– <tr>

<td>Test Logs (if test has ran): <a

href="${PROJECT_URL}ws/TestResult/archive_logs/Log-Build-${BUILD_NUMBER}.zip">${PROJECT_URL}/ws/TestResult/archive_logs/Log-Build-${BUILD_NUMBER}.zip</a>

<br />

</td>

</tr> –>

<!–

<tr>

<td>

<textarea cols=“80” rows=“30” readonly=“readonly” style=“font-family: Courier New”>${BUILD_LOG, maxLines=100,escapeHtml=true}</textarea>

</td>

</tr>–>

</table>

</body>

</html>

第二步：

第三步：设置默认邮件出发通知

第四步：进入Job进行配置

第五步：添加配置完成后构建项目查看收件箱

如果发现收不到邮件请检查手机列表是否为空

配置系统消息

方法都是同样的道理。展示的形式不一样而已

所需要的插件：

OWASP Markup Formatter：

OWASP标记格式化程序插件

使用OWASP Java HTML Sanitizer ，可以在项目描述等中输入安全的HTML标记。

第一步：

配置如图：进入系统配置

这里输入需要展示的系统信息，如果是文本格式的就直接输入展示的文本内容，若是html形式的就输入代码

<form><p><B><font size="5" color="red" >版本发布通知</font></B></p></form> 

<ul><li>

<p><B><font size="3" color="red" >此次发布结果：</font></B></p>

<font size="3" color="green" >成功</font>

</li></ul>

<ul><li>

<p><B><font size="3" color="red" >此次发布版本：</font></B></p>

<textarea text="TEXT" cols=value rows=value  disabled="disabled">

  系统版本名称-版本号

</textarea>

</li></ul>

<ul><li>

<p><B><font size="3" color="red" >版本新增内容：</font></B></p>

<textarea text="TEXT" cols=value rows=value  disabled="disabled">

 （1）新增接口：

 （2）修复bug：

</textarea>

</li></ul>

仅供参考

第二步：进入安全配置与管理选择对应的系统消息展示方式

如果需要使用html格式的展示需要安装插件：Markup Formatter

下面是html的展示效果图：

这是文本形式的效果

扩展邮件的模板解释

邮件通知配置相关的全局属性详解：

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：邮件中可以使用的变量，所有的变量都是可选的。

全局邮件变量解说

1.email-ext插件允许使用变量来动态插入数据到邮件的主题和内容主体中。

变量是一个以$(美元符号)开始，并以空格结束的字符串。

当一个邮件触发时，主题和内容主体字段的所有变量都会通过真实的值动态地替换。

同样，变量中的“值”能包含其它的变量，都将被替换成真实的内容。

2.比如，项目配置页的默认主题和内容分别对应的是全局配置页面的DEFAULT_SUBJECT和DEFAULT_CONTENT，因此它会自动地使用全局的配置。

3.同理，触发器中的Subject和Content分别对应的是项目配置页面的DEFAULT_SUBJECT和DEFAULT_CONTENT，所以它也会自动地使用项目的配置。

由于变量中的“值”能包含其它的变量，所以就能为变量快速地创建不同的切入点：全局级别(所有项目)，专属级别(单一项目)，触发器级别(构建结果)。

4.如果你要查看所有可用的变量，你可以点击配置页的Content Token Reference的问号获取详细的信息。

5.所有的变量都是可选的，每个变量可以如下表示，字符串类型使用name=“value”，而布尔型和数字型使用name=value。如果{和}标记里面没有变量，则不会被解析。

示例：$TOKEN,${TOKEN},${TOKEN,count=100},${ENV,var=”PATH”}

提示：用英文逗号分隔变量的参数。

6.常用的属性如下：

${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。匹配的行数将变为 html escaped matched line 格式；默认为空。

${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 #%nn%cn”。

showPaths,changesFormat,pathFormat分别定义如${CHANGES}的showPaths、format和pathFormat参数。

${CHANGES_SINCE_LAST_UNSTABLE} -显示显示上一次不稳固或者成功的构建之后的变化。

reverse在顶部标示新近的构建；默认false

format遍历构建信息，一个包含%X的字符串，其中%c为所有的改变，%n为构建编号；默认”Changes for Build #%nn%cn”。

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 -跳过测试的数量。