Mud Tools

Appearance

邮箱别名管理 - 租户令牌（IFeishuTenantV1MailAlias） ​

功能描述 ​

飞书邮箱别名API接口实现了添加、查询、删除等邮箱别名管理功能。支持租户管理员通过租户访问令牌管理企业内所有用户的邮箱别名。

参考文档 ​

函数列表 ​

函数名称功能描述认证方式HTTP 方法
DeleteUserMailboxAsync从回收站删除用户邮箱地址TenantAccessTokenDELETE
CreateUserMailboxAliasAsync创建用户邮箱别名TenantAccessTokenPOST
DeleteUserMailboxAliasAsync删除用户邮箱别名TenantAccessTokenDELETE
GetUserMailboxAliasPageListAsync获取用户邮箱所有别名TenantAccessTokenGET
QueryUserMailboxAddressAsync查询邮箱地址状态TenantAccessTokenPOST

函数详细内容 ​

DeleteUserMailboxAsync ​

从回收站永久删除用户邮箱地址

函数签名

csharp
Task<FeishuNullDataApiResult?> DeleteUserMailboxAsync(
    [Path] string user_mailbox_id,
    [Query] string? transfer_mailbox = null,
    CancellationToken cancellationToken = default);

认证 TenantAccessToken（租户访问令牌）

参数

参数名类型必填描述示例
user_mailbox_idstring✅用户邮箱地址，作为用户邮箱身份标识user@example.com
transfer_mailboxstring?⚪用于接收转移的邮箱地址888888@abc.com
cancellationTokenCancellationToken⚪取消操作令牌对象default

响应

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

说明

  • 该接口会永久删除用户邮箱地址，一旦删除将无法恢复
  • 支持邮件转移功能，可将被删除邮箱的邮件转移到其他邮箱
  • 仅可删除位于邮箱回收站中的用户邮箱地址

代码示例

csharp
var mailAliasApi = feishuApp.GetApi<IFeishuTenantV1MailAlias>();
var result = await mailAliasApi.DeleteUserMailboxAsync(
    "user@example.com",
    transfer_mailbox: "admin@company.com");
Console.WriteLine($"删除结果: {result.Code == 0}");

CreateUserMailboxAliasAsync ​

创建用户邮箱别名

函数签名

csharp
Task<FeishuApiResult<CreateUserMailboxAliasResult>?> CreateUserMailboxAliasAsync(
    [Path] string user_mailbox_id,
    [Body] CreateUserMailboxAliasRequest createUserMailboxAliasRequest,
    CancellationToken cancellationToken = default);

认证 TenantAccessToken（租户访问令牌）

参数

参数名类型必填描述示例
user_mailbox_idstring✅用户邮箱地址，作为用户邮箱身份标识user@example.com
createUserMailboxAliasRequestCreateUserMailboxAliasRequest✅创建用户邮箱别名请求对象-
cancellationTokenCancellationToken⚪取消操作令牌对象default

响应

json
{
  "code": 0,
  "msg": "success",
  "data": {
    "alias_id": "alias_123456",
    "alias_email": "user.alias@example.com",
    "create_time": "2026-06-03T11:34:00+08:00"
  }
}

说明

  • 邮箱别名可用于邮件收发，作为主邮箱的补充地址
  • 需要申请邮箱别名管理权限

代码示例

csharp
var mailAliasApi = feishuApp.GetApi<IFeishuTenantV1MailAlias>();
var request = new CreateUserMailboxAliasRequest
{
    AliasEmail = "user.alias@example.com"
};
var result = await mailAliasApi.CreateUserMailboxAliasAsync("user@example.com", request);
Console.WriteLine($"别名创建成功: {result?.Data?.AliasEmail}");

DeleteUserMailboxAliasAsync ​

删除用户邮箱别名

函数签名

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

认证 TenantAccessToken（租户访问令牌）

参数

参数名类型必填描述示例
user_mailbox_idstring✅用户邮箱地址，作为用户邮箱身份标识user@example.com
alias_idstring✅别名邮箱地址IDuser_alias@xxx.xx
cancellationTokenCancellationToken⚪取消操作令牌对象default

响应

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

说明

  • 删除后该别名将无法用于邮件收发
  • 删除操作不可恢复

代码示例

csharp
var mailAliasApi = feishuApp.GetApi<IFeishuTenantV1MailAlias>();
var result = await mailAliasApi.DeleteUserMailboxAliasAsync(
    "user@example.com",
    "user_alias@xxx.xx");
Console.WriteLine($"别名删除结果: {result.Code == 0}");

GetUserMailboxAliasPageListAsync ​

获取用户邮箱所有别名

函数签名

csharp
Task<FeishuApiPageListResult<EmailAlias>?> GetUserMailboxAliasPageListAsync(
    [Path] string user_mailbox_id,
    [Query] int page_size = 20,
    [Query] string? page_token = null,
    CancellationToken cancellationToken = default);

认证 TenantAccessToken（租户访问令牌）

参数

参数名类型必填描述示例
user_mailbox_idstring✅用户邮箱地址，作为用户邮箱身份标识user@example.com
page_sizeint⚪分页大小，即本次请求所返回的信息列表内的最大条目数。默认值：2020
page_tokenstring?⚪分页标记，第一次请求不填，表示从头开始遍历-
cancellationTokenCancellationToken⚪取消操作令牌对象default

响应

json
{
  "code": 0,
  "msg": "success",
  "data": {
    "aliases": [
      {
        "alias_id": "alias_123456",
        "alias_email": "user.alias@example.com",
        "create_time": "2026-06-03T11:34:00+08:00"
      }
    ],
    "page_token": "evt_xxx",
    "has_more": false
  }
}

说明

  • 该接口一次性返回所有数据，分页参数无效（接口说明）
  • 返回该用户邮箱下所有别名列表

代码示例

csharp
var mailAliasApi = feishuApp.GetApi<IFeishuTenantV1MailAlias>();
var result = await mailAliasApi.GetUserMailboxAliasPageListAsync("user@example.com");
if (result?.Data?.Items != null)
{
    foreach (var alias in result.Data.Items)
    {
        Console.WriteLine($"别名: {alias.AliasEmail}");
    }
}

QueryUserMailboxAddressAsync ​

查询邮箱地址状态

函数签名

csharp
Task<FeishuApiResult<QueryUserMailboxAddressResult>?> QueryUserMailboxAddressAsync(
    [Body] QueryUserMailboxAddressRequest request,
    CancellationToken cancellationToken = default);

认证 TenantAccessToken（租户访问令牌）

参数

参数名类型必填描述示例
requestQueryUserMailboxAddressRequest✅查询邮箱地址状态请求对象-
cancellationTokenCancellationToken⚪取消操作令牌对象default

响应

json
{
  "code": 0,
  "msg": "success",
  "data": {
    "email": "user@example.com",
    "type": "user_mailbox",
    "status": "active",
    "create_time": "2026-01-01T00:00:00+08:00"
  }
}

说明

  • 可以输入邮箱地址，查询出该邮箱地址对应的类型以及状态
  • 支持批量查询多个邮箱地址

代码示例

csharp
var mailAliasApi = feishuApp.GetApi<IFeishuTenantV1MailAlias>();
var request = new QueryUserMailboxAddressRequest
{
    Emails = new List<string> { "user@example.com", "admin@example.com" }
};
var result = await mailAliasApi.QueryUserMailboxAddressAsync(request);
if (result?.Data?.Items != null)
{
    foreach (var item in result.Data.Items)
    {
        Console.WriteLine($"邮箱: {item.Email}, 状态: {item.Status}");
    }
}