列出收信规则

列出收信规则

Tip: 使用 tenant_access_token 时，需要申请收信规则资源的数据权限。

请求

项目	值
HTTP URL	https://open.feishu.cn/open-apis/mail/v1/user_mailboxes/:user_mailbox_id/rules
HTTP Method	GET
接口频率限制	5 次/秒
支持的应用类型	custom
权限要求 调用该 API 所需的权限。开启其中任意一项权限即可调用 开启任一权限即可	mail:user_mailbox.rule:read 查看收信规则 mail:user_mailbox.rule:write 查看、创建、更新、删除收信规则

请求头

名称	类型	必填	描述
Authorization	string	是	tenant_access_token 或 user_access_token 值格式："Bearer access_token" 示例值："Bearer u-7f1bcd13fc57d46bac21793a18e560" 了解更多：如何选择与获取 access token

路径参数

名称	类型	描述
user_mailbox_id	string	用户邮箱地址 或 输入me代表当前调用接口用户 示例值："user@xxx.xx 或 me"

响应

响应体

名称	类型	描述
code	int	错误码，非 0 表示失败
msg	string	错误描述
data	\-	-
└ items	rule\[\]	规则列表
└ id	string	规则 id
└ condition	rule_condition	匹配条件
└ match_type	int	匹配类型 可选值有： - 1: 满足所有条件 - 2: 满足任意条件
└ items	rule_condition_item\[\]	匹配规则列表
└ type	int	匹配条件左值 可选值有： - 1: 发件人地址 - 2: 收件人地址 - 3: 抄送地址 - 4: 收件人或抄送地址 - 6: 主题 - 7: 正文 - 8: 附件名字 - 9: 附件类型 - 10: 任意地址 - 12: 所有邮件 - 13: 是外部邮件 - 14: 是垃圾邮件 - 15: 不是垃圾邮件 - 16: 有附件
└ operator	int	匹配条件操作符 可选值有： - 1: 包含 - 2: 不包含 - 3: 开头是 - 4: 结尾是 - 5: 是 - 6: 不是 - 7: 包含自己 - 10: 为空
└ input	string	匹配条件右值
└ action	rule_action	匹配命中后的操作
└ items	rule_action_item\[\]	匹配命中规则后的操作列表
└ type	int	操作类型 可选值有： - 1: 归档 - 2: 删除邮件 - 3: 标记为已读 - 4: 移至垃圾邮件 - 5: 不移至垃圾邮件 - 8: 添加用户标签（暂不支持） - 9: 添加旗标 - 10: 不弹出通知 - 11: 移至用户文件夹 - 12: 自动转发（暂不支持） - 13: 分享到会话（暂不支持）
└ input	string	当 type 为移动到文件夹时，该字段填文件夹的 id
└ ignore_the_rest_of_rules	boolean	是否终止规则
└ name	string	规则名称
└ is_enable	boolean	是否启用

响应体示例

{
    "code": 0,
    "msg": "success",
    "data": {
        "items": [
            {
                "id": "123124123123",
                "condition": {
                    "match_type": 1,
                    "items": [
                        {
                            "type": 1,
                            "operator": 1,
                            "input": "hello@world.com"
                        }
                    ]
                },
                "action": {
                    "items": [
                        {
                            "type": 1,
                            "input": "283412371233"
                        }
                    ]
                },
                "ignore_the_rest_of_rules": false,
                "name": "将李三的邮件标记为垃圾邮件",
                "is_enable": false
            }
        ]
    }
}

错误码

HTTP状态码	错误码	描述	排查建议
400	1230001	param invalid	修改参数后重试
500	1230003	internal server error	请稍后重试
403	1230002	no permission	成为公共邮箱成员或申请相关数据权限后调用该接口