Jenkins基础教程（44）配置Jenkins 服务器之配置邮件服务器：Jenkins邮件通知配置：让你的CI/CD会“说话”！-优快云博客

每次构建失败都像是一场无声的灾难？让Jenkins邮件通知功能成为你的专属播报员。

第一部分：为什么你的Jenkins需要邮件通知？

作为一名开发者，我们不可能时时刻刻盯着Jenkins控制台。当自动构建失败、测试用例不通过或集成出现问题时，及时的通知显得尤为关键。

邮件通知不仅仅是简单的告警工具，更是团队协作的桥梁。它能够将关键信息推送到相关负责人的收件箱，包括构建状态、失败详情、代码变更关联等，帮助我们快速响应问题。

与普通的简单邮件配置不同，通过Email Extension Plugin，我们可以定制丰富的邮件模板，设置不同的触发条件，让邮件内容更加详实有用。

第二部分：准备工作：安装必要插件

在开始配置之前，我们首先需要安装Jenkins的邮件扩展插件——Email Extension Plugin。这个插件提供了比Jenkins内置邮件功能更强大的特性，包括可定制的邮件模板、丰富的触发条件和变量支持。

安装步骤

登录Jenkins管理界面，点击顶部菜单栏的「Manage Jenkins」。
选择「Manage Plugins」进入插件管理页面。
切换到「Available」标签页，搜索“Email Extension Plugin”。
勾选该插件并点击安装（如果已安装但需要更新，这里会显示更新选项）。
安装完成后，重启Jenkins使插件生效。

小贴士：如果你不确定是否已经安装了这个插件，可以在「Installed」标签页中搜索确认。通常情况下，Email Extension Plugin会自动安装相关的SMTP插件，如果没有，你可以额外搜索并安装“SMTP Plugin”以确保完整的邮件功能支持。

第三部分：一步步配置邮件服务器

插件安装完成后，接下来就是最关键的环节——配置邮件服务器。这里我们以Gmail为例，但配置原理适用于任何SMTP服务器。

1. 进入系统配置

在Jenkins主界面，点击「Manage Jenkins」 → 「Configure System」，然后向下滚动找到「Extended E-mail Notification」部分。

2. 填写SMTP服务器信息

这里需要填写几个关键参数：

SMTP Server：对于Gmail用户，这里是smtp.gmail.com；企业邮箱用户则需要填写对应的服务器地址，如smtp.exmail.qq.com。
SMTP Port：常用的SMTP端口有587（TLS加密）、465（SSL加密）或25（非加密）。推荐使用587端口并启用TLS加密，以保证通信安全。
SMTP User Name：填写完整的邮箱地址，如your_email@gmail.com。
SMTP Password：注意：如果你使用Gmail等需要双重验证的邮箱，这里不能使用普通密码，而需要生成「应用专用密码」。
Use SMTP Authentication：务必勾选此选项以启用SMTP认证。
Start TLS if available：推荐勾选，启用TLS加密。

3. 其他重要设置

Default Subject Prefix：设置邮件主题前缀，如[Jenkins]，便于在收件箱中快速识别邮件来源。
From Address：发件人地址，建议与SMTP账户一致或设置为易于识别的地址，如jenkins@yourcompany.com。

4. 测试配置

填写完所有信息后，千万不要跳过测试环节！点击「Test Configuration」按钮，输入一个有效的邮箱地址，如果配置正确，你会收到一封测试邮件。

常见问题解决：如果测试失败，检查以下几点：

确认SMTP服务器地址和端口是否正确。
验证用户名和密码（特别是应用专用密码）是否正确。
检查网络连接，确保Jenkins服务器能够访问SMTP服务器。
查看邮箱设置，确保已开启「允许不够安全的应用」或添加了IP白名单。

第四部分：在项目中配置邮件通知

全局配置完成后，我们还需要在具体的Jenkins项目中设置邮件触发的条件和收件人。

1. 进入项目配置

选择你想要配置邮件通知的Jenkins项目，点击「Configure」进入配置页面，然后向下滚动至「Post-build Actions」部分。

2. 添加邮件通知动作

点击「Add post-build action」 → 选择「Editable Email Notification」，这里有几个关键配置项：

Recipient List：输入邮件接收者地址，多个地址用逗号分隔（如：user1@example.com,user2@example.com）。你也可以使用Jenkins变量，如$BUILD_USER_EMAIL表示触发构建的用户邮箱。
Subject：邮件主题，可以使用变量动态生成，例如：Build Status: ${BUILD_STATUS} - Job: ${JOB_NAME}。
Body：邮件正文，支持HTML格式，可以嵌入Groovy脚本动态生成内容。

3. 配置邮件触发条件

点击「Add Trigger」设置邮件触发的条件，常用选项包括：

Failure：构建失败时发送。
Success：构建成功时发送。
Unstable：构建不稳定时发送（如测试未通过）。
Fixed：上次失败后本次成功时发送。
Still Failing：上次失败后本次仍失败时发送。

完整的邮件内容示例

