Mud Tools

Appearance

邮箱 SDK 接口文档 ​

概述 ​

邮箱 SDK 提供了飞书邮箱的完整 API 封装，支持邮箱别名、联系人、文件夹、邮件组、标签、邮件、公共邮箱、收信规则、邮件模板等功能，帮助开发者构建企业级邮箱管理系统。

主要功能：

  • 邮箱别名管理
  • 邮箱联系人管理
  • 邮箱文件夹管理
  • 邮件组管理
  • 邮箱标签管理
  • 邮箱邮件管理
  • 公共邮箱管理
  • 收信规则管理
  • 邮件模板管理
  • 邮箱事件订阅

适用场景：

  • 企业邮箱自动化管理
  • 邮件批量处理与归档
  • 邮箱权限与规则配置
  • 邮件模板与草稿管理
  • 公共邮箱协同管理
  • 邮件组与通讯录管理

文档使用指引：

本索引文档提供了所有邮箱相关 API 的导航入口。每个 API 文档包含接口名称、功能描述、函数签名、参数说明及请求示例。点击各 API 链接可查看详细文档。

快速开始 ​

安装 ​

bash
dotnet add package Mud.Feishu

配置文件 ​

在 appsettings.json 中添加飞书应用配置：

json
{
  "FeishuApps": [
    {
      "AppKey": "default",
      "AppId": "cli_xxx",
      "AppSecret": "your_app_secret",
      "BaseUrl": "https://open.feishu.cn",
      "IsDefault": true
    }
  ]
}

注册服务 ​

在 Program.cs 中注册飞书服务：

csharp
// 添加飞书服务
builder.Services.AddFeishuApp(builder.Configuration, "FeishuApps");

// 注册 API 服务
builder.Services.CreateFeishuServicesBuilder()
    .AddModules(FeishuModule.All)
    .Build();

依赖注入使用 ​

在 Controller 或服务中通过构造函数注入接口：

csharp
using Mud.Feishu;

public class MailController : ControllerBase
{
    private readonly IFeishuUserV1MailMessage _messageApi;

    public MailController(IFeishuUserV1MailMessage messageApi)
    {
        _messageApi = messageApi;
    }

    [HttpGet("messages")]
    public async Task<IActionResult> GetMessages()
    {
        var result = await _messageApi.GetUserMailboxMessagePageListAsync("me");
        return Ok(result);
    }
}

API 接口导航 ​

邮箱别名管理 ​

邮箱联系人管理 ​

邮箱文件夹管理 ​

邮件组管理 ​

邮箱标签管理 ​

邮箱邮件管理 ​

公共邮箱管理 ​

收信规则管理 ​

邮件模板与草稿 ​

命名空间与版本信息 ​

  • 根命名空间：Mud.Feishu
  • 当前版本：2.0.9
  • 目标框架：.NET Standard 2.0 / .NET 6+ / .NET 8+