Java发送mail报错“java.util.ServiceConfigurationError: com.sun.mail.imap.IMAPProvider not a subtype”

背景

最近遇到一个诡异的发送邮件的问题，特记录之。

现有代码中已有 EmailUtils 类，并提供了static方法 sendEmail() ，在多个模块中被调用，一直运行良好。

现在要在另一个模块里添加发送邮件功能。把代码copy过来，稍微修改一下title，content，sender之类的参数，代码基本上大同小异。在本机测试一下 main() 方法，工作OK。然而，当我本地起server运行的时候（Java web project），却发现没有收到mail。

分析

我在调用 sendEmail() 方法的前后加了一些log，发现方法前面的log打印出来了，而方法后面的log则没有打印出来，也没有报错，所以我想是不是线程在 sendEmail() 的时候hang住了。但我想也许是我本地server环境或者性能有问题，于是先提交了代码。

部署到playground server上之后，我发现server上也是一样的现象。说明这是一个common的issue，于是重新在本地起server来调试分析。

在debug时，没发现什么明显的异常，我于是给sendEmail加上了 try...catch ，catch了 Exception ：

		try {
			xxx;
		} catch (Exception e) {
			xxx;
		}

结果并没有捕获到任何Exception，但是运行明显是出错了。线程在某处一下子跳到了 CompletableFuture 的837行 catch (Throwable ex) （我是在 CompletableFuture 的异步线程里发送邮件）。

这说明错误虽然是Throwable，但不是Exception，于是我把上面代码也改成 catch (Throwable e) ，这下终于捕获到错误了，如下：

java.util.ServiceConfigurationError: javax.mail.Provider: Provider com.sun.mail.imap.IMAPProvider not a subtype

错误来自于 EmailUtils 的这一行代码：

transport = mailSession.getTransport();

其中 mailSession 的类型是 javax.mail.Session 。

至此我才明白线程并不是hang住了，而是出了错，但是这个错误不是Exception，没有被catch所捕获到（代码里一般都是catch Exception），所以直接导致线程挂了，没有记下来log。我看到 sendEmail() 之前的log打出来了，之后的log没有打出来，还以为是线程hang住了呢。

OK，虽然明白是代码出错了，但奇怪的是，几乎同样的代码，在其它模块里能正常工作，只有在这个模块里就报错，它们都是调用了 EmailUtils 的 sendEmail() 方法，我甚至测试过把所有参数换成跟其它模块使用的参数完全一样，仍然会失败，其中原因令人费解。

找不到原因，也不知道怎么解决，只好在网上搜索这个错误。网上的说法也是五花八本，众说纷纭。但不管怎么样，其中有一个解决方法确实解决了问题，如下：

https://stackoverflow.com/questions/59641642/java-mail-exception-when-sending-email

Thread t =  Thread.currentThread();
ClassLoader ccl = t.getContextClassLoader();
t.setContextClassLoader(session.getClass().getClassLoader());
try {
    Transport.send(m);
} finally {
    t.setContextClassLoader(ccl);
}

其实我也没明白这个solution的point在哪里。反正按照这个方法试了一下，果然好使了。只不过这里是把 Transport.send(m) 包起来了，而我是在 mailSession.getTransport() 出错的，所以我把那一行以及后面的代码都包起来了。

参考

• https://stackoverflow.com/questions/59641642/java-mail-exception-when-sending-email