Android开发-在Android应用里实现自动发送邮件的功能

前言

前段时间由于项目的需要,就是在Android应用里的用户反馈功能需要当用户输入反馈的文本信息后,用户点击提交按钮自动把反馈的文本信息已发送邮件的形式发送给开发者。

要实现这个功能,首先需要两个邮箱账号,一个是发送方的邮箱地址,一个是接收方的邮箱地址。还需要发送方的邮箱授权码(授权码一般是16位的字符串,生成后一般用于客户端的登录,下文会讲如何在登录网页版的邮箱自动生成授权码)、发送方的邮箱服务器(比如QQ邮箱的服务器为:smtp.qq.com)、发送方的邮箱端口号(比如QQ邮箱的端口号为:587)。这些流程都完成后就可以进行编码的操作了。

在开始编码之前首先在AndroidStudio的build.gradle的dependencies模块里引入实现发送邮箱相关的依赖库。

dependencies {
  ...
  implementation 'com.sun.mail:android-mail:1.5.5'
  implementation 'com.sun.mail:android-activation:1.5.5'
}

然后在AndroidStudio的清单文件AndroidManifest.xml里添加访问网络相关权限。

  <uses-permission android:name="android.permission.INTERNET" />
  <uses-permission android:name="android.permission.WRITE_EXTERNAL_STORAGE" />

下面就正式进入编码的操作流程。

新建一个SendMailUtil.java工具类

import android.support.annotation.NonNull;

import net.fkm.mailtest.MyApplication;
import net.fkm.mailtest.ShareUtils;

import java.io.File;

public class SendMailUtil {

  public static void send(final File file, String toAdd) {
    final MailInfo mailInfo = creatMail(toAdd);
    final MailSender sms = new MailSender();
    new Thread(new Runnable() {
      @Override
      public void run() {
        sms.sendFileMail(mailInfo, file);
      }
    }).start();
  }

  public static void send(String toAdd) {
    final MailInfo mailInfo = creatMail(toAdd);
    final MailSender sms = new MailSender();
    new Thread(new Runnable() {
      @Override
      public void run() {
        sms.sendTextMail(mailInfo);
      }
    }).start();
  }

  @NonNull
  private static MailInfo creatMail(String toAdd) {

    String HOST = ShareUtils.getString(MyApplication.getInstance(), "HOST", "");
    String PORT = ShareUtils.getString(MyApplication.getInstance(), "PORT", "");
    String FROM_ADD = ShareUtils.getString(MyApplication.getInstance(), "FROM_ADD", "");
    String FROM_PSW = ShareUtils.getString(MyApplication.getInstance(), "FROM_PSW", "");
    final MailInfo mailInfo = new MailInfo();
    mailInfo.setMailServerHost(HOST);//发送方邮箱服务器
    mailInfo.setMailServerPort(PORT);//发送方邮箱端口号
    mailInfo.setValidate(true);
    mailInfo.setUserName(FROM_ADD); // 发送者邮箱地址
    mailInfo.setPassword(FROM_PSW);// 发送者邮箱授权码
    mailInfo.setFromAddress(FROM_ADD); // 发送者邮箱
    mailInfo.setToAddress(toAdd); // 接收者邮箱
    mailInfo.setSubject("Android应用测试"); // 邮件主题
    mailInfo.setContent("哈哈"); // 邮件文本
    return mailInfo;
  }

}

该类是获取发送邮件信息的类,只要获取发送方邮箱服务器、发送方邮箱端口号、发送者邮箱地址、发送者邮箱授权码、发送者邮箱、接收者邮箱、发送邮件的主题以及邮件文本的操作信息。

新建一个MailInfo.java实体类

import java.util.Properties;

public class MailInfo {

  private String mailServerHost;// 发送邮件的服务器的IP
  private String mailServerPort;// 发送邮件的服务器的端口
  private String fromAddress;// 邮件发送者的地址
  private String toAddress;  // 邮件接收者的地址
  private String userName;// 登陆邮件发送服务器的用户名
  private String password;// 登陆邮件发送服务器的密码
  private boolean validate = true;// 是否需要身份验证
  private String subject;// 邮件主题
  private String content;// 邮件的文本内容
  private String[] attachFileNames;// 邮件附件的文件名

