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/pop3.md
+153 -68
View File
@@ -6,23 +6,37 @@
用于连接 POP3 服务器并读取或删除邮件的内置对象
<!-- tags: Object Pop3 邮件接收 读取 获取 对象 实例 邮件 SMTP IMAP -->
<!-- tags: Object Pop3 邮件接收 读取 获取 对象 实例 邮件 SMTP IMAP 创建 生成 构造函数 实例化 new -->
### `create(host, user_name, password)`
下列范例使用本机 `127.0.0.1:42110` 的临时 POP3 测试服务
测试账号为 `tsl_user` 和 `tsl_pass`，服务器需支持 APOP 认证
### `create()`
声明：function
创建 Pop3 实例
无参数构造函数。创建 Pop3 实例，连接和认证参数由实例属性设置
<!-- tags: Object Pop3 邮件接收 创建 生成 对象 实例 邮件 SMTP IMAP -->
可见性：public
| 参数 | 类型 | 说明 |
| --- | --- | --- |
| `host` | string | 可选。字符串类型。如果指定了Host参数，会自动从Pop3配置文件里获取其他相应参数，并自动连接 |
| `user_name` | string | 可选。字符串类型，用户名 |
| `password` | string | 可选。字符串类型，密码。如果该参数不指定，而指定了HOST,USERNAME参数，则在POP3配置文件里获取密码 |
### `create(host, user_name, password)`
声明：function
构造函数。按 host、user_name 和 password 初始化 Pop3 实例
<!-- tags: Object Pop3 邮件接收 创建 生成 对象 实例 邮件 SMTP IMAP -->
可见性：public
| 参数 | 类型 | 说明 |
| ----------- | ------ | ------------------------------------------------------- |
| `host` | string | Pop3 配置名称。指定后从配置文件读取服务器参数并自动连接 |
| `user_name` | string | 登录用户名 |
| `password` | string | 登录密码 |
### `capa()`
@@ -39,9 +53,21 @@
#### 示例
```tsl
//创建pop3对象
pop3Obj := new pop3("pop3.tinysoft.com.cn","username","password");
return pop3Obj.CAPA();
obj := new Pop3();
obj.host := "127.0.0.1";
obj.port := 42110;
obj.username := "tsl_user";
obj.password := "tsl_pass";
obj.useTLS := false;
obj.authType := 1;
obj.connect();
echo obj.capa();
obj.disconnect();
// 输出：
// USER
// TOP
// UIDL
// IMPLEMENTATION TSL test
```
### `checkMessages()`
@@ -59,9 +85,17 @@ return pop3Obj.CAPA();
#### 示例
```tsl
//登陆并返回邮箱中邮件数量
ret:=CreateObject('PoP3','POP3.TINYSOFT.COM.CN',uname,password);
return ret.CheckMessages();//返回整数
obj := new Pop3();
obj.host := "127.0.0.1";
obj.port := 42110;
obj.username := "tsl_user";
obj.password := "tsl_pass";
obj.useTLS := false;
obj.authType := 1;
obj.connect();
echo obj.checkMessages();
obj.disconnect();
// 输出：1
```
### `connect()`
@@ -79,15 +113,19 @@ return ret.CheckMessages();//返回整数
#### 示例
```tsl
ret:=CreateObject('Pop3');
//通过属性设置后再连接
ret.Username:=uName;
ret.Password:=passWord;
ret.Host:='POP3.TINYSOFT.COM.CN';
ret.Port:=110;
ret.UseTLS:=0;
ret.Connect(); //连接邮箱服务器
return ret.CheckMessages();
obj := new Pop3();
obj.host := "127.0.0.1";
obj.port := 42110;
obj.username := "tsl_user";
obj.password := "tsl_pass";
obj.useTLS := false;
obj.authType := 1;
echo obj.connect(), "\n";
echo obj.checkMessages(), "\n";
obj.disconnect();
// 输出：
// 0
// 1
```
### `delete(msg_id)`
@@ -100,9 +138,9 @@ return ret.CheckMessages();
可见性：public
| 参数 | 类型 | 说明 |
| --- | --- | --- |
| `msg_id` | any | msg_id |
| 参数 | 类型 | 说明 |
| -------- | ---- | ------ |
| `msg_id` | any | msg_id |
返回：boolean
@@ -176,10 +214,10 @@ return ret.CheckMessages();
可见性：public
| 参数 | 类型 | 说明 |
| --- | --- | --- |
| `msg_id` | integer | 邮件ID |
| `msg` | TSLObj | 获取成功时返回的邮件内容，具体类型可参考FAQ： MailMsg对象 |
| 参数 | 类型 | 说明 |
| -------- | ------- | --------------------------------------------------------- |
| `msg_id` | integer | 邮件ID |
| `msg` | TSLObj | 获取成功时返回的邮件内容，具体类型可参考FAQ： MailMsg对象 |
返回：boolean
@@ -193,10 +231,10 @@ return ret.CheckMessages();
可见性：public
| 参数 | 类型 | 说明 |
| --- | --- | --- |
| `msg_id` | integer | 邮件ID |
| `msg` | TSLObj | 获取成功时返回的邮件头部信息，具体类型可参考FAQ： MailMsg对象 |
| 参数 | 类型 | 说明 |
| -------- | ------- | ------------------------------------------------------------- |
| `msg_id` | integer | 邮件ID |
| `msg` | TSLObj | 获取成功时返回的邮件头部信息，具体类型可参考FAQ： MailMsg对象 |
返回：boolean
@@ -215,9 +253,17 @@ return ret.CheckMessages();
#### 示例
```tsl
//创建pop3对象
pop3Obj := new pop3("pop3.tinysoft.com.cn","username","password");
return pop3Obj.RetrieveMailBoxSize();
obj := new Pop3();
obj.host := "127.0.0.1";
obj.port := 42110;
obj.username := "tsl_user";
obj.password := "tsl_pass";
obj.useTLS := false;
obj.authType := 1;
obj.connect();
echo obj.retrieveMailBoxSize();
obj.disconnect();
// 输出：138
```
### `retrieveMsgSize(msg_id)`
@@ -230,8 +276,8 @@ return pop3Obj.RetrieveMailBoxSize();
可见性：public
| 参数 | 类型 | 说明 |
| --- | --- | --- |
| 参数 | 类型 | 说明 |
| -------- | ------- | ------------ |
| `msg_id` | integer | 指定邮件序号 |
返回：integer
@@ -239,9 +285,17 @@ return pop3Obj.RetrieveMailBoxSize();
#### 示例
```tsl
//创建pop3对象
pop3Obj := new pop3("pop3.tinysoft.com.cn","username","password");
return pop3Obj.RetrieveMsgSize(1);
obj := new Pop3();
obj.host := "127.0.0.1";
obj.port := 42110;
obj.username := "tsl_user";
obj.password := "tsl_pass";
obj.useTLS := false;
obj.authType := 1;
obj.connect();
echo obj.retrieveMsgSize(1);
obj.disconnect();
// 输出：138
```
### `retrieveRaw(msg_id, msg_content)`
@@ -254,10 +308,10 @@ return pop3Obj.RetrieveMsgSize(1);
可见性：public
| 参数 | 类型 | 说明 |
| --- | --- | --- |
| `msg_id` | integer | 邮件ID |
| `msg_content` | string | 获取成功时返回的原始邮件内容 |
| 参数 | 类型 | 说明 |
| ------------- | ------- | ---------------------------- |
| `msg_id` | integer | 邮件ID |
| `msg_content` | string | 获取成功时返回的原始邮件内容 |
返回：boolean
@@ -271,20 +325,28 @@ return pop3Obj.RetrieveMsgSize(1);
可见性：public
| 参数 | 类型 | 说明 |
| --- | --- | --- |
| `cmd` | string | 字符串类型，发送的命令 |
| `cmd_result` | string | 可选。返回的结果串 |
| `ret_code` | string | 可选。返回的代码串 |
| 参数 | 类型 | 说明 |
| ------------ | ------ | ---------------------- |
| `cmd` | string | 字符串类型，发送的命令 |
| `cmd_result` | string | 可选。返回的结果串 |
| `ret_code` | string | 可选。返回的代码串 |
返回：integer
#### 示例
```tsl
ret:=CreateObject('PoP3','POP3.TINYSOFT.COM.CN',uName,password);
r:=ret.SendCmd('UIDL 1',cr,rc);//获取指定邮件的唯一标识
return array(r,cr,rc);
obj := new Pop3();
obj.host := "127.0.0.1";
obj.port := 42110;
obj.username := "tsl_user";
obj.password := "tsl_pass";
obj.useTLS := false;
obj.authType := 1;
obj.connect();
echo obj.sendCmd("UIDL 1", cmd_result, ret_code);
obj.disconnect();
// 输出：0
```
### `top(msg_id, result, max_lines)`
@@ -297,10 +359,10 @@ return array(r,cr,rc);
可见性：public
| 参数 | 类型 | 说明 |
| --- | --- | --- |
| `msg_id` | integer | 指定邮件序号 |
| `result` | string | 指定邮件内容返回值 |
| 参数 | 类型 | 说明 |
| ----------- | ------- | ------------------------------ |
| `msg_id` | integer | 指定邮件序号 |
| `result` | string | 指定邮件内容返回值 |
| `max_lines` | integer | 获取指定邮件前MaxLines行的内容 |
返回：boolean
@@ -308,11 +370,25 @@ return array(r,cr,rc);
#### 示例
```tsl
//创建pop3对象
pop3Obj := new pop3("pop3.tinysoft.com.cn","username","password");
ret := pop3Obj.Top(1,msg,3);
if ret then return msg;
else return "获取指定邮件前3行内容失败！";
obj := new Pop3();
obj.host := "127.0.0.1";
obj.port := 42110;
obj.username := "tsl_user";
obj.password := "tsl_pass";
obj.useTLS := false;
obj.authType := 1;
obj.connect();
obj.top(1, msg, 3);
echo msg;
obj.disconnect();
// 输出：
// From: sender@example.test
// To: recipient@example.test
// Subject: TSL POP3 test
// Message-ID: <tsl-pop3@example.test>
//
// line one
// line two
```
### `uidl(ids)`
@@ -325,8 +401,8 @@ else return "获取指定邮件前3行内容失败！";
可见性：public
| 参数 | 类型 | 说明 |
| --- | --- | --- |
| 参数 | 类型 | 说明 |
| ----- | ------ | ---------------------------- |
| `ids` | string | 字符串，存放获取到的标示列表 |
返回：boolean
@@ -334,9 +410,18 @@ else return "获取指定邮件前3行内容失败！";
#### 示例
```tsl
ret:=CreateObject('PoP3','POP3.TINYSOFT.COM.CN',uname,password);
ret.UIDL(ids); //取服务器的邮件唯一标示列表存放在ids中
return ids;
obj := new Pop3();
obj.host := "127.0.0.1";
obj.port := 42110;
obj.username := "tsl_user";
obj.password := "tsl_pass";
obj.useTLS := false;
obj.authType := 1;
obj.connect();
obj.uidl(ids);
echo ids;
obj.disconnect();
// 输出：1 tsl-message-1
```
### `AuthType`