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 _mailApi;

    public MailController(IFeishuUserV1MailMessage mailApi)
    {
        _mailApi = mailApi;
    }

    [HttpPost]
    public async Task<IActionResult> Send([FromBody] SendUserMailboxMessageRequest request)
    {
        var result = await _mailApi.SendUserMailboxMessageAsync("me", request);
        return Ok(result);
    }
}

说明：Tenant（IFeishuTenantV1*）接口使用租户访问令牌，适用于代企业内用户执行操作；User（IFeishuUserV1*）接口使用用户访问令牌，适用于以当前授权用户身份操作，user_mailbox_id 可使用占位符 me 表示当前授权用户的主邮箱。

API 接口导航 ​

邮件与会话 ​

邮箱组织与联系人 ​

邮件组与公共邮箱 ​

模板与签名 ​

搜索与事件 ​

命名空间与版本信息 ​

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