帮助中心

# getFolderPaths-获取邮箱路径

调用getFolderPaths函数按指定目录获取符合匹配的邮箱路径。

最小支持版本:6.1.0

# 接口说明

1.调用create函数创建IMAP账户实例对象iMAPAccount,详情请见create (opens new window)
2.调用connect函数连接IMAP邮箱服务器,详情请见connect (opens new window)

# 语法

<IMAPAccount object>.getFolderPaths("", *, false)
1
<IMAPAccount object>.获取邮箱路径("", *, false)
1

# 函数类型

实例函数

# 请求参数

参数名称 类型 是否必选 默认值 示例值 描述
directory Cube.Lang.String "测试" 目录名称,默认为空字符串,表示为根路径。
pattern Cube.Lang.String * "*" 匹配模式,可以包含通配符,默认为*,表示匹配所有。
onlySubscribed Cube.Lang.Boolean false false 是否只获取订阅的邮箱路径。

# 返回参数

参数名称 类型 示例值 描述
Result Cube.Lang.List ["测试", "测试/测试文件夹"] 符合匹配的邮箱路径列表。

# 请求示例

iMAPAccount.getFolderPaths("测试","*",false);
1
最近更新时间: { "value": "2023-09-12", "effect": true }