  /**
   * 获得邮件会话属性
   */
  public Properties getProperties() {
    Properties p = new Properties();
    p.put("mail.smtp.host", this.mailServerHost);
    p.put("mail.smtp.port", this.mailServerPort);
    p.put("mail.smtp.auth", validate ? "true" : "false");
    return p;
  }

  public String getMailServerHost() {
    return mailServerHost;
  }

  public void setMailServerHost(String mailServerHost) {
    this.mailServerHost = mailServerHost;
  }

  public String getMailServerPort() {
    return mailServerPort;
  }

  public void setMailServerPort(String mailServerPort) {
    this.mailServerPort = mailServerPort;
  }

  public boolean isValidate() {
    return validate;
  }

  public void setValidate(boolean validate) {
    this.validate = validate;
  }

  public String[] getAttachFileNames() {
    return attachFileNames;
  }

  public void setAttachFileNames(String[] fileNames) {
    this.attachFileNames = fileNames;
  }

  public String getFromAddress() {
    return fromAddress;
  }

  public void setFromAddress(String fromAddress) {
    this.fromAddress = fromAddress;
  }

  public String getPassword() {
    return password;
  }

  public void setPassword(String password) {
    this.password = password;
  }

  public String getToAddress() {
    return toAddress;
  }

  public void setToAddress(String toAddress) {
    this.toAddress = toAddress;
  }

  public String getUserName() {
    return userName;
  }

  public void setUserName(String userName) {
    this.userName = userName;
  }

  public String getSubject() {
    return subject;
  }

  public void setSubject(String subject) {
    this.subject = subject;
  }

  public String getContent() {
    return content;
  }

  public void setContent(String textContent) {
    this.content = textContent;
  }
  
}

在该类下主要对发送邮件的一些常用对象字段的序列化过程(如:发送邮件的服务器的IP、发送邮件的服务器的端口、邮件发送者的地址等)。

新建一个MailSender.java邮件发送器类

import net.fkm.mailtest.L;

import java.io.File;
import java.util.Date;
import java.util.Properties;

import javax.activation.DataHandler;
import javax.activation.FileDataSource;
import javax.mail.Address;
import javax.mail.Authenticator;
import javax.mail.BodyPart;
import javax.mail.Message;
import javax.mail.MessagingException;
import javax.mail.Multipart;
import javax.mail.PasswordAuthentication;
import javax.mail.Session;
import javax.mail.Transport;
import javax.mail.internet.InternetAddress;
import javax.mail.internet.MimeBodyPart;
import javax.mail.internet.MimeMessage;
import javax.mail.internet.MimeMultipart;
import javax.mail.internet.MimeUtility;

/**
 * 邮件发送器
 */
public class MailSender {
  /**
   * 以文本格式发送邮件
   *
   * @param mailInfo 待发送的邮件的信息
   */
  public boolean sendTextMail(final MailInfo mailInfo) {

    // 判断是否需要身份认证
    MyAuthenticator authenticator = null;
    Properties pro = mailInfo.getProperties();
    if (mailInfo.isValidate()) {
      // 如果需要身份认证,则创建一个密码验证器
      authenticator = new MyAuthenticator(mailInfo.getUserName(), mailInfo.getPassword());
    }
    // 根据邮件会话属性和密码验证器构造一个发送邮件的session
    Session sendMailSession = Session.getDefaultInstance(pro, authenticator);

//Session sendMailSession = Session.getInstance(pro, new Authenticator() {
//@Override
//protected PasswordAuthentication getPasswordAuthentication() {
//return new PasswordAuthentication(mailInfo.getUserName(),mailInfo.getPassword());
//}
//});

    try {
      // 根据session创建一个邮件消息
      Message mailMessage = new MimeMessage(sendMailSession);
      // 创建邮件发送者地址
      Address from = new InternetAddress(mailInfo.getFromAddress());
      // 设置邮件消息的发送者
      mailMessage.setFrom(from);
      // 创建邮件的接收者地址,并设置到邮件消息中
      Address to = new InternetAddress(mailInfo.getToAddress());
      mailMessage.setRecipient(Message.RecipientType.TO, to);
      // 设置邮件消息的主题
      mailMessage.setSubject(mailInfo.getSubject());
      // 设置邮件消息发送的时间
      mailMessage.setSentDate(new Date());

      // 设置邮件消息的主要内容
      String mailContent = mailInfo.getContent();
      mailMessage.setText(mailContent);
      // 发送邮件
      Transport.send(mailMessage);
      return true;
    } catch (MessagingException ex) {
      ex.printStackTrace();
    }
    return false;
  }

