Skip to content

列出可发信邮箱

获取当前地址的可用于发信的邮箱地址列表

请求

项目
HTTP URLhttps://open.feishu.cn/open-apis/mail/v1/user_mailboxes/:user_mailbox_id/settings/send_as
HTTP MethodGET
接口频率限制10 次/秒
支持的应用类型custom
权限要求 调用该 API 所需的权限。开启其中任意一项权限即可调用 开启任一权限即可mail:user_mailbox 查询、创建、修改和删除用户的企业邮箱 mail:user_mailbox:readonly 查询用户的企业邮箱

请求头

名称类型必填描述
Authorizationstringtenant_access_tokenuser_access_token 值格式:"Bearer access_token" 示例值:"Bearer u-7f1bcd13fc57d46bac21793a18e560" 了解更多:如何选择与获取 access token

路径参数

名称类型描述
user_mailbox_idstring邮箱地址。用户身份下可以输入me代表用户。
示例值:"abc@abc.com"

响应

响应体

名称类型描述
codeint错误码,非 0 表示失败
msgstring错误描述
data\--
  └ sendable_addressesemail_info\[\]可发信地址。包括主地址、别名地址、邮件组。
    └ email_addressstring邮箱地址
    └ email_typestring邮箱地址类型
可选值有
- MAIL_GROUP: 邮件组 - PUBLIC_MAILBOX: 公共邮箱 - USER_PRIMARY: 用户主地址 - USER_ALIAS: 用户别名 - PUBLIC_MAILBOX_ALIAS: 公共邮箱别名
    └ namestring邮箱名称

响应体示例

json
{
    "code": 0,
    "msg": "success",
    "data": {
        "sendable_addresses": [
            {
                "email_address": "abc@abc.com",
                "email_type": "USER_PRIMARY",
                "name": "Mike"
            }
        ]
    }
}

错误码

HTTP状态码错误码描述排查建议
4001230001param is invalid, check user_mailbox_id参数错误,请检查user_mailbox_id参数
4031230004permission denied: mailbox not found, unsupported mailbox type, or no access to this mailbox权限不足:邮箱不存在、邮箱类型不支持,或无权访问该邮箱,请检查user_mailbox_id参数和权限申请状态
5001230003internal server error, please retry later服务器内部错误,请稍后重试
4001230005tenant access token not support metenant_access_token身份访问时,不支持使用"me"作为user_mailbox_id参数

内容来源:飞书开放平台 · 自动爬取整理