跳转至

users

feishu.mail.users

UsersNamespace

Bases: Namespace

邮箱地址状态查询命名空间。

通过 client.mail.users 访问，封装 mail/v1/users/query，用于查询邮箱地址对应的类型与状态。

飞书文档

查询邮箱地址状态

源代码位于： feishu/mail/users.py
Python
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
class UsersNamespace(Namespace):
    r"""
    邮箱地址状态查询命名空间。

    通过 `client.mail.users` 访问，封装 `mail/v1/users/query`，用于查询邮箱地址对应的类型与状态。

    飞书文档:
        [查询邮箱地址状态](https://open.feishu.cn/document/server-docs/mail-v1/user/query)
    """

    async def query(self, email_list: Iterable[str]) -> NestedDict:
        r"""
        查询邮箱地址状态。

        Args:
            email_list: 待查询的邮箱地址列表。

        Returns:
            飞书返回的 `data` 数据体，其中 `user_list` 给出邮箱地址、状态与类型。

        Raises:
            feishu.errors.FeishuError: 请求失败或返回错误码时抛出。

        飞书文档:
            [查询邮箱地址状态](https://open.feishu.cn/document/server-docs/mail-v1/user/query)

        Examples:
            >>> await client.mail.users.query(["ops@example.com"])  # doctest:+SKIP
            {'user_list': [{'email': 'ops@example.com', ...}]}
        """
        return await self._request_data("POST", "mail/v1/users/query", json={"email_list": list(email_list)})

query async

Python
query(email_list: Iterable[str]) -> NestedDict

查询邮箱地址状态。

参数：

名称 类型 描述 默认
email_list
Iterable[str]

待查询的邮箱地址列表。

 必需

返回：

类型 描述
NestedDict

飞书返回的 data 数据体，其中 user_list 给出邮箱地址、状态与类型。

引发：

类型 描述
FeishuError

请求失败或返回错误码时抛出。
飞书文档

查询邮箱地址状态

示例：

Python Console Session
1
2
>>> await client.mail.users.query(["ops@example.com"])
{'user_list': [{'email': 'ops@example.com', ...}]}
源代码位于： feishu/mail/users.py
Python
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
async def query(self, email_list: Iterable[str]) -> NestedDict:
    r"""
    查询邮箱地址状态。

    Args:
        email_list: 待查询的邮箱地址列表。

    Returns:
        飞书返回的 `data` 数据体，其中 `user_list` 给出邮箱地址、状态与类型。

    Raises:
        feishu.errors.FeishuError: 请求失败或返回错误码时抛出。

    飞书文档:
        [查询邮箱地址状态](https://open.feishu.cn/document/server-docs/mail-v1/user/query)

    Examples:
        >>> await client.mail.users.query(["ops@example.com"])  # doctest:+SKIP
        {'user_list': [{'email': 'ops@example.com', ...}]}
    """
    return await self._request_data("POST", "mail/v1/users/query", json={"email_list": list(email_list)})