  /**
   * 以HTML格式发送邮件
   *
   * @param mailInfo 待发送的邮件信息
   */
  public static boolean sendHtmlMail(MailInfo mailInfo) {
    // 判断是否需要身份认证
    MyAuthenticator authenticator = null;
    Properties pro = mailInfo.getProperties();
    // 如果需要身份认证,则创建一个密码验证器
    if (mailInfo.isValidate()) {
      authenticator = new MyAuthenticator(mailInfo.getUserName(), mailInfo.getPassword());
    }
    // 根据邮件会话属性和密码验证器构造一个发送邮件的session
    Session sendMailSession = Session.getDefaultInstance(pro, authenticator);
    try {
      // 根据session创建一个邮件消息
      Message mailMessage = new MimeMessage(sendMailSession);
      // 创建邮件发送者地址
      Address from = new InternetAddress(mailInfo.getFromAddress());
      // 设置邮件消息的发送者
      mailMessage.setFrom(from);
      // 创建邮件的接收者地址,并设置到邮件消息中
      Address to = new InternetAddress(mailInfo.getToAddress());
      // Message.RecipientType.TO属性表示接收者的类型为TO
      mailMessage.setRecipient(Message.RecipientType.TO, to);
      // 设置邮件消息的主题
      mailMessage.setSubject(mailInfo.getSubject());
      // 设置邮件消息发送的时间
      mailMessage.setSentDate(new Date());
      // MiniMultipart类是一个容器类,包含MimeBodyPart类型的对象
      Multipart mainPart = new MimeMultipart();
      // 创建一个包含HTML内容的MimeBodyPart
      BodyPart html = new MimeBodyPart();
      // 设置HTML内容
      html.setContent(mailInfo.getContent(), "text/html; charset=utf-8");
      mainPart.addBodyPart(html);
      // 将MiniMultipart对象设置为邮件内容
      mailMessage.setContent(mainPart);
      // 发送邮件
      Transport.send(mailMessage);
      return true;
    } catch (MessagingException ex) {
      ex.printStackTrace();
    }
    return false;
  }


  /**
   * 发送带附件的邮件
   *
   * @param info
   * @return
   */
  public boolean sendFileMail(MailInfo info, File file) {
    Message attachmentMail = createAttachmentMail(info, file);
    try {
      Transport.send(attachmentMail);
      return true;
    } catch (MessagingException e) {
      e.printStackTrace();
      return false;
    }

  }

