解决 Jenkins SMTP 电子邮件通知失败

解决 Jenkins SMTP 电子邮件通知失败
解决 Jenkins SMTP 电子邮件通知失败
Daniel Marino
2024年3月21日星期四 上午1:38:52

解决 Jenkins 中的电子邮件通知问题

对于许多组织来说，Jenkins 充当其持续集成和交付管道的支柱，促进构建、测试和部署应用程序的自动化。这种自动化的一个重要组成部分是能够通过电子邮件通知团队成员构建状态。最近，大量用户报告这些通知突然停止，导致团队对其项目进度一无所知。这种中断通常可以追溯到 SMTP（简单邮件传输协议）问题，在尝试发送电子邮件时表现为 TLS（传输层安全）错误。快速识别并解决这些错误对于维持沟通流程和开发过程的效率至关重要。

遇到的错误消息通常指示“javax.net.ssl.SSLHandshakeException”，表明无法在 Jenkins 和 SMTP 服务器之间建立安全连接。此问题可能源于多种因素，包括过时或配置错误的服务器设置、端口使用不正确或 TLS 协议的兼容性问题。了解这些 SMTP 通信失败的根本原因是解决问题的第一步。在以下部分中，我们将深入研究常见原因和解决方案，帮助您将 Jenkins 电子邮件通知恢复到完整功能。

命令 描述
Session.getInstance(props, Authenticator) 创建具有指定属性和身份验证机制的邮件会话。
new MimeMessage(session) 在给定会话中构造新的电子邮件消息。
message.setFrom(InternetAddress) 设置邮件标题中的“发件人”电子邮件地址。
message.setRecipients(Message.RecipientType.TO, InternetAddress.parse(recipient)) 定义消息收件人的电子邮件地址。
message.setSubject(subject) 设置电子邮件的主题行。
message.setText(content) 设置电子邮件的主要内容。
Transport.send(message) 通过指定的传输通道发送电子邮件。
Jenkins.instance.setLocation(URL, email) 设置 Jenkins 实例的系统 URL 和管理电子邮件。
Mailer.descriptor().set* 设置各种 SMTP 配置，例如主机、端口和身份验证详细信息。
println("message") 将消息输出到 Jenkins 系统日志或控制台。

了解 Jenkins 中的电子邮件通知配置

提供的 Java 和 Groovy 脚本有助于配置 Jenkins 通过 SMTP 发送电子邮件通知，解决 TLS 握手错误等常见问题。 Java 代码片段主要在 Jenkins 作业或插件中使用来动态发送电子邮件。它首先利用 javax.mail 包设置启用身份验证的邮件会话。此设置涉及指定 SMTP 服务器详细信息，包括主机 (smtp.gmail.com) 和端口（SSL 为 587 或 465），并启用 STARTTLS 以确保加密通信。身份验证是通过嵌套身份验证器类处理的，该类为 SMTP 服务器提供必要的凭据。建立会话后，脚本将构造电子邮件消息，设置发件人、收件人、主题和正文内容。最后，消息通过 Transport.send 方法通过网络发送，如果失败（通常是由于配置错误或网络问题），该方法会抛出 MessagingException。

Groovy 脚本设计用于在 Jenkins 的脚本控制台中执行，该功能允许管理员在 Jenkins 环境中运行任意 Groovy 脚本。该脚本直接与 Jenkins 的系统级设置交互来配置内置的 Mailer 插件。它更新 SMTP 设置，例如服务器主机、端口和身份验证详细信息，与 Java 示例中提供的设置相匹配。此外，它还设置 Jenkins 实例 URL 和系统管理电子邮件，这对于电子邮件通知的正确运行至关重要。通过更新这些设置，Groovy 脚本可确保 Jenkins 能够在正确的协议下与指定的 SMTP 服务器进行通信，从而有效避免服务器因过时或不受支持的加密方法而拒绝连接时遇到的常见问题，例如 SSLHandshakeException。

使用 SMTP 配置修复 Jenkins 电子邮件通知

Java for Jenkins 插件脚本

import javax.mail.Message;
import javax.mail.MessagingException;
import javax.mail.PasswordAuthentication;
import javax.mail.Session;
import javax.mail.Transport;
import javax.mail.internet.InternetAddress;
import javax.mail.internet.MimeMessage;
import java.util.Properties;
public class MailUtil {
    public static void sendEmail(String recipient, String subject, String content) {
        final String username = "yourusername@gmail.com";
        final String password = "yourpassword";
        Properties props = new Properties();
        props.put("mail.smtp.auth", "true");
        props.put("mail.smtp.starttls.enable", "true");
        props.put("mail.smtp.host", "smtp.gmail.com");
        props.put("mail.smtp.port", "587");
        Session session = Session.getInstance(props,
          new javax.mail.Authenticator() {
            protected PasswordAuthentication getPasswordAuthentication() {
                return new PasswordAuthentication(username, password);
            }
          });
        try {
            Message message = new MimeMessage(session);
            message.setFrom(new InternetAddress("from-email@gmail.com"));
            message.setRecipients(Message.RecipientType.TO,
                    InternetAddress.parse(recipient));
            message.setSubject(subject);
            message.setText(content);
            Transport.send(message);
            System.out.println("Sent message successfully....");
        } catch (MessagingException e) {
            throw new RuntimeException(e);
        }
    }
}

