将 Gmail API Message 类编码为 Raw 格式

本文档旨在解决在使用 Java Gmail API 时，将 `Message` 对象编码为符合 API 要求的 Raw 格式的问题。通过 `MimeMessage` 创建邮件内容，并使用 `ByteArrayOutputStream` 和 `Base64.encodeBase64URLSafeString()` 方法将其转换为 URL 安全的 Base64 编码字符串，最终设置到 `Message` 对象的 `raw` 属性中，从而避免 "Required parameter Message.getRaw() must be specified" 错误。

在使用 Gmail API 发送邮件时，需要将邮件内容编码为特定的 Raw 格式，即 URL 安全的 Base64 编码字符串。 Message 对象需要设置 raw 属性，该属性包含了编码后的邮件内容。 如果缺少此步骤，API 将返回 "Required parameter Message.getRaw() must be specified" 错误。 本教程将介绍如何使用 Java 将 Message 对象编码为所需的 Raw 格式。

步骤详解

1. 创建 MimeMessage 对象:

   首先，你需要创建一个 MimeMessage 对象来构建你的邮件内容。MimeMessage 是 JavaMail API 提供的一个类，用于表示 MIME 格式的邮件消息。你可以使用它来设置邮件的头部信息（如发件人、收件人、主题）以及邮件的内容。

   import javax.mail.MessagingException;
   import javax.mail.Session;
   import javax.mail.internet.InternetAddress;
   import javax.mail.internet.MimeMessage;
   import java.util.Properties;
   
   // 创建一个 Session 对象
   Properties props = new Properties();
   Session session = Session.getDefaultInstance(props, null);
   
   try {
       MimeMessage mimeMessage = new MimeMessage(session);
       mimeMessage.setFrom(new InternetAddress("your_email@example.com"));
       mimeMessage.addRecipient(javax.mail.Message.RecipientType.TO, new InternetAddress("recipient_email@example.com"));
       mimeMessage.setSubject("邮件主题");
       mimeMessage.setText("邮件内容"); // 或者使用 setContent() 设置更复杂的 MIME 内容
   } catch (MessagingException e) {
       e.printStackTrace();
       // 处理异常
   }

2. 将 MimeMessage 转换为 Raw 格式:

   接下来，你需要将 MimeMessage 对象转换为 Gmail API 所需的 Raw 格式。这需要以下步骤：

   • 创建一个 ByteArrayOutputStream 对象，用于存储 MimeMessage 的字节数据。
   • 使用 MimeMessage.writeTo(OutputStream) 方法将 MimeMessage 的内容写入 ByteArrayOutputStream。
   • 使用 org.apache.commons.codec.binary.Base64.encodeBase64URLSafeString(byte[]) 方法将 ByteArrayOutputStream 中的字节数据编码为 URL 安全的 Base64 字符串。 请确保引入 commons-codec 依赖。

   import org.apache.commons.codec.binary.Base64;
   import java.io.ByteArrayOutputStream;
   import java.io.IOException;
   
   public Message publishMessage(MimeMessage mime) throws MessagingException, IOException {
       ByteArrayOutputStream buffer = new ByteArrayOutputStream();
       mime.writeTo(buffer);
       byte[] bytes = buffer.toByteArray();
       Message message = new Message();
       message.setRaw(Base64.encodeBase64URLSafeString(bytes));
   
       // 一些可选的操作，例如设置邮件标签
       // ...
   
       return message;
   }

3. 设置 Message 对象的 raw 属性:

   最后，你需要创建一个 com.google.api.services.gmail.model.Message 对象，并将编码后的 Base64 字符串设置到其 raw 属性中。

   import com.google.api.services.gmail.model.Message;
   
   // 在上面的 publishMessage 方法中已经完成

完整示例代码:

Cutout.Pro

AI驱动的视觉设计平台

下载

import com.google.api.services.gmail.model.Message;
import org.apache.commons.codec.binary.Base64;

import javax.mail.MessagingException;
import javax.mail.Session;
import javax.mail.internet.InternetAddress;
import javax.mail.internet.MimeMessage;
import java.io.ByteArrayOutputStream;
import java.io.IOException;
import java.util.Properties;

public class GmailHelper {

    public Message createMessageWithEmail(String from, String to, String subject, String bodyText) throws MessagingException, IOException {
        Properties props = new Properties();
        Session session = Session.getDefaultInstance(props, null);

        MimeMessage email = new MimeMessage(session);
        email.setFrom(new InternetAddress(from));
        email.addRecipient(javax.mail.Message.RecipientType.TO, new InternetAddress(to));
        email.setSubject(subject);
        email.setText(bodyText);

        return publishMessage(email);
    }

    public Message publishMessage(MimeMessage mime) throws MessagingException, IOException {
        ByteArrayOutputStream buffer = new ByteArrayOutputStream();
        mime.writeTo(buffer);
        byte[] bytes = buffer.toByteArray();
        Message message = new Message();
        message.setRaw(Base64.encodeBase64URLSafeString(bytes));

        return message;
    }

    public static void main(String[] args) {
        try {
            GmailHelper helper = new GmailHelper();
            Message message = helper.createMessageWithEmail("your_email@example.com", "recipient_email@example.com", "测试邮件", "这是一封测试邮件。");
            System.out.println("Message Raw Data: " + message.getRaw());
            // 现在你可以使用 service.users().messages().send("me", message).execute() 发送邮件了
        } catch (Exception e) {
            e.printStackTrace();
        }
    }
}

注意事项:

• 确保你已经正确配置了 Gmail API 的凭据和权限。

• commons-codec 是 Apache Commons Codec 库的一部分，提供了多种编码和解码算法，包括 Base64。 需要在你的项目中添加该依赖。 Maven配置如下:

  <dependency>
      <groupId>commons-codec</groupId>
      <artifactId>commons-codec</artifactId>
      <version>1.15</version> <!-- 使用最新版本 -->
  </dependency>

• javax.mail 是 JavaMail API，用于处理邮件消息。 确保已经添加该依赖。 Maven配置如下:

      <dependency>
          <groupId>com.sun.mail</groupId>
          <artifactId>javax.mail</artifactId>
          <version>1.6.2</version>
      </dependency>

• 在实际应用中，你应该处理可能出现的 MessagingException 和 IOException 异常。

• MimeMessage.setText() 方法只适用于纯文本邮件。如果需要发送 HTML 邮件或者包含附件的邮件，你需要使用 MimeMultipart 类来构建邮件内容。

• 在 publishMessage 方法中，你可以在设置 raw 属性之后，对 Message 对象进行其他操作，例如设置邮件标签。

总结:

通过本教程，你学习了如何将 MimeMessage 对象转换为 Gmail API 所需的 Raw 格式，并将其设置到 Message 对象的 raw 属性中。这可以帮助你避免在使用 Gmail API 发送邮件时遇到 "Required parameter Message.getRaw() must be specified" 错误。 记住，正确处理异常并根据实际需求选择合适的邮件内容构建方式非常重要。