跳转至

folders

feishu.mail.folders

FoldersNamespace

Bases: Namespace

邮箱文件夹命名空间。

通过 client.mail.folders 访问，封装用户邮箱文件夹查询接口。

飞书文档

列出邮箱文件夹

源代码位于： feishu/mail/folders.py
Python
30
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
62
63
64
65
66
class FoldersNamespace(Namespace):
    r"""
    邮箱文件夹命名空间。

    通过 `client.mail.folders` 访问，封装用户邮箱文件夹查询接口。

    飞书文档:
        [列出邮箱文件夹](https://open.feishu.cn/document/mail-v1/user_mailbox-folder/list)
    """

    async def list(self, user_mailbox_id: str, *, folder_type: int | None = None) -> list[NestedDict]:
        r"""
        列出用户邮箱文件夹。

        Args:
            user_mailbox_id: 用户邮箱地址，或用户态调用时的 `me`。
            folder_type: 文件夹类型，`1` 为系统文件夹，`2` 为用户文件夹；为空时省略。

        Returns:
            文件夹列表，每项包含 `id`、`name`、`folder_type` 等字段。

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

        飞书文档:
            [列出邮箱文件夹](https://open.feishu.cn/document/mail-v1/user_mailbox-folder/list)

        Examples:
            >>> await client.mail.folders.list("me", folder_type=1)  # doctest:+SKIP
            [{'id': 'INBOX', 'name': '收件箱', 'folder_type': 1, ...}]
        """
        data = await self._request_data(
            "GET",
            f"mail/v1/user_mailboxes/{quote_segment(user_mailbox_id)}/folders",
            params={"folder_type": folder_type},
        )
        return [NestedDict(item) for item in data.get("items", [])]

list async

Python
list(user_mailbox_id: str, *, folder_type: int | None = None) -> list[NestedDict]

列出用户邮箱文件夹。

参数：

名称 类型 描述 默认
user_mailbox_id
str

用户邮箱地址，或用户态调用时的 me。

 必需
folder_type
int | None

文件夹类型，1 为系统文件夹，2 为用户文件夹；为空时省略。

 None

返回：

类型 描述
list[NestedDict]

文件夹列表，每项包含 id、name、folder_type 等字段。

引发：

类型 描述
FeishuError

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

列出邮箱文件夹

示例：

Python Console Session
1
2
>>> await client.mail.folders.list("me", folder_type=1)
[{'id': 'INBOX', 'name': '收件箱', 'folder_type': 1, ...}]
源代码位于： feishu/mail/folders.py
Python
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
async def list(self, user_mailbox_id: str, *, folder_type: int | None = None) -> list[NestedDict]:
    r"""
    列出用户邮箱文件夹。

    Args:
        user_mailbox_id: 用户邮箱地址，或用户态调用时的 `me`。
        folder_type: 文件夹类型，`1` 为系统文件夹，`2` 为用户文件夹；为空时省略。

    Returns:
        文件夹列表，每项包含 `id`、`name`、`folder_type` 等字段。

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

    飞书文档:
        [列出邮箱文件夹](https://open.feishu.cn/document/mail-v1/user_mailbox-folder/list)

    Examples:
        >>> await client.mail.folders.list("me", folder_type=1)  # doctest:+SKIP
        [{'id': 'INBOX', 'name': '收件箱', 'folder_type': 1, ...}]
    """
    data = await self._request_data(
        "GET",
        f"mail/v1/user_mailboxes/{quote_segment(user_mailbox_id)}/folders",
        params={"folder_type": folder_type},
    )
    return [NestedDict(item) for item in data.get("items", [])]