调整 Jenkins 服务器以使用更新的 TLS 协议

Groovy for Jenkins 系统脚本控制台

import jenkins.model.Jenkins;
import hudson.tasks.Mailer;
// Set Jenkins location and admin email
Jenkins.instance.setLocation(new URL("http://yourjenkinsurl.com/"), "admin@yourdomain.com");
// Configure SMTP settings
Mailer.descriptor().setSmtpHost("smtp.gmail.com");
Mailer.descriptor().setSmtpPort(587);
Mailer.descriptor().setUseSsl(true);
Mailer.descriptor().setSmtpAuth(true);
Mailer.descriptor().setSmtpUsername("yourusername@gmail.com");
Mailer.descriptor().setSmtpPassword("yourpassword");
Mailer.descriptor().setCharset("UTF-8");
Mailer.descriptor().save();
println("SMTP settings updated successfully");

探索 Jenkins 电子邮件集成挑战

配置 Jenkins 发送电子邮件通知时，必须了解电子邮件传送系统的更广泛背景及其带来的挑战。电子邮件传送，尤其是在 Jenkins 这样的自动化系统中，很大程度上依赖于 SMTP 服务器以及这些服务器的正确配置，以确保电子邮件到达预期收件人。这不仅涉及正确的 SMTP 服务器地址和凭据，还涉及适当的端口号和加密协议。例如，端口 587 通常用于 TLS/STARTTLS 加密，而端口 465 用于 SSL。这些设置中的错误配置可能会导致电子邮件通知失败。

另一个值得考虑的方面是对 Gmail 等外部电子邮件服务的依赖，这些服务有自己的安全措施和限制，例如速率限制和身份验证要求。这些服务经常更新其安全策略以抵御垃圾邮件和网络钓鱼攻击，这可能会无意中影响来自 Jenkins 等系统的合法自动电子邮件。了解这些外部因素以及内部配置挑战对于故障排除和确保在软件开发生命周期中将电子邮件通知从 Jenkins 可靠地传递给利益相关者至关重要。

Jenkins 中的电子邮件通知常见问题解答

  1. 问题： 什么是 SMTP？
  2. 回答： SMTP 代表简单邮件传输协议，用于通过 Internet 发送电子邮件。
  3. 问题： 为什么我收不到 Jenkins 的电子邮件？
  4. 回答： 这可能是由于 SMTP 配置不正确、防火墙问题或电子邮件服务提供商阻止电子邮件造成的。
  5. 问题： 如何配置 Jenkins 使用 Gmail 发送电子邮件？
  6. 回答： 在 Jenkins 中，将 SMTP 服务器配置为 smtp.gmail.com，使用 TLS 端口 587，并提供您的 Gmail 用户名和密码。
  7. 问题： 什么是 TLS/SSL，为什么它对于电子邮件通知很重要？
  8. 回答： TLS/SSL 是用于通过互联网进行安全通信的加密协议，对于保护电子邮件中的敏感信息至关重要。
  9. 问题： 我可以在 Jenkins 中使用自定义电子邮件域吗？
  10. 回答： 是的，在 Jenkins 中配置 SMTP 服务器设置以匹配域托管服务提供的设置。

封装 Jenkins 电子邮件问题和解决方案

作为现代软件开发实践的核心，Jenkins 可自动执行任务并通过电子邮件通知让团队了解情况。然而，当 SMTP 配置出错或外部电子邮件服务加强安全性时，可能会破坏此流程，导致 TLS 握手错误，从而困扰许多开发人员。此问题强调了彻底了解 Jenkins 的电子邮件配置和 SMTP 协议（​​包括端口、安全设置和身份验证机制）的重要性。解决方案通常涉及更新 Jenkins 设置以符合当前电子邮件服务器要求或调整服务器设置以使用兼容的加密协议。通过解决这些技术挑战，开发人员可以恢复 Jenkins 的电子邮件功能，确保团队充分了解其持续集成管道。这种情况还凸显了依赖外部服务进行关键开发流程的更广泛影响，以及需要对安全策略和协议兼容性保持持续警惕。