Flutter邮件管理插件enough_mail的使用

enough_mail 是一个用于 Dart 和 Flutter 的 IMAP、POP3 和 SMTP 客户端库，适用于电子邮件开发。本文将介绍如何在 Flutter 应用中使用 enough_mail 插件。

安装

首先，在 pubspec.yaml 文件中添加 enough_mail 依赖：

dependencies:
  enough_mail: ^2.1.5

确保你已经安装了最新版本的 enough_mail，可以通过 Pub.dev 查看最新版本。

API 文档

完整的 API 文档可以在 这里 查阅。

高级 API 使用

高级 API 抽象了 IMAP 和 POP3 的细节，并自动重连，允许轻松监控邮箱中的新消息。

示例代码

以下是一个简单的示例，展示如何使用高级 API：

import 'dart:io';
import 'package:enough_mail/enough_mail.dart';

String userName = 'user.name';
String password = 'password';
String domain = 'domain.com';

void main() async {
  await mailExample();
}

MimeMessage buildMessage() {
  final builder = MessageBuilder.prepareMultipartAlternativeMessage(
    plainText: 'Hello world!',
    htmlText: '<p>Hello world!</p>',
  )
    ..from = [MailAddress('Personal Name', 'sender@domain.com')]
    ..to = [
      MailAddress('Recipient Personal Name', 'recipient@domain.com'),
      MailAddress('Other Recipient', 'other@domain.com')
    ];
  return builder.buildMimeMessage();
}

Future<void> mailExample() async {
  final email = '$userName@$domain';
  print('Discovering settings for $email...');
  final config = await Discover.discover(email);
  if (config == null) {
    print('Unable to auto-discover settings for $email');
    return;
  }
  print('Connecting to ${config.displayName}.');
  final account = MailAccount.fromDiscoveredSettings('my account', email, password, config);
  final mailClient = MailClient(account, isLogEnabled: true);
  try {
    await mailClient.connect();
    print('Connected');
    final mailboxes = await mailClient.listMailboxesAsTree(createIntermediate: false);
    print(mailboxes);
    await mailClient.selectInbox();
    final messages = await mailClient.fetchMessages(count: 20);
    messages.forEach(printMessage);
    mailClient.eventBus.on<MailLoadEvent>().listen((event) {
      print('New message at ${DateTime.now()}:');
      printMessage(event.message);
    });
    await mailClient.startPolling();
    final mimeMessage = buildMessage();
    await mailClient.sendMessage(mimeMessage);
  } on MailException catch (e) {
    print('High level API failed with $e');
  }
}

void printMessage(MimeMessage message) {
  print('From: ${message.from} with subject "${message.decodeSubject()}"');
  if (!message.isTextPlainMessage()) {
    print('Content-type: ${message.mediaType}');
  } else {
    final plainText = message.decodeTextPlainPart();
    if (plainText != null) {
      final lines = plainText.split('\r\n');
      for (final line in lines) {
        if (line.startsWith('>')) break;
        print(line);
      }
    }
  }
}

低级 API 使用

低级 API 提供了对 IMAP、SMTP 和 POP3 更底层的访问。

示例代码

以下是一个简单的低级 API 使用示例：

import 'dart:io';
import 'package:enough_mail/enough_mail.dart';

String userName = 'user.name';
String password = 'password';
String imapServerHost = 'imap.domain.com';
int imapServerPort = 993;
bool isImapServerSecure = true;
String smtpServerHost = 'smtp.domain.com';
int smtpServerPort = 465;
bool isSmtpServerSecure = true;

void main() async {
  await discoverExample();
  await imapExample();
  await smtpExample();
  exit(0);
}

Future<void> discoverExample() async {
  const email = 'someone@enough.de';
  final config = await Discover.discover(email, isLogEnabled: false);
  if (config == null) {
    print('Unable to discover settings for $email');
  } else {
    print('Settings for $email:');
    for (final provider in config.emailProviders!) {
      print('Provider: ${provider.displayName}');
      print('Provider-domains: ${provider.domains}');
      print('Documentation-url: ${provider.documentationUrl}');
      print('Incoming:');
      provider.incomingServers?.forEach(print);
      print(provider.preferredIncomingServer);
      print('Outgoing:');
      provider.outgoingServers?.forEach(print);
      print(provider.preferredOutgoingServer);
    }
  }
}

Future<void> imapExample() async {
  final client = ImapClient(isLogEnabled: false);
  try {
    await client.connectToServer(imapServerHost, imapServerPort, isSecure: isImapServerSecure);
    await client.login(userName, password);
    final mailboxes = await client.listMailboxes();
    print('Mailboxes: $mailboxes');
    await client.selectInbox();
    final fetchResult = await client.fetchRecentMessages(messageCount: 10, criteria: 'BODY.PEEK[]');
    fetchResult.messages.forEach(printMessage);
    await client.logout();
  } on ImapException catch (e) {
    print('IMAP failed with $e');
  }
}

Future<void> smtpExample() async {
  final client = SmtpClient('enough.de', isLogEnabled: true);
  try {
    await client.connectToServer(smtpServerHost, smtpServerPort, isSecure: isSmtpServerSecure);
    await client.ehlo();
    if (client.serverInfo.supportsAuth(AuthMechanism.plain)) {
      await client.authenticate('user.name', 'password', AuthMechanism.plain);
    } else if (client.serverInfo.supportsAuth(AuthMechanism.login)) {
      await client.authenticate('user.name', 'password', AuthMechanism.login);
    } else {
      return;
    }
    final mimeMessage = buildMessage();
    final sendResponse = await client.sendMessage(mimeMessage);
    print('Message sent: ${sendResponse.isOkStatus}');
  } on SmtpException catch (e) {
    print('SMTP failed with $e');
  }
}

void printMessage(MimeMessage message) {
  print('From: ${message.from} with subject "${message.decodeSubject()}"');
  if (!message.isTextPlainMessage()) {
    print('Content-type: ${message.mediaType}');
  } else {
    final plainText = message.decodeTextPlainPart();
    if (plainText != null) {
      final lines = plainText.split('\r\n');
      for (final line in lines) {
        if (line.startsWith('>')) break;
        print(line);
      }
    }
  }
}

相关项目

• enough_mail_html: 生成 HTML 输出。
• enough_mail_flutter: 提供常见的 Flutter 小部件。
• enough_mail_icalendar: 处理日历邀请。
• enough_mail_app: 一个完整的邮件应用。
• enough_convert: 提供缺少的编码。

贡献和反馈

如果你发现任何问题或有功能请求，请在 issue tracker 上提交。

感谢所有贡献者！你可以通过 fork 仓库并提交 Pull Request 来贡献代码。

许可证

enough_mail 基于商业友好的 Mozilla Public License 2.0 许可证发布。

希望这个指南能帮助你在 Flutter 应用中集成邮件功能。如果有任何问题或需要进一步的帮助，请随时提问！