  /**
   * 创建带有附件的邮件
   *
   * @return
   */
  private Message createAttachmentMail(final MailInfo info, File file) {
    //创建邮件
    MimeMessage message = null;
    Properties pro = info.getProperties();
    try {

      Session sendMailSession = Session.getInstance(pro, new Authenticator() {
        @Override
        protected PasswordAuthentication getPasswordAuthentication() {
          return new PasswordAuthentication(info.getUserName(), info.getPassword());
        }
      });

      message = new MimeMessage(sendMailSession);
      // 设置邮件的基本信息
      //创建邮件发送者地址
      Address from = new InternetAddress(info.getFromAddress());
      //设置邮件消息的发送者
      message.setFrom(from);
      //创建邮件的接受者地址,并设置到邮件消息中
      Address to = new InternetAddress(info.getToAddress());
      //设置邮件消息的接受者, Message.RecipientType.TO属性表示接收者的类型为TO
      message.setRecipient(Message.RecipientType.TO, to);
      //邮件标题
      message.setSubject(info.getSubject());

      // 创建邮件正文,为了避免邮件正文中文乱码问题,需要使用CharSet=UTF-8指明字符编码
      MimeBodyPart text = new MimeBodyPart();
      text.setContent(info.getContent(), "text/html;charset=UTF-8");

      // 创建容器描述数据关系
      MimeMultipart mp = new MimeMultipart();
      mp.addBodyPart(text);
      // 创建邮件附件
      MimeBodyPart attach = new MimeBodyPart();

      FileDataSource ds = new FileDataSource(file);
      DataHandler dh = new DataHandler(ds);
      attach.setDataHandler(dh);
      attach.setFileName(MimeUtility.encodeText(dh.getName()));
      mp.addBodyPart(attach);
      mp.setSubType("mixed");
      message.setContent(mp);
      message.saveChanges();

    } catch (Exception e) {
      L.i("创建带附件的邮件失败");
      e.printStackTrace();
    }
    // 返回生成的邮件
    return message;
  }

该类主要实现邮件发送器发送邮件的类型的类型(如以文本格式发送邮件或者以HTML格式发送邮件),还实现是否发送发送带附件的邮件功能。

最后新建一个MyAuthenticator.java邮件发送认证的类

import javax.mail.Authenticator;
import javax.mail.PasswordAuthentication;

public class MyAuthenticator extends Authenticator {
  String userName = null;
  String password = null;

  public MyAuthenticator() {
  }

  public MyAuthenticator(String username, String password) {
    this.userName = username;
    this.password = password;
  }

  protected PasswordAuthentication getPasswordAuthentication() {
    return new PasswordAuthentication(userName, password);
  }
}

该类主要实现发送方邮箱地址以及授权码,并实现接口的暴露以便外部的调用。

配置和查看发送方邮箱的服务器、端口号以及授权码

不过大家有没有发现在实现这些类的时候需要配置一些发送方的邮箱相关的信息,比如发送方邮箱服务器、发送方的邮箱端口号、发送方的邮箱授权码等,这些信息开发者是怎样查看的呢?下面以QQ邮箱为例。

首先访问QQ邮箱的网址(https://mail.qq.com/ ),然后登录自己QQ邮箱账号后进入邮箱主页后进行以下操作。

在邮箱主页的顶部导航栏点击“设置”的按钮,如下图:
Android开发-在Android应用里实现自动发送邮件的功能
点击“设置”按钮后进入邮箱设置的操作界面后在导航栏点击“帐号”按钮,如下图。
Android开发-在Android应用里实现自动发送邮件的功能

进入“账号”操作界面后往下滑找到“POP3/IMAP/SMTP/Exchange/CardDAV/CalDAV服务”的设置功能。如下图。
Android开发-在Android应用里实现自动发送邮件的功能
然后把邮箱账号的“POP3/SMTP服务”和“IMAP/SMTP服务”开启了,开启成功后会自动分配一个16位字符串的授权码,如下图。该授权码一般用于代替在第三方客户端邮箱登录该邮箱账户时所用的密码,一般是为了邮箱密码的安全考虑。
Android开发-在Android应用里实现自动发送邮件的功能
配置完成后最后不要忘了点击底部的“保存更改”的按钮,否则配置信息无效。如下图。
Android开发-在Android应用里实现自动发送邮件的功能
最后来个程序主页界面运行截图
Android开发-在Android应用里实现自动发送邮件的功能
在项目应用程序的主界面填写完相应的信息后点击“点击发送文本邮件”按钮后登录接收方的邮箱后就可以在收件箱里看到刚自动发送的邮件了。

题外话,在实际的项目开发时用到自动发送邮件功能时,以上的发送方邮箱的地址、授权码、服务器、端口号以及接收方的邮箱地址的配置信息建议由服务端动态返回给客户端,不建议直接在客户端里直接写死。一是为了邮箱账号的安全考虑,二是为了修改邮箱地址的配置信息方便。


Demo程序源码下载地址一(GitHub)
Demo程序源码下载地址二(码云)