Mud Tools

Appearance

邮箱文件夹管理 - 用户令牌（IFeishuUserV1MailFolder） ​

功能描述 ​

飞书邮箱文件夹API接口实现了修改、查询、删除等邮箱文件夹管理功能。支持用户通过用户访问令牌管理自己的邮箱文件夹。

参考文档 ​

函数列表 ​

函数名称功能描述认证方式HTTP 方法
GetUserMailboxFoldeAsync获取邮箱文件夹信息UserAccessTokenGET
CreateUserMailboxFoldeAsync创建邮箱文件夹UserAccessTokenPOST
DeleteUserMailboxFoldeAsync删除邮箱文件夹UserAccessTokenDELETE
UpdateUserMailboxFoldeAsync更新邮箱文件夹UserAccessTokenPATCH
GetUserMailboxFoldeListAsync列出邮箱文件夹UserAccessTokenGET
GetAccessibleMailboxesUserMailboxAsync列出可访问的邮箱UserAccessTokenGET

函数详细内容 ​

GetUserMailboxFoldeAsync ​

获取邮箱文件夹信息

函数签名

csharp
Task<FeishuApiResult<UserMailboxFoldeOopsResult>?> GetUserMailboxFoldeAsync(
    [Path] string user_mailbox_id,
    [Path] string folder_id,
    CancellationToken cancellationToken = default);

认证 UserAccessToken（用户访问令牌）

参数

参数名类型必填描述示例
user_mailbox_idstring✅用户邮箱地址，作为用户邮箱身份标识。使用 user_access_token 调用时，可使用占位符 me 表示当前授权用户的主邮箱。user@example.com
folder_idstring✅邮件文件夹唯一标识。可通过「获取邮箱文件夹列表」接口获取目标文件夹的 ID；若未传入该参数，默认返回根文件夹（收件箱）详情。7620095646711680541
cancellationTokenCancellationToken⚪取消操作令牌对象default

响应

json
{
  "code": 0,
  "msg": "success",
  "data": {
    "folder_id": "7620095646711680541",
    "name": "工作邮件",
    "type": 2,
    "parent_id": "0",
    "create_time": "2026-06-03T11:34:00+08:00",
    "update_time": "2026-06-03T11:34:00+08:00"
  }
}

说明

  • 通过指定文件夹ID，获取文件夹信息，包括名称、类型等
  • 若未传入folder_id，默认返回根文件夹（收件箱）详情
  • 使用 user_access_token 时，只能获取当前授权用户邮箱的文件夹信息

代码示例

csharp
var folderApi = feishuApp.GetApi<IFeishuUserV1MailFolder>();
var result = await folderApi.GetUserMailboxFoldeAsync("me", "7620095646711680541");
Console.WriteLine($"文件夹名称: {result?.Data?.Name}");

CreateUserMailboxFoldeAsync ​

创建邮箱文件夹

函数签名

csharp
Task<FeishuApiResult<UserMailboxFoldeOopsResult>?> CreateUserMailboxFoldeAsync(
    [Path] string user_mailbox_id,
    [Body] CreateUserMailboxFoldeRequest createUserMailboxFoldeRequest,
    CancellationToken cancellationToken = default);

认证 UserAccessToken（用户访问令牌）

参数

参数名类型必填描述示例
user_mailbox_idstring✅用户邮箱地址，作为用户邮箱身份标识。使用 user_access_token 调用时，可使用占位符 me 表示当前授权用户的主邮箱。user@example.com
createUserMailboxFoldeRequestCreateUserMailboxFoldeRequest✅创建用户邮箱文件夹请求对象-
cancellationTokenCancellationToken⚪取消操作令牌对象default

响应

json
{
  "code": 0,
  "msg": "success",
  "data": {
    "folder_id": "7620095646711680542",
    "name": "新建文件夹",
    "type": 2,
    "parent_id": "0",
    "create_time": "2026-06-03T11:34:00+08:00"
  }
}

说明

  • 创建用户自定义的邮箱文件夹
  • 可用于分类管理邮件
  • 使用 user_access_token 时，只能为当前授权用户邮箱创建文件夹

代码示例

csharp
var folderApi = feishuApp.GetApi<IFeishuUserV1MailFolder>();
var request = new CreateUserMailboxFoldeRequest
{
    Name = "工作邮件",
    ParentId = "0"
};
var result = await folderApi.CreateUserMailboxFoldeAsync("me", request);
Console.WriteLine($"文件夹创建成功: {result?.Data?.FolderId}");

DeleteUserMailboxFoldeAsync ​

删除邮箱文件夹

函数签名

csharp
Task<FeishuNullDataApiResult?> DeleteUserMailboxFoldeAsync(
    [Path] string user_mailbox_id,
    [Path] string folder_id,
    CancellationToken cancellationToken = default);

认证 UserAccessToken（用户访问令牌）

参数

参数名类型必填描述示例
user_mailbox_idstring✅用户邮箱地址，作为用户邮箱身份标识。使用 user_access_token 调用时，可使用占位符 me 表示当前授权用户的主邮箱。user@example.com
folder_idstring✅邮件文件夹唯一标识7620095646711680541
cancellationTokenCancellationToken⚪取消操作令牌对象default

响应

json
{
  "code": 0,
  "msg": "success",
  "data": null
}

说明

  • 通过指定文件夹ID，删除对应的邮箱文件夹
  • 删除操作不可恢复
  • 系统文件夹（收件箱、已发送等）不可删除
  • 使用 user_access_token 时，只能删除当前授权用户邮箱的文件夹