<html>
<body>
  <h2>构建通知</h2>
  <p><strong>项目:</strong> ${PROJECT_NAME}</p>
  <p><strong>构建编号:</strong> ${BUILD_NUMBER}</p>
  <p><strong>构建状态:</strong> ${BUILD_STATUS}</p>
  <p><strong>构建 URL:</strong> <a href="${BUILD_URL}">${BUILD_URL}</a></p>
  <p><strong>控制台输出:</strong> <a href="${BUILD_URL}console">查看控制台</a></p>
  <p><strong>触发用户:</strong> ${BUILD_USER}</p>
</body>
</html>

第五部分：高级配置与最佳实践

1. 使用丰富的模板变量

Email Extension Plugin提供了大量内置变量，让你能够自定义邮件内容。常用的变量包括：

${PROJECT_NAME}：项目名称
${BUILD_NUMBER}：构建编号
${BUILD_STATUS}：构建状态（成功、失败、不稳定）
${BUILD_URL}：构建详情页URL
${BUILD_USER}：触发构建的用户名
${CAUSE}：构建原因

2. 设置不同的触发条件

合理的触发条件可以避免邮件骚扰，同时确保关键信息不被遗漏。建议根据项目重要性设置不同的策略：

关键项目：失败、成功、不稳定和修复时都发送通知。
普通项目：仅在失败和不稳定时发送通知。
实验性项目：仅在失败时发送通知。

3. 邮件内容优化技巧

使用HTML格式：让邮件更易读，可以通过颜色区分不同状态（如成功用绿色，失败用红色）。
包含关键信息：构建编号、项目名称、状态、触发用户、构建时长和直接访问链接。
添加日志片段：对于失败构建，可以包含最后几条日志错误信息，帮助快速定位问题。

第六部分：实战示例：完整的项目配置

假设我们有一个名为"WebApp-CI"的Java Web应用项目，下面是一个完整的邮件通知配置示例：

1. 全局SMTP配置（Configure System）

SMTP Server: smtp.gmail.com
SMTP Port: 587
SMTP User Name: your.company@gmail.com
SMTP Password: （应用专用密码）
Use SMTP Authentication: ✓
Start TLS if available: ✓
Default Subject Prefix: [Jenkins CI]
From Address: jenkins-noreply@yourcompany.com

2. 项目级邮件通知（Project Configuration → Post-build Actions）

Recipient List：

dev-team@yourcompany.com, $BUILD_USER_EMAIL

Subject：

[${PROJECT_NAME}] 构建 #${BUILD_NUMBER} 状态: ${BUILD_STATUS}

Content（HTML格式）：

<html>
<head><meta charset="UTF-8"></head>
<body style="font-family: Arial, sans-serif;">
  <div style="background-color: #f5f5f5; padding: 20px;">
    <div style="background-color: white; padding: 20px; border-radius: 5px;">
      <h2 style="color: #333; border-bottom: 1px solid #eee; padding-bottom: 10px;">构建通知 - ${PROJECT_NAME}</h2>
      
      <table style="width: 100%; border-collapse: collapse;">
        <tr>
          <td style="padding: 8px; border: 1px solid #ddd; background-color: #f9f9f9; width: 120px;"><strong>项目名称</strong></td>
          <td style="padding: 8px; border: 1px solid #ddd;">${PROJECT_NAME}</td>
        </tr>
        <tr>
          <td style="padding: 8px; border: 1px solid #ddd; background-color: #f9f9f9;"><strong>构建编号</strong></td>
          <td style="padding: 8px; border: 1px solid #ddd;">${BUILD_NUMBER}</td>
        </tr>
        <tr>
          <td style="padding: 8px; border: 1px solid #ddd; background-color: #f9f9f9;"><strong>构建状态</strong></td>
          <td style="padding: 8px; border: 1px solid #ddd;">
            <span style="color: 
            %if "${BUILD_STATUS}" == "SUCCESS"%
              green; font-weight: bold;">成功 ✓
            %else if "${BUILD_STATUS}" == "FAILURE"%
              red; font-weight: bold;">失败 ✗
            %else%
              orange; font-weight: bold;">不稳定 ⚠
            %endif%
            </span>
          </td>
        </tr>
        <tr>
          <td style="padding: 8px; border: 1px solid #ddd; background-color: #f9f9f9;"><strong>触发用户</strong></td>
          <td style="padding: 8px; border: 1px solid #ddd;">${BUILD_USER}</td>
        </tr>
        <tr>
          <td style="padding: 8px; border: 1px solid #ddd; background-color: #f9f9f9;"><strong>构建时间</strong></td>
          <td style="padding: 8px; border: 1px solid #ddd;">${BUILD_TIMESTAMP}</td>
        </tr>
      </table>
      
      <p style="margin-top: 20px;">
        <a href="${BUILD_URL}" style="background-color: #4CAF50; color: white; padding: 10px 15px; text-decoration: none; border-radius: 4px; display: inline-block;">查看构建详情</a>
        <a href="${BUILD_URL}console" style="background-color: #008CBA; color: white; padding: 10px 15px; text-decoration: none; border-radius: 4px; display: inline-block; margin-left: 10px;">查看控制台输出</a>
      </p>
      
      <p style="margin-top: 20px; font-size: 12px; color: #999;">
        此邮件由 Jenkins CI 系统自动发送，请勿直接回复。
      </p>
    </div>
  </div>
</body>
</html>

Triggers配置：