csh/playbook
1
1
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

✨ feat(tsl-api-reference): expand API and module coverage

Browse Source
This commit is contained in:
csh
2026-08-14 17:12:55 +08:00
parent 8f1056130d
commit 3d3036ebe1
571 changed files with 47842 additions and 14458 deletions
Download Patch File Download Diff File Expand all files Collapse all files
skills/tsl-api-reference/references/codegen/builtin/object/imap.md
+45 -32
View File
@@ -6,25 +6,35 @@
用于连接 IMAP 服务器、管理邮箱并读取邮件的内置对象
<!-- tags: Object IMAP 邮件收取 对象 实例 邮件 SMTP POP3 -->
<!-- tags: Object IMAP 邮件收取 对象 实例 邮件 SMTP POP3 创建 生成 构造函数 实例化 new -->
### `create(host, user_name, password)`
### `create()`
声明：function
创建 IMAP 实例
无参数构造函数。创建 IMAP 实例，连接和认证参数由实例属性设置
<!-- tags: Object IMAP 邮件收取 创建 生成 对象 实例 邮件 SMTP POP3 -->
可见性：public
| 参数 | 类型 | 说明 |
| --- | --- | --- |
| `host` | string | 可选。字符串类型。如果指定了Host参数，会自动从IMAP配置文件里获取其他相应参数 |
| `user_name` | string | 可选。字符串类型，用户名 |
| `password` | string | 可选。字符串类型，密码。如果该参数不指定，而指定了HOST,USERNAME参数，则在POP3配置文件里获取密码 |
### `create(host, user_name, password)`
### `appendMessage(folder_name)`
声明：function
构造函数。按 host、user_name 和 password 初始化 IMAP 实例
<!-- tags: Object IMAP 邮件收取 创建 生成 对象 实例 邮件 SMTP POP3 -->
可见性：public
| 参数 | 类型 | 说明 |
| ----------- | ------ | --------------------------------------------- |
| `host` | string | IMAP 配置名称。指定后从配置文件读取服务器参数 |
| `user_name` | string | 登录用户名 |
| `password` | string | 登录密码 |
### `appendMessage(folder_name, msg)`
声明：function
@@ -34,9 +44,10 @@
可见性：public
| 参数 | 类型 | 说明 |
| --- | --- | --- |
| `folder_name` | string | 目标文件夹名称 |
| 参数 | 类型 | 说明 |
| ------------- | ------- | -------------------- |
| `folder_name` | string | 目标文件夹名称 |
| `msg` | MailMsg | 要添加的邮件消息对象 |
返回：boolean
@@ -73,13 +84,13 @@ return ret;
可见性：public
| 参数 | 类型 | 说明 |
| --- | --- | --- |
| 参数 | 类型 | 说明 |
| ------------- | ------ | ---------------------------------------------------------- |
| `folder_name` | string | 可选。邮箱文件夹名称；若未指定，默认获取收件箱中的邮件数量 |
返回：integer
### `copyMessage(folder_name)`
### `copyMessage(folder_name, msg_id, dest_folder_name)`
声明：function
@@ -89,9 +100,11 @@ return ret;
可见性：public
| 参数 | 类型 | 说明 |
| --- | --- | --- |
| `folder_name` | string | 源文件夹名称 |
| 参数 | 类型 | 说明 |
| ------------------ | ------- | -------------- |
| `folder_name` | string | 源文件夹名称 |
| `msg_id` | integer | 邮件编号 |
| `dest_folder_name` | string | 目标文件夹名称 |
返回：boolean
@@ -105,8 +118,8 @@ return ret;
可见性：public
| 参数 | 类型 | 说明 |
| --- | --- | --- |
| 参数 | 类型 | 说明 |
| ------------- | ------ | ---------- |
| `folder_name` | string | 文件夹名称 |
返回：boolean
@@ -132,8 +145,8 @@ return ret;//创建成功，返回1
可见性：public
| 参数 | 类型 | 说明 |
| --- | --- | --- |
| 参数 | 类型 | 说明 |
| ------------- | ------ | ---------------------- |
| `folder_name` | string | 要删除的邮箱文件夹名称 |
返回：boolean
@@ -160,10 +173,10 @@ return ret;//创建成功，返回1
可见性：public
| 参数 | 类型 | 说明 |
| --- | --- | --- |
| `reference` | string | 查询参考，即邮箱前缀，如"mybox/"、"mybox"等 |
| `mail_box` | string | 邮箱名称，可带*或%通配符，如"*"、"sub*"等，默认"*" |
| 参数 | 类型 | 说明 |
| ----------- | ------ | -------------------------------------------------- |
| `reference` | string | 查询参考，即邮箱前缀，如"mybox/"、"mybox"等 |
| `mail_box` | string | 邮箱名称，可带*或%通配符，如"*"、"sub*"等，默认"*" |
返回：array
@@ -212,9 +225,9 @@ return ret;
可见性：public
| 参数 | 类型 | 说明 |
| --- | --- | --- |
| `folder_name` | string | 原邮箱文件夹名称 |
| 参数 | 类型 | 说明 |
| ----------------- | ------ | ---------------- |
| `folder_name` | string | 原邮箱文件夹名称 |
| `new_folder_name` | string | 新邮箱文件夹名称 |
返回：boolean
@@ -229,9 +242,9 @@ RetrieveMailBoxSize
可见性：public
| 参数 | 类型 | 说明 |
| --- | --- | --- |
| `folder_name` | any | folder_name |
| 参数 | 类型 | 说明 |
| ------------- | ---- | ----------- |
| `folder_name` | any | folder_name |
返回：integer