代码示例

csharp
var folderApi = feishuApp.GetApi<IFeishuUserV1MailFolder>();
var result = await folderApi.DeleteUserMailboxFoldeAsync("me", "7620095646711680541");
Console.WriteLine($"文件夹删除结果: {result.Code == 0}");

UpdateUserMailboxFoldeAsync ​

更新邮箱文件夹

函数签名

csharp
Task<FeishuNullDataApiResult?> UpdateUserMailboxFoldeAsync(
    [Path] string user_mailbox_id,
    [Path] string folder_id,
    [Body] UpdateUserMailboxFoldeRequest updateUserMailboxFoldeRequest,
    CancellationToken cancellationToken = default);

认证 UserAccessToken（用户访问令牌）

参数

参数名类型必填描述示例
user_mailbox_idstring✅用户邮箱地址，作为用户邮箱身份标识。使用 user_access_token 调用时，可使用占位符 me 表示当前授权用户的主邮箱。user@example.com
folder_idstring✅邮件文件夹唯一标识7620095646711680541
updateUserMailboxFoldeRequestUpdateUserMailboxFoldeRequest✅更新用户邮箱文件夹请求对象-
cancellationTokenCancellationToken⚪取消操作令牌对象default

响应

json
{
  "code": 0,
  "msg": "success",
  "data": null
}

说明

  • 通过指定文件夹ID，更新对应的邮箱文件夹
  • 支持修改文件夹名称等属性
  • 使用 user_access_token 时，只能更新当前授权用户邮箱的文件夹

代码示例

csharp
var folderApi = feishuApp.GetApi<IFeishuUserV1MailFolder>();
var request = new UpdateUserMailboxFoldeRequest
{
    Name = "更新后的文件夹名称"
};
var result = await folderApi.UpdateUserMailboxFoldeAsync("me", "7620095646711680541", request);
Console.WriteLine($"文件夹更新结果: {result.Code == 0}");

GetUserMailboxFoldeListAsync ​

列出邮箱文件夹

函数签名

csharp
Task<FeishuApiResult<GetUserMailboxFoldeListResult>?> GetUserMailboxFoldeListAsync(
    [Path] string user_mailbox_id,
    [Query] int? folder_type = null,
    CancellationToken cancellationToken = default);

认证 UserAccessToken（用户访问令牌）

参数

参数名类型必填描述示例
user_mailbox_idstring✅用户邮箱地址，作为用户邮箱身份标识。使用 user_access_token 调用时，可使用占位符 me 表示当前授权用户的主邮箱。user@example.com
folder_typeint?⚪文件夹类型
- 1：系统文件夹
- 2：用户文件夹		2
cancellationTokenCancellationToken⚪取消操作令牌对象default

响应

json
{
  "code": 0,
  "msg": "success",
  "data": {
    "items": [
      {
        "folder_id": "7620095646711680541",
        "name": "工作邮件",
        "type": 2,
        "unread_count": 5,
        "total_count": 100
      }
    ]
  }
}

说明

  • 列出用户文件夹，可获取文件夹名称、文件夹ID、文件夹下的未读邮件和未读会话数量
  • 可通过folder_type参数筛选文件夹类型
  • 使用 user_access_token 时，只能列出当前授权用户邮箱的文件夹

代码示例

csharp
var folderApi = feishuApp.GetApi<IFeishuUserV1MailFolder>();
var result = await folderApi.GetUserMailboxFoldeListAsync("me", folder_type: 2);
if (result?.Data?.Items != null)
{
    foreach (var folder in result.Data.Items)
    {
        Console.WriteLine($"文件夹: {folder.Name}, 未读: {folder.UnreadCount}");
    }
}

GetAccessibleMailboxesUserMailboxAsync ​

列出可访问的邮箱

函数签名

csharp
Task<FeishuApiResult<GetAccessibleMailboxesUserMailboxResult>?> GetAccessibleMailboxesUserMailboxAsync(
    [Path] string user_mailbox_id,
    CancellationToken cancellationToken = default);

认证 UserAccessToken（用户访问令牌）

参数

参数名类型必填描述示例
user_mailbox_idstring✅用户邮箱地址，作为用户邮箱身份标识。使用 user_access_token 调用时，可使用占位符 me 表示当前授权用户的主邮箱。user@example.com
cancellationTokenCancellationToken⚪取消操作令牌对象default

响应

json
{
  "code": 0,
  "msg": "success",
  "data": {
    "items": [
      {
        "mailbox_id": "user@example.com",
        "mailbox_type": "user_mailbox",
        "permission": "read_write"
      },
      {
        "mailbox_id": "public@company.com",
        "mailbox_type": "public_mailbox",
        "permission": "read_only"
      }
    ]
  }
}

说明

  • 列出可访问的邮箱，包括拥有读信和发信权限的主账号、公共邮箱
  • 可用于切换操作的邮箱账户
  • 使用 user_access_token 时，列出当前授权用户可访问的所有邮箱

代码示例

csharp
var folderApi = feishuApp.GetApi<IFeishuUserV1MailFolder>();
var result = await folderApi.GetAccessibleMailboxesUserMailboxAsync("me");
if (result?.Data?.Items != null)
{
    foreach (var mailbox in result.Data.Items)
    {
        Console.WriteLine($"可访问邮箱: {mailbox.MailboxId}, 权限: {mailbox.Permission}");
    }
}