Flutter邮件发送插件mail_sender的使用

Flutter邮件发送插件mail_sender的使用

插件简介

mail_sender 是一个用于在Flutter应用程序中发送预填充邮件的插件。它支持预填充邮件正文、主题、收件人等信息，并且支持附件。

功能特性

• 预填充邮件正文、主题、收件人等信息。
• 支持附件（目前仅支持单个附件，iOS仅支持PDF格式）。

平台支持

快速开始

1. 添加依赖

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

dependencies:
  mail_sender: ^version

2. 导入包

在 Dart 文件中导入 mail_sender 包：

import 'package:mail_sender/mail_sender.dart';

3. 发送邮件

在 main.dart 文件中添加以下代码来发送邮件：

final _mailSenderPlugin = MailSender();

_mailSenderPlugin.sendMail(
  recipient: ["john.Doe@gmail.com", "jane.doe@creoit.com"], // 收件人列表
  subject: "Leave Application", // 邮件主题
  body: "Some lengthy Body text", // 邮件正文
  bcc: ["bcc@bcc.com"], // 密送列表
  cc: ["someGuy.promail@gmail.com", "msoffice@gmail.com"], // 抄送列表
  attachment: targetFile.path, // 附件路径
);

4. Android 配置

在 AndroidManifest.xml 文件中添加以下配置：

<provider
    android:name="androidx.core.content.FileProvider"
    android:authorities="${applicationId}.fileprovider"
    android:exported="false"
    android:grantUriPermissions="true">
    <meta-data
        android:name="android.support.FILE_PROVIDER_PATHS"
        android:resource="@xml/provider_paths" />
</provider>

创建一个新的文件 provider_paths.xml，并将其放置在 android/app/src/main/res/xml 文件夹中，内容如下：

<paths xmlns:android="http://schemas.android.com/apk/res/android">
    <files-path name="app_flutter_files" path="../app_flutter/" />
</paths>

5. iOS 配置

iOS 平台无需额外配置。

完整示例代码

以下是一个完整的示例代码，展示了如何在 Flutter 应用程序中使用 mail_sender 插件发送带有附件的邮件：

import 'dart:io';
import 'package:flutter/material.dart';
import 'package:mail_sender/mail_sender.dart';
import 'package:path_provider/path_provider.dart';

void main() {
  runApp(const MyApp());
}

class MyApp extends StatefulWidget {
  const MyApp({super.key});

  [@override](/user/override)
  State<MyApp> createState() => _MyAppState();
}

class _MyAppState extends State<MyApp> {
  String _platformVersion = 'Unknown';
  final _mailSenderPlugin = MailSender();

  [@override](/user/override)
  void initState() {
    super.initState();
    initPlatformState();
  }

  // 初始化平台状态
  Future<void> initPlatformState() async {
    String platformVersion;
    try {
      platformVersion = await _mailSenderPlugin.getPlatformVersion() ??
          'Unknown platform version';
    } on PlatformException {
      platformVersion = 'Failed to get platform version.';
    }

    if (!mounted) return;

    setState(() {
      _platformVersion = platformVersion;
    });
  }

  [@override](/user/override)
  Widget build(BuildContext context) {
    return MaterialApp(
      home: Scaffold(
        appBar: AppBar(
          title: const Text('Plugin example app'),
        ),
        body: Column(
          children: [
            Center(
              child: Text('Running on: $_platformVersion\n'),
            ),
            ElevatedButton(
              onPressed: () async {
                // 加载资产文件（例如 PDF）
                ByteData fileData = await rootBundle.load("assets/sample.pdf");

                // 获取应用文档目录
                File targetFile = File(
                    "${(await getApplicationDocumentsDirectory()).path}/sample.pdf");

                // 如果文件不存在，则创建文件
                if (!(await targetFile.exists())) {
                  await targetFile.create(recursive: true);
                }

                // 将资产文件写入目标文件
                await targetFile.writeAsBytes(fileData.buffer.asUint8List(
                    fileData.offsetInBytes, fileData.lengthInBytes));

                // 发送邮件
                _mailSenderPlugin.sendMail(
                  recipient: ["john.Doe@creoit.com", "jane.doe@creoit.com"],
                  subject: "Leave Application",
                  body: "Some lengthy Body text",
                  bcc: ["bcc@bcc.com"],
                  cc: ["someGuy.promail@gmail.com", "msoffice@gmail.com"],
                  attachment: targetFile.path,
                ).onError((error, stackTrace) {
                  if (error is PlatformException) {
                    print("error: $error, ${error.code}, ${error.message}, ${error.details}");
                  }
                });

                // 打印平台版本
                print(
                    "Version: ${await _mailSenderPlugin.getPlatformVersion()}");
              },
              child: Text('Send mail'),
            ),
          ],
        ),
      ),
    );
  }
}