Flutter邮件与日历集成插件enough_mail_icalendar的使用

Flutter邮件与日历集成插件enough_mail_icalendar的使用

iCalendar 支持用于电子邮件/MIME。兼容 iCalendar 消息基础互操作协议（iMIP）[RFC 6047]。

安装

在你的 pubspec.yaml 文件中添加以下依赖项：

dependencies:
  enough_mail_icalendar: ^0.2.1
  enough_mail: any
  enough_icalendar: any

enough_mail_icalendar 的最新版本为 此处 显示的版本。

API 文档

查看完整的 API 文档在 此处。

使用

使用 enough_mail_icalendar 来生成和发送 MIME 邮件消息以处理 iCalendar 请求。

导入

import 'package:enough_icalendar/enough_icalendar.dart';
import 'package:enough_mail/enough_mail.dart';
import 'package:enough_mail_icalendar/enough_mail_icalendar.dart';

生成一个 VCalendar 对应的 MimeMessage

通过 VMessageBuilder.prepareFromCalendar(...) 创建一个给定 VCalendar 对象的 MIME 消息构建器。

void buildCalendarInviteMessage(VCalendar invite) {
  final builder = VMessageBuilder.prepareFromCalendar(invite);
  final mimeMessage = builder.buildMimeMessage();
  print(mimeMessage);
  // 你可以现在像任何其他消息一样发送 MimeMessage，例如使用 `MailClient.sendMessage(mimeMessage)`
}

生成一个回复的 MimeMessage 用于已接收的 VCalendar

使用 VMessageBuilder.prepareCalendarReply(...) 创建一个回复 MIME 消息用于已接收的 VCalendar。 以下示例中邀请被接受。

void buildAcceptReplyMessage(VCalendar invite) {
  final me = MailAddress('Donna Strickland', 'b@example.com');
  final acceptMessageBuilder = VMessageBuilder.prepareCalendarReply(
    invite,
    ParticipantStatus.accepted,
    me,
  );
  final mimeMessage = acceptMessageBuilder.buildMimeMessage();
  print('\n==========================');
  print('reply message:');
  print('==========================');
  print(mimeMessage);
}

直接发送一个回复用于已接收的 VCalendar

使用 MailClient.sendCalendarReply() 实例方法直接发送回复。这将生成 MIME 消息，发送它，并在指定消息时更新原始消息的标志，当邮件服务支持任意消息标志时。

Future sendCalendarReply(
  VCalendar calendar,
  ParticipantStatus participantStatus,
  MimeMessage originatingMessage,
  MailClient mailClient,
) {
  // 生成回复邮件消息，发送它，并设置消息标志：
  return mailClient.sendCalendarReply(calendar, participantStatus,
      originatingMessage: originatingMessage);
}

检查是否已发送回复的 MimeMessage

使用 MimeMessage 实例上的 calendarParticipantStatus 获取器来检查之前设置的参与状态标志。

ParticipantStatus? getParticipantStatus(MimeMessage message) {
  // 当标志成功添加时，可以通过消息标志检测到参与者状态
  final participantStatus = message.calendarParticipantStatus;
  if (participantStatus != null) {
    print(
        '检测到 ${participantStatus.name} 通过标志 ${participantStatus.flag}');
  } else {
    print('未在 ${message.flags} 中检测到参与者状态标志');
  }
  return participantStatus;
}

特性和问题

enough_mail_icalendar 应该完全符合 iCalendar 消息基础互操作协议（iMIP）[RFC 6047]。

请在 问题跟踪器 提交功能请求和错误报告。

相关项目

• 使用 enough_icalendar 管理 iCalendar 对象
• 使用 enough_mail 通过 IMAP、POP3 和 SMTP 进行电子邮件管理

类型安全

enough_mail_icalendar 是类型安全的。

许可证

enough_mail_icalendar 在 Mozilla Public License 2.0 下获得许可。

示例代码

以下是完整的示例代码，展示了如何使用 enough_mail_icalendar 插件来生成和发送日历邀请及回复。

import 'package:enough_icalendar/enough_icalendar.dart';
import 'package:enough_mail/enough_mail.dart';
import 'package:enough_mail_icalendar/enough_mail_icalendar.dart';

void main() {
  final invite = createInvite();
  buildCalendarInviteMessage(invite);
  buildAcceptReplyMessage(invite);
}

void buildCalendarInviteMessage(VCalendar invite) {
  final builder = VMessageBuilder.prepareFromCalendar(invite);
  final mimeMessage = builder.buildMimeMessage();
  print('==========================');
  print('invite message:');
  print('==========================');
  print(mimeMessage);
  // 你可以现在像任何其他消息一样发送 MimeMessage，例如使用 `MailClient.sendMessage(mimeMessage)`
}

void buildAcceptReplyMessage(VCalendar invite) {
  final me = MailAddress('Donna Strickland', 'b@example.com');
  final acceptMessageBuilder = VMessageBuilder.prepareCalendarReply(
    invite,
    ParticipantStatus.accepted,
    me,
  );
  final mimeMessage = acceptMessageBuilder.buildMimeMessage();
  print('\n==========================');
  print('reply message:');
  print('==========================');
  print(mimeMessage);
}

Future sendCalendarReply(
  VCalendar calendar,
  ParticipantStatus participantStatus,
  MimeMessage originatingMessage,
  MailClient mailClient,
) {
  // 生成回复邮件消息，发送它，并设置消息标志：
  return mailClient.sendCalendarReply(calendar, participantStatus,
      originatingMessage: originatingMessage);
}

ParticipantStatus? getParticipantStatus(MimeMessage message) {
  // 当标志成功添加时，可以通过消息标志检测到参与者状态
  final participantStatus = message.calendarParticipantStatus;
  if (participantStatus != null) {
    print(
        '检测到 ${participantStatus.name} 通过标志 ${participantStatus.flag}');
  } else {
    print('未在 ${message.flags} 中检测到参与者状态标志');
  }
  return participantStatus;
}

VCalendar createInvite() {
  final me = MailAddress('Andrea Ghez', 'a@example.com');
  final invitees = [
    MailAddress('Andrea Ghez', 'a@example.com'),
    MailAddress('Donna Strickland', 'b@example.com'),
    MailAddress('Maria Goeppert Mayer', 'c@example.com'),
    MailAddress('Marie Curie, née Sklodowska', 'c@example.com'),
  ];
  final invite = VCalendar.createEvent(
    start: DateTime(2021, 08, 01, 11, 00),
    duration: IsoDuration(hours: 1),
    organizer: me.organizer,
    attendees: invitees.map((address) => address.attendee).toList(),
    location: 'Stockholm',
    summary: 'Physics Winners',
    description: '让我们讨论接下来要研究什么。',
  );
  return invite;
}