feat(tsl-api-reference): update API catalog and data dictionary

This commit is contained in:
csh
2026-08-11 18:10:24 +08:00
parent 34a3a5dec1
commit 7bd965de89
1231 changed files with 64187 additions and 18822 deletions
@@ -4,7 +4,9 @@
声明:class
Pop3 内置对象
用于连接 POP3 服务器并读取或删除邮件的内置对象
<!-- tags: Object Pop3 邮件接收 读取 获取 对象 实例 邮件 SMTP IMAP -->
### `create(host, user_name, password)`
@@ -12,6 +14,8 @@ Pop3 内置对象
创建 Pop3 实例
<!-- tags: Object Pop3 邮件接收 创建 生成 对象 实例 邮件 SMTP IMAP -->
可见性:public
| 参数 | 类型 | 说明 |
@@ -26,6 +30,8 @@ Pop3 内置对象
取服务器的支持命令列表
<!-- tags: Object Pop3 邮件接收 对象 实例 邮件 SMTP IMAP -->
可见性:public
返回:string
@@ -44,6 +50,8 @@ return pop3Obj.CAPA();
返回邮件的个数
<!-- tags: Object Pop3 邮件接收 返回 获取 对象 实例 邮件 SMTP IMAP -->
可见性:public
返回:integer
@@ -62,6 +70,8 @@ return ret.CheckMessages();//返回整数
连接服务器
<!-- tags: Object Pop3 邮件接收 连接 登录 对象 实例 邮件 SMTP IMAP -->
可见性:public
返回:any
@@ -86,6 +96,8 @@ return ret.CheckMessages();
删除指定的邮件,返回删除是否正确
<!-- tags: Object Pop3 邮件接收 删除 移除 对象 实例 邮件 SMTP IMAP -->
可见性:public
| 参数 | 类型 | 说明 |
@@ -100,6 +112,8 @@ return ret.CheckMessages();
断开连接
<!-- tags: Object Pop3 邮件接收 对象 实例 邮件 SMTP IMAP -->
可见性:public
返回:any
@@ -110,6 +124,8 @@ return ret.CheckMessages();
断开并且通知服务器
<!-- tags: Object Pop3 邮件接收 对象 实例 邮件 SMTP IMAP -->
可见性:public
返回:any
@@ -120,6 +136,8 @@ return ret.CheckMessages();
发送空指令保持服务的连接
<!-- tags: Object Pop3 邮件接收 发送 提交 对象 实例 邮件 SMTP IMAP -->
可见性:public
返回:any
@@ -128,7 +146,9 @@ return ret.CheckMessages();
声明:function
登录,此前必须制定Username和Password属性
连接登录,此前必须制定Username和Password属性
<!-- tags: Object Pop3 邮件接收 连接 登录 对象 实例 邮件 SMTP IMAP -->
可见性:public
@@ -140,6 +160,8 @@ return ret.CheckMessages();
复位,撤销所有本次会话中的删除操作
<!-- tags: Object Pop3 邮件接收 清除 重置 对象 实例 邮件 SMTP IMAP -->
可见性:public
返回:boolean
@@ -150,6 +172,8 @@ return ret.CheckMessages();
取邮件的内容
<!-- tags: Object Pop3 邮件接收 对象 实例 邮件 SMTP IMAP -->
可见性:public
| 参数 | 类型 | 说明 |
@@ -165,6 +189,8 @@ return ret.CheckMessages();
取邮件的内容,仅仅取邮件的头部信息,不取附件等内容
<!-- tags: Object Pop3 邮件接收 对象 实例 邮件 SMTP IMAP -->
可见性:public
| 参数 | 类型 | 说明 |
@@ -180,6 +206,8 @@ return ret.CheckMessages();
获取邮箱的大小
<!-- tags: Object Pop3 邮件接收 获取 查询 对象 实例 邮件 SMTP IMAP -->
可见性:public
返回:integer
@@ -198,6 +226,8 @@ return pop3Obj.RetrieveMailBoxSize();
取指定邮件的大小
<!-- tags: Object Pop3 邮件接收 对象 实例 邮件 SMTP IMAP -->
可见性:public
| 参数 | 类型 | 说明 |
@@ -220,6 +250,8 @@ return pop3Obj.RetrieveMsgSize(1);
取邮件的原始内容
<!-- tags: Object Pop3 邮件接收 对象 实例 邮件 SMTP IMAP -->
可见性:public
| 参数 | 类型 | 说明 |
@@ -235,6 +267,8 @@ return pop3Obj.RetrieveMsgSize(1);
发送命令
<!-- tags: Object Pop3 邮件接收 发送 提交 对象 实例 邮件 SMTP IMAP -->
可见性:public
| 参数 | 类型 | 说明 |
@@ -257,7 +291,9 @@ return array(r,cr,rc);
声明:function
取邮件的前N行内容
转换取邮件的前N行内容
<!-- tags: Object Pop3 邮件接收 转换 编码 对象 实例 邮件 SMTP IMAP -->
可见性:public
@@ -285,6 +321,8 @@ else return "获取指定邮件前3行内容失败!";
取服务器的邮件唯一标示列表
<!-- tags: Object Pop3 邮件接收 对象 实例 邮件 SMTP IMAP -->
可见性:public
| 参数 | 类型 | 说明 |
@@ -307,6 +345,8 @@ return ids;
认证类型,0:明文用户密码,1:MD5,2:SASL认证,-1:自定义认证
<!-- tags: Object Pop3 邮件接收 摘要 哈希 散列 digest hash 对象 实例 邮件 SMTP -->
可见性:public
类型:integer
@@ -319,6 +359,8 @@ return ids;
自定义认证类型,仅当 AuthType 设置为-1时有效;设置为"AUTH=*":自动选择服务器支持的认证类型;多个用分号连接
<!-- tags: Object Pop3 邮件接收 对象 实例 邮件 SMTP IMAP AUTH -->
可见性:public
类型:string
@@ -329,7 +371,9 @@ return ids;
声明:property
是否在连接的时候自动登录
控制是否在连接的时候自动登录
<!-- tags: Object Pop3 邮件接收 对象 实例 邮件 SMTP IMAP -->
可见性:public
@@ -341,7 +385,9 @@ return ids;
声明:property
取服务器的支持命令列表(不重新发送命令)
获取取服务器的支持命令列表(不重新发送命令)
<!-- tags: Object Pop3 邮件接收 获取 查询 对象 实例 邮件 SMTP IMAP -->
可见性:public
@@ -353,7 +399,9 @@ return ids;
声明:property
是否是MD5认证
指示是否是MD5认证
<!-- tags: Object Pop3 邮件接收 摘要 哈希 散列 digest hash 判断 检查 对象 实例 -->
可见性:public
@@ -365,7 +413,9 @@ return ids;
声明:property
是否执行过CAPA命令
指示是否执行过CAPA命令
<!-- tags: Object Pop3 邮件接收 判断 检查 对象 实例 邮件 SMTP IMAP CAPA -->
可见性:public
@@ -377,7 +427,9 @@ return ids;
声明:property
主机名称或地址
获取或设置主机名称或地址
<!-- tags: Object Pop3 邮件接收 获取 查询 对象 实例 邮件 SMTP IMAP -->
可见性:public
@@ -389,7 +441,9 @@ return ids;
声明:property
最后的命令执行结果
获取最后的命令执行结果
<!-- tags: Object Pop3 邮件接收 获取 查询 对象 实例 邮件 SMTP IMAP -->
可见性:public
@@ -401,7 +455,9 @@ return ids;
声明:property
最后的命令执行的返回码
获取最后的命令执行的返回码
<!-- tags: Object Pop3 邮件接收 获取 查询 对象 实例 邮件 SMTP IMAP -->
可见性:public
@@ -413,7 +469,9 @@ return ids;
声明:property
密码
获取或设置密码
<!-- tags: Object Pop3 邮件接收 获取 查询 对象 实例 邮件 SMTP IMAP -->
可见性:public
@@ -425,7 +483,9 @@ return ids;
声明:property
主机端口
获取或设置主机端口
<!-- tags: Object Pop3 邮件接收 获取 查询 对象 实例 邮件 SMTP IMAP -->
可见性:public
@@ -437,7 +497,9 @@ return ids;
声明:property
用户名
获取或设置用户名
<!-- tags: Object Pop3 邮件接收 获取 查询 对象 实例 邮件 SMTP IMAP -->
可见性:public
@@ -449,7 +511,9 @@ return ids;
声明:property
是否使用显式 TLS(即 STARTTLS 加密协议)
控制是否使用显式 TLS(即 STARTTLS 加密协议)
<!-- tags: Object Pop3 邮件接收 对象 实例 邮件 SMTP IMAP TLS STARTTLS -->
可见性:public
@@ -461,7 +525,9 @@ return ids;
声明:property
是否采用SSL连接
控制是否采用SSL连接
<!-- tags: Object Pop3 邮件接收 对象 实例 邮件 SMTP IMAP SSL -->
可见性:public