✨ feat(tsl-api-reference): update API catalog and data dictionary
This commit is contained in:
@@ -4,7 +4,9 @@
|
||||
|
||||
声明:class
|
||||
|
||||
IMAP 内置对象
|
||||
用于连接 IMAP 服务器、管理邮箱并读取邮件的内置对象
|
||||
|
||||
<!-- tags: Object IMAP 邮件收取 对象 实例 邮件 SMTP POP3 -->
|
||||
|
||||
### `create(host, user_name, password)`
|
||||
|
||||
@@ -12,6 +14,8 @@ IMAP 内置对象
|
||||
|
||||
创建 IMAP 实例
|
||||
|
||||
<!-- tags: Object IMAP 邮件收取 创建 生成 对象 实例 邮件 SMTP POP3 -->
|
||||
|
||||
可见性:public
|
||||
|
||||
| 参数 | 类型 | 说明 |
|
||||
@@ -26,6 +30,8 @@ IMAP 内置对象
|
||||
|
||||
添加邮件至指定文件夹
|
||||
|
||||
<!-- tags: Object IMAP 邮件收取 添加 追加 对象 实例 邮件 SMTP POP3 -->
|
||||
|
||||
可见性:public
|
||||
|
||||
| 参数 | 类型 | 说明 |
|
||||
@@ -40,6 +46,8 @@ IMAP 内置对象
|
||||
|
||||
获取服务器的支持命令列表
|
||||
|
||||
<!-- tags: Object IMAP 邮件收取 获取 查询 对象 实例 邮件 SMTP POP3 -->
|
||||
|
||||
可见性:public
|
||||
|
||||
返回:string
|
||||
@@ -59,7 +67,9 @@ return ret;
|
||||
|
||||
声明:function
|
||||
|
||||
查看邮箱文件夹邮件数量
|
||||
判断查看邮箱文件夹邮件数量
|
||||
|
||||
<!-- tags: Object IMAP 邮件收取 判断 检查 对象 实例 邮件 SMTP POP3 -->
|
||||
|
||||
可见性:public
|
||||
|
||||
@@ -75,6 +85,8 @@ return ret;
|
||||
|
||||
复制邮件至目标文件夹
|
||||
|
||||
<!-- tags: Object IMAP 邮件收取 对象 实例 邮件 SMTP POP3 -->
|
||||
|
||||
可见性:public
|
||||
|
||||
| 参数 | 类型 | 说明 |
|
||||
@@ -87,7 +99,9 @@ return ret;
|
||||
|
||||
声明:function
|
||||
|
||||
新建邮箱文件夹
|
||||
创建邮箱文件夹
|
||||
|
||||
<!-- tags: Object IMAP 邮件收取 创建 生成 对象 实例 邮件 SMTP POP3 -->
|
||||
|
||||
可见性:public
|
||||
|
||||
@@ -114,6 +128,8 @@ return ret;//创建成功,返回1
|
||||
|
||||
删除指定邮件文件夹
|
||||
|
||||
<!-- tags: Object IMAP 邮件收取 删除 移除 对象 实例 邮件 SMTP POP3 -->
|
||||
|
||||
可见性:public
|
||||
|
||||
| 参数 | 类型 | 说明 |
|
||||
@@ -128,6 +144,8 @@ return ret;//创建成功,返回1
|
||||
|
||||
发送空指令保持服务的连接
|
||||
|
||||
<!-- tags: Object IMAP 邮件收取 发送 提交 对象 实例 邮件 SMTP POP3 -->
|
||||
|
||||
可见性:public
|
||||
|
||||
返回:any
|
||||
@@ -138,6 +156,8 @@ return ret;//创建成功,返回1
|
||||
|
||||
获取邮箱文件夹的列表信息
|
||||
|
||||
<!-- tags: Object IMAP 邮件收取 获取 查询 对象 实例 邮件 SMTP POP3 -->
|
||||
|
||||
可见性:public
|
||||
|
||||
| 参数 | 类型 | 说明 |
|
||||
@@ -164,6 +184,8 @@ return ret;
|
||||
|
||||
登录,调用前必须先设置Host、Port、Username、Password属性
|
||||
|
||||
<!-- tags: Object IMAP 邮件收取 连接 登录 对象 实例 邮件 SMTP POP3 -->
|
||||
|
||||
可见性:public
|
||||
|
||||
返回:any
|
||||
@@ -174,6 +196,8 @@ return ret;
|
||||
|
||||
退出登录
|
||||
|
||||
<!-- tags: Object IMAP 邮件收取 对象 实例 邮件 SMTP POP3 -->
|
||||
|
||||
可见性:public
|
||||
|
||||
返回:any
|
||||
@@ -184,6 +208,8 @@ return ret;
|
||||
|
||||
重命名邮箱文件夹
|
||||
|
||||
<!-- tags: Object IMAP 邮件收取 对象 实例 邮件 SMTP POP3 -->
|
||||
|
||||
可见性:public
|
||||
|
||||
| 参数 | 类型 | 说明 |
|
||||
@@ -199,6 +225,8 @@ return ret;
|
||||
|
||||
RetrieveMailBoxSize
|
||||
|
||||
<!-- tags: Object IMAP 邮件收取 对象 实例 邮件 SMTP POP3 -->
|
||||
|
||||
可见性:public
|
||||
|
||||
| 参数 | 类型 | 说明 |
|
||||
@@ -213,6 +241,8 @@ RetrieveMailBoxSize
|
||||
|
||||
认证类型,0:明文用户密码,1:MD5,2:SASL认证,-1:自定义认证
|
||||
|
||||
<!-- tags: Object IMAP 邮件收取 摘要 哈希 散列 digest hash 对象 实例 邮件 SMTP -->
|
||||
|
||||
可见性:public
|
||||
|
||||
类型:integer
|
||||
@@ -225,6 +255,8 @@ RetrieveMailBoxSize
|
||||
|
||||
自定义认证类型,仅当 AuthType 设置为-1时有效;设置为"AUTH=*":自动选择服务器支持的认证类型;多个用分号连接
|
||||
|
||||
<!-- tags: Object IMAP 邮件收取 对象 实例 邮件 SMTP POP3 AUTH -->
|
||||
|
||||
可见性:public
|
||||
|
||||
类型:string
|
||||
@@ -235,7 +267,9 @@ RetrieveMailBoxSize
|
||||
|
||||
声明:property
|
||||
|
||||
主机名称或地址
|
||||
获取或设置主机名称或地址
|
||||
|
||||
<!-- tags: Object IMAP 邮件收取 获取 查询 对象 实例 邮件 SMTP POP3 -->
|
||||
|
||||
可见性:public
|
||||
|
||||
@@ -247,7 +281,9 @@ RetrieveMailBoxSize
|
||||
|
||||
声明:property
|
||||
|
||||
最后的命令执行结果
|
||||
获取最后的命令执行结果
|
||||
|
||||
<!-- tags: Object IMAP 邮件收取 获取 查询 对象 实例 邮件 SMTP POP3 -->
|
||||
|
||||
可见性:public
|
||||
|
||||
@@ -259,7 +295,9 @@ RetrieveMailBoxSize
|
||||
|
||||
声明:property
|
||||
|
||||
最后的命令执行的返回码
|
||||
获取最后的命令执行的返回码
|
||||
|
||||
<!-- tags: Object IMAP 邮件收取 获取 查询 对象 实例 邮件 SMTP POP3 -->
|
||||
|
||||
可见性:public
|
||||
|
||||
@@ -271,7 +309,9 @@ RetrieveMailBoxSize
|
||||
|
||||
声明:property
|
||||
|
||||
密码
|
||||
获取或设置密码
|
||||
|
||||
<!-- tags: Object IMAP 邮件收取 获取 查询 对象 实例 邮件 SMTP POP3 -->
|
||||
|
||||
可见性:public
|
||||
|
||||
@@ -283,7 +323,9 @@ RetrieveMailBoxSize
|
||||
|
||||
声明:property
|
||||
|
||||
主机端口
|
||||
获取或设置主机端口
|
||||
|
||||
<!-- tags: Object IMAP 邮件收取 获取 查询 对象 实例 邮件 SMTP POP3 -->
|
||||
|
||||
可见性:public
|
||||
|
||||
@@ -295,7 +337,9 @@ RetrieveMailBoxSize
|
||||
|
||||
声明:property
|
||||
|
||||
用户名
|
||||
获取或设置用户名
|
||||
|
||||
<!-- tags: Object IMAP 邮件收取 获取 查询 对象 实例 邮件 SMTP POP3 -->
|
||||
|
||||
可见性:public
|
||||
|
||||
@@ -307,7 +351,9 @@ RetrieveMailBoxSize
|
||||
|
||||
声明:property
|
||||
|
||||
是否使用显式 TLS(即 STARTTLS 加密协议)
|
||||
控制是否使用显式 TLS(即 STARTTLS 加密协议)
|
||||
|
||||
<!-- tags: Object IMAP 邮件收取 对象 实例 邮件 SMTP POP3 TLS STARTTLS -->
|
||||
|
||||
可见性:public
|
||||
|
||||
@@ -319,7 +365,9 @@ RetrieveMailBoxSize
|
||||
|
||||
声明:property
|
||||
|
||||
是否采用SSL连接
|
||||
控制是否采用SSL连接
|
||||
|
||||
<!-- tags: Object IMAP 邮件收取 对象 实例 邮件 SMTP POP3 SSL -->
|
||||
|
||||
可见性:public
|
||||
|
||||
|
||||
Reference in New Issue
Block a user